Struct streamflow_timelock::state::TokenStreamData

#[repr(C)]
pub struct TokenStreamData {
    pub magic: u64,
    pub ix: StreamInstruction,
    pub created_at: u64,
    pub withdrawn: u64,
    pub cancel_time: u64,
    pub sender: Pubkey,
    pub sender_tokens: Pubkey,
    pub recipient: Pubkey,
    pub recipient_tokens: Pubkey,
    pub mint: Pubkey,
    pub escrow_tokens: Pubkey,
}

TokenStreamData is the struct containing metadata for an SPL token stream.

Fields

magic: u64

Magic bytes

ix: StreamInstruction

The stream instruction

created_at: u64

Timestamp when stream was created

withdrawn: u64

Amount of funds withdrawn

cancel_time: u64

Timestamp at which stream can be safely cancelled by a 3rd party (Stream is either fully vested or there isn’t enough capital to keep it active)

sender: Pubkey

Pubkey of the stream initializer

sender_tokens: Pubkey

Pubkey of the stream initializer’s token account

recipient: Pubkey

Pubkey of the stream recipient

recipient_tokens: Pubkey

Pubkey of the stream recipient’s token account

mint: Pubkey

Pubkey of the token mint

escrow_tokens: Pubkey

Pubkey of the account holding the locked tokens

Implementations

impl TokenStreamData

pub fn new(
    start_time: u64,
    end_time: u64,
    deposited_amount: u64,
    total_amount: u64,
    period: u64,
    cliff: u64,
    cliff_amount: u64,
    created_at: u64,
    sender: Pubkey,
    sender_tokens: Pubkey,
    recipient: Pubkey,
    recipient_tokens: Pubkey,
    mint: Pubkey,
    escrow_tokens: Pubkey
) -> Self

Initialize a new TokenStreamData struct.

pub fn available(&self, now: u64) -> u64

Calculate amount available for withdrawal with given timestamp.

Trait Implementations

impl BorshDeserialize for TokenStreamData where
    u64: BorshDeserialize,
    StreamInstruction: BorshDeserialize,
    u64: BorshDeserialize,
    u64: BorshDeserialize,
    u64: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize,
    Pubkey: BorshDeserialize, 

fn deserialize(buf: &mut &[u8]) -> Result<Self, Error>

Deserializes this instance from a given slice of bytes. Updates the buffer to point at the remaining bytes.

fn try_from_slice(v: &[u8]) -> Result<Self, Error>

Deserialize this instance from a slice of bytes.

impl BorshSerialize for TokenStreamData where
    u64: BorshSerialize,
    StreamInstruction: BorshSerialize,
    u64: BorshSerialize,
    u64: BorshSerialize,
    u64: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize,
    Pubkey: BorshSerialize, 

fn serialize<W: Write>(&self, writer: &mut W) -> Result<(), Error>

fn try_to_vec(&self) -> Result<Vec<u8, Global>, Error>

Serialize this instance into a vector of bytes.

impl Debug for TokenStreamData

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

Formats the value using the given formatter.

impl Default for TokenStreamData

fn default() -> TokenStreamData

Returns the “default value” for a type.