Module `sui_system::validator`

Struct ValidatorMetadata
Struct Validator
Struct StakingRequestEvent
Struct UnstakingRequestEvent
Struct ConvertingToFungibleStakedSuiEvent
Struct RedeemingFungibleStakedSuiEvent
Constants
Function new_metadata
Function new
Function deactivate
Function activate
Function adjust_stake_and_gas_price
Function request_add_stake
Function convert_to_fungible_staked_sui
Function redeem_fungible_staked_sui
Function request_add_stake_at_genesis
Function request_withdraw_stake
Function request_set_gas_price
Function set_candidate_gas_price
Function request_set_commission_rate
Function set_candidate_commission_rate
Function deposit_stake_rewards
Function process_pending_stakes_and_withdraws
Function is_preactive
Function metadata
Function sui_address
Function name
Function description
Function image_url
Function project_url
Function network_address
Function p2p_address
Function primary_address
Function worker_address
Function protocol_pubkey_bytes
Function proof_of_possession
Function network_pubkey_bytes
Function worker_pubkey_bytes
Function next_epoch_network_address
Function next_epoch_p2p_address
Function next_epoch_primary_address
Function next_epoch_worker_address
Function next_epoch_protocol_pubkey_bytes
Function next_epoch_proof_of_possession
Function next_epoch_network_pubkey_bytes
Function next_epoch_worker_pubkey_bytes
Function operation_cap_id
Function next_epoch_gas_price
Function total_stake_amount
Function stake_amount
Function total_stake
Function voting_power
Function set_voting_power
Function pending_stake_amount
Function pending_stake_withdraw_amount
Function gas_price
Function commission_rate
Function pool_token_exchange_rate_at_epoch
Function staking_pool_id
Function is_duplicate
Macro function both_some_and_equal
Function new_unverified_validator_operation_cap_and_transfer
Function update_name
Function update_description
Function update_image_url
Function update_project_url
Function update_next_epoch_network_address
Function update_candidate_network_address
Function update_next_epoch_p2p_address
Function update_candidate_p2p_address
Function update_next_epoch_primary_address
Function update_candidate_primary_address
Function update_next_epoch_worker_address
Function update_candidate_worker_address
Function update_next_epoch_protocol_pubkey
Function update_candidate_protocol_pubkey
Function update_next_epoch_network_pubkey
Function update_candidate_network_pubkey
Function update_next_epoch_worker_pubkey
Function update_candidate_worker_pubkey
Function effectuate_staged_metadata
Macro function do_extract
Function validate_metadata
Function validate_metadata_bcs
Function get_staking_pool_ref
Function new_from_metadata

<pre><code>use <a href="../std/address.md#std_address">std::address</a>; use <a href="../std/ascii.md#std_ascii">std::ascii</a>; use <a href="../std/bcs.md#std_bcs">std::bcs</a>; use <a href="../std/internal.md#std_internal">std::internal</a>; use <a href="../std/option.md#std_option">std::option</a>; use <a href="../std/string.md#std_string">std::string</a>; use <a href="../std/type_name.md#std_type_name">std::type_name</a>; use <a href="../std/u128.md#std_u128">std::u128</a>; use <a href="../std/u64.md#std_u64">std::u64</a>; use <a href="../std/vector.md#std_vector">std::vector</a>; use <a href="../sui/accumulator.md#sui_accumulator">sui::accumulator</a>; use <a href="../sui/accumulator_settlement.md#sui_accumulator_settlement">sui::accumulator_settlement</a>; use <a href="../sui/address.md#sui_address">sui::address</a>; use <a href="../sui/bag.md#sui_bag">sui::bag</a>; use <a href="../sui/balance.md#sui_balance">sui::balance</a>; use <a href="../sui/bcs.md#sui_bcs">sui::bcs</a>; use <a href="../sui/coin.md#sui_coin">sui::coin</a>; use <a href="../sui/config.md#sui_config">sui::config</a>; use <a href="../sui/deny_list.md#sui_deny_list">sui::deny_list</a>; use <a href="../sui/dynamic_field.md#sui_dynamic_field">sui::dynamic_field</a>; use <a href="../sui/dynamic_object_field.md#sui_dynamic_object_field">sui::dynamic_object_field</a>; use <a href="../sui/event.md#sui_event">sui::event</a>; use <a href="../sui/funds_accumulator.md#sui_funds_accumulator">sui::funds_accumulator</a>; use <a href="../sui/hash.md#sui_hash">sui::hash</a>; use <a href="../sui/hex.md#sui_hex">sui::hex</a>; use <a href="../sui/object.md#sui_object">sui::object</a>; use <a href="../sui/party.md#sui_party">sui::party</a>; use <a href="../sui/protocol_config.md#sui_protocol_config">sui::protocol_config</a>; use <a href="../sui/sui.md#sui_sui">sui::sui</a>; use <a href="../sui/table.md#sui_table">sui::table</a>; use <a href="../sui/transfer.md#sui_transfer">sui::transfer</a>; use <a href="../sui/tx_context.md#sui_tx_context">sui::tx_context</a>; use <a href="../sui/types.md#sui_types">sui::types</a>; use <a href="../sui/url.md#sui_url">sui::url</a>; use <a href="../sui/vec_map.md#sui_vec_map">sui::vec_map</a>; use <a href="../sui/vec_set.md#sui_vec_set">sui::vec_set</a>; use <a href="../sui_system/staking_pool.md#sui_system_staking_pool">sui_system::staking_pool</a>; use <a href="../sui_system/validator_cap.md#sui_system_validator_cap">sui_system::validator_cap</a>; </code></pre>

Struct `ValidatorMetadata`

<pre><code>public struct <a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">ValidatorMetadata</a> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>: address</code> </dt> <dd> The Sui Address of the validator. This is the sender that created the Validator object, and also the address to send validator/coins to during withdraws. </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>: vector<u8></code> </dt> <dd> The public key bytes corresponding to the private key that the validator holds to sign transactions. For now, this is the same as AuthorityName. </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>: vector<u8></code> </dt> <dd> The public key bytes corresponding to the private key that the validator uses to establish TLS connections </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>: vector<u8></code> </dt> <dd> The public key bytes correstponding to the Narwhal Worker </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8></code> </dt> <dd> This is a proof that the validator has ownership of the private key </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_name">name</a>: <a href="../std/string.md#std_string_String">std::string::String</a></code> </dt> <dd> A unique human-readable name of this validator. </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_description">description</a>: <a href="../std/string.md#std_string_String">std::string::String</a></code> </dt> <dd> </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>: <a href="../sui/url.md#sui_url_Url">sui::url::Url</a></code> </dt> <dd> </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>: <a href="../sui/url.md#sui_url_Url">sui::url::Url</a></code> </dt> <dd> </dd> <dt> <code>net_address: <a href="../std/string.md#std_string_String">std::string::String</a></code> </dt> <dd> The network address of the validator (could also contain extra info such as port, DNS and etc.). </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: <a href="../std/string.md#std_string_String">std::string::String</a></code> </dt> <dd> The address of the validator used for p2p activities such as state sync (could also contain extra info such as port, DNS and etc.). </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: <a href="../std/string.md#std_string_String">std::string::String</a></code> </dt> <dd> The address of the narwhal primary </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: <a href="../std/string.md#std_string_String">std::string::String</a></code> </dt> <dd> The address of the narwhal worker </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>: <a href="../std/option.md#std_option_Option">std::option::Option</a><vector<u8>></code> </dt> <dd> "next_epoch" metadata only takes effects in the next epoch. If none, current value will stay unchanged. </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_next_epoch_proof_of_possession">next_epoch_proof_of_possession</a>: <a href="../std/option.md#std_option_Option">std::option::Option</a><vector<u8>></code> </dt> <dd> </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>: <a href="../std/option.md#std_option_Option">std::option::Option</a><vector<u8>></code> </dt> <dd> </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>: <a href="../std/option.md#std_option_Option">std::option::Option</a><vector<u8>></code> </dt> <dd> </dd> <dt> <code>next_epoch_net_address: <a href="../std/option.md#std_option_Option">std::option::Option</a><<a href="../std/string.md#std_string_String">std::string::String</a>></code> </dt> <dd> </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>: <a href="../std/option.md#std_option_Option">std::option::Option</a><<a href="../std/string.md#std_string_String">std::string::String</a>></code> </dt> <dd> </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>: <a href="../std/option.md#std_option_Option">std::option::Option</a><<a href="../std/string.md#std_string_String">std::string::String</a>></code> </dt> <dd> </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>: <a href="../std/option.md#std_option_Option">std::option::Option</a><<a href="../std/string.md#std_string_String">std::string::String</a>></code> </dt> <dd> </dd> <dt> <code>extra_fields: <a href="../sui/bag.md#sui_bag_Bag">sui::bag::Bag</a></code> </dt> <dd> Any extra fields that's not defined statically. </dd> </dl> </details>

