Skip to main content
Version: 1.15.0

Function: getTokenPoolFamily()

getTokenPoolFamily(type: "BurnMintTokenPool" | "BurnFromMintTokenPool" | "BurnWithFromMintTokenPool" | "BurnToAddressTokenPool" | "BurnMintWithLockReleaseFlagTokenPool" | "LockReleaseTokenPool" | "SiloedLockReleaseTokenPool"): "LockRelease" | "BurnMint"

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

Classifies a supported pool type into its ABI TokenPoolFamily by name: every burn-* pool shares the BurnMint ABI (hence the anchored ^Burn, which also covers BurnMintWithLockReleaseFlagTokenPool), and the rest share LockRelease. TOKEN_POOL_TYPES is the gate, so only allowlisted, ABI-compatible names reach here.

Parameters​

ParameterType
type"BurnMintTokenPool" | "BurnFromMintTokenPool" | "BurnWithFromMintTokenPool" | "BurnToAddressTokenPool" | "BurnMintWithLockReleaseFlagTokenPool" | "LockReleaseTokenPool" | "SiloedLockReleaseTokenPool"

Returns​

"LockRelease" | "BurnMint"