Struct SpendPlan

pub struct SpendPlan {
    pub note: Note,
    pub position: Position,
    pub randomizer: Fr,
    pub value_blinding: Fr,
    pub proof_blinding_r: Fq,
    pub proof_blinding_s: Fq,
}

A planned Spend.

Fields

note: Note

position: Position

randomizer: Fr

value_blinding: Fr

proof_blinding_r: Fq

proof_blinding_s: Fq

Implementations

impl SpendPlan

pub fn new<R: CryptoRng + RngCore>( rng: &mut R, note: Note, position: Position, ) -> SpendPlan

Create a new SpendPlan that spends the given positioned note.

pub fn dummy<R: CryptoRng + RngCore>( rng: &mut R, fvk: &FullViewingKey, ) -> SpendPlan

Create a dummy SpendPlan.

pub fn spend( &self, fvk: &FullViewingKey, auth_sig: Signature<SpendAuth>, auth_path: Proof, anchor: Root, ) -> Spend

Convenience method to construct the Spend described by this SpendPlan.

pub fn spend_body(&self, fvk: &FullViewingKey) -> Body

Construct the [spend::Body] described by this SpendPlan.

pub fn rk(&self, fvk: &FullViewingKey) -> VerificationKey<SpendAuth>

Construct the randomized verification key associated with this SpendPlan.

pub fn nullifier(&self, fvk: &FullViewingKey) -> Nullifier

Construct the Nullifier associated with this SpendPlan.

pub fn spend_proof( &self, fvk: &FullViewingKey, state_commitment_proof: Proof, anchor: Root, ) -> SpendProof

Construct the SpendProof required by the [spend::Body] described by this SpendPlan.

pub fn balance(&self) -> Balance

Trait Implementations

impl Clone for SpendPlan

fn clone(&self) -> SpendPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for SpendPlan

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SpendPlan

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for SpendPlan

type Proto = SpendPlan

fn encode_to_vec(&self) -> Vec<u8>

Encode this domain type to a byte vector, via proto type P.

fn to_proto(&self) -> Self::Proto

Convert this domain type to the associated proto type.

fn decode<B>(buf: B) -> Result<Self, Error>

where B: Buf,

Decode this domain type from a byte buffer, via proto type P.

impl From<SpendPlan> for SpendPlan

fn from(msg: SpendPlan) -> Self

Converts to this type from the input type.

impl Serialize for SpendPlan

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<SpendPlan> for SpendPlan

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: SpendPlan) -> Result<Self, Self::Error>

Performs the conversion.