Struct penumbra_transaction::plan::TransactionPlan

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

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§

source§

impl TransactionPlan

source

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.

source§

impl TransactionPlan

source

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.

source

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.

source

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

Build the serial transaction this plan describes.

source

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.

source

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

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

source§

impl TransactionPlan

source

pub fn sort_actions(&mut self)

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

source

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.

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

source

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

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

source

pub fn num_outputs(&self) -> usize

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

source

pub fn num_spends(&self) -> usize

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

source

pub fn num_proofs(&self) -> usize

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

source

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

Method to populate the detection data for this transaction plan.

source

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.

source

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

Convenience method to grab the MemoKey from the plan.

Trait Implementations§

source§

impl Clone for TransactionPlan

source§

fn clone(&self) -> TransactionPlan

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for TransactionPlan

source§

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

Formats the value using the given formatter. Read more
source§

impl Default for TransactionPlan

source§

fn default() -> TransactionPlan

Returns the “default value” for a type. Read more
source§

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

source§

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

Deserialize this value from the given Serde deserializer. Read more
source§

impl DomainType for TransactionPlan

§

type Proto = TransactionPlan

source§

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

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

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

Convert this domain type to the associated proto type. Read more
source§

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

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

impl From<TransactionPlan> for TransactionPlan

source§

fn from(msg: TransactionPlan) -> Self

Converts to this type from the input type.
source§

impl GasCost for TransactionPlan

source§

fn gas_cost(&self) -> Gas

source§

impl Serialize for TransactionPlan

source§

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

Serialize this value into the given Serde serializer. Read more
source§

impl TryFrom<TransactionPlan> for TransactionPlan

§

type Error = Error

The type returned in the event of a conversion error.
source§

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

Performs the conversion.

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. Read more
source§

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

source§

default unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
§

impl<T> Conv for T

§

fn conv<T>(self) -> T
where Self: Into<T>,

Converts self into T using Into<T>. Read more
§

impl<T> FmtForward for T

§

fn fmt_binary(self) -> FmtBinary<Self>
where Self: Binary,

Causes self to use its Binary implementation when Debug-formatted.
§

fn fmt_display(self) -> FmtDisplay<Self>
where Self: Display,

Causes self to use its Display implementation when Debug-formatted.
§

fn fmt_lower_exp(self) -> FmtLowerExp<Self>
where Self: LowerExp,

Causes self to use its LowerExp implementation when Debug-formatted.
§

fn fmt_lower_hex(self) -> FmtLowerHex<Self>
where Self: LowerHex,

Causes self to use its LowerHex implementation when Debug-formatted.
§

fn fmt_octal(self) -> FmtOctal<Self>
where Self: Octal,

Causes self to use its Octal implementation when Debug-formatted.
§

fn fmt_pointer(self) -> FmtPointer<Self>
where Self: Pointer,

Causes self to use its Pointer implementation when Debug-formatted.
§

fn fmt_upper_exp(self) -> FmtUpperExp<Self>
where Self: UpperExp,

Causes self to use its UpperExp implementation when Debug-formatted.
§

fn fmt_upper_hex(self) -> FmtUpperHex<Self>
where Self: UpperHex,

Causes self to use its UpperHex implementation when Debug-formatted.
§

fn fmt_list(self) -> FmtList<Self>
where &'a Self: for<'a> IntoIterator,

Formats each item in a sequence. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

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

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
§

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

§

fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> R
where Self: Sized,

Pipes by value. This is generally the method you want to use. Read more
§

fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> R
where R: 'a,

Borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> R
where R: 'a,

Mutably borrows self and passes that borrow into the pipe function. Read more
§

fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
where Self: Borrow<B>, B: 'a + ?Sized, R: 'a,

Borrows self, then passes self.borrow() into the pipe function. Read more
§

fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
where Self: BorrowMut<B>, B: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.borrow_mut() into the pipe function. Read more
§

fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
where Self: AsRef<U>, U: 'a + ?Sized, R: 'a,

Borrows self, then passes self.as_ref() into the pipe function.
§

fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
where Self: AsMut<U>, U: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.as_mut() into the pipe function.
§

fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
where Self: Deref<Target = T>, T: 'a + ?Sized, R: 'a,

Borrows self, then passes self.deref() into the pipe function.
§

fn pipe_deref_mut<'a, T, R>( &'a mut self, func: impl FnOnce(&'a mut T) -> R, ) -> R
where Self: DerefMut<Target = T> + Deref, T: 'a + ?Sized, R: 'a,

Mutably borrows self, then passes self.deref_mut() into the pipe function.
§

impl<T> Pointable for T

§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
§

impl<T> Tap for T

§

fn tap(self, func: impl FnOnce(&Self)) -> Self

Immutable access to a value. Read more
§

fn tap_mut(self, func: impl FnOnce(&mut Self)) -> Self

Mutable access to a value. Read more
§

fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Immutable access to the Borrow<B> of a value. Read more
§

fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Mutable access to the BorrowMut<B> of a value. Read more
§

fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Immutable access to the AsRef<R> view of a value. Read more
§

fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Mutable access to the AsMut<R> view of a value. Read more
§

fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Immutable access to the Deref::Target of a value. Read more
§

fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Mutable access to the Deref::Target of a value. Read more
§

fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self

Calls .tap() only in debug builds, and is erased in release builds.
§

fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self

Calls .tap_mut() only in debug builds, and is erased in release builds.
§

fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow<B>, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.
§

fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut<B>, B: ?Sized,

Calls .tap_borrow_mut() only in debug builds, and is erased in release builds.
§

fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
where Self: AsRef<R>, R: ?Sized,

Calls .tap_ref() only in debug builds, and is erased in release builds.
§

fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
where Self: AsMut<R>, R: ?Sized,

Calls .tap_ref_mut() only in debug builds, and is erased in release builds.
§

fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
where Self: Deref<Target = T>, T: ?Sized,

Calls .tap_deref() only in debug builds, and is erased in release builds.
§

fn tap_deref_mut_dbg<T>(self, func: impl FnOnce(&mut T)) -> Self
where Self: DerefMut<Target = T> + Deref, T: ?Sized,

Calls .tap_deref_mut() only in debug builds, and is erased in release builds.
source§

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

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

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

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

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

impl<T> TryConv for T

§

fn try_conv<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Attempts to convert self into T using TryInto<T>. Read more
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

§

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

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
§

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

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,