Skip to main content
Version: 1.15.0

Function: describeLiquidity()

describeLiquidity(type: "BurnMintTokenPool" | "BurnFromMintTokenPool" | "BurnWithFromMintTokenPool" | "BurnToAddressTokenPool" | "BurnMintWithLockReleaseFlagTokenPool" | "LockReleaseTokenPool" | "SiloedLockReleaseTokenPool", liquidity: bigint, token: string): string

Defined in: cct/evm/token-pool/contracts.ts:847

The "holds N of token" clause of an insufficient-liquidity error, naming the unsiloed bucket on a siloed pool so the figure is not mistaken for its balance.

Parameters​

ParameterTypeDescription
type"BurnMintTokenPool" | "BurnFromMintTokenPool" | "BurnWithFromMintTokenPool" | "BurnToAddressTokenPool" | "BurnMintWithLockReleaseFlagTokenPool" | "LockReleaseTokenPool" | "SiloedLockReleaseTokenPool"Pool type the liquidity was read for.
liquiditybigintAs returned by readTokenPoolLiquidity.
tokenstringThe escrowed token.

Returns​

string

The clause, with no subject.