Interface: CCIPRequest<V>

Defined in: types.ts:204

Complete CCIP request containing lane, message, log, and transaction info.

Type Parameters

Type Parameter	Default type
V extends CCIPVersion	CCIPVersion

Properties

lane

lane: Lane<V>

Defined in: types.ts:206

Lane configuration for this request.

---

log

log: Log_

Defined in: types.ts:210

Log event from the OnRamp.

---

message

message: CCIPMessage<V>

Defined in: types.ts:208

The CCIP message being sent.

---

metadata?

optional metadata: APICCIPRequestMetadata

Defined in: types.ts:235

API-enriched metadata. Present only when fetched via CCIP API.

Remarks

When a request is fetched using Chain.getMessageById or as a fallback in Chain.getMessagesInTx, this field contains additional information including message status, execution details, and network info.

When constructed from on-chain data only, this field is undefined.

Example

TypeScript

const request = await chain.getMessageById(messageId)
if (request.metadata) {
  console.log('Status:', request.metadata.status)
  console.log('Delivery time:', request.metadata.deliveryTime)
}

See

APICCIPRequestMetadata

---

tx

tx: Pick<ChainTransaction, "hash" | "logs" | "blockNumber" | "timestamp" | "from" | "error">

Defined in: types.ts:212

Transaction that emitted the request.