Type Alias: APICCIPRequestMetadata

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

Defined in: api/types.ts:169

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:181

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

---

destNetworkInfo

destNetworkInfo: NetworkInfo

Defined in: api/types.ts:185

Destination network metadata.

---

finality

finality: bigint

Defined in: api/types.ts:175

Number of block confirmations on source chain.

---

readyForManualExecution

readyForManualExecution: boolean

Defined in: api/types.ts:173

Whether message is ready for manual execution.

---

receiptTimestamp?

optional receiptTimestamp: number

Defined in: api/types.ts:179

Unix timestamp of execution receipt (if executed).

---

receiptTransactionHash?

optional receiptTransactionHash: string

Defined in: api/types.ts:177

Transaction hash of execution receipt (if executed).

---

sourceNetworkInfo

sourceNetworkInfo: NetworkInfo

Defined in: api/types.ts:183

Source network metadata.

---

status

status: MessageStatus

Defined in: api/types.ts:171

Message lifecycle status from API.