Skip to main content
Version: 1.17.1

Class: WithdrawFeeTokens

Defined in: cct/solana/token-pool/operations/withdraw-fee-tokens.ts:85

Withdraws the fees a CCIP 2.0 token pool accrued in one fee token while serving a mint.

Remarks​

authority must be the pool owner. The pool's balance in the fee token must be positive and at least amount.

Extends​

  • SolanaOperation<WithdrawFeeTokensParams, UnsignedSolanaTx, ParsedWithdrawFeeTokensParams>

Constructors​

Constructor​

new WithdrawFeeTokens(): WithdrawFeeTokens

Returns​

WithdrawFeeTokens

Inherited from​

SolanaOperation<WithdrawFeeTokensParams, UnsignedSolanaTx, ParsedWithdrawFeeTokensParams>.constructor

Properties​

name​

readonly name: "withdrawFeeTokens" = 'withdrawFeeTokens'

Defined in: cct/solana/token-pool/operations/withdraw-fee-tokens.ts:90

camelCase id; matches the token-manager facade method and error context.

Overrides​

SolanaOperation.name


splitMode​

protected readonly splitMode: SolanaSplitMode = 'atomic'

Defined in: cct/solana/operation.ts:48

Multi-transaction safety policy; resource splitting requires an operation-specific audit.

Inherited from​

SolanaOperation.splitMode

Methods​

buildUnsigned()​

protected buildUnsigned(chain: SolanaChain, opts: ParsedWithdrawFeeTokensParams): Promise<UnsignedSolanaTx>

Defined in: cct/solana/token-pool/operations/withdraw-fee-tokens.ts:117

Builds the recipient token account creation and the withdraw_fee_tokens instruction.

Parameters​

ParameterType
chainSolanaChain
optsParsedWithdrawFeeTokensParams

Returns​

Promise<UnsignedSolanaTx>

Overrides​

SolanaOperation.buildUnsigned


execute()​

execute(chain: SolanaChain, params: ExecuteWithdrawFeeTokensParams): Promise<TransactionResult>

Defined in: cct/solana/token-pool/operations/withdraw-fee-tokens.ts:174

Generate, sign, simulate, send, and confirm with the pool owner wallet.

Parameters​

ParameterType
chainSolanaChain
paramsExecuteWithdrawFeeTokensParams

Returns​

Promise<TransactionResult>

Overrides​

SolanaOperation.execute


generate()​

generate(chain: SolanaChain, params: SolanaGenerateParams<WithdrawFeeTokensParams>): Promise<UnsignedSolanaTx>

Defined in: cct/solana/operation.ts:54

Run prepare and buildUnsigned; no signing.

Parameters​

ParameterType
chainSolanaChain
paramsSolanaGenerateParams<WithdrawFeeTokensParams>

Returns​

Promise<UnsignedSolanaTx>

Inherited from​

SolanaOperation.generate


prepare()​

protected prepare(params: GenerateWithdrawFeeTokensParams): ParsedWithdrawFeeTokensParams

Defined in: cct/solana/token-pool/operations/withdraw-fee-tokens.ts:93

Parses public keys and the amount, and defaults authority to payer, before any RPC.

Parameters​

ParameterType
paramsGenerateWithdrawFeeTokensParams

Returns​

ParsedWithdrawFeeTokensParams

Overrides​

SolanaOperation.prepare


prepareWalletExecution()​

protected prepareWalletExecution(chain: SolanaChain, params: SolanaExecuteParams<WithdrawFeeTokensParams>): { computeUnits: number | undefined; parsed: ParsedWithdrawFeeTokensParams; payer: PublicKey; wallet: Wallet; }

Defined in: cct/solana/operation.ts:60

Validates the wallet and prepares signed execution parameters with it as payer.

Parameters​

ParameterType
chainSolanaChain
paramsSolanaExecuteParams<WithdrawFeeTokensParams>

Returns​

{ computeUnits: number | undefined; parsed: ParsedWithdrawFeeTokensParams; payer: PublicKey; wallet: Wallet; }

computeUnits​

computeUnits: number | undefined

parsed​

parsed: ParsedWithdrawFeeTokensParams

payer​

payer: PublicKey

wallet​

wallet: Wallet

Inherited from​

SolanaOperation.prepareWalletExecution