Type Alias: SimulateReleaseOrMintOpts

SimulateReleaseOrMintOpts = { finality?: FinalityRequested; input: ReleaseOrMintSimInput; offRamp: string; pool: string; poolInterface?: PoolInterfaceVersion; provider: JsonRpcApiProvider; }

Defined in: evm/simulate.ts:147

Options for simulateReleaseOrMint.

Properties

finality?

optional finality?: FinalityRequested

Defined in: evm/simulate.ts:160

Requested finality (v2/IPoolV2 pools only; encoded as the 2nd releaseOrMint arg).

---

input

input: ReleaseOrMintSimInput

Defined in: evm/simulate.ts:158

The ReleaseOrMintInV1 input to simulate.

---

offRamp

offRamp: string

Defined in: evm/simulate.ts:156

A registered OffRamp (for the message's source chain) on the destination Router, used as the eth_call from, satisfying the pool's _onlyOffRamp gate.

---

pool

pool: string

Defined in: evm/simulate.ts:151

Destination token pool address.

---

poolInterface?

optional poolInterface?: PoolInterfaceVersion

Defined in: evm/simulate.ts:165

Known pool interface generation, when the caller already resolved it (e.g. from the pool's typeAndVersion). Skips the ERC165 probes; omit to mirror the OffRamp's own ERC165 dispatch.

---

provider

provider: JsonRpcApiProvider

Defined in: evm/simulate.ts:149

Destination chain provider.