Skip to main content
Version: 1.15.0

Class: GetTokenPoolState

Defined in: cct/canton/token-pool/operations/get-token-pool-state.ts:79

Read a token pool's config from the ACS.

Extends​

Constructors​

Constructor​

new GetTokenPoolState(): GetTokenPoolState

Returns​

GetTokenPoolState

Inherited from​

CantonQuery< GetTokenPoolStateParams, GetTokenPoolStateResult, ParsedGetTokenPoolState >.constructor

Properties​

name​

readonly name: "getTokenPoolState" = 'getTokenPoolState'

Defined in: cct/canton/token-pool/operations/get-token-pool-state.ts:84

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

Overrides​

CantonQuery.name

Methods​

prepare()​

protected prepare(p: GetTokenPoolStateParams): ParsedGetTokenPoolState

Defined in: cct/canton/token-pool/operations/get-token-pool-state.ts:87

Validates the pool target + owner, and normalizes the pool type into a template ID.

Parameters​

ParameterType
pGetTokenPoolStateParams

Returns​

ParsedGetTokenPoolState

Overrides​

CantonQuery.prepare


query()​

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

Defined in: cct/query.ts:25

Run prepare and read; no wallet.

Parameters​

ParameterType
chainCantonChain
paramsGetTokenPoolStateParams

Returns​

Promise<GetTokenPoolStateResult>

Inherited from​

CantonQuery.query


read()​

protected read(chain: CantonChain, p: ParsedGetTokenPoolState): Promise<GetTokenPoolStateResult>

Defined in: cct/canton/token-pool/operations/get-token-pool-state.ts:107

Reads the pool contract from the ACS by InstanceAddress and decodes its createArgument. Throws when the pool is not active or not visible.

Parameters​

ParameterType
chainCantonChain
pParsedGetTokenPoolState

Returns​

Promise<GetTokenPoolStateResult>

Overrides​

CantonQuery.read