Struct SwapRoute 

pub struct SwapRoute {

    pub in_amount: u64,
    pub out_amount: u64,
    pub slippage_bps: u16,
    pub platform_fee: Option<PlatformFee>,
    pub steps: Vec<RoutePlanStep>,
    pub instructions: Vec<Instruction>,
    pub address_lookup_tables: Vec<Pubkey>,
    pub context_slot: Option<u64>,
    pub time_taken_ns: Option<u64>,
    pub expires_at_ms: Option<u64>,
    pub expires_after_slot: Option<u64>,
    pub compute_units: Option<u64>,
    pub compute_units_safe: Option<u64>,
    pub transaction: Option<Vec<u8>>,
    pub reference_id: Option<String>,
}

Information about a route for a swap.

Fields

in_amount: u64

How many input tokens are expected to go through this route.

out_amount: u64

How many output tokens are expected to come out of this route.

slippage_bps: u16

Amount of slippage encurred, in basis points.

platform_fee: Option<PlatformFee>

Platform fee information, if such a fee is charged by the provider.

steps: Vec<RoutePlanStep>

Topologically ordered DAG containing the steps that comprise this route.

May be empty if the provider does not provide information about the steps taken, or there are no steps (e.g. RFQ providers).

instructions: Vec<Instruction>

Instructions needed to execute the route.

May be empty if the provider does not support the user building their own transactions. In this case, the transaction to sign should be present in the SwapRoute::transaction field.

address_lookup_tables: Vec<Pubkey>

Address lookup tables necessary to load.

May be empty if the provider does not support the user building their own transactions. In this case, the transaction to sign should be present in the SwapRoute::transaction field.

context_slot: Option<u64>

Context slot for the route provided.

time_taken_ns: Option<u64>

Amount of time taken to generate the quote in seconds, if known.

expires_at_ms: Option<u64>

If this route expires by time, the time at which it expires, as a millisecond UNIX timestamp.

expires_after_slot: Option<u64>

If this route expires by slot, the last slot at which the route is valid.

compute_units: Option<u64>

The number of compute units this transaction is expected to consume, if known.

compute_units_safe: Option<u64>

The number of compute units that the server recommends setting for this route. Includes a buffer to allow for fluctuations in compute unit usage from various protocols as well as other instructions the user may wish to add, such as tips.

transaction: Option<Vec<u8>>

Raw transaction to be signed by the user. May be returned instead of instructions and ALTs.

reference_id: Option<String>

Reference ID for Pyth Express Relay and HashFlow RFQ providers.

Trait Implementations

impl Clone for SwapRoute

fn clone(&self) -> SwapRoute

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SwapRoute

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

Formats the value using the given formatter.

impl Default for SwapRoute

fn default() -> SwapRoute

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SwapRoute

fn deserialize<__D>( __deserializer: __D, ) -> Result<SwapRoute, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SwapRoute

fn eq(&self, other: &SwapRoute) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SwapRoute

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for SwapRoute