TypeScript: @dnsid-ai/protocol — classes

Properties

agentFQDN

agentFQDN: string = '';

Defined in: packages/protocol/src/txt-record.ts:33

cu?

optional cu?: string;

Defined in: packages/protocol/src/txt-record.ts:31

ek

ek: string = '';

Defined in: packages/protocol/src/txt-record.ts:24

fl?

optional fl?: string;

Defined in: packages/protocol/src/txt-record.ts:29

gi

gi: string = '';

Defined in: packages/protocol/src/txt-record.ts:23

ka?

optional ka?: string;

Defined in: packages/protocol/src/txt-record.ts:30

ku

ku: string = '';

Defined in: packages/protocol/src/txt-record.ts:25

lr

lr: string = '';

Defined in: packages/protocol/src/txt-record.ts:26

sg

sg: string = '';

Defined in: packages/protocol/src/txt-record.ts:28

su

su: string = '';

Defined in: packages/protocol/src/txt-record.ts:27

unknownTags

unknownTags: Map<string, string>;

Defined in: packages/protocol/src/txt-record.ts:32

v

v: string = '';

Defined in: packages/protocol/src/txt-record.ts:22

Accessors

isDnsid1

Get Signature

get isDnsid1(): boolean;

Defined in: packages/protocol/src/txt-record.ts:49

Returns

boolean

isTwoKey

Get Signature

get isTwoKey(): boolean;

Defined in: packages/protocol/src/txt-record.ts:50

Returns

boolean

usesEntityKey

Get Signature

get usesEntityKey(): boolean;

Defined in: packages/protocol/src/txt-record.ts:51

Returns

boolean

Methods

canonical()

canonical(): string;

Defined in: packages/protocol/src/txt-record.ts:135

Returns

string

governanceId()

governanceId(): string;

Defined in: packages/protocol/src/txt-record.ts:54

Profile-selected accountable-entity identifier for relationship and acceptance checks; draft 01 uses gi as signed.

Returns

string

hasStructuralGovernanceRelationship()

hasStructuralGovernanceRelationship(): boolean;

Defined in: packages/protocol/src/txt-record.ts:65

Whether the agent FQDN is equal to or beneath the accountable entity’s governance domain. A false result is valid only for delegated identities, whose relationship MUST be established by verified ISSUANCE evidence.

Returns

boolean

knownTagsCanonical()

knownTagsCanonical(): string;

Defined in: packages/protocol/src/txt-record.ts:139

Returns

string

policyFlags()

policyFlags(): Set<string>;

Defined in: packages/protocol/src/txt-record.ts:172

Returns

Set<string>

runtimeKeyAllowedHost()

runtimeKeyAllowedHost(): string;

Defined in: packages/protocol/src/txt-record.ts:58

Returns

string

runtimeKeyURI()

runtimeKeyURI(): string;

Defined in: packages/protocol/src/txt-record.ts:57

Returns

string

serialize()

serialize(): string;

Defined in: packages/protocol/src/txt-record.ts:157

Returns

string

signatureVerificationKeyAllowedHost()

signatureVerificationKeyAllowedHost(): string;

Defined in: packages/protocol/src/txt-record.ts:56

Returns

string

signatureVerificationKeyURI()

signatureVerificationKeyURI(): string;

Defined in: packages/protocol/src/txt-record.ts:55

Returns

string

validate()

validate(): void;

Defined in: packages/protocol/src/txt-record.ts:120

Returns

void

parse()

static parse(raw): DnsIdTxtRecord;

Defined in: packages/protocol/src/txt-record.ts:35

Parameters

raw

string

Returns

parseUnsignedCanonical()

static parseUnsignedCanonical(raw, agentFQDN?): DnsIdTxtRecord;

Defined in: packages/protocol/src/txt-record.ts:39

Parameters

raw

string

agentFQDN?

string

Returns

DomainLog

Defined in: packages/protocol/src/verified-domain.ts:116

The full verified event history for a domain, loaded from the lifecycle log.

Constructors

Constructor

new DomainLog(domain, events): DomainLog;

Defined in: packages/protocol/src/verified-domain.ts:120

Parameters

domain

string

events

LogEvent[]

Returns

DomainLog

Properties

domain

readonly domain: string;

Defined in: packages/protocol/src/verified-domain.ts:117

events

readonly events: LogEvent[];

Defined in: packages/protocol/src/verified-domain.ts:118

Methods

snapshotAt()

snapshotAt(at): DomainSnapshot;

Defined in: packages/protocol/src/verified-domain.ts:130

Materializes the domain state at a specific point in time. Pure computation — no I/O.

Parameters