Struct `Validator`

<pre><code>public struct <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a> has store </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>: <a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">sui_system::validator::ValidatorMetadata</a></code> </dt> <dd> Summary of the validator. </dd> <dt> <code><a href="../sui_system/voting_power.md#sui_system_voting_power">voting_power</a>: u64</code> </dt> <dd> The voting power of this validator, which might be different from its stake amount. </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_operation_cap_id">operation_cap_id</a>: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> The ID of this validator's current valid <code>UnverifiedValidatorOperationCap</code> </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>: u64</code> </dt> <dd> Gas price quote, updated only at end of epoch. </dd> <dt> <code><a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>: <a href="../sui_system/staking_pool.md#sui_system_staking_pool_StakingPool">sui_system::staking_pool::StakingPool</a></code> </dt> <dd> Staking pool for this validator. </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>: u64</code> </dt> <dd> Commission rate of the validator, in basis point. </dd> <dt> <code>next_epoch_stake: u64</code> </dt> <dd> Total amount of stake that would be active in the next epoch. </dd> <dt> <code><a href="../sui_system/validator.md#sui_system_validator_next_epoch_gas_price">next_epoch_gas_price</a>: u64</code> </dt> <dd> This validator's gas price quote for the next epoch. </dd> <dt> <code>next_epoch_commission_rate: u64</code> </dt> <dd> The commission rate of the validator starting the next epoch, in basis point. </dd> <dt> <code>extra_fields: <a href="../sui/bag.md#sui_bag_Bag">sui::bag::Bag</a></code> </dt> <dd> Any extra fields that's not defined statically. </dd> </dl> </details>

Struct `StakingRequestEvent`

Event emitted when a new stake request is received.

<pre><code>public struct <a href="../sui_system/validator.md#sui_system_validator_StakingRequestEvent">StakingRequestEvent</a> has copy, drop </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> </dd> <dt> <code>validator_address: address</code> </dt> <dd> </dd> <dt> <code>staker_address: address</code> </dt> <dd> </dd> <dt> <code>epoch: u64</code> </dt> <dd> </dd> <dt> <code>amount: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `UnstakingRequestEvent`

Event emitted when a new unstake request is received.

<pre><code>public struct <a href="../sui_system/validator.md#sui_system_validator_UnstakingRequestEvent">UnstakingRequestEvent</a> has copy, drop </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> </dd> <dt> <code>validator_address: address</code> </dt> <dd> </dd> <dt> <code>staker_address: address</code> </dt> <dd> </dd> <dt> <code>stake_activation_epoch: u64</code> </dt> <dd> </dd> <dt> <code>unstaking_epoch: u64</code> </dt> <dd> </dd> <dt> <code>principal_amount: u64</code> </dt> <dd> </dd> <dt> <code>reward_amount: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `ConvertingToFungibleStakedSuiEvent`

Event emitted when a staked SUI is converted to a fungible staked SUI.

<pre><code>public struct <a href="../sui_system/validator.md#sui_system_validator_ConvertingToFungibleStakedSuiEvent">ConvertingToFungibleStakedSuiEvent</a> has copy, drop </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> </dd> <dt> <code>stake_activation_epoch: u64</code> </dt> <dd> </dd> <dt> <code>staked_sui_principal_amount: u64</code> </dt> <dd> </dd> <dt> <code>fungible_staked_sui_amount: u64</code> </dt> <dd> </dd> </dl> </details>

Struct `RedeemingFungibleStakedSuiEvent`

Event emitted when a fungible staked SUI is redeemed.

<pre><code>public struct <a href="../sui_system/validator.md#sui_system_validator_RedeemingFungibleStakedSuiEvent">RedeemingFungibleStakedSuiEvent</a> has copy, drop </code></pre> <details> <summary>Fields</summary> <dl> <dt> <code>pool_id: <a href="../sui/object.md#sui_object_ID">sui::object::ID</a></code> </dt> <dd> </dd> <dt> <code>fungible_staked_sui_amount: u64</code> </dt> <dd> </dd> <dt> <code>sui_amount: u64</code> </dt> <dd> </dd> </dl> </details>

Constants

Invalid proof_of_possession field in ValidatorMetadata

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EInvalidProofOfPossession">EInvalidProofOfPossession</a>: u64 = 0; </code></pre>

Invalid pubkey_bytes field in ValidatorMetadata

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EMetadataInvalidPubkey">EMetadataInvalidPubkey</a>: u64 = 1; </code></pre>

Invalid network_pubkey_bytes field in ValidatorMetadata

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EMetadataInvalidNetPubkey">EMetadataInvalidNetPubkey</a>: u64 = 2; </code></pre>

Invalid worker_pubkey_bytes field in ValidatorMetadata

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EMetadataInvalidWorkerPubkey">EMetadataInvalidWorkerPubkey</a>: u64 = 3; </code></pre>

Invalid net_address field in ValidatorMetadata

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EMetadataInvalidNetAddr">EMetadataInvalidNetAddr</a>: u64 = 4; </code></pre>

Invalid p2p_address field in ValidatorMetadata

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EMetadataInvalidP2pAddr">EMetadataInvalidP2pAddr</a>: u64 = 5; </code></pre>

Invalid primary_address field in ValidatorMetadata

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EMetadataInvalidPrimaryAddr">EMetadataInvalidPrimaryAddr</a>: u64 = 6; </code></pre>

Invalid worker_address field in ValidatorMetadata

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EMetadataInvalidWorkerAddr">EMetadataInvalidWorkerAddr</a>: u64 = 7; </code></pre>

Commission rate set by the validator is higher than the threshold

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_ECommissionRateTooHigh">ECommissionRateTooHigh</a>: u64 = 8; </code></pre>

