Struct penumbra_view::Planner

source ·
pub struct Planner<R: RngCore + CryptoRng> { /* private fields */ }
Expand description

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

Implementations§

source§

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

source

pub fn new(rng: R) -> Self

Create a new planner.

source

pub fn action<A: Into<ActionPlan>>(&mut self, action: A) -> &mut Self

Add an arbitrary action to the planner.

source

pub fn set_gas_prices(&mut self, gas_prices: GasPrices) -> &mut Self

Set the current gas prices for fee prediction.

source

pub fn set_fee_tier(&mut self, fee_tier: FeeTier) -> &mut Self

Set the fee tier.

source

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

Set the expiry height for the transaction.

source

pub fn memo(&mut self, text: String) -> &mut Self

Set a human-readable memo text for the transaction.

Errors if the memo is too long.

source

pub fn memo_return_address(&mut self, address: Address) -> &mut Self

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.

source

pub fn change_address(&mut self, address: Address) -> &mut Self

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.

source

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

Spend a specific positioned note in the transaction.

source

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.

source

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

Open a liquidity position in the order book.

source

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

Close a liquidity position in the order book.

source

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

Withdraw a liquidity position in the order book.

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

source

pub fn dutch_auction_schedule( &mut self, description: DutchAuctionDescription ) -> &mut Self

Schedule a Dutch auction.

source

pub fn dutch_auction_end(&mut self, auction_id: AuctionId) -> &mut Self

Ends a Dutch auction.

source

pub fn dutch_auction_withdraw( &mut self, plan: ActionDutchAuctionWithdrawPlan ) -> &mut Self

Withdraws the reserves of the Dutch auction.

source

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.

source

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

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

source

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

Add a delegation to this transaction.

source

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

Add an undelegation to this transaction.

source

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

Add an undelegate claim to this transaction.

source

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

Upload a validator definition in this transaction.

source

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

Submit a new governance proposal in this transaction.

source

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

Withdraw a governance proposal in this transaction.

source

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

Claim a governance proposal deposit in this transaction.

source

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

Deposit a value into the Community Pool.

source

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

Cast a validator vote in this transaction.

source

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

Perform an ICS-20 withdrawal

source

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

Perform an IBC action

source

pub async fn delegator_vote<V: ViewClient>( &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 Self, Error>

Vote with all possible vote weight on a given proposal.

source

pub fn delegator_vote_precise(&mut self, plan: DelegatorVotePlan) -> &mut Self

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

source

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.

source

pub async fn plan<V: ViewClient>( &mut self, view: &mut V, 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.

Trait Implementations§

source§

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

source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<R> !Freeze for Planner<R>

§

impl<R> RefUnwindSafe for Planner<R>
where R: RefUnwindSafe,

§

impl<R> Send for Planner<R>
where R: Send,

§

impl<R> Sync for Planner<R>
where R: Sync,

§

impl<R> Unpin for Planner<R>
where R: Unpin,

§

impl<R> UnwindSafe for Planner<R>
where R: UnwindSafe,

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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
source§

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

source§

fn into(self) -> U

Calls U::from(self).

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

source§

impl<T> IntoRequest<T> for T

source§

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
source§

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> 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
source§

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

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

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

Performs the conversion.
source§

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

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