Skip to main content
Version: 1.15.0

Class: GetTokenPoolState

Defined in: cct/solana/token-pool/operations/get-token-pool-state.ts:91

Reads the complete state of a Solana token pool.

Extends​

Constructors​

Constructor​

new GetTokenPoolState(): GetTokenPoolState

Returns​

GetTokenPoolState

Inherited from​

SolanaQuery< GetTokenPoolStateParams, GetTokenPoolStateResult, ParsedGetTokenPoolStateParams >.constructor

Properties​

name​

readonly name: "getTokenPoolState" = 'getTokenPoolState'

Defined in: cct/solana/token-pool/operations/get-token-pool-state.ts:96

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

Overrides​

SolanaQuery.name

Methods​

prepare()​

protected prepare(params: GetTokenPoolStateParams): ParsedGetTokenPoolStateParams

Defined in: cct/solana/token-pool/operations/get-token-pool-state.ts:102

Converts the mint and the optional pool program.

Parameters​

ParameterType
paramsGetTokenPoolStateParams

Returns​

ParsedGetTokenPoolStateParams

Throws​

CCTParamsInvalidError if tokenAddress or poolProgramAddress is not a public key

Overrides​

SolanaQuery.prepare


query()​

query(chain: SolanaChain, params: GetTokenPoolStateParams): Promise<GetTokenPoolStateResult>

Defined in: cct/query.ts:25

Run prepare and read; no wallet.

Parameters​

ParameterType
chainSolanaChain
paramsGetTokenPoolStateParams

Returns​

Promise<GetTokenPoolStateResult>

Inherited from​

SolanaQuery.query


read()​

protected read(chain: SolanaChain, __namedParameters: ParsedGetTokenPoolStateParams): Promise<GetTokenPoolStateResult>

Defined in: cct/solana/token-pool/operations/get-token-pool-state.ts:114

Reads and serializes the token pool config account in the arm of its resolved pool type.

Parameters​

ParameterType
chainSolanaChain
__namedParametersParsedGetTokenPoolStateParams

Returns​

Promise<GetTokenPoolStateResult>

Overrides​

SolanaQuery.read