Validator Metadata is too long

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>: u64 = 9; </code></pre>

Intended validator is not a candidate one.

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>: u64 = 10; </code></pre>

Stake amount is invalid or wrong.

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EInvalidStakeAmount">EInvalidStakeAmount</a>: u64 = 11; </code></pre>

Function called during non-genesis times.

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_ECalledDuringNonGenesis">ECalledDuringNonGenesis</a>: u64 = 12; </code></pre>

New Capability is not created by the validator itself

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_ENewCapNotCreatedByValidatorItself">ENewCapNotCreatedByValidatorItself</a>: u64 = 100; </code></pre>

Capability code is not valid

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EInvalidCap">EInvalidCap</a>: u64 = 101; </code></pre>

Validator trying to set gas price higher than threshold.

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EGasPriceHigherThanThreshold">EGasPriceHigherThanThreshold</a>: u64 = 102; </code></pre>

Invalid protocol public key length.

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_EInvalidProtocolPubKeyLength">EInvalidProtocolPubKeyLength</a>: u64 = 16; </code></pre>

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_MAX_COMMISSION_RATE">MAX_COMMISSION_RATE</a>: u64 = 2000; </code></pre>

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>: u64 = 256; </code></pre>

Max gas price a validator can set is 100K MIST.

<pre><code>const <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_GAS_PRICE">MAX_VALIDATOR_GAS_PRICE</a>: u64 = 100000; </code></pre>

