Enum solana_stake_program::stake_instruction::StakeInstruction

pub enum StakeInstruction {
    Initialize(Authorized, Lockup),
    Authorize(Pubkey, StakeAuthorize),
    DelegateStake,
    Split(u64),
    Withdraw(u64),
    Deactivate,
    SetLockup(LockupArgs),
}

Variants

Initialize(Authorized, Lockup)

Initialize a stake with Lockup and Authorized information

Expects 2 Accounts: 0 - Uninitialized StakeAccount 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 requires Authorized::staker or Authorized::withdrawer signature, depending on which key's being updated

Expects 2 Accounts: 0 - StakeAccount to be updated with the Pubkey for authorization 1 - Clock sysvar Account that carries clock bank epoch

DelegateStake

Delegate a stake to a particular vote account requires Authorized::staker signature

Expects 4 Accounts: 0 - Initialized StakeAccount to be delegated 1 - VoteAccount to which this Stake will be delegated 2 - Clock sysvar Account that carries clock bank epoch 3 - Config Account that carries stake config

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. Requires Authorized::staker signature and the signature of the split-off stake address.

The source stake must be either Initialized or a Stake.

Expects 2 Accounts: 0 - StakeAccount to be split 1 - Uninitialized StakeAcount that will take the split-off amount

Withdraw(u64)

Withdraw unstaked lamports from the stake account requires Authorized::withdrawer signature. If withdrawal is before lockup has expired, also requires signature of the lockup custodian.

Expects 4 Accounts: 0 - StakeAccount from which to withdraw 1 - Account to which the lamports will be transferred 2 - Syscall Account that carries epoch 3 - StakeHistory sysvar that carries stake warmup/cooldown history

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 requires Authorized::staker signature

Expects 2 Accounts: 0 - Delegate StakeAccount 1 - Syscall Account that carries epoch

SetLockup(LockupArgs)

Set stake lockup requires Lockup::custodian signature

Expects 1 Account: 0 - initialized StakeAccount

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

Formats the value using the given formatter.

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

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::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: &StakeInstruction) -> bool

This method tests for !=.

impl Serialize for StakeInstruction

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for StakeInstruction