Struct penumbra_view::Planner

pub struct Planner<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: RngCore + CryptoRng> Planner<R>

pub fn new(rng: R) -> Self

Create a new planner.

pub fn balance(&self) -> &Balance

Get the current transaction balance of the planner.

pub fn notes_requests( &self, account_group_id: AccountGroupId, source: AddressIndex ) -> (Vec<NotesRequest>, Vec<NotesForVotingRequest>)

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

pub fn expiry_height(&mut self, expiry_height: u64) -> &mut Self

Set the expiry height for the transaction plan.

pub fn memo(&mut self, memo: MemoPlaintext) -> Result<&mut Self>

Set a memo for this transaction plan.

Errors if the memo is too long.

pub fn fee(&mut self, fee: Fee) -> &mut Self

Add a fee to the transaction plan.

This function should be called once.

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

Spend a specific positioned note in the transaction.

If you don’t use this method to specify spends, they will be filled in automatically from the view service when the plan is finished.

pub fn position_open(&mut self, position: Position) -> &mut Self

Open a liquidity position in the order book.

pub fn position_close(&mut self, position_id: Id) -> &mut Self

Close a liquidity position in the order book.

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

Withdraw a liquidity position in the order book.

pub fn swap_claim(&mut self, plan: SwapClaimPlan) -> &mut Self

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

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

Perform a swap based on input notes in the transaction.

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

Add an output note from this transaction.

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

pub fn delegate( &mut self, unbonded_amount: u128, rate_data: RateData ) -> &mut Self

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, delegation_amount: Amount, rate_data: RateData ) -> &mut Self

Add an undelegation to this transaction.

TODO: can we put the chain parameters into the planner at the start, so we can compute end_epoch_index?

pub fn undelegate_claim(&mut self, claim_plan: UndelegateClaimPlan) -> &mut Self

Add an undelegate claim to this transaction.

pub fn validator_definition(&mut self, new_validator: Definition) -> &mut Self

Upload a validator definition in this transaction.

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

Submit a new governance proposal in this transaction.

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

Withdraw a governance proposal in this transaction.

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

Claim a governance proposal deposit in this transaction.

pub fn dao_deposit(&mut self, value: Value) -> &mut Self

Deposit a value into the DAO.

pub fn validator_vote(&mut self, vote: ValidatorVote) -> &mut Self

Cast a validator vote in this transaction.

pub fn ics20_withdrawal(&mut self, withdrawal: Ics20Withdrawal) -> &mut Self

Perform an ICS-20 withdrawal

pub fn ibc_action(&mut self, ibc_action: IbcAction) -> &mut Self

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 Self

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 Self

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 async fn plan<V: ViewClient>( &mut self, view: &mut V, account_group_id: AccountGroupId, source: AddressIndex ) -> Result<TransactionPlan>

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 plan_with_spendable_and_votable_notes( &mut self, chain_params: &ChainParameters, fmd_params: &FmdParameters, spendable_notes: Vec<SpendableNoteRecord>, votable_notes: Vec<Vec<(SpendableNoteRecord, IdentityKey)>>, self_address: Address ) -> Result<TransactionPlan>

Add spends and change outputs as required to balance the transaction, using the spendable notes provided. It is the caller’s responsibility to ensure that the notes are the result of collected responses to the requests generated by an immediately preceding call to [Planner::note_requests].

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

Trait Implementations

impl<R: RngCore + CryptoRng> Debug for Planner<R>

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

Formats the value using the given formatter.