Function `new_metadata`

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_new_metadata">new_metadata</a>(<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>: address, <a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_name">name</a>: <a href="../std/string.md#std_string_String">std::string::String</a>, <a href="../sui_system/validator.md#sui_system_validator_description">description</a>: <a href="../std/string.md#std_string_String">std::string::String</a>, <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>: <a href="../sui/url.md#sui_url_Url">sui::url::Url</a>, <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>: <a href="../sui/url.md#sui_url_Url">sui::url::Url</a>, net_address: <a href="../std/string.md#std_string_String">std::string::String</a>, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: <a href="../std/string.md#std_string_String">std::string::String</a>, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: <a href="../std/string.md#std_string_String">std::string::String</a>, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: <a href="../std/string.md#std_string_String">std::string::String</a>, extra_fields: <a href="../sui/bag.md#sui_bag_Bag">sui::bag::Bag</a>): <a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">sui_system::validator::ValidatorMetadata</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_new_metadata">new_metadata</a>( <a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>: address, <a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_name">name</a>: String, <a href="../sui_system/validator.md#sui_system_validator_description">description</a>: String, <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>: Url, <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>: Url, net_address: String, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: String, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: String, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: String, extra_fields: Bag, ): <a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">ValidatorMetadata</a> { <a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">ValidatorMetadata</a> { <a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>, <a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>, <a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>, <a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>, <a href="../sui_system/validator.md#sui_system_validator_name">name</a>, <a href="../sui_system/validator.md#sui_system_validator_description">description</a>, <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>, <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>, net_address, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>, <a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>: option::none(), <a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>: option::none(), <a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>: option::none(), <a href="../sui_system/validator.md#sui_system_validator_next_epoch_proof_of_possession">next_epoch_proof_of_possession</a>: option::none(), next_epoch_net_address: option::none(), <a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>: option::none(), <a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>: option::none(), <a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>: option::none(), extra_fields, } } </code></pre> </details>

Function `new`

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_new">new</a>(<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>: address, <a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_name">name</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_description">description</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>: vector<u8>, net_address: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>: u64, <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>: u64, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_new">new</a>( <a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>: address, <a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_name">name</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_description">description</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>: vector<u8>, net_address: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>: u64, <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>: u64, ctx: &mut TxContext, ): <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a> { assert!( net_address.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a> && <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a> && <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a> && <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a> && <a href="../sui_system/validator.md#sui_system_validator_name">name</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a> && <a href="../sui_system/validator.md#sui_system_validator_description">description</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a> && <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a> && <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); assert!(<a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a> <= <a href="../sui_system/validator.md#sui_system_validator_MAX_COMMISSION_RATE">MAX_COMMISSION_RATE</a>, <a href="../sui_system/validator.md#sui_system_validator_ECommissionRateTooHigh">ECommissionRateTooHigh</a>); assert!(<a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a> < <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_GAS_PRICE">MAX_VALIDATOR_GAS_PRICE</a>, <a href="../sui_system/validator.md#sui_system_validator_EGasPriceHigherThanThreshold">EGasPriceHigherThanThreshold</a>); let <a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a> = <a href="../sui_system/validator.md#sui_system_validator_new_metadata">new_metadata</a>( <a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>, <a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>, <a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>, <a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>, <a href="../sui_system/validator.md#sui_system_validator_name">name</a>.to_ascii_string().to_string(), <a href="../sui_system/validator.md#sui_system_validator_description">description</a>.to_ascii_string().to_string(), url::new_unsafe_from_bytes(<a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>), url::new_unsafe_from_bytes(<a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>), net_address.to_ascii_string().to_string(), <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>.to_ascii_string().to_string(), <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>.to_ascii_string().to_string(), <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>.to_ascii_string().to_string(), bag::new(ctx), ); // Checks that the keys & addresses & PoP are valid. <a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); <a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_new_from_metadata">new_from_metadata</a>(<a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>, <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>, ctx) } </code></pre> </details>

Function `deactivate`

Mark Validator's <code>StakingPool</code> as inactive by setting the <code>deactivation_epoch</code>.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_deactivate">deactivate</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, deactivation_epoch: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_deactivate">deactivate</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, deactivation_epoch: u64) { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.deactivate_staking_pool(deactivation_epoch) } </code></pre> </details>

Function `activate`

Activate Validator's <code>StakingPool</code> by setting the <code>activation_epoch</code>.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_activate">activate</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, activation_epoch: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_activate">activate</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, activation_epoch: u64) { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.activate_staking_pool(activation_epoch); } </code></pre> </details>

Function `adjust_stake_and_gas_price`

Process pending stake and pending withdraws, and update the gas price.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_adjust_stake_and_gas_price">adjust_stake_and_gas_price</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_adjust_stake_and_gas_price">adjust_stake_and_gas_price</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>) { self.<a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a> = self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_gas_price">next_epoch_gas_price</a>; self.<a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a> = self.next_epoch_commission_rate; } </code></pre> </details>

Function `request_add_stake`

Request to add stake to the validator's staking pool, processed at the end of the epoch.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_add_stake">request_add_stake</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, stake: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><<a href="../sui/sui.md#sui_sui_SUI">sui::sui::SUI</a>>, staker_address: address, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui_system/staking_pool.md#sui_system_staking_pool_StakedSui">sui_system::staking_pool::StakedSui</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_add_stake">request_add_stake</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, stake: Balance<SUI>, staker_address: address, ctx: &mut TxContext, ): StakedSui { let <a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a> = stake.value(); assert!(<a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a> > 0, <a href="../sui_system/validator.md#sui_system_validator_EInvalidStakeAmount">EInvalidStakeAmount</a>); let stake_epoch = ctx.epoch() + 1; let staked_sui = self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_request_add_stake">request_add_stake</a>(stake, stake_epoch, ctx); // Process stake right away if staking pool is preactive. if (self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>()) { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.process_pending_stake(); }; self.next_epoch_stake = self.next_epoch_stake + <a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a>; event::emit(<a href="../sui_system/validator.md#sui_system_validator_StakingRequestEvent">StakingRequestEvent</a> { pool_id: self.<a href="../sui_system/validator.md#sui_system_validator_staking_pool_id">staking_pool_id</a>(), validator_address: self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>, staker_address, epoch: ctx.epoch(), amount: <a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a>, }); staked_sui } </code></pre> </details>

Function `convert_to_fungible_staked_sui`

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_convert_to_fungible_staked_sui">convert_to_fungible_staked_sui</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, staked_sui: <a href="../sui_system/staking_pool.md#sui_system_staking_pool_StakedSui">sui_system::staking_pool::StakedSui</a>, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui_system/staking_pool.md#sui_system_staking_pool_FungibleStakedSui">sui_system::staking_pool::FungibleStakedSui</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_convert_to_fungible_staked_sui">convert_to_fungible_staked_sui</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, staked_sui: StakedSui, ctx: &mut TxContext, ): FungibleStakedSui { let stake_activation_epoch = staked_sui.activation_epoch(); let staked_sui_principal_amount = staked_sui.amount(); let fungible_staked_sui = self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_convert_to_fungible_staked_sui">convert_to_fungible_staked_sui</a>(staked_sui, ctx); event::emit(<a href="../sui_system/validator.md#sui_system_validator_ConvertingToFungibleStakedSuiEvent">ConvertingToFungibleStakedSuiEvent</a> { pool_id: self.<a href="../sui_system/validator.md#sui_system_validator_staking_pool_id">staking_pool_id</a>(), stake_activation_epoch, staked_sui_principal_amount, fungible_staked_sui_amount: fungible_staked_sui.value(), }); fungible_staked_sui } </code></pre> </details>

Function `redeem_fungible_staked_sui`

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_redeem_fungible_staked_sui">redeem_fungible_staked_sui</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, fungible_staked_sui: <a href="../sui_system/staking_pool.md#sui_system_staking_pool_FungibleStakedSui">sui_system::staking_pool::FungibleStakedSui</a>, ctx: &<a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><<a href="../sui/sui.md#sui_sui_SUI">sui::sui::SUI</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_redeem_fungible_staked_sui">redeem_fungible_staked_sui</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, fungible_staked_sui: FungibleStakedSui, ctx: &TxContext, ): Balance<SUI> { let fungible_staked_sui_amount = fungible_staked_sui.value(); let sui = self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_redeem_fungible_staked_sui">redeem_fungible_staked_sui</a>(fungible_staked_sui, ctx); self.next_epoch_stake = self.next_epoch_stake - sui.value(); event::emit(<a href="../sui_system/validator.md#sui_system_validator_RedeemingFungibleStakedSuiEvent">RedeemingFungibleStakedSuiEvent</a> { pool_id: self.<a href="../sui_system/validator.md#sui_system_validator_staking_pool_id">staking_pool_id</a>(), fungible_staked_sui_amount, sui_amount: sui.value(), }); sui } </code></pre> </details>

Function `request_add_stake_at_genesis`

Request to add stake to the validator's staking pool at genesis

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_add_stake_at_genesis">request_add_stake_at_genesis</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, stake: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><<a href="../sui/sui.md#sui_sui_SUI">sui::sui::SUI</a>>, staker_address: address, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_add_stake_at_genesis">request_add_stake_at_genesis</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, stake: Balance<SUI>, staker_address: address, ctx: &mut TxContext, ) { assert!(ctx.epoch() == 0, <a href="../sui_system/validator.md#sui_system_validator_ECalledDuringNonGenesis">ECalledDuringNonGenesis</a>); let <a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a> = stake.value(); assert!(<a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a> > 0, <a href="../sui_system/validator.md#sui_system_validator_EInvalidStakeAmount">EInvalidStakeAmount</a>); // 0 = <a href="../sui_system/genesis.md#sui_system_genesis">genesis</a> epoch let staked_sui = self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_request_add_stake">request_add_stake</a>(stake, 0, ctx); transfer::public_transfer(staked_sui, staker_address); // Process stake right away self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.process_pending_stake(); self.next_epoch_stake = self.next_epoch_stake + <a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a>; } </code></pre> </details>

Function `request_withdraw_stake`

Request to withdraw stake from the validator's staking pool, processed at the end of the epoch.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_withdraw_stake">request_withdraw_stake</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, staked_sui: <a href="../sui_system/staking_pool.md#sui_system_staking_pool_StakedSui">sui_system::staking_pool::StakedSui</a>, ctx: &<a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><<a href="../sui/sui.md#sui_sui_SUI">sui::sui::SUI</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_withdraw_stake">request_withdraw_stake</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, staked_sui: StakedSui, ctx: &TxContext, ): Balance<SUI> { let principal_amount = staked_sui.amount(); let stake_activation_epoch = staked_sui.activation_epoch(); let withdrawn_stake = self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_request_withdraw_stake">request_withdraw_stake</a>(staked_sui, ctx); let withdraw_amount = withdrawn_stake.value(); let reward_amount = withdraw_amount - principal_amount; self.next_epoch_stake = self.next_epoch_stake - withdraw_amount; event::emit(<a href="../sui_system/validator.md#sui_system_validator_UnstakingRequestEvent">UnstakingRequestEvent</a> { pool_id: self.<a href="../sui_system/validator.md#sui_system_validator_staking_pool_id">staking_pool_id</a>(), validator_address: self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>, staker_address: ctx.sender(), stake_activation_epoch, unstaking_epoch: ctx.epoch(), principal_amount, reward_amount, }); withdrawn_stake } </code></pre> </details>

Function `request_set_gas_price`

Request to set new gas price for the next epoch. Need to present a <code>ValidatorOperationCap</code>.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_set_gas_price">request_set_gas_price</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, verified_cap: <a href="../sui_system/validator_cap.md#sui_system_validator_cap_ValidatorOperationCap">sui_system::validator_cap::ValidatorOperationCap</a>, new_price: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_set_gas_price">request_set_gas_price</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, verified_cap: ValidatorOperationCap, new_price: u64, ) { assert!(new_price < <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_GAS_PRICE">MAX_VALIDATOR_GAS_PRICE</a>, <a href="../sui_system/validator.md#sui_system_validator_EGasPriceHigherThanThreshold">EGasPriceHigherThanThreshold</a>); let validator_address = verified_cap.verified_operation_cap_address(); assert!(validator_address == self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>, <a href="../sui_system/validator.md#sui_system_validator_EInvalidCap">EInvalidCap</a>); self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_gas_price">next_epoch_gas_price</a> = new_price; } </code></pre> </details>

Function `set_candidate_gas_price`

Set new gas price for the candidate validator.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_set_candidate_gas_price">set_candidate_gas_price</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, verified_cap: <a href="../sui_system/validator_cap.md#sui_system_validator_cap_ValidatorOperationCap">sui_system::validator_cap::ValidatorOperationCap</a>, new_price: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_set_candidate_gas_price">set_candidate_gas_price</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, verified_cap: ValidatorOperationCap, new_price: u64, ) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); assert!(new_price < <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_GAS_PRICE">MAX_VALIDATOR_GAS_PRICE</a>, <a href="../sui_system/validator.md#sui_system_validator_EGasPriceHigherThanThreshold">EGasPriceHigherThanThreshold</a>); let validator_address = verified_cap.verified_operation_cap_address(); assert!(validator_address == self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>, <a href="../sui_system/validator.md#sui_system_validator_EInvalidCap">EInvalidCap</a>); self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_gas_price">next_epoch_gas_price</a> = new_price; self.<a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a> = new_price; } </code></pre> </details>

Function `request_set_commission_rate`

Request to set new commission rate for the next epoch.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_set_commission_rate">request_set_commission_rate</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, new_commission_rate: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_request_set_commission_rate">request_set_commission_rate</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, new_commission_rate: u64) { assert!(new_commission_rate <= <a href="../sui_system/validator.md#sui_system_validator_MAX_COMMISSION_RATE">MAX_COMMISSION_RATE</a>, <a href="../sui_system/validator.md#sui_system_validator_ECommissionRateTooHigh">ECommissionRateTooHigh</a>); self.next_epoch_commission_rate = new_commission_rate; } </code></pre> </details>

Function `set_candidate_commission_rate`

Set new commission rate for the candidate validator.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_set_candidate_commission_rate">set_candidate_commission_rate</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, new_commission_rate: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_set_candidate_commission_rate">set_candidate_commission_rate</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, new_commission_rate: u64) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); assert!(new_commission_rate <= <a href="../sui_system/validator.md#sui_system_validator_MAX_COMMISSION_RATE">MAX_COMMISSION_RATE</a>, <a href="../sui_system/validator.md#sui_system_validator_ECommissionRateTooHigh">ECommissionRateTooHigh</a>); self.<a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a> = new_commission_rate; } </code></pre> </details>

