DID BTCR2 JS

Appearance

Class: GenesisDocument ​

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

GenesisDocument extends the DidDocument class for creating and managing intermediate DID documents. This class is used to create a minimal DID document with a placeholder ID. It is used in the process of creating a new DID document. GenesisDocument

Extends ​

Constructors ​

Constructor ​

new GenesisDocument(document): GenesisDocument

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

Parameters ​

document ​

object | DidDocument

Returns ​

GenesisDocument

Overrides ​

DidDocument.constructor

Properties ​

@context? ​

optional @context: (string | JsonObject)[] = BTCR2_DID_DOCUMENT_CONTEXT

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

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'.

Inherited from ​

DidDocument.@context

assertionMethod? ​

optional assertionMethod: (string | DidVerificationMethod)[]

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

The assertion methods of the DID Document.

Inherited from ​

DidDocument.assertionMethod

authentication? ​

optional authentication: (string | DidVerificationMethod)[]

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

The authentication methods of the DID Document.

Inherited from ​

DidDocument.authentication

capabilityDelegation? ​

optional capabilityDelegation: (string | DidVerificationMethod)[]

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

The capability delegation methods of the DID Document.

Inherited from ​

DidDocument.capabilityDelegation

capabilityInvocation? ​

optional capabilityInvocation: (string | DidVerificationMethod)[]

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

The capability invocation methods of the DID Document.

Inherited from ​

DidDocument.capabilityInvocation

controller? ​

optional controller: string[]

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

The controller of the DID Document.

Inherited from ​

DidDocument.controller

deactivated? ​

optional deactivated: boolean

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

Inherited from ​

DidDocument.deactivated

id ​

id: string

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

The identifier of the DID Document.

Inherited from ​

DidDocument.id

service ​

service: BeaconService[]

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

The services of the DID Document.

Inherited from ​

DidDocument.service

verificationMethod ​

verificationMethod: DidVerificationMethod[]

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

The verification methods of the DID Document.

Inherited from ​

DidDocument.verificationMethod

Methods ​

json() ​

json(): DidDocument

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

Convert the DidDocument to a JSON object.

Returns ​

DidDocument

The JSON representation of the DidDocument.

Inherited from ​

DidDocument.json

toDidDocument() ​

toDidDocument(did): DidDocument

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

Convert the GenesisDocument to a DidDocument by replacing the placeholder value with the provided DID.

Parameters ​

did ​

string

The DID to replace the placeholder value in the document.

Returns ​

DidDocument

A new DidDocument with the placeholder value replaced by the provided DID.

toIntermediate() ​

toIntermediate(): GenesisDocument

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

Convert the DidDocument to an GenesisDocument.

Returns ​

GenesisDocument

The GenesisDocument representation of the DidDocument.

Inherited from ​

DidDocument.toIntermediate

validateGenesis() ​

validateGenesis(): boolean

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

Validate the GenesisDocument.

Returns ​

boolean

True if the GenesisDocument is valid.

Inherited from ​

DidDocument.validateGenesis

create() ​

static create(verificationMethod, relationships, service): GenesisDocument

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

Create a minimal GenesisDocument with a placeholder ID.

Parameters ​

verificationMethod ​

DidVerificationMethod[]

The public key in multibase format.

relationships ​

VerificationRelationships

The public key in multibase format.

service ​

BeaconService[]

The service to be included in the document.

Returns ​

GenesisDocument

A new GenesisDocument with the placeholder ID.

fromDidDocument() ​

static fromDidDocument(didDocument): GenesisDocument

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

Create an GenesisDocument from a DidDocument by replacing the DID with a placeholder value.

Parameters ​

didDocument ​

DidDocument

The DidDocument to convert.

Returns ​

GenesisDocument

The GenesisDocument representation of the DidDocument.

fromExternalIdentifier() ​

static fromExternalIdentifier(data): DidDocument

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

Create a DidDocument from "x1" btcr2 identifier.

Parameters ​

data ​

ExternalData

The verification methods of the DID Document.

Returns ​

DidDocument

A new DidDocument.

Inherited from ​

DidDocument.fromExternalIdentifier

fromJSON() ​

static fromJSON(object): GenesisDocument

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

Taken an object, convert it to an IntermediateDocuemnt and then to a DidDocument.

Parameters ​

object ​

The JSON object to convert.

object | DidDocument

Returns ​

GenesisDocument

The created DidDocument.

fromKeyIdentifier() ​

static fromKeyIdentifier(id, publicKeyMultibase, service): DidDocument

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

Create a minimal DidDocument from "k1" btcr2 identifier.

Parameters ​

id ​

string

publicKeyMultibase ​

string

The public key in multibase format.

service ​

BeaconService[]

The beacon services to be included in the document.

Returns ​

DidDocument

A new DidDocument with the placeholder ID.

Inherited from ​

DidDocument.fromKeyIdentifier

fromPublicKey() ​

static fromPublicKey(publicKey, network): GenesisDocument

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

Create a minimal GenesisDocument from a public key.

Parameters ​

publicKey ​

Bytes

The public key in bytes format.

network ​

string

Returns ​

GenesisDocument

A new GenesisDocument with the placeholder ID.

isValid() ​

static isValid(didDocument): boolean

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

Validates a DidDocument by breaking it into modular validation methods.

Parameters ​

didDocument ​

DidDocument

The DID document to validate.

Returns ​

boolean

True if the DID document is valid.

Throws ​

If any validation check fails.

Inherited from ​

DidDocument.isValid

sanitize() ​

static sanitize(doc): DidDocument

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

Sanitize the DID Document by removing undefined values

Parameters ​

doc ​

DidDocument

Returns ​

DidDocument

The sanitized DID Document

Inherited from ​

DidDocument.sanitize

validate() ​

static validate(didDocument): DidDocument

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

Validate the DID Document

Parameters ​

didDocument ​

DidDocument | GenesisDocument

Returns ​

DidDocument

Validated DID Document.

Throws ​

If the DID Document is invalid.

Inherited from ​

DidDocument.validate