Type Alias: MessageSearchFilters

MessageSearchFilters = { destChainSelector?: bigint; readyForManualExecOnly?: boolean; receiver?: string; sender?: string; sourceChainSelector?: bigint; sourceTokenAddress?: string; sourceTransactionHash?: string; }

Defined in: api/types.ts:171

Filters for searching CCIP messages via the API.

All fields are optional — omit a field to leave it unfiltered. Chain selectors are accepted as bigint and converted to strings for the API.

See

CCIPAPIClient.searchMessages

Example

TypeScript

const api = CCIPAPIClient.fromUrl()
// Find messages from a specific sender on a specific lane
const page = await api.searchMessages({
  sender: '0x9d087fC03ae39b088326b67fA3C788236645b717',
  sourceChainSelector: 16015286601757825753n,
  destChainSelector: 14767482510784806043n,
})

Properties

destChainSelector?

optional destChainSelector?: bigint

Defined in: api/types.ts:179

Filter by destination chain selector

---

readyForManualExecOnly?

optional readyForManualExecOnly?: boolean

Defined in: api/types.ts:185

When true, return only messages eligible for manual execution (stuck/failed messages)

---

receiver?

optional receiver?: string

Defined in: api/types.ts:175

Filter by receiver address

---

sender?

optional sender?: string

Defined in: api/types.ts:173

Filter by sender address

---

sourceChainSelector?

optional sourceChainSelector?: bigint

Defined in: api/types.ts:177

Filter by source chain selector

---

sourceTokenAddress?

optional sourceTokenAddress?: string

Defined in: api/types.ts:183

Filter by source token address

---

sourceTransactionHash?

optional sourceTransactionHash?: string

Defined in: api/types.ts:181

Filter by source transaction hash