Function `deposit_stake_rewards`

Deposit stakes rewards into the validator's staking pool, called at the end of the epoch.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_deposit_stake_rewards">deposit_stake_rewards</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, reward: <a href="../sui/balance.md#sui_balance_Balance">sui::balance::Balance</a><<a href="../sui/sui.md#sui_sui_SUI">sui::sui::SUI</a>>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_deposit_stake_rewards">deposit_stake_rewards</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, reward: Balance<SUI>) { self.next_epoch_stake = self.next_epoch_stake + reward.value(); self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.deposit_rewards(reward); } </code></pre> </details>

Function `process_pending_stakes_and_withdraws`

Process pending stakes and withdraws, called at the end of the epoch.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_process_pending_stakes_and_withdraws">process_pending_stakes_and_withdraws</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, ctx: &<a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_process_pending_stakes_and_withdraws">process_pending_stakes_and_withdraws</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, ctx: &TxContext) { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_process_pending_stakes_and_withdraws">process_pending_stakes_and_withdraws</a>(ctx); // TODO: bring this assertion back when we are ready. // assert!(<a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a>(self) == self.next_epoch_stake, <a href="../sui_system/validator.md#sui_system_validator_EInvalidStakeAmount">EInvalidStakeAmount</a>); } </code></pre> </details>

Function `is_preactive`

Returns true if the validator is preactive.

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): bool { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>() } </code></pre> </details>

Function `metadata`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">sui_system::validator::ValidatorMetadata</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &<a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">ValidatorMetadata</a> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a> } </code></pre> </details>

Function `sui_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): address </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): address { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a> } </code></pre> </details>

Function `name`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_name">name</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/string.md#std_string_String">std::string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_name">name</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &String { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_name">name</a> } </code></pre> </details>

Function `description`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_description">description</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/string.md#std_string_String">std::string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_description">description</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &String { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_description">description</a> } </code></pre> </details>

Function `image_url`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../sui/url.md#sui_url_Url">sui::url::Url</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Url { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a> } </code></pre> </details>

Function `project_url`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../sui/url.md#sui_url_Url">sui::url::Url</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Url { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a> } </code></pre> </details>

Function `network_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_network_address">network_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/string.md#std_string_String">std::string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_network_address">network_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &String { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.net_address } </code></pre> </details>

Function `p2p_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/string.md#std_string_String">std::string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &String { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a> } </code></pre> </details>

Function `primary_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/string.md#std_string_String">std::string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &String { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a> } </code></pre> </details>

Function `worker_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/string.md#std_string_String">std::string::String</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &String { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a> } </code></pre> </details>

Function `protocol_pubkey_bytes`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &vector<u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &vector<u8> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a> } </code></pre> </details>

Function `proof_of_possession`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &vector<u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &vector<u8> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a> } </code></pre> </details>

Function `network_pubkey_bytes`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &vector<u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &vector<u8> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a> } </code></pre> </details>

Function `worker_pubkey_bytes`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &vector<u8> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &vector<u8> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a> } </code></pre> </details>

Function `next_epoch_network_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_address">next_epoch_network_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/option.md#std_option_Option">std::option::Option</a><<a href="../std/string.md#std_string_String">std::string::String</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_address">next_epoch_network_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Option<String> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.next_epoch_net_address } </code></pre> </details>

Function `next_epoch_p2p_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/option.md#std_option_Option">std::option::Option</a><<a href="../std/string.md#std_string_String">std::string::String</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Option<String> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a> } </code></pre> </details>

Function `next_epoch_primary_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/option.md#std_option_Option">std::option::Option</a><<a href="../std/string.md#std_string_String">std::string::String</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Option<String> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a> } </code></pre> </details>

Function `next_epoch_worker_address`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/option.md#std_option_Option">std::option::Option</a><<a href="../std/string.md#std_string_String">std::string::String</a>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Option<String> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a> } </code></pre> </details>

Function `next_epoch_protocol_pubkey_bytes`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/option.md#std_option_Option">std::option::Option</a><vector<u8>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Option<vector<u8>> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a> } </code></pre> </details>

Function `next_epoch_proof_of_possession`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_proof_of_possession">next_epoch_proof_of_possession</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/option.md#std_option_Option">std::option::Option</a><vector<u8>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_proof_of_possession">next_epoch_proof_of_possession</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Option<vector<u8>> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_proof_of_possession">next_epoch_proof_of_possession</a> } </code></pre> </details>

Function `next_epoch_network_pubkey_bytes`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/option.md#std_option_Option">std::option::Option</a><vector<u8>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Option<vector<u8>> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a> } </code></pre> </details>

Function `next_epoch_worker_pubkey_bytes`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../std/option.md#std_option_Option">std::option::Option</a><vector<u8>> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &Option<vector<u8>> { &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a> } </code></pre> </details>

Function `operation_cap_id`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_operation_cap_id">operation_cap_id</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../sui/object.md#sui_object_ID">sui::object::ID</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_operation_cap_id">operation_cap_id</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &ID { &self.<a href="../sui_system/validator.md#sui_system_validator_operation_cap_id">operation_cap_id</a> } </code></pre> </details>

Function `next_epoch_gas_price`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_gas_price">next_epoch_gas_price</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_next_epoch_gas_price">next_epoch_gas_price</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_gas_price">next_epoch_gas_price</a> } </code></pre> </details>

Function `total_stake_amount`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_total_stake_amount">total_stake_amount</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_total_stake_amount">total_stake_amount</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.sui_balance() } </code></pre> </details>

Function `stake_amount`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_stake_amount">stake_amount</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.sui_balance() } </code></pre> </details>

Function `total_stake`

