Skip to main content
Version: 1.15.0

Type Alias: DeployTokenAndTokenPoolViaFactoryParams

DeployTokenAndTokenPoolViaFactoryParams = FactoryDeployCommon & { lockBox?: string; token: { decimals: number; maxSupply: bigint; name: string; owner?: string; preMint?: bigint; preMintRecipient?: string; symbol: string; }; type: FactoryTokenPoolType; }

Defined in: cct/evm/token-pool-factory/deploy.ts:129

Parameters for deployTokenAndTokenPoolViaFactory.

Type Declaration​

lockBox?​

optional lockBox?: string

Existing lockbox for a LockRelease pool; omit to have the factory deploy (and return) one.

token​

token: { decimals: number; maxSupply: bigint; name: string; owner?: string; preMint?: bigint; preMintRecipient?: string; symbol: string; }

CrossChainToken constructor inputs; ccipAdmin and burnMintRoleAdmin are forced to the factory.

token.decimals​

decimals: number

token.maxSupply​

maxSupply: bigint

token.name​

name: string

token.owner?​

optional owner?: string

DEFAULT_ADMIN of the token; defaults to futureOwner (or sender).

token.preMint?​

optional preMint?: bigint

token.preMintRecipient?​

optional preMintRecipient?: string

token.symbol​

symbol: string

type​

type: FactoryTokenPoolType

Local pool type; BurnMintTokenPool or LockReleaseTokenPool.