Get messages and attestations

curl --request GET \
  --url https://iris-api-sandbox.circle.com/v2/messages/{sourceDomainId}

{
  "messages": [
    {
      "message": "0x00000000000000050000000300000000000194c2a65fc943419a5ad590042fd67c9791fd015acf53a54cc823edb8ff81b9ed722e00000000000000000000000019330d10d9cc8751218eaf51e8885d058642e08a000000000000000000000000fc05ad74c6fe2e7046e091d6ad4f660d2a15976200000000c6fa7af3bedbad3a3d65f36aabc97431b1bbe4c2d2f6e0e47ca60203452f5d610000000000000000000000002d475f4746419c83be23056309a8e2ac33b30e3b0000000000000000000000000000000000000000000000000000000002b67df0feae5e08f5e6bf04d8c1de7dada9235c56996f4420b14371d6c6f3ddd2f2da78",
      "eventNonce": "9682",
      "attestation": "0x6edd90f4a0ad0212fd9fbbd5058a25aa8ee10ce77e4fc143567bbe73fb6e164f384a3e14d350c8a4fc50b781177297e03c16b304e8d7656391df0f59a75a271f1b",
      "decodedMessage": {
        "sourceDomain": "7",
        "destinationDomain": "5",
        "nonce": "569",
        "sender": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
        "recipient": "0xb7317b4EFEa194a22bEB42506065D3772C2E95EF",
        "destinationCaller": "0xf2Edb1Ad445C6abb1260049AcDDCA9E84D7D8aaA",
        "messageBody": "0x00000000000000050000000300000000000194c2a65fc943419a5ad590042fd67c9791fd015acf53a54cc823edb8ff81b9ed722e00000000000000000000000019330d10d9cc8751218eaf51e8885d058642e08a000000000000000000000000fc05ad74c6fe2e7046e091d6ad4f660d2a15976200000000c6fa7af3bedbad3a3d65f36aabc97431b1bbe4c2d2f6e0e47ca60203452f5d610000000000000000000000002d475f4746419c83be23056309a8e2ac33b30e3b0000000000000000000000000000000000000000000000000000000002b67df0feae5e08f5e6bf04d8c1de7dada9235c56996f4420b14371d6c6f3ddd2f2da78",
        "decodedMessageBody": {
          "burnToken": "0x4Bc078D75390C0f5CCc3e7f59Ae2159557C5eb85",
          "mintRecipient": "0xb7317b4EFEa194a22bEB42506065D3772C2E95EF",
          "amount": "5000",
          "messageSender": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"
        }
      },
      "cctpVersion": "2",
      "status": "complete"
    }
  ]
}

GET

messages

{sourceDomainId}

Get messages and attestations

curl --request GET \
  --url https://iris-api-sandbox.circle.com/v2/messages/{sourceDomainId}

{
  "messages": [
    {
      "message": "0x00000000000000050000000300000000000194c2a65fc943419a5ad590042fd67c9791fd015acf53a54cc823edb8ff81b9ed722e00000000000000000000000019330d10d9cc8751218eaf51e8885d058642e08a000000000000000000000000fc05ad74c6fe2e7046e091d6ad4f660d2a15976200000000c6fa7af3bedbad3a3d65f36aabc97431b1bbe4c2d2f6e0e47ca60203452f5d610000000000000000000000002d475f4746419c83be23056309a8e2ac33b30e3b0000000000000000000000000000000000000000000000000000000002b67df0feae5e08f5e6bf04d8c1de7dada9235c56996f4420b14371d6c6f3ddd2f2da78",
      "eventNonce": "9682",
      "attestation": "0x6edd90f4a0ad0212fd9fbbd5058a25aa8ee10ce77e4fc143567bbe73fb6e164f384a3e14d350c8a4fc50b781177297e03c16b304e8d7656391df0f59a75a271f1b",
      "decodedMessage": {
        "sourceDomain": "7",
        "destinationDomain": "5",
        "nonce": "569",
        "sender": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350",
        "recipient": "0xb7317b4EFEa194a22bEB42506065D3772C2E95EF",
        "destinationCaller": "0xf2Edb1Ad445C6abb1260049AcDDCA9E84D7D8aaA",
        "messageBody": "0x00000000000000050000000300000000000194c2a65fc943419a5ad590042fd67c9791fd015acf53a54cc823edb8ff81b9ed722e00000000000000000000000019330d10d9cc8751218eaf51e8885d058642e08a000000000000000000000000fc05ad74c6fe2e7046e091d6ad4f660d2a15976200000000c6fa7af3bedbad3a3d65f36aabc97431b1bbe4c2d2f6e0e47ca60203452f5d610000000000000000000000002d475f4746419c83be23056309a8e2ac33b30e3b0000000000000000000000000000000000000000000000000000000002b67df0feae5e08f5e6bf04d8c1de7dada9235c56996f4420b14371d6c6f3ddd2f2da78",
        "decodedMessageBody": {
          "burnToken": "0x4Bc078D75390C0f5CCc3e7f59Ae2159557C5eb85",
          "mintRecipient": "0xb7317b4EFEa194a22bEB42506065D3772C2E95EF",
          "amount": "5000",
          "messageSender": "0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"
        }
      },
      "cctpVersion": "2",
      "status": "complete"
    }
  ]
}

