Struct TransactionPlan

pub struct TransactionPlan {
    pub actions: Vec<ActionPlan>,
    pub transaction_parameters: TransactionParameters,
    pub detection_data: Option<DetectionDataPlan>,
    pub memo: Option<MemoPlan>,
}

A declaration of a planned Transaction, for use in transaction authorization and creation.

Fields

actions: Vec<ActionPlan>

transaction_parameters: TransactionParameters

detection_data: Option<DetectionDataPlan>

memo: Option<MemoPlan>

Implementations

impl TransactionPlan

pub fn authorize<R: RngCore + CryptoRng>( &self, rng: R, sk: &SpendKey, ) -> Result<AuthorizationData>

Authorize this TransactionPlan with the provided SpendKey.

The returned AuthorizationData can be used to build a Transaction.

impl TransactionPlan

pub fn build_unauth_with_actions( self, actions: Vec<Action>, witness_data: &WitnessData, ) -> Result<Transaction>

Builds a TransactionPlan by slotting in the provided prebuilt actions instead of using the ActionPlans in the TransactionPlan.

pub fn apply_auth_data( &self, auth_data: &AuthorizationData, transaction: Transaction, ) -> Result<Transaction>

Slot in the AuthorizationData and derive the synthetic blinding factors needed to compute the binding signature and assemble the transaction.

pub fn build( self, full_viewing_key: &FullViewingKey, witness_data: &WitnessData, auth_data: &AuthorizationData, ) -> Result<Transaction>

Build the serial transaction this plan describes.

pub async fn build_concurrent( self, full_viewing_key: &FullViewingKey, witness_data: &WitnessData, auth_data: &AuthorizationData, ) -> Result<Transaction>

Available on crate feature parallel only.

Build the transaction this plan describes while proving concurrently. This can be used in environments that support tokio tasks.

pub fn witness_data(&self, sct: &Tree) -> Result<WitnessData, Error>

Returns a WitnessData, which may be used to build this transaction.

impl TransactionPlan

pub fn sort_actions(&mut self)

Sort the actions in TransactionPlan by type, using the protobuf field number in the ActionPlan.

pub fn effect_hash(&self, fvk: &FullViewingKey) -> Result<EffectHash>

Computes the EffectHash for the [Transaction] described by this TransactionPlan.

This method does not require constructing the entire [Transaction], but it does require the associated FullViewingKey to derive effecting data that will be fed into the EffectHash.

This method is not an EffectingData impl because it needs an extra input, the FVK, to partially construct the transaction.

pub fn spend_plans(&self) -> impl Iterator<Item = &SpendPlan>

pub fn output_plans(&self) -> impl Iterator<Item = &OutputPlan>

pub fn delegations(&self) -> impl Iterator<Item = &Delegate>

pub fn undelegations(&self) -> impl Iterator<Item = &Undelegate>

pub fn undelegate_claim_plans( &self, ) -> impl Iterator<Item = &UndelegateClaimPlan>

pub fn ibc_actions(&self) -> impl Iterator<Item = &IbcRelay>

pub fn validator_definitions(&self) -> impl Iterator<Item = &Definition>

pub fn proposal_submits(&self) -> impl Iterator<Item = &ProposalSubmit>

pub fn proposal_withdraws(&self) -> impl Iterator<Item = &ProposalWithdraw>

pub fn delegator_vote_plans(&self) -> impl Iterator<Item = &DelegatorVotePlan>

pub fn validator_votes(&self) -> impl Iterator<Item = &ValidatorVote>

pub fn proposal_deposit_claims( &self, ) -> impl Iterator<Item = &ProposalDepositClaim>

pub fn swap_plans(&self) -> impl Iterator<Item = &SwapPlan>

pub fn swap_claim_plans(&self) -> impl Iterator<Item = &SwapClaimPlan>

pub fn community_pool_spends(&self) -> impl Iterator<Item = &CommunityPoolSpend>

pub fn community_pool_deposits( &self, ) -> impl Iterator<Item = &CommunityPoolDeposit>

pub fn community_pool_outputs( &self, ) -> impl Iterator<Item = &CommunityPoolOutput>

pub fn position_openings(&self) -> impl Iterator<Item = &PositionOpen>

pub fn position_closings(&self) -> impl Iterator<Item = &PositionClose>

pub fn position_withdrawals( &self, ) -> impl Iterator<Item = &PositionWithdrawPlan>

pub fn ics20_withdrawals(&self) -> impl Iterator<Item = &Ics20Withdrawal>

pub fn dest_addresses(&self) -> Vec<Address>

Convenience method to get all the destination addresses for each OutputPlans.

pub fn num_outputs(&self) -> usize

Convenience method to get the number of OutputPlans in this transaction.

pub fn num_spends(&self) -> usize

Convenience method to get the number of SpendPlans in this transaction.

pub fn num_proofs(&self) -> usize

Convenience method to get the number of proofs in this transaction.

pub fn populate_detection_data<R: CryptoRng + Rng>( &mut self, rng: R, precision: Precision, )

Method to populate the detection data for this transaction plan.

pub fn with_populated_detection_data<R: CryptoRng + Rng>( self, rng: R, precision_bits: Precision, ) -> Self

A builder-style version of TransactionPlan::populate_detection_data().

Populates the detection data for this transaction plan.

pub fn memo_key(&self) -> Option<PayloadKey>

Convenience method to grab the MemoKey from the plan.

Trait Implementations

impl Clone for TransactionPlan

fn clone(&self) -> TransactionPlan

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionPlan

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

Formats the value using the given formatter.

impl Default for TransactionPlan

fn default() -> TransactionPlan

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransactionPlan

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl DomainType for TransactionPlan

type Proto = TransactionPlan

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<TransactionPlan> for TransactionPlan

fn from(msg: TransactionPlan) -> Self

Converts to this type from the input type.

impl GasCost for TransactionPlan

fn gas_cost(&self) -> Gas

impl Serialize for TransactionPlan

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<TransactionPlan> for TransactionPlan

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: TransactionPlan) -> Result<Self, Self::Error>

Performs the conversion.