Struct stable_swap_anchor::WithdrawOne

pub struct WithdrawOne<'info> {
    pub user: SwapUserContext<'info>,
    pub pool_mint: AccountInfo<'info>,
    pub input_lp: AccountInfo<'info>,
    pub quote_reserves: AccountInfo<'info>,
    pub output: SwapOutput<'info>,
}

Accounts for a withdraw_one instruction.

Fields

user: SwapUserContext<'info>

The context of the user.

pool_mint: AccountInfo<'info>

The pool mint of the swap.

input_lp: AccountInfo<'info>

The input (user)’s LP token account

quote_reserves: AccountInfo<'info>

The TokenAccount holding the swap’s reserves of quote tokens; i.e., the token not being withdrawn.

• If withdrawing token A, this is swap_info.token_b.reserves.
• If withdrawing token B, this is swap_info.token_a.reserves.

These reserves are needed for the withdraw_one instruction since the StableSwap “D” invariant requires both the base and quote reserves to determine how many tokens are paid out to users withdrawing from the swap.

For more info, see stable_swap_client::state::SwapTokenInfo::reserves.

output: SwapOutput<'info>

Accounts for output tokens.

Trait Implementations

impl<'info> Accounts<'info> for WithdrawOne<'info> where
    'info: 'info, 

fn try_accounts(
    program_id: &Pubkey,
    accounts: &mut &[AccountInfo<'info>],
    ix_data: &[u8]
) -> Result<Self, ProgramError>

Returns the validated accounts struct. What constitutes “valid” is program dependent. However, users of these types should never have to worry about account substitution attacks. For example, if a program expects a Mint account from the SPL token program in a particular field, then it should be impossible for this method to return Ok if any other account type is given–from the SPL token program or elsewhere.

impl<'info> AccountsExit<'info> for WithdrawOne<'info> where
    'info: 'info, 

fn exit(&self, program_id: &Pubkey) -> ProgramResult

program_id is the currently executing program.

impl<'info> ToAccountInfos<'info> for WithdrawOne<'info> where
    'info: 'info, 

fn to_account_infos(&self) -> Vec<AccountInfo<'info>>

impl<'info> ToAccountMetas for WithdrawOne<'info>

fn to_account_metas(&self, is_signer: Option<bool>) -> Vec<AccountMeta>

is_signer is given as an optional override for the signer meta field. This covers the edge case when a program-derived-address needs to relay a transaction from a client to another program but sign the transaction before the relay. The client cannot mark the field as a signer, and so we have to override the is_signer meta field given by the client.