NEW

CCIP is now live for all developers. See what's new.

CCIPLocalSimulatorFork API reference

Typedefs

Evm2EvmMessage : Object

requestLinkFromTheFaucet(linkAddress, to, amount) ⇒ Promise.<string>

Requests LINK tokens from the faucet and returns the transaction hash

Kind: global function
Returns: Promise.<string> - Promise resolving to the transaction hash of the fund transfer

ParamTypeDescription
linkAddressstringThe address of the LINK contract on the current network
tostringThe address to send LINK to
amountbigintThe amount of LINK to request

getEvm2EvmMessage(receipt) ⇒ Evm2EvmMessage | null

Parses a transaction receipt to extract the sent message Scans through transaction logs to find a CCIPSendRequested event and then decodes it to an object

Kind: global function
Returns: Evm2EvmMessage |

null - Returns either the sent message or null if provided receipt does not contain CCIPSendRequested log

ParamTypeDescription
receiptobjectThe transaction receipt from the ccipSend call

routeMessage(routerAddress, evm2EvmMessage) ⇒ Promise.<void>

Routes the sent message from the source network on the destination (current) network

Kind: global function
Returns: Promise.<void> - Either resolves with no value if the message is successfully routed, or reverts
Throws:

  • Error Fails if no off-ramp matches the message's source chain selector or if calling router.getOffRamps()
ParamTypeDescription
routerAddressstringAddress of the destination Router
evm2EvmMessageEvm2EvmMessageSent cross-chain message

Evm2EvmMessage : Object

Kind: global typedef
Properties

NameType
sourceChainSelectorbigint
senderstring
receiverstring
sequenceNumberbigint
gasLimitbigint
strictboolean
noncebigint
feeTokenstring
feeTokenAmountbigint
datastring
tokenAmountsArray.<{token: string, amount: bigint}>
sourceTokenDataArray.<string>
messageIdstring

Stay updated on the latest Chainlink news