Class IntermediateDidDocument

IntermediateDidDocument extends the Btc1DidDocument 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. IntermediateDidDocument

Hierarchy (View Summary)

Btc1DidDocument
- IntermediateDidDocument

Constructors

constructor

new IntermediateDidDocument(document: IBtc1DidDocument): IntermediateDidDocument
Parameters
- document: IBtc1DidDocument
Returns IntermediateDidDocument
Overrides Btc1DidDocument.constructor
- Defined in packages/method/src/utils/did-document.ts:434

Properties

`Optional`@context

"@context"?: (string | JSONObject)[] = BTC1_DID_DOCUMENT_CONTEXT

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

`Optional`assertionMethod

assertionMethod?: (string | Btc1VerificationMethod)[]

The assertion methods of the DID Document.

`Optional`authentication

authentication?: (string | Btc1VerificationMethod)[]

The authentication methods of the DID Document.

`Optional`capabilityDelegation

capabilityDelegation?: (string | Btc1VerificationMethod)[]

The capability delegation methods of the DID Document.

`Optional`capabilityInvocation

capabilityInvocation?: (string | Btc1VerificationMethod)[]

The capability invocation methods of the DID Document.

`Optional`controller

controller?: string[]

The controller of the DID Document.

id

id: string

The identifier of the DID Document.

service

service: BeaconService[]

The services of the DID Document.

verificationMethod

verificationMethod: Btc1VerificationMethod[]

The verification methods of the DID Document.

Methods

json

json(): JSONObject
Convert the Btc1DidDocument to a JSON object.

Returns JSONObject
The JSON representation of the Btc1DidDocument.
Inherited from Btc1DidDocument.json
- Defined in packages/method/src/utils/did-document.ts:184

toBtc1DidDocument

toBtc1DidDocument(did: string): Btc1DidDocument
Convert the IntermediateDidDocument to a Btc1DidDocument by replacing the placeholder value with the provided DID.
Parameters
- did: string
  The DID to replace the placeholder value in the document.
Returns Btc1DidDocument
A new Btc1DidDocument with the placeholder value replaced by the provided DID.
- Defined in packages/method/src/utils/did-document.ts:460

toIntermediate

toIntermediate(): IntermediateDidDocument
Convert the Btc1DidDocument to an IntermediateDidDocument.

Returns IntermediateDidDocument
The IntermediateDidDocument representation of the Btc1DidDocument.
Inherited from Btc1DidDocument.toIntermediate
- Defined in packages/method/src/utils/did-document.ts:418

validateIntermediate

validateIntermediate(): void
Validate the IntermediateDidDocument.

Returns void
True if the IntermediateDidDocument is valid.
Inherited from Btc1DidDocument.validateIntermediate
- Defined in packages/method/src/utils/did-document.ts:391

`Static`create

create(
    verificationMethod: Btc1VerificationMethod[],
    relationships: VerificationRelationships,
    service: BeaconService[],
): IntermediateDidDocument
Create a minimal IntermediateDidDocument with a placeholder ID.
Parameters
- verificationMethod: Btc1VerificationMethod[]
  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 IntermediateDidDocument
A new IntermediateDidDocument with the placeholder ID.
- Defined in packages/method/src/utils/did-document.ts:446

`Static`from

from(object: JSONObject): Btc1DidDocument
Create a Btc1DidDocument from a JSON object.
Parameters
- object: JSONObject
  The JSON object to convert.
Returns Btc1DidDocument
The created Btc1DidDocument.
- Defined in packages/method/src/utils/did-document.ts:471

`Static`fromExternalIdentifier

fromExternalIdentifier(data: ExternalData): Btc1DidDocument
Create a Btc1DidDocument from "x1" btc1 identifier.
Parameters
- data: ExternalData
  The verification methods of the DID Document.
Returns Btc1DidDocument
A new Btc1DidDocument.
Inherited from Btc1DidDocument.fromExternalIdentifier
- Defined in packages/method/src/utils/did-document.ts:232

`Static`fromKeyIdentifier

fromKeyIdentifier(
    id: string,
    publicKeyMultibase: string,
    service: BeaconService[],
): Btc1DidDocument
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.
Inherited from Btc1DidDocument.fromKeyIdentifier
- Defined in packages/method/src/utils/did-document.ts:204

`Static`isValid

isValid(didDocument: Btc1DidDocument): boolean
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.
Inherited from Btc1DidDocument.isValid
- Defined in packages/method/src/utils/did-document.ts:256

`Static`sanitize

sanitize(doc: Btc1DidDocument): Btc1DidDocument
Sanitize the DID Document by removing undefined values
Parameters
- doc: Btc1DidDocument
Returns Btc1DidDocument
The sanitized DID Document
Inherited from Btc1DidDocument.sanitize
- Defined in packages/method/src/utils/did-document.ts:241

`Static`validate

validate(
didDocument: Btc1DidDocument | IntermediateDidDocument,
): Btc1DidDocument
Validate the DID Document
Parameters
- didDocument: Btc1DidDocument | IntermediateDidDocument
Returns Btc1DidDocument
Validated DID Document.

Throws
If the DID Document is invalid.
Inherited from Btc1DidDocument.validate
- Defined in packages/method/src/utils/did-document.ts:376

Class IntermediateDidDocument

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns IntermediateDidDocument

Properties

Optional@context

OptionalassertionMethod

Optionalauthentication

OptionalcapabilityDelegation

OptionalcapabilityInvocation

Optionalcontroller

id

service

verificationMethod

Methods

json

Returns JSONObject

toBtc1DidDocument

Parameters

Returns Btc1DidDocument

toIntermediate

Returns IntermediateDidDocument

validateIntermediate

Returns void

Staticcreate

Parameters

Returns IntermediateDidDocument

Staticfrom

Parameters

Returns Btc1DidDocument

StaticfromExternalIdentifier

Parameters

Returns Btc1DidDocument

StaticfromKeyIdentifier

Parameters

Returns Btc1DidDocument

StaticisValid

Parameters

Returns boolean

Throws

Staticsanitize

Parameters

Returns Btc1DidDocument

Staticvalidate

Parameters

Returns Btc1DidDocument

Throws

Settings

On This Page

`Optional`@context

`Optional`assertionMethod

`Optional`authentication

`Optional`capabilityDelegation

`Optional`capabilityInvocation

`Optional`controller

`Static`create

`Static`from

`Static`fromExternalIdentifier

`Static`fromKeyIdentifier

`Static`isValid

`Static`sanitize

`Static`validate