at

Date

Returns

DomainSnapshot

Throws

VerificationError if no events exist at or before at, or no ISSUANCE event found.

DomainSnapshot

Defined in: packages/protocol/src/verified-domain.ts:305

The materialized state of a domain at a specific point in time.

Constructors

Constructor

new DomainSnapshot(fields): DomainSnapshot;

Defined in: packages/protocol/src/verified-domain.ts:316

Parameters

fields

activeKey

activeKeyThumbprint

string

domain

string

events

LogEvent[]

governanceId

string

historicalState

AgentStatusState

keyBoundAt

Date

snapshotAt

Date

Returns

DomainSnapshot

Properties

activeKey

readonly activeKey: DnsIdJWK;

Defined in: packages/protocol/src/verified-domain.ts:309

activeKeyThumbprint

readonly activeKeyThumbprint: string;

Defined in: packages/protocol/src/verified-domain.ts:310

domain

readonly domain: string;

Defined in: packages/protocol/src/verified-domain.ts:306

events

readonly events: LogEvent[];

Defined in: packages/protocol/src/verified-domain.ts:314

governanceId

readonly governanceId: string;

Defined in: packages/protocol/src/verified-domain.ts:312

historicalState

readonly historicalState: AgentStatusState;

Defined in: packages/protocol/src/verified-domain.ts:308

Lifecycle state materialized from the verified log history at snapshotAt.

keyBoundAt

readonly keyBoundAt: Date;

Defined in: packages/protocol/src/verified-domain.ts:311

snapshotAt

readonly snapshotAt: Date;

Defined in: packages/protocol/src/verified-domain.ts:313

IdentityManager

Defined in: packages/protocol/src/identity-manager.ts:312

Core DNSid protocol facade.

This package-local version intentionally exposes only DNSid protocol-core methods. JWT/JWS, HTTP Message Signatures, transport, registry workflows, and concrete key storage live in sibling packages.

Implements

IdentityResolver

Constructors

Constructor

new IdentityManager(config?, deps?): IdentityManager;

Defined in: packages/protocol/src/identity-manager.ts:332

Parameters

config?

DnsidConfig = {}

Data-only configuration; omit identity for a verification-only manager.

deps?

IdentityManagerDependencies = {}

Injected runtime objects. The protocol core has no default DNS/HTTPS implementations, so config.transport settings have no consumer here and are rejected; runtime factories (for example @dnsid-ai/sdk/node) consume them before delegating.

Returns

IdentityManager

Properties

config

readonly config: DnsidConfig & object;

Defined in: packages/protocol/src/identity-manager.ts:314

Validated immutable snapshot. identity is absent for verification-only managers.

Type Declaration

transport

transport: TransportConfig;

verification

verification: VerificationConfig;

Methods

canonicalizeLogEvent()

canonicalizeLogEvent(event): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: packages/protocol/src/identity-manager.ts:394

Parameters

event

Returns

Promise<Uint8Array<ArrayBufferLike>>

createTxtRecord()

createTxtRecord(): Promise<string>;

Defined in: packages/protocol/src/identity-manager.ts:539

Builds and signs the _dnsid TXT record for DNS publication.

Returns

Promise<string>

evictDomain()

evictDomain(domain): void;

Defined in: packages/protocol/src/identity-manager.ts:1051

Removes a domain from the IdentityManager cache.

Parameters

domain

string

Returns

void

getEntityKeySet()

getEntityKeySet(): Promise<JWKS>;

Defined in: packages/protocol/src/identity-manager.ts:501

Returns the accountable-entity public key set for ek JWKS publication.

Returns

Promise<JWKS>

getKeyProvider()

getKeyProvider(): KeyProvider;

Defined in: packages/protocol/src/identity-manager.ts:372

Returns

KeyProvider

getKeySet()

getKeySet(): Promise<JWKS>;

Defined in: packages/protocol/src/identity-manager.ts:494

Returns the local identity’s operational public key set for ku JWKS publication.

Returns

Promise<JWKS>

loadDomainLog()

loadDomainLog(vd): Promise<DomainLog>;

Defined in: packages/protocol/src/identity-manager.ts:1037

Loads the full verified event history for a domain from its bound lifecycle log.

Parameters

vd

VerifiedDomain

Returns

Promise<DomainLog>

requiredLogSignatures()

requiredLogSignatures(event): LogSignerRole[];

Defined in: packages/protocol/src/identity-manager.ts:399

Parameters

event

OperationalKeyRotationOptions

Returns

LogSignerRole[]

rotateOperationalKey()

rotateOperationalKey(options): Promise<OperationalKeyRotationResult>;

