Struct QuoteParams 

pub struct QuoteParams<'a> { /* private fields */ }

Parameters for requesting a swap quote from a pool.

Contains the tokens to swap between, the input amount, and whether the simulation should return a modified state to reflect the swap execution.

Implementations

impl<'a> QuoteParams<'a>

pub fn with_context(self, context: Context) -> Self

pub fn context(&self) -> &Context

impl<'a> QuoteParams<'a>

pub fn fixed_in( token_in: &'a TokenAddress, token_out: &'a TokenAddress, amount: BigUint, ) -> SimulationResult<Self>

Creates new fixed input parameters with default settings (no state modification).

Arguments

• token_in - The token to sell
• token_out - The token to buy
• amount - The amount of input token to sell

pub fn fixed_out( token_in: &'a TokenAddress, token_out: &'a TokenAddress, amount: BigUint, ) -> SimulationResult<Self>

Creates new fixed output parameters with default settings (no state modification).

Arguments

• token_in - The token to sell
• token_out - The token to buy
• amount - The amount of output token to buy

pub fn amount(&self) -> &QuoteAmount

pub fn with_new_state(self) -> Self

Configures the quote to modify the state during simulation.

When enabled, the quote simulation will return an updated state as if the swap was actually executed.

pub fn token_in(&self) -> &TokenAddress

Returns the input token address.

pub fn token_out(&self) -> &TokenAddress

Returns the output token address.

pub fn should_return_new_state(&self) -> bool

Returns whether the simulation should return the post-swap state.

Trait Implementations

impl<'a> Clone for QuoteParams<'a>

fn clone(&self) -> QuoteParams<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for QuoteParams<'a>

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

Formats the value using the given formatter.