Struct StreamInstruction 

#[repr(C)]
pub struct StreamInstruction {
    pub start_time: u64,
    pub end_time: u64,
    pub deposited_amount: u64,
    pub total_amount: u64,
    pub period: u64,
    pub cliff: u64,
    pub cliff_amount: u64,
    pub is_cancelable_by_sender: bool,
    pub is_cancelable_by_recipient: bool,
    pub is_withdrawal_public: bool,
    pub is_transferable: bool,
    pub padding: u32,
}

The struct containing instructions for initializing a stream

Fields

start_time: u64

Timestamp when the tokens start vesting

end_time: u64

Timestamp when all tokens are fully vested

deposited_amount: u64

Initially deposited amount of tokens (currently not used, set to total_amount and left for extension in future)

total_amount: u64

Total amount of the tokens in the escrow account if contract is fully vested

period: u64

Time step (period) in seconds per which the vesting occurs

cliff: u64

Vesting contract “cliff” timestamp

cliff_amount: u64

Amount unlocked at the “cliff” timestamp

is_cancelable_by_sender: bool

Whether or not a stream can be canceled by a sender (currently not used, set to TRUE)

is_cancelable_by_recipient: bool

Whether or not a stream can be canceled by a recipient (currently not used, set to FALSE)

is_withdrawal_public: bool

Whether or not a 3rd party can initiate withdraw in the name of recipient (currently not used, set to FALSE)

is_transferable: bool

Whether or not a recipient can transfer the stream (currently not used, set to TRUE)

padding: u32

Implementations

impl StreamInstruction

pub fn new( start_time: u64, end_time: u64, total_amount: u64, period: u64, cliff: u64, cliff_amount: u64, ) -> Self

Trait Implementations

impl BorshDeserialize for StreamInstruction

where u64: BorshDeserialize, bool: BorshDeserialize, u32: 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 StreamInstruction

where u64: BorshSerialize, bool: BorshSerialize, u32: BorshSerialize,

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

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

Serialize this instance into a vector of bytes.

impl Clone for StreamInstruction

fn clone(&self) -> StreamInstruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamInstruction

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

Formats the value using the given formatter.

impl Default for StreamInstruction

fn default() -> Self

Returns the “default value” for a type.