Type Alias: APICCIPRequestMetadata

APICCIPRequestMetadata = { deliveryTime?: bigint; destNetworkInfo: NetworkInfo; offRamp?: string; readyForManualExecution: boolean; receiptTimestamp?: number; receiptTransactionHash?: string; sourceNetworkInfo: NetworkInfo; status: MessageStatus; }

Defined in: api/types.ts:287

API-specific metadata fields for CCIP requests.

Remarks

These fields are only available when fetching via the CCIP API. This type is the value of the metadata field on CCIPRequest.

Example

TypeScript

const request = await chain.getMessageById(messageId)
if (request.metadata) {
  console.log(`Status: ${request.metadata.status}`)
  if (request.metadata.receiptTransactionHash) {
    console.log(`Executed in tx: ${request.metadata.receiptTransactionHash}`)
  }
}

Properties

deliveryTime?

optional deliveryTime?: bigint

Defined in: api/types.ts:297

End-to-end delivery time in milliseconds (if completed).

---

destNetworkInfo

destNetworkInfo: NetworkInfo

Defined in: api/types.ts:301

Destination network metadata.

---

offRamp?

optional offRamp?: string

Defined in: api/types.ts:303

OffRamp address on dest

---

readyForManualExecution

readyForManualExecution: boolean

Defined in: api/types.ts:291

Whether message is ready for manual execution.

---

receiptTimestamp?

optional receiptTimestamp?: number

Defined in: api/types.ts:295

Unix timestamp of execution receipt (if executed).

---

receiptTransactionHash?

optional receiptTransactionHash?: string

Defined in: api/types.ts:293

Transaction hash of execution receipt (if executed).

---

sourceNetworkInfo

sourceNetworkInfo: NetworkInfo

Defined in: api/types.ts:299

Source network metadata.

---

status

status: MessageStatus

Defined in: api/types.ts:289

Message lifecycle status from API.