Web5 SDK Documentation/web5.sdk.dids.didcore

Package-level declarations

Types

class Did(val uri: String, val url: String, val method: String, val id: String, val params: Map<String, String> = emptyMap(), val path: String? = null, val query: String? = null, val fragment: String? = null)

DID provides a way to parse and handle Decentralized Identifier (DID) URIs according to the W3C DID Core specification (https://www.w3.org/TR/did-core/).

DidDocument

class DidDocument(val id: String, val context: List<String>? = null, val alsoKnownAs: List<String>? = null, val controller: List<String>? = null, val verificationMethod: List<VerificationMethod>? = null, val service: List<Service>? = null, val assertionMethod: List<String>? = null, val authentication: List<String>? = null, val keyAgreement: List<String>? = null, val capabilityDelegation: List<String>? = null, val capabilityInvocation: List<String>? = null)

DidDocument represents a set of data describing the DID subject including mechanisms such as:

DidDocumentMetadata

open class DidDocumentMetadata(var created: String? = null, var updated: String? = null, var deactivated: Boolean? = null, var versionId: String? = null, var nextUpdate: String? = null, var nextVersionId: String? = null, var equivalentId: String? = null, var canonicalId: String? = null)

Contains metadata about the DID document. DID document metadata spec: https://www.w3.org/TR/did-core/#did-document-metadata

class ID(val value: String) : VMSelector

ID.

Purpose

enum Purpose : Enum<Purpose> , VMSelector

Enum representing the purpose of a public key.

Service

class Service(val id: String, val type: String, val serviceEndpoint: List<String>)

Service is used in DID documents to express ways of communicating with the DID subject or associated entities. A service can be any type of service the DID subject wants to advertise. Service spec: https://www.w3.org/TR/did-core/#services

VerificationMethod

class VerificationMethod(val id: String, val type: String, val controller: String, val publicKeyJwk: Jwk? = null)

VerificationMethod expresses verification methods, such as cryptographic public keys, which can be used to authenticate or authorize interactions with the DID subject or associated parties. For example, a cryptographic public key can be used as a verification method with respect to a digital signature; in such usage, it verifies that the signer could use the associated cryptographic private key. Specification Reference: https://www.w3.org/TR/did-core/#verification-methods

VMSelector

interface VMSelector

VerificationMethod Selector.