Return the total amount staked with this validator

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_total_stake">total_stake</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_total_stake">total_stake</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.sui_balance() } </code></pre> </details>

Function `voting_power`

Return the voting power of this validator.

<pre><code>public fun <a href="../sui_system/voting_power.md#sui_system_voting_power">voting_power</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/voting_power.md#sui_system_voting_power">voting_power</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/voting_power.md#sui_system_voting_power">voting_power</a> } </code></pre> </details>

Function `set_voting_power`

Set the voting power of this validator, called only from validator_set.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_set_voting_power">set_voting_power</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, new_voting_power: u64) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_set_voting_power">set_voting_power</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, new_voting_power: u64) { self.<a href="../sui_system/voting_power.md#sui_system_voting_power">voting_power</a> = new_voting_power; } </code></pre> </details>

Function `pending_stake_amount`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_pending_stake_amount">pending_stake_amount</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_pending_stake_amount">pending_stake_amount</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_pending_stake_amount">pending_stake_amount</a>() } </code></pre> </details>

Function `pending_stake_withdraw_amount`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_pending_stake_withdraw_amount">pending_stake_withdraw_amount</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_pending_stake_withdraw_amount">pending_stake_withdraw_amount</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_pending_stake_withdraw_amount">pending_stake_withdraw_amount</a>() } </code></pre> </details>

Function `gas_price`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a> } </code></pre> </details>

Function `commission_rate`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): u64 </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): u64 { self.<a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a> } </code></pre> </details>

Function `pool_token_exchange_rate_at_epoch`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_pool_token_exchange_rate_at_epoch">pool_token_exchange_rate_at_epoch</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, epoch: u64): <a href="../sui_system/staking_pool.md#sui_system_staking_pool_PoolTokenExchangeRate">sui_system::staking_pool::PoolTokenExchangeRate</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_pool_token_exchange_rate_at_epoch">pool_token_exchange_rate_at_epoch</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, epoch: u64): PoolTokenExchangeRate { self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>.<a href="../sui_system/validator.md#sui_system_validator_pool_token_exchange_rate_at_epoch">pool_token_exchange_rate_at_epoch</a>(epoch) } </code></pre> </details>

Function `staking_pool_id`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_staking_pool_id">staking_pool_id</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): <a href="../sui/object.md#sui_object_ID">sui::object::ID</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_staking_pool_id">staking_pool_id</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): ID { object::id(&self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>) } </code></pre> </details>

