Interface: IDidDocument ​
Defined in: packages/method/src/utils/did-document.ts:86
BTCR2 DID Document Interface IDidDocument
Extends ​
DidDocument
Properties ​
@context? ​
optional@context: (string|JSONObject)[]
Defined in: packages/method/src/utils/did-document.ts:89
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'.
Overrides ​
IIDidDocument.@context
alsoKnownAs? ​
optionalalsoKnownAs:string[]
Defined in: node_modules/.pnpm/@web5+dids@1.2.0/node_modules/@web5/dids/dist/types/types/did-core.d.ts:121
A DID subject can have multiple identifiers for different purposes, or at different times. The assertion that two or more DIDs (or other types of URI) refer to the same DID subject can be made using the alsoKnownAs property.
See ​
DID Core Specification, § Also Known As
Inherited from ​
IIDidDocument.alsoKnownAs
assertionMethod? ​
optionalassertionMethod: (string|DidVerificationMethod)[]
Defined in: packages/method/src/utils/did-document.ts:92
The assertion methods of the DID Document.
Overrides ​
IIDidDocument.assertionMethod
authentication? ​
optionalauthentication: (string|DidVerificationMethod)[]
Defined in: packages/method/src/utils/did-document.ts:91
The authentication methods of the DID Document.
Overrides ​
IIDidDocument.authentication
capabilityDelegation? ​
optionalcapabilityDelegation: (string|DidVerificationMethod)[]
Defined in: packages/method/src/utils/did-document.ts:94
The capability delegation methods of the DID Document.
Overrides ​
IIDidDocument.capabilityDelegation
capabilityInvocation? ​
optionalcapabilityInvocation: (string|DidVerificationMethod)[]
Defined in: packages/method/src/utils/did-document.ts:93
The capability invocation methods of the DID Document.
Overrides ​
IIDidDocument.capabilityInvocation
controller? ​
optionalcontroller:string[]
Defined in: packages/method/src/utils/did-document.ts:88
The controller of the DID Document.
Overrides ​
IIDidDocument.controller
id ​
id:
string
Defined in: packages/method/src/utils/did-document.ts:87
The identifier of the DID Document.
Overrides ​
IIDidDocument.id
keyAgreement? ​
optionalkeyAgreement: (string|DidVerificationMethod)[]
Defined in: node_modules/.pnpm/@web5+dids@1.2.0/node_modules/@web5/dids/dist/types/types/did-core.d.ts:163
The keyAgreement verification relationship is used to specify how an entity can generate encryption material in order to transmit confidential information intended for the DID subject, such as for the purposes of establishing a secure communication channel with the recipient.
See ​
DID Core Specification, § Key Agreement
Inherited from ​
IIDidDocument.keyAgreement
service ​
service:
BeaconService[]
Defined in: packages/method/src/utils/did-document.ts:95
The services of the DID Document.
Overrides ​
IIDidDocument.service
verificationMethod ​
verificationMethod:
DidVerificationMethod[]
Defined in: packages/method/src/utils/did-document.ts:90
The verification methods of the DID Document.
Overrides ​
IIDidDocument.verificationMethod