Skip to main content
Version: 1.16.1

Type Alias: DeployBurnToAddressTokenPoolParams

DeployBurnToAddressTokenPoolParams = DeployTokenPoolBaseParams & { burnAddress: string; type: "BurnToAddressTokenPool"; }

Defined in: cct/evm/token-pool/operations/deploy-token-pool.ts:68

Params for a BurnToAddressTokenPool: the TokenPool base constructor plus burnAddress.

Type Declaration​

burnAddress​

burnAddress: string

Address that receives every outbound amount, e.g. 0x000000000000000000000000000000000000dEaD. Must hold no key or code that can move tokens out.

Remarks​

Permanent. Stored in i_burnAddress, immutable with no setter. The zero address is rejected: the contract accepts it, but OpenZeppelin ERC20s revert ERC20InvalidReceiver on a transfer to it, so every lockOrBurn would revert.

type​

type: "BurnToAddressTokenPool"

Remarks​

Burns by transferring to burnAddress instead of calling burn, so total supply does not drop. The pool needs no burn role on the token, only the mint role for inbound.