SPLTokenSwapProgram.withdraw constructor

SPLTokenSwapProgram.withdraw({ required SolAddress tokenSwap, required SolAddress authority, required SolAddress userTransferAuthority, required SolAddress poolMint, required SolAddress feeAccount, required SolAddress sourcePoolAccount, required SolAddress fromA, required SolAddress fromB, required SolAddress userAccountA, required SolAddress userAccountB, required SolAddress mintA, required SolAddress mintB, required SolAddress poolTokenProgramId, required SolAddress tokenProgramIdA, required SolAddress tokenProgramIdB, required SPLTokenSwapWithdrawLayout layout, required SolAddress swapProgramId, })

Withdraw both types of tokens from the pool at the current ratio, given pool tokens. The pool tokens are burned in exchange for an equivalent amount of token A and B.

Implementation

factory SPLTokenSwapProgram.withdraw({
  /// Token-swap
  required SolAddress tokenSwap,

  /// swap authority
  required SolAddress authority,

  /// user transfer authority
  required SolAddress userTransferAuthority,

  /// Pool mint account, swap authority is the owner
  required SolAddress poolMint,

  /// Fee account, to receive withdrawal fees
  required SolAddress feeAccount,

  /// SOURCE Pool account, amount is transferable by user
  /// transfer authority.
  required SolAddress sourcePoolAccount,

  /// token_a Swap Account to withdraw FROM.
  required SolAddress fromA,

  /// token_b Swap Account to withdraw FROM.
  required SolAddress fromB,

  /// token_a user Account to credit.
  required SolAddress userAccountA,

  /// token_b user Account to credit.
  required SolAddress userAccountB,

  /// Token A mint
  required SolAddress mintA,

  /// Token B mint
  required SolAddress mintB,

  /// Pool Token program id
  required SolAddress poolTokenProgramId,

  /// Token A program id
  required SolAddress tokenProgramIdA,

  /// Token B program id
  required SolAddress tokenProgramIdB,
  required SPLTokenSwapWithdrawLayout layout,
  required SolAddress swapProgramId,
}) {
  return SPLTokenSwapProgram(
      layout: layout,
      keys: [
        tokenSwap.toReadOnly(),
        authority.toReadOnly(),
        userTransferAuthority.toSigner(),
        poolMint.toWritable(),
        sourcePoolAccount.toWritable(),
        fromA.toWritable(),
        fromB.toWritable(),
        userAccountA.toWritable(),
        userAccountB.toWritable(),
        feeAccount.toWritable(),
        mintA.toReadOnly(),
        mintB.toReadOnly(),
        poolTokenProgramId.toReadOnly(),
        tokenProgramIdA.toReadOnly(),
        tokenProgramIdB.toReadOnly(),
      ],
      programId: swapProgramId);
}