Enum solana_sdk::stake::instruction::StakeInstruction

pub enum StakeInstruction {
    Initialize(Authorized, Lockup),
    Authorize(Pubkey, StakeAuthorize),
    DelegateStake,
    Split(u64),
    Withdraw(u64),
    Deactivate,
    SetLockup(LockupArgs),
    Merge,
    AuthorizeWithSeed(AuthorizeWithSeedArgs),
    InitializeChecked,
    AuthorizeChecked(StakeAuthorize),
    AuthorizeCheckedWithSeed(AuthorizeCheckedWithSeedArgs),
    SetLockupChecked(LockupCheckedArgs),
}

Variants

Initialize(Authorized, Lockup)

Initialize a stake with lockup and authorization information

Account references

0. [WRITE] Uninitialized stake account
1. [] Rent sysvar

Authorized carries pubkeys that must sign staker transactions and withdrawer transactions. Lockup carries information about withdrawal restrictions

Authorize(Pubkey, StakeAuthorize)

Authorize a key to manage stake or withdrawal

Account references

0. [WRITE] Stake account to be updated
1. [] Clock sysvar
2. [SIGNER] The stake or withdraw authority
3. Optional: [SIGNER] Lockup authority, if updating StakeAuthorize::Withdrawer before lockup expiration

DelegateStake

Delegate a stake to a particular vote account

Account references

0. [WRITE] Initialized stake account to be delegated
1. [] Vote account to which this stake will be delegated
2. [] Clock sysvar
3. [] Stake history sysvar that carries stake warmup/cooldown history
4. [] Address of config account that carries stake config
5. [SIGNER] Stake authority

The entire balance of the staking account is staked. DelegateStake can be called multiple times, but re-delegation is delayed by one epoch

Split(u64)

Split u64 tokens and stake off a stake account into another stake account.

Account references

0. [WRITE] Stake account to be split; must be in the Initialized or Stake state
1. [WRITE] Uninitialized stake account that will take the split-off amount
2. [SIGNER] Stake authority

Withdraw(u64)

Withdraw unstaked lamports from the stake account

Account references

0. [WRITE] Stake account from which to withdraw
1. [WRITE] Recipient account
2. [] Clock sysvar
3. [] Stake history sysvar that carries stake warmup/cooldown history
4. [SIGNER] Withdraw authority
5. Optional: [SIGNER] Lockup authority, if before lockup expiration

The u64 is the portion of the stake account balance to be withdrawn, must be <= StakeAccount.lamports - staked_lamports.

Deactivate

Deactivates the stake in the account

Account references

0. [WRITE] Delegated stake account
1. [] Clock sysvar
2. [SIGNER] Stake authority

SetLockup(LockupArgs)

Set stake lockup

If a lockup is not active, the withdraw authority may set a new lockup If a lockup is active, the lockup custodian may update the lockup parameters

Account references

0. [WRITE] Initialized stake account
1. [SIGNER] Lockup authority or withdraw authority

Merge

Merge two stake accounts.

Both accounts must have identical lockup and authority keys. A merge is possible between two stakes in the following states with no additional conditions:

• two deactivated stakes
• an inactive stake into an activating stake during its activation epoch

For the following cases, the voter pubkey and vote credits observed must match:

• two activated stakes
• two activating accounts that share an activation epoch, during the activation epoch

All other combinations of stake states will fail to merge, including all “transient” states, where a stake is activating or deactivating with a non-zero effective stake.

Account references

0. [WRITE] Destination stake account for the merge
1. [WRITE] Source stake account for to merge. This account will be drained
2. [] Clock sysvar
3. [] Stake history sysvar that carries stake warmup/cooldown history
4. [SIGNER] Stake authority

AuthorizeWithSeed(AuthorizeWithSeedArgs)

Authorize a key to manage stake or withdrawal with a derived key

Account references

0. [WRITE] Stake account to be updated
1. [SIGNER] Base key of stake or withdraw authority
2. [] Clock sysvar
3. Optional: [SIGNER] Lockup authority, if updating StakeAuthorize::Withdrawer before lockup expiration

InitializeChecked

Initialize a stake with authorization information

This instruction is similar to Initialize except that the withdraw authority must be a signer, and no lockup is applied to the account.

Account references

0. [WRITE] Uninitialized stake account
1. [] Rent sysvar
2. [] The stake authority
3. [SIGNER] The withdraw authority

AuthorizeChecked(StakeAuthorize)

Authorize a key to manage stake or withdrawal

This instruction behaves like Authorize with the additional requirement that the new stake or withdraw authority must also be a signer.

Account references

0. [WRITE] Stake account to be updated
1. [] Clock sysvar
2. [SIGNER] The stake or withdraw authority
3. [SIGNER] The new stake or withdraw authority
4. Optional: [SIGNER] Lockup authority, if updating StakeAuthorize::Withdrawer before lockup expiration

AuthorizeCheckedWithSeed(AuthorizeCheckedWithSeedArgs)

Authorize a key to manage stake or withdrawal with a derived key

This instruction behaves like AuthorizeWithSeed with the additional requirement that the new stake or withdraw authority must also be a signer.

Account references

0. [WRITE] Stake account to be updated
1. [SIGNER] Base key of stake or withdraw authority
2. [] Clock sysvar
3. [SIGNER] The new stake or withdraw authority
4. Optional: [SIGNER] Lockup authority, if updating StakeAuthorize::Withdrawer before lockup expiration

SetLockupChecked(LockupCheckedArgs)

Set stake lockup

This instruction behaves like SetLockup with the additional requirement that the new lockup authority also be a signer.

If a lockup is not active, the withdraw authority may set a new lockup If a lockup is active, the lockup custodian may update the lockup parameters

Account references

0. [WRITE] Initialized stake account
1. [SIGNER] Lockup authority or withdraw authority
2. Optional: [SIGNER] New lockup authority

Trait Implementations

impl Clone for StakeInstruction

fn clone(&self) -> StakeInstruction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for StakeInstruction

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StakeInstruction

fn deserialize<__D>( __deserializer: __D ) -> Result<StakeInstruction, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq<StakeInstruction> for StakeInstruction

fn eq(&self, other: &StakeInstruction) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StakeInstruction

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StakeInstruction