Skip to main content
Version: 1.17.0

Function: getTokenPoolFamily()

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

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

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

Parameters​

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

Returns​

"LockRelease" | "BurnMint" | "SiloedLockRelease"