Interface: CCIPRequest<V>

Defined in: types.ts:163

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

Lane configuration for this request.

---

log

log: { blockTimestamp: number; data: Record<string, unknown> | BytesLike; tx?: { blockNumber: number; error?: unknown; from: string; hash: string; logs?: readonly { blockTimestamp: number; data: Record<string, unknown> | BytesLike; tx?: { hash: string; logs?: readonly { transactionHash: string; blockNumber: number; address: string; topics: readonly string[]; index: number; blockTimestamp: number; data: Record<string, unknown> | BytesLike; tx?: ... | undefined; }[] | undefined; blockNumber: number; timestamp: number; from: string; error?: unknown; }...; }[]; timestamp: number; }; }

Defined in: types.ts:167

blockTimestamp

blockTimestamp: number

data

data: Record<string, unknown> | BytesLike

Log data as bytes or parsed object.

tx?

optional tx?: { blockNumber: number; error?: unknown; from: string; hash: string; logs?: readonly { blockTimestamp: number; data: Record<string, unknown> | BytesLike; tx?: { hash: string; logs?: readonly { transactionHash: string; blockNumber: number; address: string; topics: readonly string[]; index: number; blockTimestamp: number; data: Record<string, unknown> | BytesLike; tx?: ... | undefined; }[] | undefined; blockNumber: number; timestamp: number; from: string; error?: unknown; }...; }[]; timestamp: number; }

Optional reference to the containing transaction.

tx.blockNumber

blockNumber: number

Block number containing this transaction.

tx.error?

optional error?: unknown

Optional error if transaction failed.

tx.from

from: string

Sender address.

tx.hash

hash: string

Transaction hash.

tx.logs?

optional logs?: readonly { blockTimestamp: number; data: Record<string, unknown> | BytesLike; tx?: { hash: string; logs?: readonly { transactionHash: string; blockNumber: number; address: string; topics: readonly string[]; index: number; blockTimestamp: number; data: Record<string, unknown> | BytesLike; tx?: ... | undefined; }[] | undefined; blockNumber: number; timestamp: number; from: string; error?: unknown; }...; }[]

Logs emitted by this transaction.

tx.timestamp

timestamp: number

Unix timestamp of the block.

---

message

message: CCIPMessage<V>

Defined in: types.ts:166

---

metadata?

optional metadata?: APICCIPRequestMetadata

Defined in: types.ts:192

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

Transaction that emitted the request.