Skip to main content
Version: 1.15.0

Type Alias: ApplyAllowlistUpdatesParams

ApplyAllowlistUpdatesParams = { adds?: string[]; poolAddress: string; removes?: string[]; sender?: string; }

Defined in: cct/evm/token-pool/operations/apply-allowlist-updates.ts:43

Parameters for ApplyAllowlistUpdates. Either array may be omitted, but at least one address across both is required.

Properties​

adds?​

optional adds?: string[]

Defined in: cct/evm/token-pool/operations/apply-allowlist-updates.ts:60

Addresses to add to the allowlist. Must contain no duplicates, no zero address, and no address that also appears in removes. No entry may already be allowlisted — the holder silently ignores the rest. Defaults to [].


poolAddress​

poolAddress: string

Defined in: cct/evm/token-pool/operations/apply-allowlist-updates.ts:48

Token pool whose allowlist is being updated. On v2.0.0 the update lands on the pool's bound AdvancedPoolHooks, and so applies to every pool bound to them.


removes?​

optional removes?: string[]

Defined in: cct/evm/token-pool/operations/apply-allowlist-updates.ts:54

Addresses to remove from the allowlist. Applied before adds on-chain. Must contain no duplicates, no zero address, and no address that also appears in adds. Every entry must currently be allowlisted — the holder silently ignores the rest. Defaults to [].


sender?​

optional sender?: string

Defined in: cct/evm/token-pool/operations/apply-allowlist-updates.ts:67

Allowlist holder's owner: the pool owner on v1.5.0–v1.6.1, the AdvancedPoolHooks owner on v2.0.0. Sets tx.from for offline / multisig signing. When supplied it is also checked against the holder's on-chain owner() before any calldata is built, since both gate applyAllowListUpdates on onlyOwner.