Enum penumbra_transaction::plan::ActionPlan

pub enum ActionPlan {
Show 24 variants
    Spend(SpendPlan),
    Output(OutputPlan),
    Delegate(Delegate),
    Undelegate(Undelegate),
    UndelegateClaim(UndelegateClaimPlan),
    ValidatorDefinition(Definition),
    Swap(SwapPlan),
    SwapClaim(SwapClaimPlan),
    IbcAction(IbcRelay),
    ProposalSubmit(ProposalSubmit),
    ProposalWithdraw(ProposalWithdraw),
    DelegatorVote(DelegatorVotePlan),
    ValidatorVote(ValidatorVote),
    ProposalDepositClaim(ProposalDepositClaim),
    PositionOpen(PositionOpen),
    PositionClose(PositionClose),
    PositionWithdraw(PositionWithdrawPlan),
    CommunityPoolSpend(CommunityPoolSpend),
    CommunityPoolOutput(CommunityPoolOutput),
    CommunityPoolDeposit(CommunityPoolDeposit),
    Ics20Withdrawal(Ics20Withdrawal),
    ActionDutchAuctionSchedule(ActionDutchAuctionSchedule),
    ActionDutchAuctionEnd(ActionDutchAuctionEnd),
    ActionDutchAuctionWithdraw(ActionDutchAuctionWithdrawPlan),
}

Expand description

A declaration of a planned Action, for use in transaction creation.

Actions that don’t have any private data are passed through, while actions that do are replaced by a “Plan” analogue that includes openings of commitments and other private data.

Variants§

Spend(SpendPlan)

Describes a proposed spend.

Output(OutputPlan)

Describes a proposed output.

Delegate(Delegate)

We don’t need any extra information (yet) to understand delegations, because we don’t yet use flow encryption.

Undelegate(Undelegate)

We don’t need any extra information (yet) to understand undelegations, because we don’t yet use flow encryption.

UndelegateClaim(UndelegateClaimPlan)

ValidatorDefinition(Definition)

Swap(SwapPlan)

Describes a proposed swap.

SwapClaim(SwapClaimPlan)

Describes a swap claim.

IbcAction(IbcRelay)

ProposalSubmit(ProposalSubmit)

Propose a governance vote.

ProposalWithdraw(ProposalWithdraw)

Withdraw a proposed vote.

DelegatorVote(DelegatorVotePlan)

Vote on a proposal as a delegator.

ValidatorVote(ValidatorVote)

Vote on a proposal as a validator.

ProposalDepositClaim(ProposalDepositClaim)

Claim the deposit for a finished proposal.

PositionOpen(PositionOpen)

PositionClose(PositionClose)

PositionWithdraw(PositionWithdrawPlan)

CommunityPoolSpend(CommunityPoolSpend)

CommunityPoolOutput(CommunityPoolOutput)

CommunityPoolDeposit(CommunityPoolDeposit)

Ics20Withdrawal(Ics20Withdrawal)

ActionDutchAuctionSchedule(ActionDutchAuctionSchedule)

ActionDutchAuctionEnd(ActionDutchAuctionEnd)

ActionDutchAuctionWithdraw(ActionDutchAuctionWithdrawPlan)

Implementations§

impl ActionPlan

pub fn build_unauth( action_plan: ActionPlan, fvk: &FullViewingKey, witness_data: &WitnessData, memo_key: Option<PayloadKey> ) -> Result<Action>

Builds a planned Action specified by this ActionPlan.

The resulting action is unauth in the sense that this method does not have access to authorization data, so any required authorization data will be filled in with dummy zero values, to be replaced later.

This method is useful for controlling how a transaction’s actions are built (e.g., building them in parallel, or via Web Workers).

pub fn balance(&self) -> Balance

pub fn value_blinding(&self) -> Fr

pub fn effect_hash( &self, fvk: &FullViewingKey, memo_key: &PayloadKey ) -> EffectHash

Compute the effect hash of the action this plan will produce.