Path Parameters

sourceDomainId

integer

required

Source domain identifier for a blockchain on CCTP.

Required range: x >= 0

Example:

3

Query Parameters

transactionHash

string

The transaction hash to filter messages. At least one of transactionHash or nonce is required.

Example:

"0x912f22a13e9ccb979b621500f6952b2afd6e75be7eadaed93fc2625fe11c52a2"

nonce

string

The nonce to filter messages. At least one of transactionHash or nonce is required.

Example:

"234"

Response

Successfully retrieved messages.

messages

object[]

Show child attributes

messages.message

string

The hex-encoded message. 0x if the attestation is not yet available.

Example:

"0x00000000000000050000000300000000000194c2a65fc943419a5ad590042fd67c9791fd015acf53a54cc823edb8ff81b9ed722e00000000000000000000000019330d10d9cc8751218eaf51e8885d058642e08a000000000000000000000000fc05ad74c6fe2e7046e091d6ad4f660d2a15976200000000c6fa7af3bedbad3a3d65f36aabc97431b1bbe4c2d2f6e0e47ca60203452f5d610000000000000000000000002d475f4746419c83be23056309a8e2ac33b30e3b0000000000000000000000000000000000000000000000000000000002b67df0feae5e08f5e6bf04d8c1de7dada9235c56996f4420b14371d6c6f3ddd2f2da78"

messages.eventNonce

string

The nonce associated with the message.

Example:

"9682"

messages.attestation

string | null

The attestation. PENDING if the attestation is not yet available.

Example:

"0x6edd90f4a0ad0212fd9fbbd5058a25aa8ee10ce77e4fc143567bbe73fb6e164f384a3e14d350c8a4fc50b781177297e03c16b304e8d7656391df0f59a75a271f1b"

messages.decodedMessage

object

Decoded representation of the message. Null or empty if decoding fails.

Show child attributes

messages.decodedMessage.sourceDomain

string

The ID of a CCTP domain.

Example:

"0"

messages.decodedMessage.destinationDomain

string

The ID of a CCTP domain.

Example:

"0"

messages.decodedMessage.nonce

string

The nonce associated with the message.

Example:

"9682"

messages.decodedMessage.sender

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

messages.decodedMessage.recipient

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

messages.decodedMessage.destinationCaller

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

messages.decodedMessage.minFinalityThreshold

enum<string>

Minimum finality threshold before allowed to attest.

Available options:

1000,

2000

messages.decodedMessage.finalityThresholdExecuted

enum<string>

Actual finality threshold executed from source chain.

Available options:

1000,

2000

messages.decodedMessage.messageBody

string

Application-specific message to be handled by recipient.

messages.decodedMessage.decodedMessageBody

object

Decoded representation of the message body. Null or empty if decoding fails or is not applicable.

Show child attributes

messages.decodedMessage.decodedMessageBody.burnToken

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

messages.decodedMessage.decodedMessageBody.mintRecipient

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

messages.decodedMessage.decodedMessageBody.amount

string

Amount of burned tokens

Example:

"10000"

messages.decodedMessage.decodedMessageBody.messageSender

string

Blockchain generated unique identifier, associated with wallet (account), smart contract or other blockchain objects.

Example:

"0xca9142d0b9804ef5e239d3bc1c7aa0d1c74e7350"

messages.decodedMessage.decodedMessageBody.maxFee

string

Maximum fee to pay on the destination domain, specified in units of burnToken.

Example:

"1000"

messages.decodedMessage.decodedMessageBody.feeExecuted

string

Actual fee charged on the destination domain, specified in units of burnToken.

Example:

"1000"

messages.decodedMessage.decodedMessageBody.expirationBlock

string

Block number at which the message expires.

Example:

"12345678"

messages.decodedMessage.decodedMessageBody.hookData

string

Arbitrary data to be included in the depositForBurn on source domain that is executed on destination domain.

messages.cctpVersion

enum<string>

Available options:

1,

2

Example:

"2"

messages.status

enum<string>

Status of the attestation, whether it is signed or awaiting more block confirmations.

Available options:

complete,

pending_confirmations

messages.delayReason

enum<string> | null

Reason for message processing delay.

Available options:

insufficient_fee,

amount_above_max,

insufficient_allowance_available

Get public keys

Re-attest a pre-finality message