Skip to main content
Version: 1.0.0

Interface: CCIPRequest<V>

Defined in: types.ts:208

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

Type Parameters

Type ParameterDefault type
V extends CCIPVersionCCIPVersion

Properties

lane

lane: Lane<V>

Defined in: types.ts:210

Lane configuration for this request.


log

log: ChainLog

Defined in: types.ts:212


message

message: CCIPMessage<V>

Defined in: types.ts:211


metadata?

optional metadata: APICCIPRequestMetadata

Defined in: types.ts:237

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: Omit<ChainTransaction, "logs">

Defined in: types.ts:214

Transaction that emitted the request.