DID BTCR2 JS

Appearance

Class: DidMethodApi ​

Defined in: packages/api/src/method.ts:20

DID method operations sub-facade: create, resolve, update, deactivate.

Lazily initialized by DidBtcr2Api because it depends on BitcoinApi which requires network configuration.

Constructors ​

Constructor ​

new DidMethodApi(btc?, cas?, logger?): DidMethodApi

Defined in: packages/api/src/method.ts:25

Parameters ​

btc? ​

BitcoinApi

cas? ​

CasApi

logger? ​

Logger

Returns ​

DidMethodApi

Methods ​

buildUpdate() ​

buildUpdate(sourceDocument): UpdateBuilder

Defined in: packages/api/src/method.ts:225

Create a fluent builder for a DID update operation.

Parameters ​

sourceDocument ​

Btcr2DidDocument

The current DID document to update.

Returns ​

UpdateBuilder

An UpdateBuilder for chaining update parameters.

Example ​

ts
const signed = await api.btcr2
  .buildUpdate(currentDoc)
  .patch({ op: 'add', path: '/service/1', value: newService })
  .version(2)
  .signer('#initialKey')
  .beacon('#beacon-0')
  .execute();

createDeterministic() ​

createDeterministic(genesisBytes, options?): string

Defined in: packages/api/src/method.ts:38

Create a deterministic (k1) DID from a public key. Sets idType to KEY automatically.

Parameters ​

genesisBytes ​

Bytes

The compressed public key bytes (33 bytes).

options? ​

Omit<DidCreateOptions, "idType"> = {}

Creation options (idType is set for you).

Returns ​

string

The created DID identifier string.

createExternal() ​

createExternal(genesisBytes, options?): string

Defined in: packages/api/src/method.ts:50

Create a non-deterministic (x1) DID from external genesis document bytes. Sets idType to EXTERNAL automatically.

Parameters ​

genesisBytes ​

Bytes

The genesis document bytes.

options? ​

Omit<DidCreateOptions, "idType"> = {}

Creation options (idType is set for you).

Returns ​

string

The created DID identifier string.

deactivate() ​

deactivate(): Promise<SignedBTCR2Update>

Defined in: packages/api/src/method.ts:230

Deactivate a DID (not yet implemented in the core method).

Returns ​

Promise<SignedBTCR2Update>

getSigningMethod() ​

getSigningMethod(didDocument, methodId?): DidVerificationMethod

Defined in: packages/api/src/method.ts:205

Get the signing method from a DID document by method ID.

Parameters ​

didDocument ​

Btcr2DidDocument

The DID document.

methodId? ​

string

The method ID (if omitted, the first signing method is returned).

Returns ​

DidVerificationMethod

The found signing method.

resolve() ​

resolve(did, options?): Promise<DidResolutionResult>

Defined in: packages/api/src/method.ts:63

Resolve a DID by driving the sans-I/O Resolver state machine. If a Bitcoin connection is configured on the API, it is used automatically to fetch beacon signals. Sidecar data flows through options.sidecar.

Parameters ​

did ​

string

The DID to resolve.

options? ​

ResolutionOptions

Resolution options.

Returns ​

Promise<DidResolutionResult>

The resolution result.

update() ​

update(params): Promise<SignedBTCR2Update>

Defined in: packages/api/src/method.ts:170

Update an existing DID document. If a Bitcoin connection is configured on the API, it is injected automatically.

Parameters ​

params ​

The update parameters.

beaconId ​

string

bitcoin? ​

BitcoinConnection

patches ​

PatchOperation[]

signingMaterial? ​

string | Bytes

sourceDocument ​

Btcr2DidDocument

sourceVersionId ​

number

verificationMethodId ​

string

Returns ​

Promise<SignedBTCR2Update>

The signed update.