Struct streamflow_sdk::state::Contract

source · [−]

#[repr(C)]
pub struct Contract {Show 26 fields
    pub magic: u64,
    pub version: u8,
    pub created_at: u64,
    pub amount_withdrawn: u64,
    pub canceled_at: u64,
    pub end_time: u64,
    pub last_withdrawn_at: u64,
    pub sender: Pubkey,
    pub sender_tokens: Pubkey,
    pub recipient: Pubkey,
    pub recipient_tokens: Pubkey,
    pub mint: Pubkey,
    pub escrow_tokens: Pubkey,
    pub streamflow_treasury: Pubkey,
    pub streamflow_treasury_tokens: Pubkey,
    pub streamflow_fee_total: u64,
    pub streamflow_fee_withdrawn: u64,
    pub streamflow_fee_percent: f32,
    pub partner: Pubkey,
    pub partner_tokens: Pubkey,
    pub partner_fee_total: u64,
    pub partner_fee_withdrawn: u64,
    pub partner_fee_percent: f32,
    pub ix: CreateParams,
    pub ix_padding: Vec<u8>,
    pub closed: bool,
}

Expand description

The struct containing metadata for an SPL token stream

Fields

magic: u64

Magic bytes

version: u8

Version of the program

created_at: u64

Timestamp when stream was created

amount_withdrawn: u64

Amount of funds withdrawn

canceled_at: u64

Timestamp when stream was canceled (if canceled)

end_time: u64

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

last_withdrawn_at: u64

Timestamp of the last withdrawal

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

Escrow account holding the locked tokens for recipient

streamflow_treasury: Pubkey

Streamflow treasury authority

streamflow_treasury_tokens: Pubkey

Escrow account holding the locked tokens for Streamflow (fee account)

streamflow_fee_total: u64

The total fee amount for streamflow

streamflow_fee_withdrawn: u64

The withdrawn fee amount for streamflow

streamflow_fee_percent: f32

Fee percentage for Streamflow

partner: Pubkey

Streamflow partner authority

partner_tokens: Pubkey

Escrow account holding the locked tokens for Streamflow partner (fee account)

partner_fee_total: u64

The total fee amount for the partner

partner_fee_withdrawn: u64

The withdrawn fee amount for the partner

partner_fee_percent: f32

Fee percentage for partner

ix: CreateParams

The stream instruction

ix_padding: Vec<u8>

Padding for ix: CreateParams to allow for future upgrades.

closed: bool

Trait Implementations

source

impl BorshDeserialize for Contract where
 u64: BorshDeserialize,
 u8: BorshDeserialize,
 u64: BorshDeserialize,
 u64: BorshDeserialize,
 u64: BorshDeserialize,
 u64: BorshDeserialize,
 u64: BorshDeserialize,
 Pubkey: BorshDeserialize,
 Pubkey: BorshDeserialize,
 Pubkey: BorshDeserialize,
 Pubkey: BorshDeserialize,
 Pubkey: BorshDeserialize,
 Pubkey: BorshDeserialize,
 Pubkey: BorshDeserialize,
 Pubkey: BorshDeserialize,
 u64: BorshDeserialize,
 u64: BorshDeserialize,
 f32: BorshDeserialize,
 Pubkey: BorshDeserialize,
 Pubkey: BorshDeserialize,
 u64: BorshDeserialize,
 u64: BorshDeserialize,
 f32: BorshDeserialize,
 CreateParams: BorshDeserialize,
 Vec<u8>: BorshDeserialize,
 bool: BorshDeserialize,

source

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. Read more

source

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

Deserialize this instance from a slice of bytes.

source

impl BorshSerialize for Contract where
 u64: BorshSerialize,
 u8: BorshSerialize,
 u64: BorshSerialize,
 u64: BorshSerialize,
 u64: BorshSerialize,
 u64: BorshSerialize,
 u64: BorshSerialize,
 Pubkey: BorshSerialize,
 Pubkey: BorshSerialize,
 Pubkey: BorshSerialize,
 Pubkey: BorshSerialize,
 Pubkey: BorshSerialize,
 Pubkey: BorshSerialize,
 Pubkey: BorshSerialize,
 Pubkey: BorshSerialize,
 u64: BorshSerialize,
 u64: BorshSerialize,
 f32: BorshSerialize,
 Pubkey: BorshSerialize,
 Pubkey: BorshSerialize,
 u64: BorshSerialize,
 u64: BorshSerialize,
 f32: BorshSerialize,
 CreateParams: BorshSerialize,
 Vec<u8>: BorshSerialize,
 bool: BorshSerialize,

source

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

source

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

impl RefUnwindSafe for Contract

impl Send for Contract

impl Sync for Contract

impl Unpin for Contract

impl UnwindSafe for Contract

Blanket Implementations

Creates owned data from borrowed data, usually by cloning. Read more

source

pub fn clone_into(&self, target: &mut T)

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct streamflow_sdk::state::Contract

Fields

Trait Implementations

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

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

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

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

impl Clone for Contract

fn clone(&self) -> Contract

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

impl Debug for Contract

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

Auto Trait Implementations

impl RefUnwindSafe for Contract

impl Send for Contract

impl Sync for Contract

impl Unpin for Contract

impl UnwindSafe for Contract

Blanket Implementations

impl<T> AbiExample for T

pub default fn example() -> T

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> Same<T> for T

type Output = T

impl<T> ToOwned for T where T: Clone,

type Owned = T

pub fn to_owned(&self) -> T

pub fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

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

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToOwned for T where
T: Clone,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,