Defined in: packages/protocol/src/identity-manager.ts:509

Runs the draft-01 operational-key rotation transaction.

Parameters

options

Returns

Promise<OperationalKeyRotationResult>

signAndWriteEvent()

signAndWriteEvent(event): Promise<string>;

Defined in: packages/protocol/src/identity-manager.ts:387

Signs and appends a lifecycle event to the local identity log.

Parameters

event

Returns

Promise<string>

signEvent()

signEvent(event, role): Promise<LogEvent>;

Defined in: packages/protocol/src/identity-manager.ts:412

Parameters

event

IdentityResolver.verifyDomain

role

LogSignerRole

Returns

Promise<LogEvent>

signEventWithProvider()

signEventWithProvider(
   event,
   role,
   keyProvider,
   logBinding?
): Promise<LogEvent>;

Defined in: packages/protocol/src/identity-manager.ts:422

Parameters

logBinding?

Pick<LogReader, "canonical"> & object | null

Returns

Promise<LogEvent>

verifyDomain()

verifyDomain(
   domain,
   peerCert?,
   options?
): Promise<VerifiedDomain>;

Defined in: packages/protocol/src/identity-manager.ts:590

Verifies a DNSid identity according to the protocol, then enforces configured trustedEntities acceptance. Acceptance runs per invocation, including cache hits, and is never cached; a denial leaves valid protocol evidence cached.

Parameters

domain

string

peerCert?

TLSCertificate

options?

VerificationOptions = {}

Returns

Promise<VerifiedDomain>

Implementation of

writeSignedEvent()

writeSignedEvent(event): Promise<string>;

Defined in: packages/protocol/src/identity-manager.ts:467

Parameters

event

Returns

Promise<string>

InMemoryIdentityCache

Defined in: packages/protocol/src/identity-cache.ts:29

Default in-memory cache implementation.

Implements

IdentityCache

Constructors

Constructor

new InMemoryIdentityCache(): InMemoryIdentityCache;

Returns

InMemoryIdentityCache

Methods

evict()

evict(domain): void;

Defined in: packages/protocol/src/identity-cache.ts:54

Removes a domain from the cache immediately.

Parameters

domain

string

Returns

void

Implementation of

IdentityCache.evict

get()

get(domain): VerifiedDomain | null;

Defined in: packages/protocol/src/identity-cache.ts:32

Returns the cached VerifiedDomain for a domain, or null if not cached or expired.

Parameters

domain

string

Returns

VerifiedDomain | null

Implementation of

IdentityCache.get

put()

put(domain, result): void;

Defined in: packages/protocol/src/identity-cache.ts:42

Stores a verified domain result. Entry expires at result.expiry().

Parameters

domain

string

result

VerifiedDomain

Returns

void

Implementation of

IdentityCache.put

JWKS

Defined in: packages/protocol/src/jwks.ts:100

Wrapper around a JWK Set document.

Constructors

Constructor

new JWKS(keys): JWKS;

Defined in: packages/protocol/src/jwks.ts:103

Parameters

keys

DnsIdJWK[]

Returns

JWKS

Properties

keys

readonly keys: DnsIdJWK[];

Defined in: packages/protocol/src/jwks.ts:101

Methods

currentOperationalSigningKey()

currentOperationalSigningKey(): DnsIdJWK;

Defined in: packages/protocol/src/jwks.ts:174

Returns

currentRecordSigningKey()

currentRecordSigningKey(): DnsIdJWK;

Defined in: packages/protocol/src/jwks.ts:170

Returns

draft01RecordSigningKeyById()

draft01RecordSigningKeyById(kid): DnsIdJWK | null;

Defined in: packages/protocol/src/jwks.ts:136

Returns the draft-01-compatible record-signing key matching kid, or null if none.

Parameters

kid

string

Returns

DnsIdJWK | null

keyById()

keyById(kid): DnsIdJWK | null;

Defined in: packages/protocol/src/jwks.ts:131

Returns the key matching the given kid, or null if not found.

Parameters

kid

string

Returns

DnsIdJWK | null

signingKeys()

signingKeys(): DnsIdJWK[];

Defined in: packages/protocol/src/jwks.ts:112

Returns all keys suitable for signature verification. A key qualifies if use is absent/sig and it has a supported signature algorithm binding.

Returns

DnsIdJWK[]

Throws

ValidationError if no signing keys are present.

toJSON()

toJSON(): object;

Defined in: packages/protocol/src/jwks.ts:207

Returns the JWKS as a plain JSON-serializable object.

Returns

object

keys

keys: DnsIdJWK[];

validate()

validate(): void;

