TokenMessenger

depositForBurn

Deposits and burns tokens from sender to be minted on destination domain. Minted tokens will be transferred to mintRecipient.

Parameters

FieldTypeDescription
amountuint256Amount of tokens to deposit and burn.
destinationDomainuint32Destination domain identifier.
mintRecipientbytes32Address of mint recipient on destination domain.
burnTokenaddressAddress of contract to burn deposited tokens, on local domain.

depositForBurnWithCaller

Same as depositForBurn, but with an additional parameter, destinationCaller. This parameter specifies which address has permission to call receiveMessage on the destination domain for this message.

Parameters

FieldTypeDescription
amountuint256Amount of tokens to deposit and burn.
destinationDomainuint32Destination domain identifier.
mintRecipientbytes32Address of mint recipient on destination domain.
burnTokenaddressAddress of contract to burn deposited tokens, on local domain.
destinationCallerbytes32Caller on the destination domain, as bytes32.

replaceDepositForBurn

Replace a BurnMessage to change the mint recipient and/or destination caller. Allows the sender of a previous BurnMessage (created by depositForBurn or depositForBurnWithCaller) to send a new BurnMessage to replace the original. The new BurnMessage will reuse the amount and burn token of the original, without requiring a new deposit.

This is useful in cases where the user specified an incorrect address and has no way to safely mint the previously burned USDC.

📘

The sender of the original depositForBurn has access to call replaceDepositForBurn, and the resulting mint will supersede the original mint, as long as the original mint has not confirmed yet on-chain. Therefore, it is important to note that when using a third-party bridge that integrates with CCTP to burn and mint USDC, it is the choice of the bridge if and when to replace messages on behalf of users. As usual, when sending USDC to smart contracts, it is important to understand what functionality those contracts have, and what their trust model is.

Parameters

FieldTypeDescription
originalMessagebytes memoryOriginal message bytes (to replace).
originalAttestationbytes calldataOriginal attestation bytes
newDestinationCallerbytes32The new destination caller, which may be the same as the original destination caller, a new destination caller, or an empty destination caller, indicating that any destination caller is valid.
newMintRecipientbytes32The new mint recipient, which may be the same as the original mint recipient, or different.

What’s Next