DID BTC1 JS

Appearance

@did-btc1/method

@did-btc1/method / Btc1DidDocument

Class: Btc1DidDocument ​

Defined in: packages/method/src/utils/did-document.ts:111

BTC1 DID Document extends the DidDocument class adding helper methods and properties Btc1DidDocument

Implements ​

Extended by ​

Implements ​

Constructors ​

Constructor ​

> new Btc1DidDocument(document): Btc1DidDocument

Defined in: packages/method/src/utils/did-document.ts:122

Parameters ​

document ​

IBtc1DidDocument

Returns ​

Btc1DidDocument

Properties ​

@context? ​

> optional @context: (string | JSONObject)[] = BTC1_DID_DOCUMENT_CONTEXT

Defined in: packages/method/src/utils/did-document.ts:114

A JSON-LD context link, which provides a JSON-LD processor with the information necessary to interpret the DID document JSON. The default context URL is 'https://www.w3.org/ns/did/v1'.

Implementation of ​

IBtc1DidDocument.@context

assertionMethod? ​

> optional assertionMethod: (string | Btc1VerificationMethod)[]

Defined in: packages/method/src/utils/did-document.ts:117

The assertion methods of the DID Document.

Implementation of ​

IBtc1DidDocument.assertionMethod

authentication? ​

> optional authentication: (string | Btc1VerificationMethod)[]

Defined in: packages/method/src/utils/did-document.ts:116

The authentication methods of the DID Document.

Implementation of ​

IBtc1DidDocument.authentication

capabilityDelegation? ​

> optional capabilityDelegation: (string | Btc1VerificationMethod)[]

Defined in: packages/method/src/utils/did-document.ts:119

The capability delegation methods of the DID Document.

Implementation of ​

IBtc1DidDocument.capabilityDelegation

capabilityInvocation? ​

> optional capabilityInvocation: (string | Btc1VerificationMethod)[]

Defined in: packages/method/src/utils/did-document.ts:118

The capability invocation methods of the DID Document.

Implementation of ​

IBtc1DidDocument.capabilityInvocation

controller? ​

> optional controller: string[]

Defined in: packages/method/src/utils/did-document.ts:113

The controller of the DID Document.

Implementation of ​

IBtc1DidDocument.controller

id ​

> id: string

Defined in: packages/method/src/utils/did-document.ts:112

The identifier of the DID Document.

Implementation of ​

IBtc1DidDocument.id

service ​

> service: BeaconService[]

Defined in: packages/method/src/utils/did-document.ts:120

The services of the DID Document.

Implementation of ​

IBtc1DidDocument.service

verificationMethod ​

> verificationMethod: Btc1VerificationMethod[]

Defined in: packages/method/src/utils/did-document.ts:115

The verification methods of the DID Document.

Implementation of ​

IBtc1DidDocument.verificationMethod

Methods ​

json() ​

> json(): JSONObject

Defined in: packages/method/src/utils/did-document.ts:184

Convert the Btc1DidDocument to a JSON object.

Returns ​

JSONObject

The JSON representation of the Btc1DidDocument.

toIntermediate() ​

> toIntermediate(): IntermediateDidDocument

Defined in: packages/method/src/utils/did-document.ts:418

Convert the Btc1DidDocument to an IntermediateDidDocument.

Returns ​

IntermediateDidDocument

The IntermediateDidDocument representation of the Btc1DidDocument.

validateIntermediate() ​

> validateIntermediate(): void

Defined in: packages/method/src/utils/did-document.ts:391

Validate the IntermediateDidDocument.

Returns ​

void

True if the IntermediateDidDocument is valid.

fromExternalIdentifier() ​

> static fromExternalIdentifier(data): Btc1DidDocument

Defined in: packages/method/src/utils/did-document.ts:232

Create a Btc1DidDocument from "x1" btc1 identifier.

Parameters ​

data ​

ExternalData

The verification methods of the DID Document.

Returns ​

Btc1DidDocument

A new Btc1DidDocument.

fromKeyIdentifier() ​

> static fromKeyIdentifier(id, publicKeyMultibase, service): Btc1DidDocument

Defined in: packages/method/src/utils/did-document.ts:204

Create a minimal Btc1DidDocument from "k1" btc1 identifier.

Parameters ​

id ​

string

publicKeyMultibase ​

string

The public key in multibase format.

service ​

BeaconService[]

The beacon services to be included in the document.

Returns ​

Btc1DidDocument

A new Btc1DidDocument with the placeholder ID.

isValid() ​

> static isValid(didDocument): boolean

Defined in: packages/method/src/utils/did-document.ts:256

Validates a Btc1DidDocument by breaking it into modular validation methods.

Parameters ​

didDocument ​

Btc1DidDocument

The DID document to validate.

Returns ​

boolean

True if the DID document is valid.

Throws ​

If any validation check fails.

sanitize() ​

> static sanitize(doc): Btc1DidDocument

Defined in: packages/method/src/utils/did-document.ts:241

Sanitize the DID Document by removing undefined values

Parameters ​

doc ​

Btc1DidDocument

Returns ​

Btc1DidDocument

The sanitized DID Document

validate() ​

> static validate(didDocument): Btc1DidDocument

Defined in: packages/method/src/utils/did-document.ts:376

Validate the DID Document

Parameters ​

didDocument ​

Btc1DidDocument | IntermediateDidDocument

Returns ​

Btc1DidDocument

Validated DID Document.

Throws ​

If the DID Document is invalid.