Defined in: packages/protocol/src/jwks.ts:147

Validates the key set.

Returns

void

Throws

ValidationError if:

no signing key has a kid field
any present alg field is inconsistent with the key’s kty/crv binding
no key is suitable for signing

validateOperational()

validateOperational(): void;

Defined in: packages/protocol/src/jwks.ts:190

Returns

void

validateRecordSigning()

validateRecordSigning(): void;

Defined in: packages/protocol/src/jwks.ts:178

Returns

void

validateRecordSigningKeyset()

validateRecordSigningKeyset(): Promise<void>;

Defined in: packages/protocol/src/jwks.ts:184

Validates the single current draft-01 ek key and its importable public material.

Returns

Promise<void>

LogRegistry

Defined in: packages/protocol/src/log-registry.ts:15

Single injection point for all log interaction. Holds one factory per log method.

Constructors

Constructor

new LogRegistry(): LogRegistry;

Returns

LogRegistry

Methods

newReader()

newReader(lr, options?): LogReader;

Defined in: packages/protocol/src/log-registry.ts:41

Creates a LogReader bound to the given lr string. Returns a NoopLogReader if no factory is registered for the method.

Parameters

lr

string

options?

signal?

AbortSignal

Returns

LogReader

Throws

ParseError if lr is malformed (no colon, empty method, or method violates pattern).

register()

register(method, factory): void;

Defined in: packages/protocol/src/log-registry.ts:29

Registers a factory for the given method name (e.g. “algorand”, “ctlog”, “scitt”).

Parameters

method

string

factory

LogReaderFactory

Returns

void

Throws

ArgumentError if method does not match [a-z][a-z0-9-]*

snapshot()

snapshot(): LogRegistry;

Defined in: packages/protocol/src/log-registry.ts:19

Copies method selection for an immutable manager verification context.

Returns

LogRegistry

NoopLogReader

Defined in: packages/protocol/src/log-registry.ts:63

Returned by LogRegistry.newReader when no factory is registered for the method. Every method raises VerificationError{code: LogError}.

Implements

LogReader

Constructors

Constructor

new NoopLogReader(method): NoopLogReader;

Defined in: packages/protocol/src/log-registry.ts:66

Parameters

method

string

Returns

NoopLogReader

Methods

canonical()

canonical(_event): Promise<Uint8Array<ArrayBufferLike>>;

Defined in: packages/protocol/src/log-registry.ts:77

Returns the canonical byte representation of the event for this log method. Used to verify the signatures required by the log method on events read from the log. MUST produce identical output to Log.canonical for the same supported event.

Parameters

_event

LogReader.keyTimestamp

Returns

Promise<Uint8Array<ArrayBufferLike>>

Implementation of

LogReader.canonical

keyTimestamp()

keyTimestamp(_domain, _keyThumbprint): Promise<Date>;

Defined in: packages/protocol/src/log-registry.ts:78

Returns the timestamp at which the given key thumbprint was bound to the domain (ISSUANCE or KEY_ROTATION event). Used for ka validation.

Parameters

_domain

string

_keyThumbprint

string

Returns

Promise<Date>

Implementation of

readEvent()

readEvent(_ref): Promise<LogEvent>;

Defined in: packages/protocol/src/log-registry.ts:82

Reads a single event by its log reference. MUST verify inclusion proof and timestamp proof before returning.

Parameters

_ref

string

Returns

Promise<LogEvent>

Implementation of

LogReader.readEvent

rebuildHistory()

rebuildHistory(_domain): Promise<LogEvent[]>;

Defined in: packages/protocol/src/log-registry.ts:83

Rebuilds the full event history for the domain in authoritative log order. MUST verify inclusion proofs, timestamp proofs, append-only consistency, and required lifecycle signatures on every returned event. Event signature verification MUST use the public keys valid for that event in the reconstructed lifecycle history. Events with invalid signatures MUST NOT be returned.

Parameters

_domain

string

Returns

Promise<LogEvent[]>

Implementation of

LogReader.rebuildHistory

verifyBilateralBinding()

verifyBilateralBinding(
   _record,
   _entityKey,
   _operationalKey
): Promise<{
  initialEntityThumbprint: string;
  initialOperationalThumbprint: string;
  timestamp: Date;
}>;

Defined in: packages/protocol/src/log-registry.ts:79

Verifies draft-01 bilateral ISSUANCE binding for the current TXT record.

Parameters

_record

unknown

_entityKey

unknown

_operationalKey

unknown

Returns

Promise<{ initialEntityThumbprint: string; initialOperationalThumbprint: string; timestamp: Date; }>

Implementation of