Trait Implementations§

impl Clone for ActionPlan

fn clone(&self) -> ActionPlan

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

impl Debug for ActionPlan

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

Formats the value using the given formatter. Read more

impl<'de> Deserialize<'de> for ActionPlan

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

Deserialize this value from the given Serde deserializer. Read more

impl DomainType for ActionPlan

type Proto = ActionPlan

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

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

fn from(msg: ActionPlan) -> Self

Converts to this type from the input type.

impl From<CommunityPoolDeposit> for ActionPlan

fn from(inner: CommunityPoolDeposit) -> ActionPlan

Converts to this type from the input type.

impl From<CommunityPoolOutput> for ActionPlan

fn from(inner: CommunityPoolOutput) -> ActionPlan

Converts to this type from the input type.

impl From<CommunityPoolSpend> for ActionPlan

fn from(inner: CommunityPoolSpend) -> ActionPlan

Converts to this type from the input type.

impl From<Definition> for ActionPlan

fn from(inner: Definition) -> ActionPlan

Converts to this type from the input type.

impl From<Delegate> for ActionPlan

fn from(inner: Delegate) -> ActionPlan

Converts to this type from the input type.

impl From<DelegatorVotePlan> for ActionPlan

fn from(inner: DelegatorVotePlan) -> ActionPlan

Converts to this type from the input type.

impl From<IbcRelay> for ActionPlan

fn from(inner: IbcRelay) -> ActionPlan

Converts to this type from the input type.

impl From<Ics20Withdrawal> for ActionPlan

fn from(inner: Ics20Withdrawal) -> ActionPlan

Converts to this type from the input type.

impl From<OutputPlan> for ActionPlan

fn from(inner: OutputPlan) -> ActionPlan

Converts to this type from the input type.

impl From<PositionClose> for ActionPlan

fn from(inner: PositionClose) -> ActionPlan

Converts to this type from the input type.

impl From<PositionOpen> for ActionPlan

fn from(inner: PositionOpen) -> ActionPlan

Converts to this type from the input type.

impl From<PositionWithdrawPlan> for ActionPlan

fn from(inner: PositionWithdrawPlan) -> ActionPlan

Converts to this type from the input type.

impl From<ProposalSubmit> for ActionPlan

fn from(inner: ProposalSubmit) -> ActionPlan

Converts to this type from the input type.

impl From<SpendPlan> for ActionPlan

fn from(inner: SpendPlan) -> ActionPlan

Converts to this type from the input type.

impl From<SwapClaimPlan> for ActionPlan

fn from(inner: SwapClaimPlan) -> ActionPlan

Converts to this type from the input type.

impl From<SwapPlan> for ActionPlan

fn from(inner: SwapPlan) -> ActionPlan

Converts to this type from the input type.

impl From<Undelegate> for ActionPlan

fn from(inner: Undelegate) -> ActionPlan

Converts to this type from the input type.

impl From<UndelegateClaimPlan> for ActionPlan

fn from(inner: UndelegateClaimPlan) -> ActionPlan

Converts to this type from the input type.

impl From<ValidatorVote> for ActionPlan

fn from(inner: ValidatorVote) -> ActionPlan

Converts to this type from the input type.

impl GasCost for ActionPlan

fn gas_cost(&self) -> Gas

impl Serialize for ActionPlan

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

Serialize this value into the given Serde serializer. Read more

impl TryFrom<ActionPlan> for ActionPlan

type Error = Error

The type returned in the event of a conversion error.

fn try_from(proto: ActionPlan) -> Result<Self, Self::Error>

Performs the conversion.

Auto Trait Implementations§

impl !Freeze for ActionPlan

impl RefUnwindSafe for ActionPlan

impl Send for ActionPlan

impl Sync for ActionPlan

impl Unpin for ActionPlan

impl UnwindSafe for ActionPlan

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. 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

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoRequest<T> for T

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

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.

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

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

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

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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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.

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

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