Skip to main content
Version: 1.15.0

Type Alias: FetchVerificationsOpts

FetchVerificationsOpts = { apiClient?: CCIPAPIClient | null; fetch?: typeof globalThis.fetch; getAddress?: (address: BytesLike) => string; indexer?: readonly string[] | NetworkType; known?: readonly VerifierResult[]; policy?: VerificationPolicy; pollInterval?: number; timeoutMs?: number; verifiers?: readonly string[]; verifierTransport?: VerifierTransport; watch?: AbortSignal; }

Defined in: commits.ts:53

Options for fetchVerifications.

Properties​

apiClient?​

optional apiClient?: CCIPAPIClient | null

Defined in: commits.ts:57

CCIP API client to race against the indexers; omit or pass null to skip.


fetch?​

optional fetch?: typeof globalThis.fetch

Defined in: commits.ts:63

Custom fetch used for indexer requests; defaults to globalThis.fetch.


getAddress?​

optional getAddress?: (address: BytesLike) => string

Defined in: commits.ts:86

Renders a destination CCV address, as a string or raw bytes, in the destination family's canonical format, so results and policy match regardless of each source's encoding (default: hex).

Parameters​

ParameterType
addressBytesLike

Returns​

string


indexer?​

optional indexer?: readonly string[] | NetworkType

Defined in: commits.ts:55

Indexer base URLs, or a NetworkType to use the built-in defaults.


known?​

optional known?: readonly VerifierResult[]

Defined in: commits.ts:73

Results already at hand (e.g. attestations obtained out of band); they win over fetched ones.


policy?​

optional policy?: VerificationPolicy

Defined in: commits.ts:71

The destination's CCV policy. When given, results from every source are merged (one per destination CCV) and the call resolves only once they cover it: every required CCV, plus optionalThreshold of the optional ones. Without it, the first source to answer wins.


pollInterval?​

optional pollInterval?: number

Defined in: commits.ts:61

Milliseconds between poll retries when watch is set (default: 5000).


timeoutMs?​

optional timeoutMs?: number

Defined in: commits.ts:65

Per-request timeout in milliseconds for indexer and verifier requests (default: 30000).


verifiers?​

optional verifiers?: readonly string[]

Defined in: commits.ts:78

Verifier endpoint URLs to read attestations from directly (see readVerifier). They are the last source: tried in order, and only while the API and indexers leave policy uncovered.


verifierTransport?​

optional verifierTransport?: VerifierTransport

Defined in: commits.ts:80

Transport for verifiers (default: grpcWebTransport).


watch?​

optional watch?: AbortSignal

Defined in: commits.ts:59

AbortSignal that cancels in-flight requests and terminates the poll loop.