LogReader.verifyBilateralBinding

verifyNonRevocation()

verifyNonRevocation(_domain, _at): Promise<LoggedStateEvidence>;

Defined in: packages/protocol/src/log-registry.ts:81

Verifies that the domain is neither REVOKED nor RETIRED at the given timestamp. Raises on a terminal state or if complete, fresh evidence cannot be established. Returns the accepted proof boundary.

Parameters

_domain

string

_at

Date

Returns

Promise<LoggedStateEvidence>

Implementation of

LogReader.verifyNonRevocation

verifyOperationalContinuity()

verifyOperationalContinuity(
   _domain,
   _initialOperationalThumbprint,
   _currentOperationalThumbprint
): Promise<void>;

Defined in: packages/protocol/src/log-registry.ts:80

Verifies KEY_ROTATION continuity from ISSUANCE to the current operational key.

Parameters

_domain

string

_initialOperationalThumbprint

string

_currentOperationalThumbprint

string

Returns

Promise<void>

Implementation of

LogReader.verifyOperationalContinuity

ParseError

Defined in: packages/protocol/src/errors.ts:43

Thrown when raw input (e.g. a TXT record or duration string) cannot be parsed into its structured form.

Extends

Error

Constructors

Constructor

new ParseError(message): ParseError;

Defined in: packages/protocol/src/errors.ts:44

Parameters

message

string

Returns

ParseError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

stack?

optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

ValidationError

Defined in: packages/protocol/src/errors.ts:51

Thrown when parsed data is structurally sound but violates a DNSid protocol constraint.

Extends

Error

Constructors

Constructor

new ValidationError(message): ValidationError;

Defined in: packages/protocol/src/errors.ts:52

Parameters

message

string

Returns

ValidationError

Overrides

Error.constructor

Properties

cause?

optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

stack?

optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

VerificationError

Defined in: packages/protocol/src/errors.ts:82

Thrown when DNSid identity verification fails.

Carries a VerificationCode for programmatic handling and a transient flag indicating whether a retry may succeed (see retryTransientVerification).

Extends

Error

Constructors

Constructor

new VerificationError(message, init): VerificationError;

Defined in: packages/protocol/src/errors.ts:96

Parameters

message

string

init

VerificationErrorInit

Returns

VerificationError

Overrides

Error.constructor

Properties

agentState?

readonly optional agentState?: string;

Defined in: packages/protocol/src/errors.ts:88

Agent state reported by the status document, when the failure is state-related.

cause?

optional cause?: unknown;

Defined in: node_modules/typescript/lib/lib.es2022.error.d.ts:24

Inherited from

Error.cause

code

readonly code: VerificationCode;

Defined in: packages/protocol/src/errors.ts:84

Classification of the failure.

errorCategory?

readonly optional errorCategory?: LifecycleErrorCategory;

Defined in: packages/protocol/src/errors.ts:90

Lifecycle conformance category, when the failure maps to a lifecycle state-machine rule.

message

message: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1075

Inherited from

Error.message

name

name: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1074

Inherited from

Error.name

stack?

optional stack?: string;

Defined in: node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

Error.stack

transient

readonly transient: boolean;

Defined in: packages/protocol/src/errors.ts:86

True when retrying the verification may succeed.

verifiedEntityKeyThumbprint?

readonly optional verifiedEntityKeyThumbprint?: string;

Defined in: packages/protocol/src/errors.ts:94

Observed verified record-signing key thumbprint (CounterpartyNotAccepted only). Never echoes configured pins.

verifiedGovernanceId?

readonly optional verifiedGovernanceId?: string;

Defined in: packages/protocol/src/errors.ts:92

Observed verified governance ID (CounterpartyNotAccepted only). Never echoes configured policy.

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/@types/node/globals.d.ts:67

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

Error.stackTraceLimit

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/@types/node/globals.d.ts:51

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

Error.captureStackTrace

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/@types/node/globals.d.ts:55

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

Error.prepareStackTrace

VerifiedDomain

Defined in: packages/protocol/src/verified-domain.ts:12

Result of a successful verifyDomain call. Contains all verified data for the domain.

Constructors

Constructor

new VerifiedDomain(fields): VerifiedDomain;

Defined in: packages/protocol/src/verified-domain.ts:31

Parameters

fields

dnsExpiresAt?

Date

dnssecState

DNSSECState

dnsTTL

number

domain

string

jwks

JWKS

keyBoundAt

Date

lastStatusCheckAt

Date

logReader

LogReader

record

recordSigningJwks?

JWKS

recordSigningTlsCert?

TLSCertificate

registryStatus

AgentStatus

signingKey