Skip to main content
Version: 1.16.1

Type Alias: DeployCrossChainPoolTokenParams

DeployCrossChainPoolTokenParams = { advancedPoolHooks?: string; ccipAdmin?: string; decimals: number; maxSupply: bigint; name: string; preMint?: bigint; preMintRecipient?: string; rmnProxy: string; router: string; sender?: string; symbol: string; }

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:20

Parameters for DeployCrossChainPoolToken: deploys CrossChainPoolToken (v2.0.0).

Remarks​

No owner: the deployer owns the contract (hand off with transferPoolOwnership).

Properties​

advancedPoolHooks?​

optional advancedPoolHooks?: string

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:46

AdvancedPoolHooks contract to bind at construction, as returned by deployAdvancedPoolHooks. Defaults to the zero address, which leaves the pool enforcing no sender allowlist and no CCV requirements.

Remarks​

Re-pointable after deploy with updateAdvancedPoolHooks.

ccipAdmin?​

optional ccipAdmin?: string

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:35

CCIP admin (getCCIPAdmin); defaults to the zero address, which the contract replaces with the deployer.

decimals​

decimals: number

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:24

The token's own decimals (uint8), also the pool's local token decimals.

maxSupply​

maxSupply: bigint

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:26

Max supply cap; 0n means unlimited.

name​

name: string

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:21

preMint?​

optional preMint?: bigint

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:28

Amount minted at deploy; defaults to 0n. Must be <= maxSupply when capped.

preMintRecipient?​

optional preMintRecipient?: string

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:30

Recipient of preMint; required when preMint > 0, must be unset otherwise.

rmnProxy​

rmnProxy: string

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:37

Non-zero RMN proxy address.

router​

router: string

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:39

Non-zero CCIP router address.

sender?​

optional sender?: string

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:48

Deployer address; sets tx.from for offline / multisig signing. Becomes the owner.

symbol​

symbol: string

Defined in: cct/evm/token-pool/operations/deploy-cross-chain-pool-token.ts:22