Skip to main content
Version: 1.15.0

Class: WithdrawLiquidity

Defined in: cct/solana/token-pool/operations/withdraw-liquidity.ts:64

Withdraws tokens from a lock-release pool into a rebalancer's associated token account.

Extends​

  • SolanaOperation<WithdrawLiquidityParams, UnsignedSolanaTx, ParsedWithdrawLiquidityParams>

Constructors​

Constructor​

new WithdrawLiquidity(): WithdrawLiquidity

Returns​

WithdrawLiquidity

Inherited from​

SolanaOperation< WithdrawLiquidityParams, UnsignedSolanaTx, ParsedWithdrawLiquidityParams >.constructor

Properties​

name​

readonly name: "withdrawLiquidity" = 'withdrawLiquidity'

Defined in: cct/solana/token-pool/operations/withdraw-liquidity.ts:69

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:36

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

Inherited from​

SolanaOperation.splitMode

Methods​

buildUnsigned()​

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

Defined in: cct/solana/token-pool/operations/withdraw-liquidity.ts:91

Builds the unsigned Solana withdrawLiquidity instruction for a lock-release pool.

Parameters​

ParameterType
chainSolanaChain
optsParsedWithdrawLiquidityParams

Returns​

Promise<UnsignedSolanaTx>

Overrides​

SolanaOperation.buildUnsigned


execute()​

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

Defined in: cct/solana/token-pool/operations/withdraw-liquidity.ts:144

Generate, sign, simulate, send, and confirm with the rebalancer wallet.

Parameters​

ParameterType
chainSolanaChain
paramsExecuteWithdrawLiquidityParams

Returns​

Promise<TransactionResult>

Overrides​

SolanaOperation.execute


generate()​

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

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

Run prepare and buildUnsigned; no signing.

Parameters​

ParameterType
chainSolanaChain
paramsSolanaGenerateParams<WithdrawLiquidityParams>

Returns​

Promise<UnsignedSolanaTx>

Inherited from​

SolanaOperation.generate


parse()​

protected parse(params: GenerateWithdrawLiquidityParams): ParsedWithdrawLiquidityParams

Defined in: cct/solana/token-pool/operations/withdraw-liquidity.ts:72

Parses public keys, validates amount, and defaults authority to payer without mutating caller params.

Parameters​

ParameterType
paramsGenerateWithdrawLiquidityParams

Returns​

ParsedWithdrawLiquidityParams

Overrides​

SolanaOperation.parse


prepare()​

protected prepare(params: SolanaGenerateParams): ParsedWithdrawLiquidityParams

Defined in: cct/operation.ts:48

validate then parse — the single pre-RPC step, before any chain access.

Parameters​

ParameterType
paramsSolanaGenerateParams

Returns​

ParsedWithdrawLiquidityParams

Inherited from​

SolanaOperation.prepare


prepareWalletExecution()​

protected prepareWalletExecution(params: SolanaExecuteParams<WithdrawLiquidityParams>): { computeUnits: number | undefined; parsed: ParsedWithdrawLiquidityParams; payer: PublicKey; wallet: Wallet; }

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

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

Parameters​

ParameterType
paramsSolanaExecuteParams<WithdrawLiquidityParams>

Returns​

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

computeUnits​

computeUnits: number | undefined

parsed​

parsed: ParsedWithdrawLiquidityParams

payer​

payer: PublicKey

wallet​

wallet: Wallet

Inherited from​

SolanaOperation.prepareWalletExecution


validate()​

protected validate(_params: SolanaGenerateParams): void

Defined in: cct/operation.ts:36

Reject invalid params before any chain RPC. No-op by default: an op that normalizes as it checks does that work in parse instead, and needs no empty stub here.

Parameters​

ParameterType
_paramsSolanaGenerateParams

Returns​

void

Inherited from​

SolanaOperation.validate