Function `is_duplicate`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_is_duplicate">is_duplicate</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, other: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_is_duplicate">is_duplicate</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, other: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): bool { let self = &self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>; let other = &other.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>; self.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a> == other.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a> || self.<a href="../sui_system/validator.md#sui_system_validator_name">name</a> == other.<a href="../sui_system/validator.md#sui_system_validator_name">name</a> || self.net_address == other.net_address || self.<a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a> == other.<a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a> || self.<a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a> == other.<a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a> || self.<a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a> == other.<a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a> || self.<a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a> == other.<a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a> || self.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a> == other.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a> || self.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a> == other.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a> || self.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a> == other.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a> || self.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a> == other.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a> // All next epoch parameters. || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.next_epoch_net_address, other.next_epoch_net_address) || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>, other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>) || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>, other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>) || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>, other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>) || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>, other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>) || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>, other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>) || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>, other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>) || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>, other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>) || <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a>!(self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>, other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>) // My next epoch parameters with other current epoch parameters. || self.next_epoch_net_address.is_some_and!(|v| v == other.net_address) || self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>.is_some_and!(|v| v == other.<a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>) || self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>.is_some_and!(|v| v == other.<a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>) || self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>.is_some_and!(|v| v == other.<a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>) || self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>.is_some_and!(|v| v == other.<a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>) || self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>.is_some_and!(|v| v == other.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>) || self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>.is_some_and!(|v| v == other.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>) || self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>.is_some_and!(|v| v == other.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>) || self.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>.is_some_and!(|v| v == other.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>) // Other next epoch parameters with my current epoch parameters. || other.next_epoch_net_address.is_some_and!(|v| v == self.net_address) || other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>.is_some_and!(|v| v == self.<a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>) || other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>.is_some_and!(|v| v == self.<a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>) || other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>.is_some_and!(|v| v == self.<a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>) || other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>.is_some_and!(|v| v == self.<a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a>) || other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>.is_some_and!(|v| v == self.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>) || other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>.is_some_and!(|v| v == self.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>) || other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>.is_some_and!(|v| v == self.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a>) || other.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>.is_some_and!(|v| v == self.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a>) } </code></pre> </details>

Macro function `both_some_and_equal`

<pre><code>macro fun <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a><$T>($a: <a href="../std/option.md#std_option_Option">std::option::Option</a><$T>, $b: <a href="../std/option.md#std_option_Option">std::option::Option</a><$T>): bool </code></pre> <details> <summary>Implementation</summary> <pre><code>macro fun <a href="../sui_system/validator.md#sui_system_validator_both_some_and_equal">both_some_and_equal</a><$T>($a: Option<$T>, $b: Option<$T>): bool { let (a, b) = ($a, $b); a.is_some_and!(|a| b.is_some_and!(|b| a == b)) } </code></pre> </details>

Function `new_unverified_validator_operation_cap_and_transfer`

Create a new <code>UnverifiedValidatorOperationCap</code>, transfer to the validator, and registers it, thus revoking the previous cap's permission.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_new_unverified_validator_operation_cap_and_transfer">new_unverified_validator_operation_cap_and_transfer</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_new_unverified_validator_operation_cap_and_transfer">new_unverified_validator_operation_cap_and_transfer</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, ctx: &mut TxContext, ) { let sender = ctx.sender(); assert!(sender == self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>, <a href="../sui_system/validator.md#sui_system_validator_ENewCapNotCreatedByValidatorItself">ENewCapNotCreatedByValidatorItself</a>); let new_id = <a href="../sui_system/validator_cap.md#sui_system_validator_cap_new_unverified_validator_operation_cap_and_transfer">validator_cap::new_unverified_validator_operation_cap_and_transfer</a>(sender, ctx); self.<a href="../sui_system/validator.md#sui_system_validator_operation_cap_id">operation_cap_id</a> = new_id; } </code></pre> </details>

Function `update_name`

Update name of the validator.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_name">update_name</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_name">name</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_name">update_name</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_name">name</a>: vector<u8>) { assert!(<a href="../sui_system/validator.md#sui_system_validator_name">name</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_name">name</a> = <a href="../sui_system/validator.md#sui_system_validator_name">name</a>.to_ascii_string().to_string(); } </code></pre> </details>

Function `update_description`

Update description of the validator.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_description">update_description</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_description">description</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_description">update_description</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_description">description</a>: vector<u8>) { assert!( <a href="../sui_system/validator.md#sui_system_validator_description">description</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_description">description</a> = <a href="../sui_system/validator.md#sui_system_validator_description">description</a>.to_ascii_string().to_string(); } </code></pre> </details>

Function `update_image_url`

Update image url of the validator.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_image_url">update_image_url</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_image_url">update_image_url</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>: vector<u8>) { assert!( <a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a> = url::new_unsafe_from_bytes(<a href="../sui_system/validator.md#sui_system_validator_image_url">image_url</a>); } </code></pre> </details>

Function `update_project_url`

Update project url of the validator.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_project_url">update_project_url</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_project_url">update_project_url</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>: vector<u8>) { assert!( <a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a> = url::new_unsafe_from_bytes(<a href="../sui_system/validator.md#sui_system_validator_project_url">project_url</a>); } </code></pre> </details>

Function `update_next_epoch_network_address`

Update network address of this validator, taking effects from next epoch

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_network_address">update_next_epoch_network_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, net_address: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_network_address">update_next_epoch_network_address</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, net_address: vector<u8>, ) { assert!( net_address.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); let net_address = net_address.to_ascii_string().to_string(); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.next_epoch_net_address = option::some(net_address); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_candidate_network_address`

Update network address of this candidate validator

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_network_address">update_candidate_network_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, net_address: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_network_address">update_candidate_network_address</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, net_address: vector<u8>, ) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); assert!( net_address.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); let net_address = net_address.to_ascii_string().to_string(); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.net_address = net_address; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_next_epoch_p2p_address`

Update p2p address of this validator, taking effects from next epoch

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_p2p_address">update_next_epoch_p2p_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_p2p_address">update_next_epoch_p2p_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: vector<u8>) { assert!( <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); let <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a> = <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>.to_ascii_string().to_string(); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a> = option::some(<a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_candidate_p2p_address`

Update p2p address of this candidate validator

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_p2p_address">update_candidate_p2p_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_p2p_address">update_candidate_p2p_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>: vector<u8>) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); assert!( <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); let <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a> = <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>.to_ascii_string().to_string(); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a> = <a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a>; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_next_epoch_primary_address`

Update primary address of this validator, taking effects from next epoch

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_primary_address">update_next_epoch_primary_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_primary_address">update_next_epoch_primary_address</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: vector<u8>, ) { assert!( <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); let <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a> = <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>.to_ascii_string().to_string(); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a> = option::some(<a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_candidate_primary_address`

Update primary address of this candidate validator

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_primary_address">update_candidate_primary_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_primary_address">update_candidate_primary_address</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>: vector<u8>, ) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); assert!( <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); let <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a> = <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>.to_ascii_string().to_string(); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a> = <a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a>; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_next_epoch_worker_address`

Update worker address of this validator, taking effects from next epoch

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_worker_address">update_next_epoch_worker_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_worker_address">update_next_epoch_worker_address</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: vector<u8>, ) { assert!( <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); let <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a> = <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>.to_ascii_string().to_string(); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a> = option::some(<a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_candidate_worker_address`

Update worker address of this candidate validator

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_worker_address">update_candidate_worker_address</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_worker_address">update_candidate_worker_address</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>: vector<u8>, ) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); assert!( <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>.length() <= <a href="../sui_system/validator.md#sui_system_validator_MAX_VALIDATOR_METADATA_LENGTH">MAX_VALIDATOR_METADATA_LENGTH</a>, <a href="../sui_system/validator.md#sui_system_validator_EValidatorMetadataExceedingLengthLimit">EValidatorMetadataExceedingLengthLimit</a>, ); let <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a> = <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>.to_ascii_string().to_string(); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a> = <a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a>; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_next_epoch_protocol_pubkey`

Update protocol public key of this validator, taking effects from next epoch

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_protocol_pubkey">update_next_epoch_protocol_pubkey</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, protocol_pubkey: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_protocol_pubkey">update_next_epoch_protocol_pubkey</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, protocol_pubkey: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8>, ) { assert!(protocol_pubkey.length() == 96, <a href="../sui_system/validator.md#sui_system_validator_EInvalidProtocolPubKeyLength">EInvalidProtocolPubKeyLength</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a> = option::some(protocol_pubkey); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_proof_of_possession">next_epoch_proof_of_possession</a> = option::some(<a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_candidate_protocol_pubkey`

Update protocol public key of this candidate validator

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_protocol_pubkey">update_candidate_protocol_pubkey</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, protocol_pubkey: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_protocol_pubkey">update_candidate_protocol_pubkey</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, protocol_pubkey: vector<u8>, <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>: vector<u8>, ) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); assert!(protocol_pubkey.length() == 96, <a href="../sui_system/validator.md#sui_system_validator_EInvalidProtocolPubKeyLength">EInvalidProtocolPubKeyLength</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a> = protocol_pubkey; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a> = <a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a>; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_next_epoch_network_pubkey`

Update network public key of this validator, taking effects from next epoch

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_network_pubkey">update_next_epoch_network_pubkey</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, network_pubkey: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_network_pubkey">update_next_epoch_network_pubkey</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, network_pubkey: vector<u8>, ) { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a> = option::some(network_pubkey); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_candidate_network_pubkey`

Update network public key of this candidate validator

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_network_pubkey">update_candidate_network_pubkey</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, network_pubkey: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_network_pubkey">update_candidate_network_pubkey</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, network_pubkey: vector<u8>, ) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a> = network_pubkey; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_next_epoch_worker_pubkey`

Update Narwhal worker public key of this validator, taking effects from next epoch

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_worker_pubkey">update_next_epoch_worker_pubkey</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, worker_pubkey: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_next_epoch_worker_pubkey">update_next_epoch_worker_pubkey</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, worker_pubkey: vector<u8>, ) { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a> = option::some(worker_pubkey); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `update_candidate_worker_pubkey`

Update Narwhal worker public key of this candidate validator

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_worker_pubkey">update_candidate_worker_pubkey</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>, worker_pubkey: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_update_candidate_worker_pubkey">update_candidate_worker_pubkey</a>( self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>, worker_pubkey: vector<u8>, ) { assert!(self.<a href="../sui_system/validator.md#sui_system_validator_is_preactive">is_preactive</a>(), <a href="../sui_system/validator.md#sui_system_validator_ENotValidatorCandidate">ENotValidatorCandidate</a>); self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a> = worker_pubkey; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.validate(); } </code></pre> </details>

Function `effectuate_staged_metadata`

Effectuate all staged next epoch metadata for this validator. NOTE: this function SHOULD ONLY be called by validator_set when advancing an epoch.

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_effectuate_staged_metadata">effectuate_staged_metadata</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_effectuate_staged_metadata">effectuate_staged_metadata</a>(self: &mut <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>) { <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a>!(&mut self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.next_epoch_net_address, |v| { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.net_address = v }); <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a>!(&mut self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_p2p_address">next_epoch_p2p_address</a>, |v| { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_p2p_address">p2p_address</a> = v }); <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a>!(&mut self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_primary_address">next_epoch_primary_address</a>, |v| { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_primary_address">primary_address</a> = v }); <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a>!(&mut self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_address">next_epoch_worker_address</a>, |v| { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_worker_address">worker_address</a> = v }); <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a>!(&mut self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_protocol_pubkey_bytes">next_epoch_protocol_pubkey_bytes</a>, |v| { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_protocol_pubkey_bytes">protocol_pubkey_bytes</a> = v; self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_proof_of_possession">proof_of_possession</a> = self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_proof_of_possession">next_epoch_proof_of_possession</a>.extract(); }); <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a>!(&mut self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_network_pubkey_bytes">next_epoch_network_pubkey_bytes</a>, |v| { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_network_pubkey_bytes">network_pubkey_bytes</a> = v }); <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a>!(&mut self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_next_epoch_worker_pubkey_bytes">next_epoch_worker_pubkey_bytes</a>, |v| { self.<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_worker_pubkey_bytes">worker_pubkey_bytes</a> = v }); } </code></pre> </details>

Macro function `do_extract`

Helper macro which extracts the value from <code>Some</code> and applies <code>$f</code> to it.

<pre><code>macro fun <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a><$T>($o: &mut <a href="../std/option.md#std_option_Option">std::option::Option</a><$T>, $f: |$T| -> ()) </code></pre> <details> <summary>Implementation</summary> <pre><code>macro fun <a href="../sui_system/validator.md#sui_system_validator_do_extract">do_extract</a><$T>($o: &mut Option<$T>, $f: |$T|) { let o = $o; if (o.is_some()) { $f(o.extract()); } } </code></pre> </details>

Function `validate_metadata`

Aborts if validator metadata is valid

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_validate_metadata">validate_metadata</a>(<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>: &<a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">sui_system::validator::ValidatorMetadata</a>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_validate_metadata">validate_metadata</a>(<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>: &<a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">ValidatorMetadata</a>) { <a href="../sui_system/validator.md#sui_system_validator_validate_metadata_bcs">validate_metadata_bcs</a>(bcs::to_bytes(<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>)); } </code></pre> </details>

Function `validate_metadata_bcs`

<pre><code>public fun <a href="../sui_system/validator.md#sui_system_validator_validate_metadata_bcs">validate_metadata_bcs</a>(<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>: vector<u8>) </code></pre> <details> <summary>Implementation</summary> <pre><code>public native fun <a href="../sui_system/validator.md#sui_system_validator_validate_metadata_bcs">validate_metadata_bcs</a>(<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>: vector<u8>); </code></pre> </details>

Function `get_staking_pool_ref`

<pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_get_staking_pool_ref">get_staking_pool_ref</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a>): &<a href="../sui_system/staking_pool.md#sui_system_staking_pool_StakingPool">sui_system::staking_pool::StakingPool</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>public(package) fun <a href="../sui_system/validator.md#sui_system_validator_get_staking_pool_ref">get_staking_pool_ref</a>(self: &<a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a>): &StakingPool { &self.<a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a> } </code></pre> </details>

Function `new_from_metadata`

Create a new validator from the given <code><a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">ValidatorMetadata</a></code>, called by both <code><a href="../sui_system/validator.md#sui_system_validator_new">new</a></code> and <code>new_for_testing</code>.

<pre><code>fun <a href="../sui_system/validator.md#sui_system_validator_new_from_metadata">new_from_metadata</a>(<a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>: <a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">sui_system::validator::ValidatorMetadata</a>, <a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>: u64, <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>: u64, ctx: &mut <a href="../sui/tx_context.md#sui_tx_context_TxContext">sui::tx_context::TxContext</a>): <a href="../sui_system/validator.md#sui_system_validator_Validator">sui_system::validator::Validator</a> </code></pre> <details> <summary>Implementation</summary> <pre><code>fun <a href="../sui_system/validator.md#sui_system_validator_new_from_metadata">new_from_metadata</a>( <a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>: <a href="../sui_system/validator.md#sui_system_validator_ValidatorMetadata">ValidatorMetadata</a>, <a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>: u64, <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>: u64, ctx: &mut TxContext, ): <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a> { let <a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a> = <a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>.<a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>; let <a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a> = <a href="../sui_system/staking_pool.md#sui_system_staking_pool_new">staking_pool::new</a>(ctx); let <a href="../sui_system/validator.md#sui_system_validator_operation_cap_id">operation_cap_id</a> = <a href="../sui_system/validator_cap.md#sui_system_validator_cap_new_unverified_validator_operation_cap_and_transfer">validator_cap::new_unverified_validator_operation_cap_and_transfer</a>( <a href="../sui_system/validator.md#sui_system_validator_sui_address">sui_address</a>, ctx, ); <a href="../sui_system/validator.md#sui_system_validator_Validator">Validator</a> { <a href="../sui_system/validator.md#sui_system_validator_metadata">metadata</a>, // Initialize the voting power to be 0. // At the epoch change where this <a href="../sui_system/validator.md#sui_system_validator">validator</a> is actually added to the // active <a href="../sui_system/validator.md#sui_system_validator">validator</a> set, the voting power will be updated accordingly. <a href="../sui_system/voting_power.md#sui_system_voting_power">voting_power</a>: 0, <a href="../sui_system/validator.md#sui_system_validator_operation_cap_id">operation_cap_id</a>, <a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>, <a href="../sui_system/staking_pool.md#sui_system_staking_pool">staking_pool</a>, <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>, next_epoch_stake: 0, <a href="../sui_system/validator.md#sui_system_validator_next_epoch_gas_price">next_epoch_gas_price</a>: <a href="../sui_system/validator.md#sui_system_validator_gas_price">gas_price</a>, next_epoch_commission_rate: <a href="../sui_system/validator.md#sui_system_validator_commission_rate">commission_rate</a>, extra_fields: bag::new(ctx), } } </code></pre> </details>

Struct ValidatorMetadata

Struct Validator

Struct StakingRequestEvent

Struct UnstakingRequestEvent

Struct ConvertingToFungibleStakedSuiEvent

Struct RedeemingFungibleStakedSuiEvent

Constants

Function new_metadata

Function new

Function deactivate

Function activate

Function adjust_stake_and_gas_price

Function request_add_stake

Function convert_to_fungible_staked_sui

Function redeem_fungible_staked_sui

Function request_add_stake_at_genesis

Function request_withdraw_stake

Function request_set_gas_price

Function set_candidate_gas_price

Function request_set_commission_rate

Function set_candidate_commission_rate

Function deposit_stake_rewards

Function process_pending_stakes_and_withdraws

Function is_preactive

Function metadata

Function sui_address

Function name

Function description

Function image_url

Function project_url

Function network_address

Function p2p_address

Function primary_address

Function worker_address

Function protocol_pubkey_bytes

Function proof_of_possession

Function network_pubkey_bytes

Function worker_pubkey_bytes

Function next_epoch_network_address

Function next_epoch_p2p_address

Function next_epoch_primary_address

Function next_epoch_worker_address

Function next_epoch_protocol_pubkey_bytes

Function next_epoch_proof_of_possession

Function next_epoch_network_pubkey_bytes

Function next_epoch_worker_pubkey_bytes

Function operation_cap_id

Function next_epoch_gas_price

Function total_stake_amount

Function stake_amount

Function total_stake

Function voting_power

Function set_voting_power

Function pending_stake_amount

Function pending_stake_withdraw_amount

Function gas_price

Function commission_rate

Function pool_token_exchange_rate_at_epoch

Function staking_pool_id

Function is_duplicate

Macro function both_some_and_equal

Function new_unverified_validator_operation_cap_and_transfer

Function update_name

Function update_description

Function update_image_url

Function update_project_url

Function update_next_epoch_network_address

Function update_candidate_network_address

Function update_next_epoch_p2p_address

Function update_candidate_p2p_address

Function update_next_epoch_primary_address

Function update_candidate_primary_address

Function update_next_epoch_worker_address

Function update_candidate_worker_address

Function update_next_epoch_protocol_pubkey

Function update_candidate_protocol_pubkey

Function update_next_epoch_network_pubkey

Function update_candidate_network_pubkey

Function update_next_epoch_worker_pubkey