Struct penumbra_view :: Planner Copy item path

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

pub fn new(rng: R) -> Self

Create a new planner.

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

Set the current gas prices for fee prediction.

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

Set the fee tier.

pub fn balance(&self) -> &Balance

Get the current transaction balance of the planner.

pub fn notes_requests( &self, 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 add_gas_fees(&mut self) -> &mut Self

Calculate gas cost-based fees and add 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.

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

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, epoch: Epoch, unbonded_amount: Amount, 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, epoch: Epoch, 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 community_pool_deposit(&mut self, value: Value) -> &mut Self

Deposit a value into the Community Pool.

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: IbcRelay) -> &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 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 Self

Initiates a Dutch auction using protocol-controlled liquidity.

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

Ends a Dutch auction using protocol-controlled liquidity.

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

Withdraws the reserves of the Dutch auction.

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.

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

pub fn plan_with_spendable_and_votable_notes( &mut self, chain_id: String, fmd_params: &Parameters, 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. Read more

Auto Trait Implementations§

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

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

impl<T> From<T> for T

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

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

fn into(self) -> U

Calls U::from(self).

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

impl<T> IntoRequest<T> for T

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: '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: '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: '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: '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

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(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Immutable access to the Borrow of a value. Read more

fn tap_borrow_mut(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, B: ?Sized,

Mutable access to the BorrowMut 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(self, func: impl FnOnce(&B)) -> Self
where Self: Borrow, B: ?Sized,

Calls .tap_borrow() only in debug builds, and is erased in release builds.

fn tap_borrow_mut_dbg(self, func: impl FnOnce(&mut B)) -> Self
where Self: BorrowMut, 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

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, >::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