Struct solana_vest_program::vest_state::VestState

[+] Show declaration

pub struct VestState {
    pub terminator_pubkey: Pubkey,
    pub payee_pubkey: Pubkey,
    pub start_date_time: DateTime<Utc>,
    pub date_pubkey: Pubkey,
    pub total_lamports: u64,
    pub redeemed_lamports: u64,
    pub reneged_lamports: u64,
    pub is_fully_vested: bool,
}

Fields

terminator_pubkey: Pubkey

[−] Expand description

The address authorized to terminate this contract with a signed Terminate instruction

payee_pubkey: Pubkey

[−] Expand description

The address authorized to redeem vested tokens

start_date_time: DateTime<Utc>

[−] Expand description

The day from which the vesting contract begins

date_pubkey: Pubkey

[−] Expand description

Address of an account containing a trusted date, used to drive the vesting schedule

total_lamports: u64

[−] Expand description

The number of lamports to send the payee if the schedule completes

redeemed_lamports: u64

[−] Expand description

The number of lamports the payee has already redeemed

reneged_lamports: u64

[−] Expand description

The number of lamports the terminator repurchased

is_fully_vested: bool

[−] Expand description

True if the terminator has declared this contract fully vested.

Implementations

impl VestState[−]

pub fn serialize(&self, output: &mut [u8]) -> Result<(), InstructionError>

pub fn deserialize(input: &[u8]) -> Result<Self, InstructionError>

pub fn redeem_tokens(
    &mut self,
    contract_account: &mut Account,
    current_date: Date<Utc>,
    payee_account: &mut Account
)[−]

Redeem vested tokens.

pub fn renege(
    &mut self,
    contract_account: &mut Account,
    payee_account: &mut Account,
    lamports: u64
)[−]

Renege on the given number of tokens and send them to the given payee.

pub fn vest_all(&mut self)[−]

Mark this contract as fully vested, regardless of the date.

Trait Implementations

impl Clone for VestState[+]

[+] Show hidden undocumented items

fn clone(&self) -> VestState[−]

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)[−]

Performs copy-assignment from source.

impl Debug for VestState[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Default for VestState[+]

[+] Show hidden undocumented items

fn default() -> Self[−]

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for VestState[+]

[+] Show hidden undocumented items

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, [−]

Deserialize this value from the given Serde deserializer.

impl PartialEq<VestState> for VestState[+]

[+] Show hidden undocumented items

fn eq(&self, other: &VestState) -> bool[−]

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

fn ne(&self, other: &VestState) -> bool[−]

This method tests for !=.

impl Serialize for VestState[+]

[+] Show hidden undocumented items

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 VestState