Type Alias: ReleaseOrMintSimInput

ReleaseOrMintSimInput = { localToken: string; offchainTokenData?: BytesLike; originalSender?: BytesLike; receiver: string; remoteChainSelector: bigint; sourceDenominatedAmount: bigint; sourcePoolAddress: BytesLike; sourcePoolData?: BytesLike; }

Defined in: evm/simulate.ts:118

Pool.ReleaseOrMintInV1 — ABI-compatible from v1.5.0 through v2.0 (only amount was renamed to sourceDenominatedAmount).

Properties

localToken

localToken: string

Defined in: evm/simulate.ts:128

Token address on this (destination) chain.

---

offchainTokenData?

optional offchainTokenData?: BytesLike

Defined in: evm/simulate.ts:143

Offchain data (USDC-CCTP attestations etc.); '' for all pool-liquidity cases.

---

originalSender?

optional originalSender?: BytesLike

Defined in: evm/simulate.ts:120

Original sender on the source chain (address or raw bytes; may be empty).

---

receiver

receiver: string

Defined in: evm/simulate.ts:124

Token recipient on this (destination) chain.

---

remoteChainSelector

remoteChainSelector: bigint

Defined in: evm/simulate.ts:122

Source chain selector.

---

sourceDenominatedAmount

sourceDenominatedAmount: bigint

Defined in: evm/simulate.ts:126

Amount, denominated in the decimals declared by sourcePoolData (see below).

---

sourcePoolAddress

sourcePoolAddress: BytesLike

Defined in: evm/simulate.ts:133

Source pool address as raw bytes (abi-encoded address for EVM sources). Must match a remote pool configured on the destination pool, else the pool reverts InvalidSourcePoolAddress.

---

sourcePoolData?

optional sourcePoolData?: BytesLike

Defined in: evm/simulate.ts:141

The source pool's lockOrBurn return (destPoolData). Every base-TokenPool pool returns abi.encode(uint256(sourceDecimals)); the destination pool falls back to its own decimals when empty. Default 0x — correct whenever sourceDenominatedAmount is already expressed in the destination token's decimals (or decimals match). For source pools returning other data, obtain the exact value with simulateLockOrBurn.