Class: CantonTokenManager
Defined in: cct/canton/index.ts:55
Canton CCT manager. Holds a CantonChain and exposes the CCT admin
operations as methods. Each write op has a generateUnsigned<Op> (build
unsigned JsCommands, no signing) and an <op> (sign + submit) variant; each
read op has a single <op> method (no wallet).
Extends
TokenManager<typeofCanton>
Constructors
Constructor
new CantonTokenManager(
chain:CantonChain):CantonTokenManager
Defined in: cct/canton/index.ts:68
Creates a Canton CCT manager for an existing chain.
Parameters
| Parameter | Type |
|---|---|
chain | CantonChain |
Returns
CantonTokenManager
Overrides
TokenManager<typeof ChainFamily.Canton>.constructor
Properties
chain
readonlychain:CantonChain
Defined in: cct/canton/index.ts:56
Chain this manager builds and submits through.
Overrides
TokenManager.chain
Methods
applyChainUpdates()
applyChainUpdates(
opts:ExecuteApplyChainUpdatesParams):Promise<ExecuteApplyChainUpdatesResult>
Defined in: cct/canton/index.ts:113
Adds and/or removes remote-chain configs on a token pool.
Parameters
| Parameter | Type |
|---|---|
opts | ExecuteApplyChainUpdatesParams |
Returns
Promise<ExecuteApplyChainUpdatesResult>
deployTokenPool()
deployTokenPool(
opts:ExecuteDeployTokenPoolParams):Promise<CantonDeployResult>
Defined in: cct/canton/index.ts:99
Atomically deploys and initializes a BurnMintTokenPool/LockReleaseTokenPool (registry-pools family).
Parameters
| Parameter | Type |
|---|---|
opts | ExecuteDeployTokenPoolParams |
Returns
Promise<CantonDeployResult>
generateUnsignedApplyChainUpdates()
generateUnsignedApplyChainUpdates(
opts:GenerateApplyChainUpdatesParams):Promise<UnsignedCantonTx>
Defined in: cct/canton/index.ts:106
Builds unsigned applyChainUpdates commands.
Parameters
| Parameter | Type |
|---|---|
opts | GenerateApplyChainUpdatesParams |
Returns
Promise<UnsignedCantonTx>
generateUnsignedDeployTokenPool()
generateUnsignedDeployTokenPool(
opts:GenerateDeployTokenPoolParams):Promise<UnsignedCantonTx>
Defined in: cct/canton/index.ts:92
Builds unsigned deployTokenPool commands — a single CreateAndExercise
that creates the registry-pools BurnMintTokenPool/LockReleaseTokenPool
and atomically calls Initialize on it (TAR registration + lane rate
limiters).
Parameters
| Parameter | Type |
|---|---|
opts | GenerateDeployTokenPoolParams |
Returns
Promise<UnsignedCantonTx>
getRateLimiterState()
getRateLimiterState(
opts:GetRateLimiterStateParams):Promise<GetRateLimiterStateResult>
Defined in: cct/canton/index.ts:136
Reads a RateLimiter contract's config (capacity/rate/enabled/observers) from the ACS.
Parameters
| Parameter | Type |
|---|---|
opts | GetRateLimiterStateParams |
Returns
Promise<GetRateLimiterStateResult>
getTokenAdminRegistry()
getTokenAdminRegistry(
opts:GetTokenAdminRegistryParams):Promise<GetTokenAdminRegistryResult>
Defined in: cct/canton/index.ts:122
Reads the TAR state for an instrument (admin, pendingAdmin, pool, factory wiring).
Parameters
| Parameter | Type |
|---|---|
opts | GetTokenAdminRegistryParams |
Returns
Promise<GetTokenAdminRegistryResult>
getTokenPoolState()
getTokenPoolState(
opts:GetTokenPoolStateParams):Promise<GetTokenPoolStateResult>
Defined in: cct/canton/index.ts:131
Reads a token pool's config from the ACS.
Parameters
| Parameter | Type |
|---|---|
opts | GetTokenPoolStateParams |
Returns
Promise<GetTokenPoolStateResult>
fromChain()
staticfromChain(chain:CantonChain):CantonTokenManager
Defined in: cct/canton/index.ts:74
Wraps an existing CantonChain.
Parameters
| Parameter | Type |
|---|---|
chain | CantonChain |
Returns
CantonTokenManager
fromUrl()
staticfromUrl(url:string,ctx?:ChainContext):Promise<CantonTokenManager>
Defined in: cct/canton/index.ts:79
Creates from a Canton JSON Ledger API URL.
Parameters
| Parameter | Type |
|---|---|
url | string |
ctx? | ChainContext |
Returns
Promise<CantonTokenManager>