Skip to main content

Interface: VerifyFederationOptions

Defined in: packages/federation-verify/src/verify.ts:50

What verifyFederation is asked.

Properties​

chainOnly?​

readonly optional chainOnly?: boolean

Defined in: packages/federation-verify/src/verify.ts:65

Stop at the anchor and leave its governance framework alone.

clock?​

readonly optional clock?: () => Date

Defined in: packages/federation-verify/src/verify.ts:56

The time every date is checked against; the system clock by default.

Returns​

Date

entityId​

readonly entityId: string

Defined in: packages/federation-verify/src/verify.ts:52

The entity to verify, in the form ENTITY_ID accepts.

expectedAnchor?​

readonly optional expectedAnchor?: string

Defined in: packages/federation-verify/src/verify.ts:58

The anchor the chain must end at. Without it, whichever anchor is reached is reported.

fetcher​

readonly fetcher: DocumentFetcher

Defined in: packages/federation-verify/src/verify.ts:54

How published documents are reached.

onEntry?​

readonly optional onEntry?: (entry) => void

Defined in: packages/federation-verify/src/verify.ts:67

Called with each entry as it is recorded, for a caller that prints as it goes.

Parameters​

entry​

ReportEntry

Returns​

void

pinnedAnchorKeys?​

readonly optional pinnedAnchorKeys?: PinnedAnchorKeys

Defined in: packages/federation-verify/src/verify.ts:63

The anchor's keys held in advance. Without them the anchor's keys are whatever its own configuration says over TLS, and a verified outcome's basis says so.