Struct TransactionParams 

pub struct TransactionParams {
    pub user_public_key: Pubkey,
    pub close_input_token_account: Option<bool>,
    pub create_output_token_account: Option<bool>,
    pub fee_account: Option<Pubkey>,
    pub fee_bps: Option<u16>,
    pub fee_from_input_mint: Option<bool>,
    pub output_account: Option<Pubkey>,
}

Parameters for how transaction data should be generated for swaps.

Fields

user_public_key: Pubkey

Public key of the user requesting the swap, needed for transaction generation.

close_input_token_account: Option<bool>

If true, close the input token account as part of the transaction.

create_output_token_account: Option<bool>

If true, an idempotent ATA will be added to the transactions, if supported by the providers.

fee_account: Option<Pubkey>

The address of an associated token account that will be used to collect fees.

Unless fee_is_input_mint is set to true, must be in terms of the output mint.

The fee acount must already exist, or the user must add the ATA creation instruction themselves.

fee_bps: Option<u16>

Fee amount to take, in basis points.

If not specified, default fee for the requester is used.

fee_from_input_mint: Option<bool>

Whether the fee should be taken in terms of the input mint. Default is false, in which case the fee is taken in terms of the output mint.

output_account: Option<Pubkey>

Address of the token account into which to place the output of the swap. If not specified, the funds will be deposited into an ATA associated with the user’s wallet.

Trait Implementations

impl Clone for TransactionParams

fn clone(&self) -> TransactionParams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransactionParams

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

Formats the value using the given formatter.

impl Default for TransactionParams

fn default() -> TransactionParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TransactionParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TransactionParams

fn eq(&self, other: &TransactionParams) -> 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 TransactionParams

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 Eq for TransactionParams

impl StructuralPartialEq for TransactionParams