Struct 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 action<A>(&mut self, action: A) -> &mut Planner<R>

where A: Into<ActionPlan>,

Add an arbitrary action to the 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.

pub fn memo(&mut self, text: String) -> &mut Planner<R>

Set a human-readable memo text for the transaction.

Errors if the memo is too long.

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

Customize the return address for the memo.

If unset, this will default to the address for the source account. This must be an address controlled by the user, as the expectation is that the recipient can use the address to transact with the sender.

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

Set the change address for the transaction.

If unset, this will default to the address for the source account.

This can be a foreign address, allowing “send max” functionality.

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, description: DutchAuctionDescription, ) -> &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: &DutchAuction, ) -> &mut Planner<R>

Withdraws the reserves of the Dutch auction.

Uses the provided auction state to automatically end the auction if necessary.

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

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 async fn delegator_vote<V>( &mut self, view: &mut V, source: AddressIndex, proposal: u64, vote: Vote, start_block_height: u64, start_position: Position, start_rate_data: BTreeMap<IdentityKey, RateData>, ) -> Result<&mut Planner<R>, Error>

where V: ViewClient,

Vote with all possible vote weight on a given proposal.

pub fn delegator_vote_precise( &mut self, plan: DelegatorVotePlan, ) -> &mut Planner<R>

Vote with a specific positioned note in the transaction, rather than automatically.

pub fn prioritize_and_filter_spendable_notes( &mut self, records: Vec<SpendableNoteRecord>, ) -> Vec<SpendableNoteRecord>

Prioritize notes to spend to release value of a specific transaction.

Various logic is possible for note selection. Currently, this method prioritizes notes sent to a one-time address, then notes with the largest value:

• Prioritizing notes sent to one-time addresses optimizes for a future in which we implement DAGSync keyed by fuzzy message detection (which will not be able to detect notes sent to one-time addresses). Spending these notes immediately converts them into change notes, sent to the default address for the users’ account, which are detectable.

• Prioritizing notes with the largest value optimizes for gas used by the transaction.

We may want to make note prioritization configurable in the future. For instance, a user might prefer a note prioritization strategy that harvested capital losses when possible, using cost basis information retained by the view server.

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.

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.