Enum solana_budget_program::budget_expr::BudgetExpr

#[repr(C)]
pub enum BudgetExpr {
    Pay(Payment),
    After(Condition, Box<BudgetExpr>),
    Or((Condition, Box<BudgetExpr>), (Condition, Box<BudgetExpr>)),
    And(Condition, Condition, Box<BudgetExpr>),
}

A data type representing a payment plan.

Variants

Pay

Make a payment.

Tuple Fields of Pay

0: Payment

After

Make a payment after some condition.

Tuple Fields of After

0: Condition1: Box<BudgetExpr>

Or

Either make a payment after one condition or a different payment after another condition, which ever condition is satisfied first.

Tuple Fields of Or

0: (Condition, Box<BudgetExpr>)1: (Condition, Box<BudgetExpr>)

And

Make a payment after both of two conditions are satisfied

Tuple Fields of And

0: Condition1: Condition2: Box<BudgetExpr>

Implementations

impl BudgetExpr

pub fn new_payment(lamports: u64, to: &Pubkey) -> Self

Create the simplest budget - one that pays lamports to Pubkey.

pub fn new_authorized_payment(from: &Pubkey, lamports: u64, to: &Pubkey) -> Self

Create a budget that pays lamports to to after being witnessed by from.

pub fn new_payment_when_account_data(
    account_pubkey: &Pubkey,
    account_program_id: &Pubkey,
    account_hash: Hash,
    lamports: u64,
    to: &Pubkey
) -> Self

Create a budget that pays lamports to to after witnessing account data in account_pubkey with the given hash.

pub fn new_cancelable_authorized_payment(
    witness: &Pubkey,
    lamports: u64,
    to: &Pubkey,
    from: Option<Pubkey>
) -> Self

Create a budget that pays lamports to to after being witnessed by witness unless canceled with a signature from from.

pub fn new_2_2_multisig_payment(
    from0: &Pubkey,
    from1: &Pubkey,
    lamports: u64,
    to: &Pubkey
) -> Self

Create a budget that pays lamportstotoafter being witnessed by 2xfrom`s

pub fn new_future_payment(
    dt: DateTime<Utc>,
    dt_pubkey: &Pubkey,
    lamports: u64,
    to: &Pubkey
) -> Self

Create a budget that pays lamports to to after the given DateTime signed by dt_pubkey.

pub fn new_cancelable_future_payment(
    dt: DateTime<Utc>,
    dt_pubkey: &Pubkey,
    lamports: u64,
    to: &Pubkey,
    from: Option<Pubkey>
) -> Self

Create a budget that pays lamports to to after the given DateTime signed by dt_pubkey unless canceled by from.

pub fn final_payment(&self) -> Option<Payment>

Return Payment if the budget requires no additional Witnesses.

pub fn verify(&self, spendable_lamports: u64) -> bool

Return true if the budget spends exactly spendable_lamports.

pub fn apply_witness(&mut self, witness: &Witness, from: &Pubkey)

Apply a witness to the budget to see if the budget can be reduced. If so, modify the budget in-place.

Trait Implementations

impl Clone for BudgetExpr

fn clone(&self) -> BudgetExpr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BudgetExpr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BudgetExpr

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

Deserialize this value from the given Serde deserializer.

impl PartialEq<BudgetExpr> for BudgetExpr

fn eq(&self, other: &BudgetExpr) -> bool

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

fn ne(&self, other: &BudgetExpr) -> bool

This method tests for !=.

impl Serialize for BudgetExpr

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for BudgetExpr

impl StructuralEq for BudgetExpr

impl StructuralPartialEq for BudgetExpr