DID BTCR2 JS

Appearance

Class: Resolver ​

Defined in: packages/method/src/core/resolver.ts:132

Sans-I/O state machine for did:btcr2 resolution.

Created by DidBtcr2.resolve (the factory). The caller drives resolution by repeatedly calling resolve and provide:

typescript
const resolver = DidBtcr2.resolve(did, { sidecar });
let state = resolver.resolve();

while (state.status === 'action-required') {
  for (const need of state.needs) { ... fetch & provide ... }
  state = resolver.resolve();
}
const { didDocument, metadata } = state.result;

The Resolver performs zero I/O. All external data (Bitcoin signals, CAS data, genesis documents) flows through the advance/provide protocol.

Resolver

Constructors ​

Constructor ​

new Resolver(didComponents, sidecarData, currentDocument, options?): Resolver

Defined in: packages/method/src/core/resolver.ts:154

Internal

— Use DidBtcr2.resolve to create instances.

Parameters ​

didComponents ​

DidComponents

sidecarData ​

SidecarData

currentDocument ​

DidDocument | null

options? ​
genesisDocument? ​

object

versionId? ​

string

versionTime? ​

string

Returns ​

Resolver

Methods ​

provide() ​

Call Signature ​

provide(need, data): void

Defined in: packages/method/src/core/resolver.ts:674

Provide data the resolver requested in a previous resolve call. Call once per need, then call resolve again to continue.

Analogous to Rust's Resolver::process_responses().

Parameters ​
need ​

NeedGenesisDocument

The DataNeed being fulfilled (from the needs array).

data ​

object

The data payload corresponding to the need kind.

Returns ​

void

Call Signature ​

provide(need, data): void

Defined in: packages/method/src/core/resolver.ts:675

Provide data the resolver requested in a previous resolve call. Call once per need, then call resolve again to continue.

Analogous to Rust's Resolver::process_responses().

Parameters ​
need ​

NeedBeaconSignals

The DataNeed being fulfilled (from the needs array).

data ​

Map<BeaconService, BeaconSignal[]>

The data payload corresponding to the need kind.

Returns ​

void

Call Signature ​

provide(need, data): void

Defined in: packages/method/src/core/resolver.ts:676

Provide data the resolver requested in a previous resolve call. Call once per need, then call resolve again to continue.

Analogous to Rust's Resolver::process_responses().

Parameters ​
need ​

NeedCASAnnouncement

The DataNeed being fulfilled (from the needs array).

data ​

CASAnnouncement

The data payload corresponding to the need kind.

Returns ​

void

Call Signature ​

provide(need, data): void

Defined in: packages/method/src/core/resolver.ts:677

Provide data the resolver requested in a previous resolve call. Call once per need, then call resolve again to continue.

Analogous to Rust's Resolver::process_responses().

Parameters ​
need ​

NeedSignedUpdate

The DataNeed being fulfilled (from the needs array).

data ​

SignedBTCR2Update

The data payload corresponding to the need kind.

Returns ​

void

resolve() ​

resolve(): ResolverState

Defined in: packages/method/src/core/resolver.ts:530

Advance the state machine. Returns either:

  • { status: 'action-required', needs } — caller must provide data via provide
  • { status: 'resolved', result } — resolution complete

Analogous to Rust's Resolver::resolve().

Returns ​

ResolverState

deterministic() ​

static deterministic(didComponents): DidDocument

Defined in: packages/method/src/core/resolver.ts:182

Implements subsection 7.2.d.1 if genesis bytes is a secp256k1 Public Key.

Parameters ​

didComponents ​

DidComponents

The decoded components of the did.

Returns ​

DidDocument

The resolved DID Document object.

external() ​

static external(didComponents, genesisDocument): DidDocument

Defined in: packages/method/src/core/resolver.ts:219

Implements subsection 7.2.d.2 if genesis_bytes is a SHA-256 Hash.

Parameters ​

didComponents ​

DidComponents

BTCR2 DID components used to resolve the DID Document

genesisDocument ​

object

The genesis document for resolving the DID Document.

Returns ​

DidDocument

The resolved DID Document object

Throws ​

InvalidDidDocument if not conformant to DID Core v1.1

sidecarData() ​

static sidecarData(sidecar?): SidecarData

Defined in: packages/method/src/core/resolver.ts:254

Implements subsection Process Sidecar Data

Parameters ​

sidecar? ​

Sidecar = ...

The sidecar data to process.

Returns ​

SidecarData

The processed sidecar data containing maps of updates, CAS announcements, and SMT proofs.

updates() ​

static updates(currentDocument, unsortedUpdates, versionTime?, versionId?): DidResolutionResponse

Defined in: packages/method/src/core/resolver.ts:287

Implements subsection 7.2.f Process updates Array.

Parameters ​

currentDocument ​

DidDocument

The current DID Document to apply the updates to.

unsortedUpdates ​

[SignedBTCR2Update, BlockMetadata][]

The unsorted array of BTCR2 Signed Updates and their associated Block Metadata.

versionTime? ​

string

The optional version time to limit updates to.

versionId? ​

string

The optional version id to limit updates to.

Returns ​

DidResolutionResponse

The updated DID Document, number of confirmations, and version id.