Struct penumbra_wallet::plan::Planner

pub struct Planner<R>
where
    R: RngCore + CryptoRng,
{ /* private fields */ }

A planner for a TransactionPlan that can fill in the required spends and change outputs upon finalization to make a transaction balance.

Implementations

impl<R> Planner<R>

where R: RngCore + CryptoRng,

pub fn new(rng: R) -> Planner<R>

Create a new planner.

pub fn set_gas_prices(&mut self, gas_prices: GasPrices) -> &mut Planner<R>

Set the current gas prices for fee prediction.

pub fn set_fee_tier(&mut self, fee_tier: FeeTier) -> &mut Planner<R>

Set the fee tier.

pub fn expiry_height(&mut self, expiry_height: u64) -> &mut Planner<R>

Set the expiry height for the transaction plan.

pub fn memo(&mut self, memo: MemoPlaintext) -> Result<&mut Planner<R>, Error>

Set a memo for this transaction plan.

Errors if the memo is too long.

pub fn fee(&mut self, fee: Fee) -> &mut Planner<R>

Add a fee to the transaction plan.

This function should be called once.

pub fn spend(&mut self, note: Note, position: Position) -> &mut Planner<R>

Spend a specific positioned note in the transaction.

pub fn output(&mut self, value: Value, address: Address) -> &mut Planner<R>

Add an output note from this transaction.

Any unused output value will be redirected back to the originating address as change notes.

pub fn position_open(&mut self, position: Position) -> &mut Planner<R>

Open a liquidity position in the order book.

pub fn position_close(&mut self, position_id: Id) -> &mut Planner<R>

Close a liquidity position in the order book.

pub fn position_withdraw( &mut self, position_id: Id, reserves: Reserves, pair: TradingPair ) -> &mut Planner<R>

Withdraw a liquidity position in the order book.

Note: Currently this only supports an initial withdrawal from Closed, with no rewards.

pub fn dutch_auction_schedule( &mut self, input: Value, output_id: Id, max_output: Amount, min_output: Amount, start_height: u64, end_height: u64, step_count: u64, nonce: [u8; 32] ) -> &mut Planner<R>

Schedule a Dutch auction.

pub fn dutch_auction_end(&mut self, auction_id: AuctionId) -> &mut Planner<R>

Ends a Dutch auction.

pub fn dutch_auction_withdraw( &mut self, auction_id: AuctionId, seq: u64, reserves_input: Value, reserves_output: Value ) -> &mut Planner<R>

Withdraws the reserves of the Dutch auction.

pub fn swap( &mut self, input_value: Value, into_asset: Id, swap_claim_fee: Fee, claim_address: Address ) -> Result<&mut Planner<R>, Error>

Perform a swap based on input notes in the transaction.

pub fn swap_claim(&mut self, plan: SwapClaimPlan) -> &mut Planner<R>

Perform a swap claim based on an input swap NFT with a pre-paid fee.

pub fn delegate( &mut self, epoch: Epoch, unbonded_amount: Amount, rate_data: RateData ) -> &mut Planner<R>

Add a delegation to this transaction.

If you don’t specify spends or outputs as well, they will be filled in automatically.

pub fn undelegate( &mut self, epoch: Epoch, delegation_amount: Amount, rate_data: RateData ) -> &mut Planner<R>

Add an undelegation to this transaction.

pub fn undelegate_claim( &mut self, claim_plan: UndelegateClaimPlan ) -> &mut Planner<R>

Add an undelegate claim to this transaction.

pub fn validator_definition( &mut self, new_validator: Definition ) -> &mut Planner<R>

Upload a validator definition in this transaction.

pub fn proposal_submit( &mut self, proposal: Proposal, deposit_amount: Amount ) -> &mut Planner<R>

Submit a new governance proposal in this transaction.

pub fn proposal_withdraw( &mut self, proposal: u64, reason: String ) -> &mut Planner<R>

Withdraw a governance proposal in this transaction.

pub fn proposal_deposit_claim( &mut self, proposal: u64, deposit_amount: Amount, outcome: Outcome<()> ) -> &mut Planner<R>

Claim a governance proposal deposit in this transaction.

pub fn community_pool_deposit(&mut self, value: Value) -> &mut Planner<R>

Deposit a value into the Community Pool.

pub fn validator_vote(&mut self, vote: ValidatorVote) -> &mut Planner<R>

Cast a validator vote in this transaction.

pub fn ics20_withdrawal( &mut self, withdrawal: Ics20Withdrawal ) -> &mut Planner<R>

Perform an ICS-20 withdrawal

pub fn ibc_action(&mut self, ibc_action: IbcRelay) -> &mut Planner<R>

Perform an IBC action

pub fn delegator_vote( &mut self, proposal: u64, start_block_height: u64, start_position: Position, start_rate_data: BTreeMap<IdentityKey, RateData>, vote: Vote ) -> &mut Planner<R>

Vote with all possible vote weight on a given proposal.

Voting twice on the same proposal in the same planner will overwrite the previous vote.

pub fn delegator_vote_precise( &mut self, proposal: u64, start_position: Position, vote: Vote, note: Note, position: Position, unbonded_amount: Amount ) -> &mut Planner<R>

Vote with a specific positioned note in the transaction.

If you don’t use this method to specify votes, they will be filled in automatically from the implied voting intent by vote when the plan is finished.

pub fn voting_notes_requests( &self, source: AddressIndex ) -> Vec<NotesForVotingRequest>

Get all the voting note requests necessary to fulfill the current Balance.

pub async fn plan<V>( &mut self, view: &mut V, source: AddressIndex ) -> Result<TransactionPlan, Error>

where V: ViewClient,

Add spends and change outputs as required to balance the transaction, using the view service provided to supply the notes and other information.

Clears the contents of the planner, which can be re-used.

pub fn add_votes( &mut self, voting_notes: Vec<Vec<(SpendableNoteRecord, IdentityKey)>> ) -> Result<(), Error>

Trait Implementations

impl<R> Debug for Planner<R>

where R: RngCore + CryptoRng,

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

Formats the value using the given formatter.