#[repr(C)]
pub enum SwapInstruction {
    Initialize(InitializeData),
    Swap(SwapData),
    Deposit(DepositData),
    Withdraw(WithdrawData),
    WithdrawOne(WithdrawOneData),
}
Expand description

Instructions supported by the SwapInfo program.

Variants

Initialize(InitializeData)

Initializes a new SwapInfo.

  1. [writable, signer] New StableSwap to create.
  2. [] $authority derived from create_program_address(&[StableSwap account])
  3. [] admin Account.
  4. [] admin_fee_a admin fee Account for token_a.
  5. [] admin_fee_b admin fee Account for token_b.
  6. [] token_a Account. Must be non zero, owned by $authority.
  7. [] token_b Account. Must be non zero, owned by $authority.
  8. [writable] Pool Token Mint. Must be empty, owned by $authority.

Swap(SwapData)

Swap the tokens in the pool.

  1. []StableSwap
  2. [] $authority
  3. [signer] User authority.
  4. [writable] token_(A|B) SOURCE Account, amount is transferable by $authority,
  5. [writable] token_(A|B) Base Account to swap INTO. Must be the SOURCE token.
  6. [writable] token_(A|B) Base Account to swap FROM. Must be the DESTINATION token.
  7. [writable] token_(A|B) DESTINATION Account assigned to USER as the owner.
  8. [writable] token_(A|B) admin fee Account. Must have same mint as DESTINATION token.
  9. [] Token program id

Deposit(DepositData)

Deposit some tokens into the pool. The output is a “pool” token representing ownership into the pool. Inputs are converted to the current ratio.

  1. []StableSwap
  2. [] $authority
  3. [signer] User authority.
  4. [writable] token_a $authority can transfer amount,
  5. [writable] token_b $authority can transfer amount,
  6. [writable] token_a Base Account to deposit into.
  7. [writable] token_b Base Account to deposit into.
  8. [writable] Pool MINT account, $authority is the owner.
  9. [writable] Pool Account to deposit the generated tokens, user is the owner.
  10. [] Token program id

Withdraw(WithdrawData)

Withdraw tokens from the pool at the current ratio.

  1. []StableSwap
  2. [] $authority
  3. [signer] User authority.
  4. [writable] Pool mint account, $authority is the owner
  5. [writable] SOURCE Pool account, amount is transferable by $authority.
  6. [writable] token_a Swap Account to withdraw FROM.
  7. [writable] token_b Swap Account to withdraw FROM.
  8. [writable] token_a user Account to credit.
  9. [writable] token_b user Account to credit.
  10. [writable] admin_fee_a admin fee Account for token_a.
  11. [writable] admin_fee_b admin fee Account for token_b.
  12. [] Token program id

WithdrawOne(WithdrawOneData)

Withdraw one token from the pool at the current ratio.

  1. []StableSwap
  2. [] $authority
  3. [signer] User authority.
  4. [writable] Pool mint account, $authority is the owner
  5. [writable] SOURCE Pool account, amount is transferable by $authority.
  6. [writable] token_(A|B) BASE token Swap Account to withdraw FROM.
  7. [writable] token_(A|B) QUOTE token Swap Account to exchange to base token.
  8. [writable] token_(A|B) BASE token user Account to credit.
  9. [writable] token_(A|B) admin fee Account. Must have same mint as BASE token.
  10. [] Token program id

Implementations

Unpacks a byte buffer into a SwapInstruction.

Packs a SwapInstruction into a byte buffer.

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

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

The alignment of pointer.

The type for initializers.

Initializes a with the given initializer. Read more

Dereferences the given pointer. Read more

Mutably dereferences the given pointer. Read more

Drops the object pointed to by the given pointer. Read more

Should always be Self

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.