Enum ActionPlan

pub enum ActionPlan {
    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),
}

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 variant_index(&self) -> usize

Canonical action plan ordering according to protobuf definitions

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.

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

Performs copy-assignment from source.

impl Debug for ActionPlan

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

Formats the value using the given formatter.

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.

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.

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

fn from(inner: ActionDutchAuctionEnd) -> ActionPlan

Converts to this type from the input type.

impl From<ActionDutchAuctionSchedule> for ActionPlan

fn from(inner: ActionDutchAuctionSchedule) -> ActionPlan

Converts to this type from the input type.

impl From<ActionDutchAuctionWithdrawPlan> for ActionPlan

fn from(inner: ActionDutchAuctionWithdrawPlan) -> ActionPlan

Converts to this type from the input type.

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

fn from(inner: ProposalDepositClaim) -> 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<ProposalWithdraw> for ActionPlan

fn from(inner: ProposalWithdraw) -> 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.

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.