Struct CreateParams 

#[repr(C)]
pub struct CreateParams {

    pub start_time: u64,
    pub net_amount_deposited: u64,
    pub period: u64,
    pub amount_per_period: u64,
    pub cliff: u64,
    pub cliff_amount: u64,
    pub cancelable_by_sender: bool,
    pub cancelable_by_recipient: bool,
    pub automatic_withdrawal: bool,
    pub transferable_by_sender: bool,
    pub transferable_by_recipient: bool,
    pub can_topup: bool,
    pub stream_name: [u8; 64],
    pub withdraw_frequency: u64,
    pub ghost: u32,
    pub pausable: bool,
    pub can_update_rate: bool,
}

The struct containing parameters for initializing a stream

Fields

start_time: u64

Timestamp when the tokens start vesting

net_amount_deposited: u64

Deposited amount of tokens

period: u64

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

amount_per_period: u64

Amount released per period. Combined with period, we get a release rate.

cliff: u64

Vesting contract “cliff” timestamp

cliff_amount: u64

Amount unlocked at the “cliff” timestamp

cancelable_by_sender: bool

Whether a stream can be canceled by a sender

cancelable_by_recipient: bool

Whether a stream can be canceled by a recipient

automatic_withdrawal: bool

Whether a 3rd party can initiate withdraw in the name of recipient

transferable_by_sender: bool

Whether the sender can transfer the stream

transferable_by_recipient: bool

Whether the recipient can transfer the stream

can_topup: bool

Whether topup is enabled

stream_name: [u8; 64]

The name of this stream

withdraw_frequency: u64

Withdraw frequency

ghost: u32

used as padding len in serialization in old streams, added for backwards compatibility

pausable: bool

Whether the contract can be paused

can_update_rate: bool

Whether the contract can update release amount

Trait Implementations

impl BorshDeserialize for CreateParams

where u64: BorshDeserialize, bool: BorshDeserialize, [u8; 64]: BorshDeserialize, u32: BorshDeserialize,

fn deserialize_reader<R: Read>(reader: &mut R) -> Result<Self, Error>

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.

fn try_from_reader<R>(reader: &mut R) -> Result<Self, Error>

where R: Read,

impl BorshSerialize for CreateParams

where u64: BorshSerialize, bool: BorshSerialize, [u8; 64]: 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 CreateParams

fn clone(&self) -> CreateParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateParams

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

Formats the value using the given formatter.