Skip to main content
Version: 1.3

Wasm Api Reference

Classes

CoreDID

A method-agnostic Decentralized Identifier (DID).

CoreDocument

A method-agnostic DID Document.

Note: All methods that involve reading from this class may potentially raise an error if the object is being concurrently modified.

Credential
CustomMethodData

A custom verification method data format.

DIDUrl

A method agnostic DID Url.

DecodedJptCredential
DecodedJptPresentation
DecodedJws

A cryptographically verified decoded token from a JWS.

Contains the decoded headers and the raw claims.

DecodedJwtCredential

A cryptographically verified and decoded Credential.

Note that having an instance of this type only means the JWS it was constructed from was verified. It does not imply anything about a potentially present proof property on the credential itself.

DecodedJwtPresentation

A cryptographically verified and decoded presentation.

Note that having an instance of this type only means the JWS it was constructed from was verified. It does not imply anything about a potentially present proof property on the presentation itself.

Disclosure

Represents an elements constructing a disclosure. Object properties and array elements disclosures are supported.

See: https://www.ietf.org/archive/id/draft-ietf-oauth-selective-disclosure-jwt-07.html#name-disclosures

DomainLinkageConfiguration

DID Configuration Resource which contains Domain Linkage Credentials. It can be placed in an origin's .well-known directory to prove linkage between the origin and a DID. See: https://identity.foundation/.well-known/resources/did-configuration/#did-configuration-resource

Note:

Duration

A span of time.

EdDSAJwsVerifier

An implementor of IJwsVerifier that can handle theEdDSA algorithm.

IotaDID

A DID conforming to the IOTA DID method specification.

IotaDocument

A DID Document adhering to the IOTA DID method specification.

Note: All methods that involve reading from this class may potentially raise an error if the object is being concurrently modified.

IotaDocumentMetadata

Additional attributes related to an IOTA DID Document.

IotaIdentityClientExt

An extension interface that provides helper functions for publication and resolution of DID documents in Alias Outputs.

IssuerProtectedHeader
Jpt

A JSON Proof Token (JPT).

JptCredentialValidationOptions

Options to declare validation criteria for Jpt.

JptCredentialValidator
JptCredentialValidatorUtils

Utility functions for validating JPT credentials.

JptPresentationValidationOptions

Options to declare validation criteria for a Jpt presentation.

JptPresentationValidator
JptPresentationValidatorUtils

Utility functions for verifying JPT presentations.

Jwk
JwkGenOutput

The result of a key generation in JwkStorage.

JwpCredentialOptions
JwpIssued
JwpPresentationOptions

Options to be set in the JWT claims of a verifiable presentation.

JwpVerificationOptions
Jws

A wrapper around a JSON Web Signature (JWS).

JwsHeader
JwsSignatureOptions
JwsVerificationOptions
Jwt

A wrapper around a JSON Web Token (JWK).

JwtCredentialValidationOptions

Options to declare validation criteria when validating credentials.

JwtCredentialValidator

A type for decoding and validating Credential.

JwtDomainLinkageValidator

A validator for a Domain Linkage Configuration and Credentials.

JwtPresentationOptions
JwtPresentationValidationOptions

Options to declare validation criteria when validating presentation.

JwtPresentationValidator
KeyBindingJWTValidationOptions

Options to declare validation criteria when validating credentials.

KeyBindingJwtClaims

Claims set for key binding JWT.

LinkedDomainService
MethodData

Supported verification method data formats.

MethodDigest

Unique identifier of a VerificationMethod.

NOTE: This class does not have a JSON representation, use the methods pack and unpack instead.

MethodScope

Supported verification method types.

MethodType

Supported verification method types.

PayloadEntry
Payloads
Presentation
PresentationProtectedHeader
Proof

Represents a cryptographic proof that can be used to validate verifiable credentials and presentations.

This representation does not inherently implement any standard; instead, it can be utilized to implement standards or user-defined proofs. The presence of thetype field is necessary to accommodate different types of cryptographic proofs.

Note that this proof is not related to JWT and can be used in combination or as an alternative to it.

ProofUpdateCtx
Resolver

Convenience type for resolving DID documents from different DID methods.

Also provides methods for resolving DID Documents associated with verifiable Credentials and Presentations.

Configuration

The resolver will only be able to resolve DID documents for methods it has been configured for in the constructor.

RevocationBitmap

A compressed bitmap for managing credential revocation.

RevocationTimeframeStatus

Information used to determine the current status of a Credential.

SdJwt

Representation of an SD-JWT of the format<Issuer-signed JWT>~<Disclosure 1>~<Disclosure 2>~...~<Disclosure N>~<optional KB-JWT>.

SdJwtCredentialValidator

A type for decoding and validating Credential.

SdObjectDecoder

Substitutes digests in an SD-JWT object by their corresponding plaintext values provided by disclosures.

SdObjectEncoder

Transforms a JSON object into an SD-JWT object by substituting selected values with their corresponding disclosure digests.

Note: digests are created using the sha-256 algorithm.

SelectiveDisclosurePresentation

Used to construct a JwpPresentedBuilder and handle the selective disclosure of attributes

  • @context MUST NOT be blinded
  • id MUST be blinded
  • type MUST NOT be blinded
  • issuer MUST NOT be blinded
  • issuanceDate MUST be blinded (if Timeframe Revocation mechanism is used)
  • expirationDate MUST be blinded (if Timeframe Revocation mechanism is used)
  • credentialSubject (User have to choose which attribute must be blinded)
  • credentialSchema MUST NOT be blinded
  • credentialStatus MUST NOT be blinded
  • refreshService MUST NOT be blinded (probably will be used for Timeslot Revocation mechanism)
  • termsOfUse NO reason to use it in ZK VC (will be in any case blinded)
  • evidence (User have to choose which attribute must be blinded)
Service

A DID Document Service used to enable trusted interactions associated with a DID subject.

StatusList2021

StatusList2021 data structure as described in W3C's VC status list 2021.

StatusList2021Credential

A parsed StatusList2021Credential.

StatusList2021CredentialBuilder

Builder type to construct valid StatusList2021Credential istances.

StatusList2021Entry

StatusList2021Entry implementation.

Storage

A type wrapping a JwkStorage and KeyIdStorage that should always be used together when working with storage backed DID documents.

Timestamp
UnknownCredential
VerificationMethod

A DID Document Verification Method.

Members

StatusCheck

Controls validation behaviour when checking whether or not a credential has been revoked by itscredentialStatus.

Strict

Validate the status if supported, reject any unsupportedcredentialStatus types.

Only RevocationBitmap2022 is currently supported.

This is the default.

SkipUnsupported

Validate the status if supported, skip any unsupportedcredentialStatus types.

SkipAll

Skip all status checks.

CredentialStatus
PayloadType
ProofAlgorithm
StatusPurpose

Purpose of a StatusList2021.

FailFast

Declares when validation should return if an error occurs.

AllErrors

Return all errors that occur during validation.

FirstError

Return after the first error occurs.

StateMetadataEncoding
SerializationType
MethodRelationship
PresentationProofAlgorithm
SubjectHolderRelationship

Declares how credential subjects must relate to the presentation holder.

See also the Subject-Holder Relationship section of the specification.

AlwaysSubject

The holder must always match the subject on all credentials, regardless of their nonTransferable property. This variant is the default.

SubjectOnNonTransferable

The holder must match the subject only for credentials where the nonTransferable property is true.

Any

The holder is not required to have any kind of relationship to any credential subject.

Functions

encodeB64(data)string

Encode the given bytes in url-safe base64.

decodeB64(data)Uint8Array

Decode the given url-safe base64-encoded slice into its raw bytes.

start()

Initializes the console error panic hook for better error messages

verifyEd25519(alg, signingInput, decodedSignature, publicKey)

Verify a JWS signature secured with the EdDSA algorithm and curve Ed25519.

This function is useful when one is composing a IJwsVerifier that delegatesEdDSA verification with curve Ed25519 to this function.

Warning

This function does not check whether alg = EdDSA in the protected header. Callers are expected to assert this prior to calling the function.

CoreDID

A method-agnostic Decentralized Identifier (DID).

Kind: global class

coreDID.setMethodName(value)

Set the method name of the CoreDID.

Kind: instance method of CoreDID

ParamType
valuestring

coreDID.setMethodId(value)

Set the method-specific-id of the DID.

Kind: instance method of CoreDID

ParamType
valuestring

coreDID.scheme() ⇒ string

Returns the CoreDID scheme.

E.g.

  • "did:example:12345678" -> "did"
  • "did:iota:smr:12345678" -> "did"

Kind: instance method of CoreDID

coreDID.authority() ⇒ string

Returns the CoreDID authority: the method name and method-id.

E.g.

  • "did:example:12345678" -> "example:12345678"
  • "did:iota:smr:12345678" -> "iota:smr:12345678"

Kind: instance method of CoreDID

coreDID.method() ⇒ string

Returns the CoreDID method name.

E.g.

  • "did:example:12345678" -> "example"
  • "did:iota:smr:12345678" -> "iota"

Kind: instance method of CoreDID

coreDID.methodId() ⇒ string

Returns the CoreDID method-specific ID.

E.g.

  • "did:example:12345678" -> "12345678"
  • "did:iota:smr:12345678" -> "smr:12345678"

Kind: instance method of CoreDID

coreDID.join(segment) ⇒ DIDUrl

Construct a new DIDUrl by joining with a relative DID Url string.

Kind: instance method of CoreDID

ParamType
segmentstring

coreDID.toUrl() ⇒ DIDUrl

Clones the CoreDID into a DIDUrl.

Kind: instance method of CoreDID

coreDID.intoUrl() ⇒ DIDUrl

Converts the CoreDID into a DIDUrl, consuming it.

Kind: instance method of CoreDID

coreDID.toString() ⇒ string

Returns the CoreDID as a string.

Kind: instance method of CoreDID

coreDID.toCoreDid() ⇒ CoreDID

Kind: instance method of CoreDID

coreDID.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of CoreDID

coreDID.clone() ⇒ CoreDID

Deep clones the object.

Kind: instance method of CoreDID

CoreDID.parse(input) ⇒ CoreDID

Parses a CoreDID from the given input.

Errors

Throws an error if the input is not a valid CoreDID.

Kind: static method of CoreDID

ParamType
inputstring

CoreDID.validMethodName(value) ⇒ boolean

Validates whether a string is a valid DID method name.

Kind: static method of CoreDID

ParamType
valuestring

CoreDID.validMethodId(value) ⇒ boolean

Validates whether a string is a valid DID method-id.

Kind: static method of CoreDID

ParamType
valuestring

CoreDID.fromJSON(json) ⇒ CoreDID

Deserializes an instance from a JSON object.

Kind: static method of CoreDID

ParamType
jsonany

CoreDocument

A method-agnostic DID Document.

Note: All methods that involve reading from this class may potentially raise an error if the object is being concurrently modified.

Kind: global class

new CoreDocument(values)

Creates a new CoreDocument with the given properties.

ParamType
valuesICoreDocument

coreDocument.id() ⇒ CoreDID

Returns a copy of the DID Document id.

Kind: instance method of CoreDocument

coreDocument.setId(id)

Sets the DID of the document.

Warning

Changing the identifier can drastically alter the results of resolve_method, resolve_service and the related DID URL dereferencing algorithm.

Kind: instance method of CoreDocument

ParamType
idCoreDID

coreDocument.controller() ⇒ Array.<CoreDID>

Returns a copy of the document controllers.

Kind: instance method of CoreDocument

coreDocument.setController(controllers)

Sets the controllers of the DID Document.

Note: Duplicates will be ignored. Use null to remove all controllers.

Kind: instance method of CoreDocument

ParamType
controllersCoreDID | Array.<CoreDID> | null

coreDocument.alsoKnownAs() ⇒ Array.<string>

Returns a copy of the document's alsoKnownAs set.

Kind: instance method of CoreDocument

coreDocument.setAlsoKnownAs(urls)

Sets the alsoKnownAs property in the DID document.

Kind: instance method of CoreDocument

ParamType
urlsstring | Array.<string> | null

coreDocument.verificationMethod() ⇒ Array.<VerificationMethod>

Returns a copy of the document's verificationMethod set.

Kind: instance method of CoreDocument

coreDocument.authentication() ⇒ Array.<(DIDUrl|VerificationMethod)>

Returns a copy of the document's authentication set.

Kind: instance method of CoreDocument

coreDocument.assertionMethod() ⇒ Array.<(DIDUrl|VerificationMethod)>

Returns a copy of the document's assertionMethod set.

Kind: instance method of CoreDocument

coreDocument.keyAgreement() ⇒ Array.<(DIDUrl|VerificationMethod)>

Returns a copy of the document's keyAgreement set.

Kind: instance method of CoreDocument

coreDocument.capabilityDelegation() ⇒ Array.<(DIDUrl|VerificationMethod)>

Returns a copy of the document's capabilityDelegation set.

Kind: instance method of CoreDocument

coreDocument.capabilityInvocation() ⇒ Array.<(DIDUrl|VerificationMethod)>

Returns a copy of the document's capabilityInvocation set.

Kind: instance method of CoreDocument

coreDocument.properties() ⇒ Map.<string, any>

Returns a copy of the custom DID Document properties.

Kind: instance method of CoreDocument

coreDocument.setPropertyUnchecked(key, value)

Sets a custom property in the DID Document. If the value is set to null, the custom property will be removed.

WARNING

This method can overwrite existing properties like id and result in an invalid document.

Kind: instance method of CoreDocument

ParamType
keystring
valueany

coreDocument.service() ⇒ Array.<Service>

Returns a set of all Service in the document.

Kind: instance method of CoreDocument

coreDocument.insertService(service)

Add a new Service to the document.

Errors if there already exists a service or verification method with the same id.

Kind: instance method of CoreDocument

ParamType
serviceService

coreDocument.removeService(didUrl) ⇒ Service | undefined

Remove a Service identified by the given DIDUrl from the document.

Returns true if the service was removed.

Kind: instance method of CoreDocument

ParamType
didUrlDIDUrl

coreDocument.resolveService(query) ⇒ Service | undefined

Returns the first Service with an id property matching the provided query, if present.

Kind: instance method of CoreDocument

ParamType
queryDIDUrl | string

coreDocument.methods([scope]) ⇒ Array.<VerificationMethod>

Returns a list of all VerificationMethod in the DID Document, whose verification relationship matches scope.

If scope is not set, a list over the embedded methods is returned.

Kind: instance method of CoreDocument

ParamType
[scope]MethodScope | undefined

coreDocument.verificationRelationships() ⇒ Array.<(DIDUrl|VerificationMethod)>

Returns an array of all verification relationships.

Kind: instance method of CoreDocument

coreDocument.insertMethod(method, scope)

Adds a new method to the document in the given scope.

Kind: instance method of CoreDocument

ParamType
methodVerificationMethod
scopeMethodScope

coreDocument.removeMethod(did) ⇒ VerificationMethod | undefined

Removes all references to the specified Verification Method.

Kind: instance method of CoreDocument

ParamType
didDIDUrl

coreDocument.resolveMethod(query, [scope]) ⇒ VerificationMethod | undefined

Returns a copy of the first verification method with an id property matching the provided query and the verification relationship specified by scope, if present.

Kind: instance method of CoreDocument

ParamType
queryDIDUrl | string
[scope]MethodScope | undefined

coreDocument.attachMethodRelationship(didUrl, relationship) ⇒ boolean

Attaches the relationship to the given method, if the method exists.

Note: The method needs to be in the set of verification methods, so it cannot be an embedded one.

Kind: instance method of CoreDocument

ParamType
didUrlDIDUrl
relationshipMethodRelationship

coreDocument.detachMethodRelationship(didUrl, relationship) ⇒ boolean

Detaches the given relationship from the given method, if the method exists.

Kind: instance method of CoreDocument

ParamType
didUrlDIDUrl
relationshipMethodRelationship

coreDocument.verifyJws(jws, options, signatureVerifier, [detachedPayload]) ⇒ DecodedJws

Decodes and verifies the provided JWS according to the passed options and signatureVerifier. If no signatureVerifier argument is provided a default verifier will be used that is (only) capable of verifying EdDSA signatures.

Regardless of which options are passed the following conditions must be met in order for a verification attempt to take place.

  • The JWS must be encoded according to the JWS compact serialization.
  • The kid value in the protected header must be an identifier of a verification method in this DID document, or set explicitly in the options.

Kind: instance method of CoreDocument

ParamType
jwsJws
optionsJwsVerificationOptions
signatureVerifierIJwsVerifier
[detachedPayload]string | undefined

coreDocument.revokeCredentials(serviceQuery, indices)

If the document has a RevocationBitmap service identified by serviceQuery, revoke all specified indices.

Kind: instance method of CoreDocument

ParamType
serviceQueryDIDUrl | string
indicesnumber | Array.<number>

coreDocument.unrevokeCredentials(serviceQuery, indices)

If the document has a RevocationBitmap service identified by serviceQuery, unrevoke all specified indices.

Kind: instance method of CoreDocument

ParamType
serviceQueryDIDUrl | string
indicesnumber | Array.<number>

coreDocument.clone() ⇒ CoreDocument

Deep clones the CoreDocument.

Kind: instance method of CoreDocument

coreDocument._shallowCloneInternal() ⇒ CoreDocument

Warning

This is for internal use only. Do not rely on or call this method.

Kind: instance method of CoreDocument

coreDocument._strongCountInternal() ⇒ number

Warning

This is for internal use only. Do not rely on or call this method.

Kind: instance method of CoreDocument

coreDocument.toJSON() ⇒ any

Serializes to a plain JS representation.

Kind: instance method of CoreDocument

coreDocument.generateMethod(storage, keyType, alg, fragment, scope) ⇒ Promise.<string>

Generate new key material in the given storage and insert a new verification method with the corresponding public key material into the DID document.

  • If no fragment is given the kid of the generated JWK is used, if it is set, otherwise an error is returned.
  • The keyType must be compatible with the given storage. Storages are expected to export key type constants for that use case.

The fragment of the generated method is returned.

Kind: instance method of CoreDocument

ParamType
storageStorage
keyTypestring
algJwsAlgorithm
fragmentstring | undefined
scopeMethodScope

coreDocument.purgeMethod(storage, id) ⇒ Promise.<void>

Remove the method identified by the fragment from the document and delete the corresponding key material in the storage.

Kind: instance method of CoreDocument

ParamType
storageStorage
idDIDUrl

coreDocument.createJws(storage, fragment, payload, options) ⇒ Promise.<Jws>

Sign the payload according to options with the storage backed private key corresponding to the public key material in the verification method identified by the given `fragment.

Upon success a string representing a JWS encoded according to the Compact JWS Serialization format is returned. See RFC7515 section 3.1.

Kind: instance method of CoreDocument

ParamType
storageStorage
fragmentstring
payloadstring
optionsJwsSignatureOptions

coreDocument.createCredentialJwt(storage, fragment, credential, options, [custom_claims]) ⇒ Promise.<Jwt>

Produces a JWT where the payload is produced from the given credential in accordance with VC Data Model v1.1.

Unless the kid is explicitly set in the options, the kid in the protected header is the id of the method identified by fragment and the JWS signature will be produced by the corresponding private key backed by the storage in accordance with the passed options.

The custom_claims can be used to set additional claims on the resulting JWT.

Kind: instance method of CoreDocument

ParamType
storageStorage
fragmentstring
credentialCredential
optionsJwsSignatureOptions
[custom_claims]Record.<string, any> | undefined

coreDocument.createPresentationJwt(storage, fragment, presentation, signature_options, presentation_options) ⇒ Promise.<Jwt>

Produces a JWT where the payload is produced from the given presentation. in accordance with VC Data Model v1.1.

Unless the kid is explicitly set in the options, the kid in the protected header is the id of the method identified by fragment and the JWS signature will be produced by the corresponding private key backed by the storage in accordance with the passed options.

Kind: instance method of CoreDocument

ParamType
storageStorage
fragmentstring
presentationPresentation
signature_optionsJwsSignatureOptions
presentation_optionsJwtPresentationOptions

CoreDocument.fromJSON(json) ⇒ CoreDocument

Deserializes an instance from a plain JS representation.

Kind: static method of CoreDocument

ParamType
jsonany

Credential

Kind: global class

new Credential(values)

Constructs a new Credential.

ParamType
valuesICredential

credential.context() ⇒ Array.<(string|Record.<string, any>)>

Returns a copy of the JSON-LD context(s) applicable to the Credential.

Kind: instance method of Credential

credential.id() ⇒ string | undefined

Returns a copy of the unique URI identifying the Credential .

Kind: instance method of Credential

credential.type() ⇒ Array.<string>

Returns a copy of the URIs defining the type of the Credential.

Kind: instance method of Credential

credential.credentialSubject() ⇒ Array.<Subject>

Returns a copy of the Credential subject(s).

Kind: instance method of Credential

credential.issuer() ⇒ string | Issuer

Returns a copy of the issuer of the Credential.

Kind: instance method of Credential

credential.issuanceDate() ⇒ Timestamp

Returns a copy of the timestamp of when the Credential becomes valid.

Kind: instance method of Credential

credential.expirationDate() ⇒ Timestamp | undefined

Returns a copy of the timestamp of when the Credential should no longer be considered valid.

Kind: instance method of Credential

credential.credentialStatus() ⇒ Array.<Status>

Returns a copy of the information used to determine the current status of the Credential.

Kind: instance method of Credential

credential.credentialSchema() ⇒ Array.<Schema>

Returns a copy of the information used to assist in the enforcement of a specific Credential structure.

Kind: instance method of Credential

credential.refreshService() ⇒ Array.<RefreshService>

Returns a copy of the service(s) used to refresh an expired Credential.

Kind: instance method of Credential

credential.termsOfUse() ⇒ Array.<Policy>

Returns a copy of the terms-of-use specified by the Credential issuer.

Kind: instance method of Credential

credential.evidence() ⇒ Array.<Evidence>

Returns a copy of the human-readable evidence used to support the claims within the Credential.

Kind: instance method of Credential

credential.nonTransferable() ⇒ boolean | undefined

Returns whether or not the Credential must only be contained within a Presentation with a proof issued from the Credential subject.

Kind: instance method of Credential

credential.proof() ⇒ Proof | undefined

Optional cryptographic proof, unrelated to JWT.

Kind: instance method of Credential

credential.properties() ⇒ Map.<string, any>

Returns a copy of the miscellaneous properties on the Credential.

Kind: instance method of Credential

credential.setProof([proof])

Sets the proof property of the Credential.

Note that this proof is not related to JWT.

Kind: instance method of Credential

ParamType
[proof]Proof | undefined

credential.toJwtClaims([custom_claims]) ⇒ Record.<string, any>

Serializes the Credential as a JWT claims set in accordance with VC Data Model v1.1.

The resulting object can be used as the payload of a JWS when issuing the credential.

Kind: instance method of Credential

ParamType
[custom_claims]Record.<string, any> | undefined

credential.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of Credential

credential.clone() ⇒ Credential

Deep clones the object.

Kind: instance method of Credential

Credential.BaseContext() ⇒ string

Returns the base JSON-LD context.

Kind: static method of Credential

Credential.BaseType() ⇒ string

Returns the base type.

Kind: static method of Credential

Credential.createDomainLinkageCredential(values) ⇒ Credential

Kind: static method of Credential

ParamType
valuesIDomainLinkageCredential

Credential.fromJSON(json) ⇒ Credential

Deserializes an instance from a JSON object.

Kind: static method of Credential

ParamType
jsonany

CustomMethodData

A custom verification method data format.

Kind: global class

new CustomMethodData(name, data)

ParamType
namestring
dataany

customMethodData.clone() ⇒ CustomMethodData

Deep clones the object.

Kind: instance method of CustomMethodData

customMethodData.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of CustomMethodData

CustomMethodData.fromJSON(json) ⇒ CustomMethodData

Deserializes an instance from a JSON object.

Kind: static method of CustomMethodData

ParamType
jsonany

DIDUrl

A method agnostic DID Url.

Kind: global class

didUrl.did() ⇒ CoreDID

Return a copy of the CoreDID section of the DIDUrl.

Kind: instance method of DIDUrl

didUrl.urlStr() ⇒ string

Return a copy of the relative DID Url as a string, including only the path, query, and fragment.

Kind: instance method of DIDUrl

didUrl.fragment() ⇒ string | undefined

Returns a copy of the DIDUrl method fragment, if any. Excludes the leading '#'.

Kind: instance method of DIDUrl

didUrl.setFragment([value])

Sets the fragment component of the DIDUrl.

Kind: instance method of DIDUrl

ParamType
[value]string | undefined

didUrl.path() ⇒ string | undefined

Returns a copy of the DIDUrl path.

Kind: instance method of DIDUrl

didUrl.setPath([value])

Sets the path component of the DIDUrl.

Kind: instance method of DIDUrl

ParamType
[value]string | undefined

didUrl.query() ⇒ string | undefined

Returns a copy of the DIDUrl method query, if any. Excludes the leading '?'.

Kind: instance method of DIDUrl

didUrl.setQuery([value])

Sets the query component of the DIDUrl.

Kind: instance method of DIDUrl

ParamType
[value]string | undefined

didUrl.join(segment) ⇒ DIDUrl

Append a string representing a path, query, and/or fragment, returning a new DIDUrl.

Must begin with a valid delimiter character: '/', '?', '#'. Overwrites the existing URL segment and any following segments in order of path, query, then fragment.

I.e.

  • joining a path will clear the query and fragment.
  • joining a query will clear the fragment.
  • joining a fragment will only overwrite the fragment.

Kind: instance method of DIDUrl

ParamType
segmentstring

didUrl.toString() ⇒ string

Returns the DIDUrl as a string.

Kind: instance method of DIDUrl

didUrl.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of DIDUrl

didUrl.clone() ⇒ DIDUrl

Deep clones the object.

Kind: instance method of DIDUrl

DIDUrl.parse(input) ⇒ DIDUrl

Parses a DIDUrl from the input string.

Kind: static method of DIDUrl

ParamType
inputstring

DIDUrl.fromJSON(json) ⇒ DIDUrl

Deserializes an instance from a JSON object.

Kind: static method of DIDUrl

ParamType
jsonany

DecodedJptCredential

Kind: global class

decodedJptCredential.clone() ⇒ DecodedJptCredential

Deep clones the object.

Kind: instance method of DecodedJptCredential

decodedJptCredential.credential() ⇒ Credential

Returns the Credential embedded into this JPT.

Kind: instance method of DecodedJptCredential

decodedJptCredential.customClaims() ⇒ Map.<string, any>

Returns the custom claims parsed from the JPT.

Kind: instance method of DecodedJptCredential

decodedJptCredential.decodedJwp() ⇒ JwpIssued

Kind: instance method of DecodedJptCredential

DecodedJptPresentation

Kind: global class

decodedJptPresentation.clone() ⇒ DecodedJptPresentation

Deep clones the object.

Kind: instance method of DecodedJptPresentation

decodedJptPresentation.credential() ⇒ Credential

Returns the Credential embedded into this JPT.

Kind: instance method of DecodedJptPresentation

decodedJptPresentation.customClaims() ⇒ Map.<string, any>

Returns the custom claims parsed from the JPT.

Kind: instance method of DecodedJptPresentation

decodedJptPresentation.aud() ⇒ string | undefined

Returns the aud property parsed from the JWT claims.

Kind: instance method of DecodedJptPresentation

DecodedJws

A cryptographically verified decoded token from a JWS.

Contains the decoded headers and the raw claims.

Kind: global class

decodedJws.claims() ⇒ string

Returns a copy of the parsed claims represented as a string.

Errors

An error is thrown if the claims cannot be represented as a string.

This error can only occur if the Token was decoded from a detached payload.

Kind: instance method of DecodedJws

decodedJws.claimsBytes() ⇒ Uint8Array

Return a copy of the parsed claims represented as an array of bytes.

Kind: instance method of DecodedJws

decodedJws.protectedHeader() ⇒ JwsHeader

Returns a copy of the protected header.

Kind: instance method of DecodedJws

decodedJws.clone() ⇒ DecodedJws

Deep clones the object.

Kind: instance method of DecodedJws

decodedJws.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of DecodedJws

DecodedJwtCredential

A cryptographically verified and decoded Credential.

Note that having an instance of this type only means the JWS it was constructed from was verified. It does not imply anything about a potentially present proof property on the credential itself.

Kind: global class

decodedJwtCredential.credential() ⇒ Credential

Returns a copy of the credential parsed to the Verifiable Credentials Data model.

Kind: instance method of DecodedJwtCredential

decodedJwtCredential.protectedHeader() ⇒ JwsHeader

Returns a copy of the protected header parsed from the decoded JWS.

Kind: instance method of DecodedJwtCredential

decodedJwtCredential.customClaims() ⇒ Record.<string, any> | undefined

The custom claims parsed from the JWT.

Kind: instance method of DecodedJwtCredential

decodedJwtCredential.intoCredential() ⇒ Credential

Consumes the object and returns the decoded credential.

Warning

This destroys the DecodedJwtCredential object.

Kind: instance method of DecodedJwtCredential

DecodedJwtPresentation

A cryptographically verified and decoded presentation.

Note that having an instance of this type only means the JWS it was constructed from was verified. It does not imply anything about a potentially present proof property on the presentation itself.

Kind: global class

decodedJwtPresentation.presentation() ⇒ Presentation

Kind: instance method of DecodedJwtPresentation

decodedJwtPresentation.protectedHeader() ⇒ JwsHeader

Returns a copy of the protected header parsed from the decoded JWS.

Kind: instance method of DecodedJwtPresentation

decodedJwtPresentation.intoPresentation() ⇒ Presentation

Consumes the object and returns the decoded presentation.

Warning

This destroys the DecodedJwtPresentation object.

Kind: instance method of DecodedJwtPresentation

decodedJwtPresentation.expirationDate() ⇒ Timestamp | undefined

The expiration date parsed from the JWT claims.

Kind: instance method of DecodedJwtPresentation

decodedJwtPresentation.issuanceDate() ⇒ Timestamp | undefined

The issuance date parsed from the JWT claims.

Kind: instance method of DecodedJwtPresentation

decodedJwtPresentation.audience() ⇒ string | undefined

The aud property parsed from JWT claims.

Kind: instance method of DecodedJwtPresentation

decodedJwtPresentation.customClaims() ⇒ Record.<string, any> | undefined

The custom claims parsed from the JWT.

Kind: instance method of DecodedJwtPresentation

Disclosure

Represents an elements constructing a disclosure. Object properties and array elements disclosures are supported.

See: https://www.ietf.org/archive/id/draft-ietf-oauth-selective-disclosure-jwt-07.html#name-disclosures

Kind: global class

new Disclosure(salt, claim_name, claim_value)

ParamType
saltstring
claim_namestring | undefined
claim_valueany

disclosure.disclosure() ⇒ string

Returns a copy of the base64url-encoded string.

Kind: instance method of Disclosure

disclosure.toEncodedString() ⇒ string

Returns a copy of the base64url-encoded string.

Kind: instance method of Disclosure

disclosure.toString() ⇒ string

Returns a copy of the base64url-encoded string.

Kind: instance method of Disclosure

disclosure.salt() ⇒ string

Returns a copy of the salt value.

Kind: instance method of Disclosure

disclosure.claimName() ⇒ string | undefined

Returns a copy of the claim name, optional for array elements.

Kind: instance method of Disclosure

disclosure.claimValue() ⇒ any

Returns a copy of the claim Value which can be of any type.

Kind: instance method of Disclosure

disclosure.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of Disclosure

Disclosure.parse(disclosure) ⇒ Disclosure

Parses a Base64 encoded disclosure into a Disclosure.

Error

Returns an InvalidDisclosure if input is not a valid disclosure.

Kind: static method of Disclosure

ParamType
disclosurestring

Disclosure.fromJSON(json) ⇒ Disclosure

Deserializes an instance from a JSON object.

Kind: static method of Disclosure

ParamType
jsonany

DomainLinkageConfiguration

DID Configuration Resource which contains Domain Linkage Credentials. It can be placed in an origin's .well-known directory to prove linkage between the origin and a DID. See: https://identity.foundation/.well-known/resources/did-configuration/#did-configuration-resource

Note:

Kind: global class

new DomainLinkageConfiguration(linkedDids)

Constructs a new DomainLinkageConfiguration.

ParamType
linkedDidsArray.<Jwt>

domainLinkageConfiguration.linkedDids() ⇒ Array.<Jwt>

List of the Domain Linkage Credentials.

Kind: instance method of DomainLinkageConfiguration

domainLinkageConfiguration.issuers() ⇒ Array.<CoreDID>

List of the issuers of the Domain Linkage Credentials.

Kind: instance method of DomainLinkageConfiguration

domainLinkageConfiguration.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of DomainLinkageConfiguration

domainLinkageConfiguration.clone() ⇒ DomainLinkageConfiguration

Deep clones the object.

Kind: instance method of DomainLinkageConfiguration

DomainLinkageConfiguration.fromJSON(json) ⇒ DomainLinkageConfiguration

Deserializes an instance from a JSON object.

Kind: static method of DomainLinkageConfiguration

ParamType
jsonany

Duration

A span of time.

Kind: global class

duration.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of Duration

Duration.seconds(seconds) ⇒ Duration

Create a new Duration with the given number of seconds.

Kind: static method of Duration

ParamType
secondsnumber

Duration.minutes(minutes) ⇒ Duration

Create a new Duration with the given number of minutes.

Kind: static method of Duration

ParamType
minutesnumber

Duration.hours(hours) ⇒ Duration

Create a new Duration with the given number of hours.

Kind: static method of Duration

ParamType
hoursnumber

Duration.days(days) ⇒ Duration

Create a new Duration with the given number of days.

Kind: static method of Duration

ParamType
daysnumber

Duration.weeks(weeks) ⇒ Duration

Create a new Duration with the given number of weeks.

Kind: static method of Duration

ParamType
weeksnumber

Duration.fromJSON(json) ⇒ Duration

Deserializes an instance from a JSON object.

Kind: static method of Duration

ParamType
jsonany

EdDSAJwsVerifier

An implementor of IJwsVerifier that can handle the EdDSA algorithm.

Kind: global class

new EdDSAJwsVerifier()

Constructs an EdDSAJwsVerifier.

edDSAJwsVerifier.verify(alg, signingInput, decodedSignature, publicKey)

Verify a JWS signature secured with the EdDSA algorithm. Only the Ed25519 curve is supported for now.

This function is useful when one is building an IJwsVerifier that extends the default provided by the IOTA Identity Framework.

Warning

This function does not check whether alg = EdDSA in the protected header. Callers are expected to assert this prior to calling the function.

Kind: instance method of EdDSAJwsVerifier

ParamType
algJwsAlgorithm
signingInputUint8Array
decodedSignatureUint8Array
publicKeyJwk

IotaDID

A DID conforming to the IOTA DID method specification.

Kind: global class

new IotaDID(bytes, network)

Constructs a new IotaDID from a byte representation of the tag and the given network name.

See also placeholder.

ParamType
bytesUint8Array
networkstring

did.network() ⇒ string

Returns the Tangle network name of the IotaDID.

Kind: instance method of IotaDID

did.tag() ⇒ string

Returns a copy of the unique tag of the IotaDID.

Kind: instance method of IotaDID

did.toCoreDid() ⇒ CoreDID

Returns the DID represented as a CoreDID.

Kind: instance method of IotaDID

did.scheme() ⇒ string

Returns the DID scheme.

E.g.

  • "did:example:12345678" -> "did"
  • "did:iota:main:12345678" -> "did"

Kind: instance method of IotaDID

did.authority() ⇒ string

Returns the DID authority: the method name and method-id.

E.g.

  • "did:example:12345678" -> "example:12345678"
  • "did:iota:main:12345678" -> "iota:main:12345678"

Kind: instance method of IotaDID

did.method() ⇒ string

Returns the DID method name.

E.g.

  • "did:example:12345678" -> "example"
  • "did:iota:main:12345678" -> "iota"

Kind: instance method of IotaDID

did.methodId() ⇒ string

Returns the DID method-specific ID.

E.g.

  • "did:example:12345678" -> "12345678"
  • "did:iota:main:12345678" -> "main:12345678"

Kind: instance method of IotaDID

did.join(segment) ⇒ DIDUrl

Construct a new DIDUrl by joining with a relative DID Url string.

Kind: instance method of IotaDID

ParamType
segmentstring

did.toUrl() ⇒ DIDUrl

Clones the DID into a DIDUrl.

Kind: instance method of IotaDID

did.toAliasId() ⇒ string

Returns the hex-encoded AliasId with a '0x' prefix, from the DID tag.

Kind: instance method of IotaDID

did.intoUrl() ⇒ DIDUrl

Converts the DID into a DIDUrl, consuming it.

Kind: instance method of IotaDID

did.toString() ⇒ string

Returns the DID as a string.

Kind: instance method of IotaDID

did.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of IotaDID

did.clone() ⇒ IotaDID

Deep clones the object.

Kind: instance method of IotaDID

IotaDID.METHOD ⇒ string

The IOTA DID method name ("iota").

Kind: static property of IotaDID

IotaDID.DEFAULT_NETWORK ⇒ string

The default Tangle network ("iota").

Kind: static property of IotaDID

IotaDID.fromAliasId(aliasId, network) ⇒ IotaDID

Constructs a new IotaDID from a hex representation of an Alias Id and the given network name.

Kind: static method of IotaDID

ParamType
aliasIdstring
networkstring

IotaDID.placeholder(network) ⇒ IotaDID

Creates a new placeholder IotaDID with the given network name.

E.g. did:iota:smr:0x0000000000000000000000000000000000000000000000000000000000000000.

Kind: static method of IotaDID

ParamType
networkstring

IotaDID.parse(input) ⇒ IotaDID

Parses a IotaDID from the input string.

Kind: static method of IotaDID

ParamType
inputstring

IotaDID.fromJSON(json) ⇒ IotaDID

Deserializes an instance from a JSON object.

Kind: static method of IotaDID

ParamType
jsonany

IotaDocument

A DID Document adhering to the IOTA DID method specification.

Note: All methods that involve reading from this class may potentially raise an error if the object is being concurrently modified.

Kind: global class

new IotaDocument(network)

Constructs an empty IOTA DID Document with a placeholder identifier for the given network.

ParamType
networkstring

iotaDocument.id() ⇒ IotaDID

Returns a copy of the DID Document id.

Kind: instance method of IotaDocument

iotaDocument.controller() ⇒ Array.<IotaDID>

Returns a copy of the list of document controllers.

NOTE: controllers are determined by the state_controller unlock condition of the output during resolution and are omitted when publishing.

Kind: instance method of IotaDocument

iotaDocument.setController(controller)

Sets the controllers of the document.

Note: Duplicates will be ignored. Use null to remove all controllers.

Kind: instance method of IotaDocument

ParamType
controllerArray.<IotaDID> | null

iotaDocument.alsoKnownAs() ⇒ Array.<string>

Returns a copy of the document's alsoKnownAs set.

Kind: instance method of IotaDocument

iotaDocument.setAlsoKnownAs(urls)

Sets the alsoKnownAs property in the DID document.

Kind: instance method of IotaDocument

ParamType
urlsstring | Array.<string> | null

iotaDocument.properties() ⇒ Map.<string, any>

Returns a copy of the custom DID Document properties.

Kind: instance method of IotaDocument

iotaDocument.setPropertyUnchecked(key, value)

Sets a custom property in the DID Document. If the value is set to null, the custom property will be removed.

WARNING

This method can overwrite existing properties like id and result in an invalid document.

Kind: instance method of IotaDocument

ParamType
keystring
valueany

iotaDocument.service() ⇒ Array.<Service>

Return a set of all Service in the document.

Kind: instance method of IotaDocument

iotaDocument.insertService(service)

Add a new Service to the document.

Returns true if the service was added.

Kind: instance method of IotaDocument

ParamType
serviceService

iotaDocument.removeService(did) ⇒ Service | undefined

Remove a Service identified by the given DIDUrl from the document.

Returns true if a service was removed.

Kind: instance method of IotaDocument

ParamType
didDIDUrl

iotaDocument.resolveService(query) ⇒ Service | undefined

Returns the first Service with an id property matching the provided query, if present.

Kind: instance method of IotaDocument

ParamType
queryDIDUrl | string

iotaDocument.methods([scope]) ⇒ Array.<VerificationMethod>

Returns a list of all VerificationMethod in the DID Document, whose verification relationship matches scope.

If scope is not set, a list over the embedded methods is returned.

Kind: instance method of IotaDocument

ParamType
[scope]MethodScope | undefined

iotaDocument.insertMethod(method, scope)

Adds a new method to the document in the given scope.

Kind: instance method of IotaDocument

ParamType
methodVerificationMethod
scopeMethodScope

iotaDocument.removeMethod(did) ⇒ VerificationMethod | undefined

Removes all references to the specified Verification Method.

Kind: instance method of IotaDocument

ParamType
didDIDUrl

iotaDocument.resolveMethod(query, [scope]) ⇒ VerificationMethod | undefined

Returns a copy of the first verification method with an id property matching the provided query and the verification relationship specified by scope, if present.

Kind: instance method of IotaDocument

ParamType
queryDIDUrl | string
[scope]MethodScope | undefined

iotaDocument.attachMethodRelationship(didUrl, relationship) ⇒ boolean

Attaches the relationship to the given method, if the method exists.

Note: The method needs to be in the set of verification methods, so it cannot be an embedded one.

Kind: instance method of IotaDocument

ParamType
didUrlDIDUrl
relationshipMethodRelationship

iotaDocument.detachMethodRelationship(didUrl, relationship) ⇒ boolean

Detaches the given relationship from the given method, if the method exists.

Kind: instance method of IotaDocument

ParamType
didUrlDIDUrl
relationshipMethodRelationship

iotaDocument.verifyJws(jws, options, signatureVerifier, [detachedPayload]) ⇒ DecodedJws

Decodes and verifies the provided JWS according to the passed options and signatureVerifier. If no signatureVerifier argument is provided a default verifier will be used that is (only) capable of verifying EdDSA signatures.

Regardless of which options are passed the following conditions must be met in order for a verification attempt to take place.

  • The JWS must be encoded according to the JWS compact serialization.
  • The kid value in the protected header must be an identifier of a verification method in this DID document.

Kind: instance method of IotaDocument

ParamType
jwsJws
optionsJwsVerificationOptions
signatureVerifierIJwsVerifier
[detachedPayload]string | undefined

iotaDocument.pack() ⇒ Uint8Array

Serializes the document for inclusion in an Alias Output's state metadata with the default StateMetadataEncoding.

Kind: instance method of IotaDocument

iotaDocument.packWithEncoding(encoding) ⇒ Uint8Array

Serializes the document for inclusion in an Alias Output's state metadata.

Kind: instance method of IotaDocument

ParamType
encodingStateMetadataEncoding

iotaDocument.metadata() ⇒ IotaDocumentMetadata

Returns a copy of the metadata associated with this document.

NOTE: Copies all the metadata. See also metadataCreated, metadataUpdated, metadataPreviousMessageId, metadataProof if only a subset of the metadata required.

Kind: instance method of IotaDocument

iotaDocument.metadataCreated() ⇒ Timestamp | undefined

Returns a copy of the timestamp of when the DID document was created.

Kind: instance method of IotaDocument

iotaDocument.setMetadataCreated(timestamp)

Sets the timestamp of when the DID document was created.

Kind: instance method of IotaDocument

ParamType
timestampTimestamp | undefined

iotaDocument.metadataUpdated() ⇒ Timestamp | undefined

Returns a copy of the timestamp of the last DID document update.

Kind: instance method of IotaDocument

iotaDocument.setMetadataUpdated(timestamp)

Sets the timestamp of the last DID document update.

Kind: instance method of IotaDocument

ParamType
timestampTimestamp | undefined

iotaDocument.metadataDeactivated() ⇒ boolean | undefined

Returns a copy of the deactivated status of the DID document.

Kind: instance method of IotaDocument

iotaDocument.setMetadataDeactivated([deactivated])

Sets the deactivated status of the DID document.

Kind: instance method of IotaDocument

ParamType
[deactivated]boolean | undefined

iotaDocument.metadataStateControllerAddress() ⇒ string | undefined

Returns a copy of the Bech32-encoded state controller address, if present.

Kind: instance method of IotaDocument

iotaDocument.metadataGovernorAddress() ⇒ string | undefined

Returns a copy of the Bech32-encoded governor address, if present.

Kind: instance method of IotaDocument

iotaDocument.setMetadataPropertyUnchecked(key, value)

Sets a custom property in the document metadata. If the value is set to null, the custom property will be removed.

Kind: instance method of IotaDocument

ParamType
keystring
valueany

iotaDocument.revokeCredentials(serviceQuery, indices)

If the document has a RevocationBitmap service identified by serviceQuery, revoke all specified indices.

Kind: instance method of IotaDocument

ParamType
serviceQueryDIDUrl | string
indicesnumber | Array.<number>

iotaDocument.unrevokeCredentials(serviceQuery, indices)

If the document has a RevocationBitmap service identified by serviceQuery, unrevoke all specified indices.

Kind: instance method of IotaDocument

ParamType
serviceQueryDIDUrl | string
indicesnumber | Array.<number>

iotaDocument.clone() ⇒ IotaDocument

Returns a deep clone of the IotaDocument.

Kind: instance method of IotaDocument

iotaDocument._shallowCloneInternal() ⇒ IotaDocument

Warning

This is for internal use only. Do not rely on or call this method.

Kind: instance method of IotaDocument

iotaDocument._strongCountInternal() ⇒ number

Warning

This is for internal use only. Do not rely on or call this method.

Kind: instance method of IotaDocument

iotaDocument.toJSON() ⇒ any

Serializes to a plain JS representation.

Kind: instance method of IotaDocument

iotaDocument.toCoreDocument() ⇒ CoreDocument

Transforms the IotaDocument to its CoreDocument representation.

Kind: instance method of IotaDocument

iotaDocument.generateMethod(storage, keyType, alg, fragment, scope) ⇒ Promise.<string>

Generate new key material in the given storage and insert a new verification method with the corresponding public key material into the DID document.

  • If no fragment is given the kid of the generated JWK is used, if it is set, otherwise an error is returned.
  • The keyType must be compatible with the given storage. Storages are expected to export key type constants for that use case.

The fragment of the generated method is returned.

Kind: instance method of IotaDocument

ParamType
storageStorage
keyTypestring
algJwsAlgorithm
fragmentstring | undefined
scopeMethodScope

iotaDocument.purgeMethod(storage, id) ⇒ Promise.<void>

Remove the method identified by the given fragment from the document and delete the corresponding key material in the given storage.

Kind: instance method of IotaDocument

ParamType
storageStorage
idDIDUrl

iotaDocument.createJwt(storage, fragment, payload, options) ⇒ Promise.<Jws>

Deprecated

Sign the payload according to options with the storage backed private key corresponding to the public key material in the verification method identified by the given `fragment.

Upon success a string representing a JWS encoded according to the Compact JWS Serialization format is returned. See RFC7515 section 3.1.

Kind: instance method of IotaDocument

ParamType
storageStorage
fragmentstring
payloadstring
optionsJwsSignatureOptions

iotaDocument.createJws(storage, fragment, payload, options) ⇒ Promise.<Jws>

Sign the payload according to options with the storage backed private key corresponding to the public key material in the verification method identified by the given `fragment.

Upon success a string representing a JWS encoded according to the Compact JWS Serialization format is returned. See RFC7515 section 3.1.

Kind: instance method of IotaDocument

ParamType
storageStorage
fragmentstring
payloadstring
optionsJwsSignatureOptions

iotaDocument.createCredentialJwt(storage, fragment, credential, options, [custom_claims]) ⇒ Promise.<Jwt>

Produces a JWS where the payload is produced from the given credential in accordance with VC Data Model v1.1.

Unless the kid is explicitly set in the options, the kid in the protected header is the id of the method identified by fragment and the JWS signature will be produced by the corresponding private key backed by the storage in accordance with the passed options.

The custom_claims can be used to set additional claims on the resulting JWT.

Kind: instance method of IotaDocument

ParamType
storageStorage
fragmentstring
credentialCredential
optionsJwsSignatureOptions
[custom_claims]Record.<string, any> | undefined

iotaDocument.createPresentationJwt(storage, fragment, presentation, signature_options, presentation_options) ⇒ Promise.<Jwt>

Produces a JWT where the payload is produced from the given presentation. in accordance with VC Data Model v1.1.

Unless the kid is explicitly set in the options, the kid in the protected header is the id of the method identified by fragment and the JWS signature will be produced by the corresponding private key backed by the storage in accordance with the passed options.

Kind: instance method of IotaDocument

ParamType
storageStorage
fragmentstring
presentationPresentation
signature_optionsJwsSignatureOptions
presentation_optionsJwtPresentationOptions

iotaDocument.generateMethodJwp(storage, alg, fragment, scope) ⇒ Promise.<string>

Kind: instance method of IotaDocument

ParamType
storageStorage
algProofAlgorithm
fragmentstring | undefined
scopeMethodScope

iotaDocument.createIssuedJwp(storage, fragment, jpt_claims, options) ⇒ Promise.<string>

Kind: instance method of IotaDocument

ParamType
storageStorage
fragmentstring
jpt_claimsJptClaims
optionsJwpCredentialOptions

iotaDocument.createPresentedJwp(presentation, method_id, options) ⇒ Promise.<string>

Kind: instance method of IotaDocument

ParamType
presentationSelectiveDisclosurePresentation
method_idstring
optionsJwpPresentationOptions

iotaDocument.createCredentialJpt(credential, storage, fragment, options, [custom_claims]) ⇒ Promise.<Jpt>

Kind: instance method of IotaDocument

ParamType
credentialCredential
storageStorage
fragmentstring
optionsJwpCredentialOptions
[custom_claims]Map.<string, any> | undefined

iotaDocument.createPresentationJpt(presentation, method_id, options) ⇒ Promise.<Jpt>

Kind: instance method of IotaDocument

ParamType
presentationSelectiveDisclosurePresentation
method_idstring
optionsJwpPresentationOptions

IotaDocument.newWithId(id) ⇒ IotaDocument

Constructs an empty DID Document with the given identifier.

Kind: static method of IotaDocument

ParamType
idIotaDID

IotaDocument.unpackFromOutput(did, aliasOutput, allowEmpty) ⇒ IotaDocument

Deserializes the document from an Alias Output.

If allowEmpty is true, this will return an empty DID document marked as deactivated if stateMetadata is empty.

The tokenSupply must be equal to the token supply of the network the DID is associated with.

NOTE: did is required since it is omitted from the serialized DID Document and cannot be inferred from the state metadata. It also indicates the network, which is not encoded in the AliasId alone.

Kind: static method of IotaDocument

ParamType
didIotaDID
aliasOutputAliasOutputBuilderParams
allowEmptyboolean

IotaDocument.unpackFromBlock(network, block) ⇒ Array.<IotaDocument>

Returns all DID documents of the Alias Outputs contained in the block's transaction payload outputs, if any.

Errors if any Alias Output does not contain a valid or empty DID Document.

Kind: static method of IotaDocument

ParamType
networkstring
blockBlock

IotaDocument.fromJSON(json) ⇒ IotaDocument

Deserializes an instance from a plain JS representation.

Kind: static method of IotaDocument

ParamType
jsonany

IotaDocumentMetadata

Additional attributes related to an IOTA DID Document.

Kind: global class

iotaDocumentMetadata.created() ⇒ Timestamp | undefined

Returns a copy of the timestamp of when the DID document was created.

Kind: instance method of IotaDocumentMetadata

iotaDocumentMetadata.updated() ⇒ Timestamp | undefined

Returns a copy of the timestamp of the last DID document update.

Kind: instance method of IotaDocumentMetadata

iotaDocumentMetadata.deactivated() ⇒ boolean | undefined

Returns a copy of the deactivated status of the DID document.

Kind: instance method of IotaDocumentMetadata

iotaDocumentMetadata.stateControllerAddress() ⇒ string | undefined

Returns a copy of the Bech32-encoded state controller address, if present.

Kind: instance method of IotaDocumentMetadata

iotaDocumentMetadata.governorAddress() ⇒ string | undefined

Returns a copy of the Bech32-encoded governor address, if present.

Kind: instance method of IotaDocumentMetadata

iotaDocumentMetadata.properties() ⇒ Map.<string, any>

Returns a copy of the custom metadata properties.

Kind: instance method of IotaDocumentMetadata

iotaDocumentMetadata.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of IotaDocumentMetadata

iotaDocumentMetadata.clone() ⇒ IotaDocumentMetadata

Deep clones the object.

Kind: instance method of IotaDocumentMetadata

IotaDocumentMetadata.fromJSON(json) ⇒ IotaDocumentMetadata

Deserializes an instance from a JSON object.

Kind: static method of IotaDocumentMetadata

ParamType
jsonany

IotaIdentityClientExt

An extension interface that provides helper functions for publication and resolution of DID documents in Alias Outputs.

Kind: global class

IotaIdentityClientExt.newDidOutput(client, address, document, [rentStructure]) ⇒ Promise.<AliasOutputBuilderParams>

Create a DID with a new Alias Output containing the given document.

The address will be set as the state controller and governor unlock conditions. The minimum required token deposit amount will be set according to the given rent_structure, which will be fetched from the node if not provided. The returned Alias Output can be further customised before publication, if desired.

NOTE: this does not publish the Alias Output.

Kind: static method of IotaIdentityClientExt

ParamType
clientIIotaIdentityClient
addressAddress
documentIotaDocument
[rentStructure]IRent | undefined

IotaIdentityClientExt.updateDidOutput(client, document) ⇒ Promise.<AliasOutputBuilderParams>

Fetches the associated Alias Output and updates it with document in its state metadata. The storage deposit on the output is left unchanged. If the size of the document increased, the amount should be increased manually.

NOTE: this does not publish the updated Alias Output.

Kind: static method of IotaIdentityClientExt

ParamType
clientIIotaIdentityClient
documentIotaDocument

IotaIdentityClientExt.deactivateDidOutput(client, did) ⇒ Promise.<AliasOutputBuilderParams>

Removes the DID document from the state metadata of its Alias Output, effectively deactivating it. The storage deposit on the output is left unchanged, and should be reallocated manually.

Deactivating does not destroy the output. Hence, it can be re-activated by publishing an update containing a DID document.

NOTE: this does not publish the updated Alias Output.

Kind: static method of IotaIdentityClientExt

ParamType
clientIIotaIdentityClient
didIotaDID

IotaIdentityClientExt.resolveDid(client, did) ⇒ Promise.<IotaDocument>

Resolve a IotaDocument. Returns an empty, deactivated document if the state metadata of the Alias Output is empty.

Kind: static method of IotaIdentityClientExt

ParamType
clientIIotaIdentityClient
didIotaDID

IotaIdentityClientExt.resolveDidOutput(client, did) ⇒ Promise.<AliasOutputBuilderParams>

Fetches the IAliasOutput associated with the given DID.

Kind: static method of IotaIdentityClientExt

ParamType
clientIIotaIdentityClient
didIotaDID

IssuerProtectedHeader

Kind: global class

issuerProtectedHeader.typ ⇒ string | undefined

JWP type (JPT).

Kind: instance property of IssuerProtectedHeader

issuerProtectedHeader.typ

JWP type (JPT).

Kind: instance property of IssuerProtectedHeader

ParamType
[arg0]string | undefined

issuerProtectedHeader.alg ⇒ ProofAlgorithm

Algorithm used for the JWP.

Kind: instance property of IssuerProtectedHeader

issuerProtectedHeader.alg

Algorithm used for the JWP.

Kind: instance property of IssuerProtectedHeader

ParamType
arg0ProofAlgorithm

issuerProtectedHeader.kid ⇒ string | undefined

ID for the key used for the JWP.

Kind: instance property of IssuerProtectedHeader

issuerProtectedHeader.kid

ID for the key used for the JWP.

Kind: instance property of IssuerProtectedHeader

ParamType
[arg0]string | undefined

issuerProtectedHeader.cid ⇒ string | undefined

Not handled for now. Will be used in the future to resolve external claims

Kind: instance property of IssuerProtectedHeader

issuerProtectedHeader.cid

Not handled for now. Will be used in the future to resolve external claims

Kind: instance property of IssuerProtectedHeader

ParamType
[arg0]string | undefined

issuerProtectedHeader.claims() ⇒ Array.<string>

Kind: instance method of IssuerProtectedHeader

Jpt

A JSON Proof Token (JPT).

Kind: global class

new Jpt(jpt_string)

Creates a new Jpt.

ParamType
jpt_stringstring

jpt.toString() ⇒ string

Kind: instance method of Jpt

jpt.clone() ⇒ Jpt

Deep clones the object.

Kind: instance method of Jpt

JptCredentialValidationOptions

Options to declare validation criteria for Jpt.

Kind: global class

new JptCredentialValidationOptions([opts])

Creates a new default istance.

ParamType
[opts]IJptCredentialValidationOptions | undefined

jptCredentialValidationOptions.clone() ⇒ JptCredentialValidationOptions

Deep clones the object.

Kind: instance method of JptCredentialValidationOptions

jptCredentialValidationOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JptCredentialValidationOptions

JptCredentialValidationOptions.fromJSON(json) ⇒ JptCredentialValidationOptions

Deserializes an instance from a JSON object.

Kind: static method of JptCredentialValidationOptions

ParamType
jsonany

JptCredentialValidator

Kind: global class

JptCredentialValidator.validate(credential_jpt, issuer, options, fail_fast) ⇒ DecodedJptCredential

Kind: static method of JptCredentialValidator

ParamType
credential_jptJpt
issuerCoreDocument | IToCoreDocument
optionsJptCredentialValidationOptions
fail_fastFailFast

JptCredentialValidatorUtils

Utility functions for validating JPT credentials.

Kind: global class

JptCredentialValidatorUtils.extractIssuer(credential) ⇒ CoreDID

Utility for extracting the issuer field of a Credential as a DID.

Errors

Fails if the issuer field is not a valid DID.

Kind: static method of JptCredentialValidatorUtils

ParamType
credentialCredential

JptCredentialValidatorUtils.extractIssuerFromIssuedJpt(credential) ⇒ CoreDID

Utility for extracting the issuer field of a credential in JPT representation as DID.

Errors

If the JPT decoding fails or the issuer field is not a valid DID.

Kind: static method of JptCredentialValidatorUtils

ParamType
credentialJpt

JptCredentialValidatorUtils.checkTimeframesWithValidityTimeframe2024(credential, validity_timeframe, status_check)

Kind: static method of JptCredentialValidatorUtils

ParamType
credentialCredential
validity_timeframeTimestamp | undefined
status_checkStatusCheck

JptCredentialValidatorUtils.checkRevocationWithValidityTimeframe2024(credential, issuer, status_check)

Checks whether the credential status has been revoked.

Only supports RevocationTimeframe2024.

Kind: static method of JptCredentialValidatorUtils

ParamType
credentialCredential
issuerCoreDocument | IToCoreDocument
status_checkStatusCheck

JptCredentialValidatorUtils.checkTimeframesAndRevocationWithValidityTimeframe2024(credential, issuer, validity_timeframe, status_check)

Checks whether the credential status has been revoked or the timeframe interval is INVALID

Only supports RevocationTimeframe2024.

Kind: static method of JptCredentialValidatorUtils

ParamType
credentialCredential
issuerCoreDocument | IToCoreDocument
validity_timeframeTimestamp | undefined
status_checkStatusCheck

JptPresentationValidationOptions

Options to declare validation criteria for a Jpt presentation.

Kind: global class

new JptPresentationValidationOptions([opts])

ParamType
[opts]IJptPresentationValidationOptions | undefined

jptPresentationValidationOptions.clone() ⇒ JptPresentationValidationOptions

Deep clones the object.

Kind: instance method of JptPresentationValidationOptions

jptPresentationValidationOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JptPresentationValidationOptions

JptPresentationValidationOptions.fromJSON(json) ⇒ JptPresentationValidationOptions

Deserializes an instance from a JSON object.

Kind: static method of JptPresentationValidationOptions

ParamType
jsonany

JptPresentationValidator

Kind: global class

JptPresentationValidator.validate(presentation_jpt, issuer, options, fail_fast) ⇒ DecodedJptPresentation

Decodes and validates a Presented Credential issued as a JPT (JWP Presented Form). A DecodedJptPresentation is returned upon success.

The following properties are validated according to options:

  • the holder's proof on the JWP,
  • the expiration date,
  • the issuance date,
  • the semantic structure.

Kind: static method of JptPresentationValidator

ParamType
presentation_jptJpt
issuerCoreDocument | IToCoreDocument
optionsJptPresentationValidationOptions
fail_fastFailFast

JptPresentationValidatorUtils

Utility functions for verifying JPT presentations.

Kind: global class

JptPresentationValidatorUtils.extractIssuerFromPresentedJpt(presentation) ⇒ CoreDID

Utility for extracting the issuer field of a credential in JPT representation as DID.

Errors

If the JPT decoding fails or the issuer field is not a valid DID.

Kind: static method of JptPresentationValidatorUtils

ParamType
presentationJpt

JptPresentationValidatorUtils.checkTimeframesWithValidityTimeframe2024(credential, validity_timeframe, status_check)

Check timeframe interval in credentialStatus with RevocationTimeframeStatus.

Kind: static method of JptPresentationValidatorUtils

ParamType
credentialCredential
validity_timeframeTimestamp | undefined
status_checkStatusCheck

Jwk

Kind: global class

new Jwk(jwk)

ParamType
jwkIJwkParams

jwk.kty() ⇒ JwkType

Returns the value for the key type parameter (kty).

Kind: instance method of Jwk

jwk.use() ⇒ JwkUse | undefined

Returns the value for the use property (use).

Kind: instance method of Jwk

jwk.keyOps() ⇒ Array.<JwkOperation>

Kind: instance method of Jwk

jwk.alg() ⇒ JwsAlgorithm | undefined

Returns the value for the algorithm property (alg).

Kind: instance method of Jwk

jwk.kid() ⇒ string | undefined

Returns the value of the key ID property (kid).

Kind: instance method of Jwk

jwk.x5u() ⇒ string | undefined

Returns the value of the X.509 URL property (x5u).

Kind: instance method of Jwk

jwk.x5c() ⇒ Array.<string>

Returns the value of the X.509 certificate chain property (x5c).

Kind: instance method of Jwk

jwk.x5t() ⇒ string | undefined

Returns the value of the X.509 certificate SHA-1 thumbprint property (x5t).

Kind: instance method of Jwk

jwk.x5t256() ⇒ string | undefined

Returns the value of the X.509 certificate SHA-256 thumbprint property (x5t#S256).

Kind: instance method of Jwk

jwk.paramsEc() ⇒ JwkParamsEc | undefined

If this JWK is of kty EC, returns those parameters.

Kind: instance method of Jwk

jwk.paramsOkp() ⇒ JwkParamsOkp | undefined

If this JWK is of kty OKP, returns those parameters.

Kind: instance method of Jwk

jwk.paramsOct() ⇒ JwkParamsOct | undefined

If this JWK is of kty OCT, returns those parameters.

Kind: instance method of Jwk

jwk.paramsRsa() ⇒ JwkParamsRsa | undefined

If this JWK is of kty RSA, returns those parameters.

Kind: instance method of Jwk

jwk.toPublic() ⇒ Jwk | undefined

Returns a clone of the Jwk with all private key components unset. Nothing is returned when kty = oct as this key type is not considered public by this library.

Kind: instance method of Jwk

jwk.isPublic() ⇒ boolean

Returns true if all private key components of the key are unset, false otherwise.

Kind: instance method of Jwk

jwk.isPrivate() ⇒ boolean

Returns true if all private key components of the key are set, false otherwise.

Kind: instance method of Jwk

jwk.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of Jwk

jwk.clone() ⇒ Jwk

Deep clones the object.

Kind: instance method of Jwk

Jwk.fromJSON(json) ⇒ Jwk

Deserializes an instance from a JSON object.

Kind: static method of Jwk

ParamType
jsonany

JwkGenOutput

The result of a key generation in JwkStorage.

Kind: global class

new JwkGenOutput(key_id, jwk)

ParamType
key_idstring
jwkJwk

jwkGenOutput.jwk() ⇒ Jwk

Returns the generated public Jwk.

Kind: instance method of JwkGenOutput

jwkGenOutput.keyId() ⇒ string

Returns the key id of the generated Jwk.

Kind: instance method of JwkGenOutput

jwkGenOutput.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwkGenOutput

jwkGenOutput.clone() ⇒ JwkGenOutput

Deep clones the object.

Kind: instance method of JwkGenOutput

JwkGenOutput.fromJSON(json) ⇒ JwkGenOutput

Deserializes an instance from a JSON object.

Kind: static method of JwkGenOutput

ParamType
jsonany

JwpCredentialOptions

Kind: global class

jwpCredentialOptions.kid ⇒ string | undefined

Kind: instance property of JwpCredentialOptions

jwpCredentialOptions.kid

Kind: instance property of JwpCredentialOptions

ParamType
[arg0]string | undefined

jwpCredentialOptions.toJSON() ⇒ any

Kind: instance method of JwpCredentialOptions

JwpCredentialOptions.fromJSON(value) ⇒ JwpCredentialOptions

Kind: static method of JwpCredentialOptions

ParamType
valueany

JwpIssued

Kind: global class

jwpIssued.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwpIssued

jwpIssued.clone() ⇒ JwpIssued

Deep clones the object.

Kind: instance method of JwpIssued

jwpIssued.encode(serialization) ⇒ string

Kind: instance method of JwpIssued

ParamType
serializationSerializationType

jwpIssued.setProof(proof)

Kind: instance method of JwpIssued

ParamType
proofUint8Array

jwpIssued.getProof() ⇒ Uint8Array

Kind: instance method of JwpIssued

jwpIssued.getPayloads() ⇒ Payloads

Kind: instance method of JwpIssued

jwpIssued.setPayloads(payloads)

Kind: instance method of JwpIssued

ParamType
payloadsPayloads

jwpIssued.getIssuerProtectedHeader() ⇒ IssuerProtectedHeader

Kind: instance method of JwpIssued

JwpIssued.fromJSON(json) ⇒ JwpIssued

Deserializes an instance from a JSON object.

Kind: static method of JwpIssued

ParamType
jsonany

JwpPresentationOptions

Options to be set in the JWT claims of a verifiable presentation.

Kind: global class

jwpPresentationOptions.audience ⇒ string | undefined

Sets the audience for presentation (aud property in JWP Presentation Header).

Kind: instance property of JwpPresentationOptions

jwpPresentationOptions.audience

Sets the audience for presentation (aud property in JWP Presentation Header).

Kind: instance property of JwpPresentationOptions

ParamType
[arg0]string | undefined

jwpPresentationOptions.nonce ⇒ string | undefined

The nonce to be placed in the Presentation Protected Header.

Kind: instance property of JwpPresentationOptions

jwpPresentationOptions.nonce

The nonce to be placed in the Presentation Protected Header.

Kind: instance property of JwpPresentationOptions

ParamType
[arg0]string | undefined

JwpVerificationOptions

Kind: global class

jwpVerificationOptions.clone() ⇒ JwpVerificationOptions

Deep clones the object.

Kind: instance method of JwpVerificationOptions

jwpVerificationOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwpVerificationOptions

JwpVerificationOptions.fromJSON(json) ⇒ JwpVerificationOptions

Deserializes an instance from a JSON object.

Kind: static method of JwpVerificationOptions

ParamType
jsonany

JwpVerificationOptions.new([opts]) ⇒ JwpVerificationOptions

Kind: static method of JwpVerificationOptions

ParamType
[opts]IJwpVerificationOptions | undefined

Jws

A wrapper around a JSON Web Signature (JWS).

Kind: global class

new Jws(jws_string)

Creates a new Jws from the given string.

ParamType
jws_stringstring

jws.toString() ⇒ string

Returns a clone of the JWS string.

Kind: instance method of Jws

JwsHeader

Kind: global class

new JwsHeader()

Create a new empty JwsHeader.

jwsHeader.alg() ⇒ JwsAlgorithm | undefined

Returns the value for the algorithm claim (alg).

Kind: instance method of JwsHeader

jwsHeader.setAlg(value)

Sets a value for the algorithm claim (alg).

Kind: instance method of JwsHeader

ParamType
valueJwsAlgorithm

jwsHeader.b64() ⇒ boolean | undefined

Returns the value of the base64url-encode payload claim (b64).

Kind: instance method of JwsHeader

jwsHeader.setB64(value)

Sets a value for the base64url-encode payload claim (b64).

Kind: instance method of JwsHeader

ParamType
valueboolean

jwsHeader.custom() ⇒ Record.<string, any> | undefined

Additional header parameters.

Kind: instance method of JwsHeader

jwsHeader.has(claim) ⇒ boolean

Kind: instance method of JwsHeader

ParamType
claimstring

jwsHeader.isDisjoint(other) ⇒ boolean

Returns true if none of the fields are set in both self and other.

Kind: instance method of JwsHeader

ParamType
otherJwsHeader

jwsHeader.jku() ⇒ string | undefined

Returns the value of the JWK Set URL claim (jku).

Kind: instance method of JwsHeader

jwsHeader.setJku(value)

Sets a value for the JWK Set URL claim (jku).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.jwk() ⇒ Jwk | undefined

Returns the value of the JWK claim (jwk).

Kind: instance method of JwsHeader

jwsHeader.setJwk(value)

Sets a value for the JWK claim (jwk).

Kind: instance method of JwsHeader

ParamType
valueJwk

jwsHeader.kid() ⇒ string | undefined

Returns the value of the key ID claim (kid).

Kind: instance method of JwsHeader

jwsHeader.setKid(value)

Sets a value for the key ID claim (kid).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.x5u() ⇒ string | undefined

Returns the value of the X.509 URL claim (x5u).

Kind: instance method of JwsHeader

jwsHeader.setX5u(value)

Sets a value for the X.509 URL claim (x5u).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.x5c() ⇒ Array.<string>

Returns the value of the X.509 certificate chain claim (x5c).

Kind: instance method of JwsHeader

jwsHeader.setX5c(value)

Sets values for the X.509 certificate chain claim (x5c).

Kind: instance method of JwsHeader

ParamType
valueArray.<string>

jwsHeader.x5t() ⇒ string | undefined

Returns the value of the X.509 certificate SHA-1 thumbprint claim (x5t).

Kind: instance method of JwsHeader

jwsHeader.setX5t(value)

Sets a value for the X.509 certificate SHA-1 thumbprint claim (x5t).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.x5tS256() ⇒ string | undefined

Returns the value of the X.509 certificate SHA-256 thumbprint claim (x5t#S256).

Kind: instance method of JwsHeader

jwsHeader.setX5tS256(value)

Sets a value for the X.509 certificate SHA-256 thumbprint claim (x5t#S256).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.typ() ⇒ string | undefined

Returns the value of the token type claim (typ).

Kind: instance method of JwsHeader

jwsHeader.setTyp(value)

Sets a value for the token type claim (typ).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.cty() ⇒ string | undefined

Returns the value of the content type claim (cty).

Kind: instance method of JwsHeader

jwsHeader.setCty(value)

Sets a value for the content type claim (cty).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.crit() ⇒ Array.<string>

Returns the value of the critical claim (crit).

Kind: instance method of JwsHeader

jwsHeader.setCrit(value)

Sets values for the critical claim (crit).

Kind: instance method of JwsHeader

ParamType
valueArray.<string>

jwsHeader.url() ⇒ string | undefined

Returns the value of the url claim (url).

Kind: instance method of JwsHeader

jwsHeader.setUrl(value)

Sets a value for the url claim (url).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.nonce() ⇒ string | undefined

Returns the value of the nonce claim (nonce).

Kind: instance method of JwsHeader

jwsHeader.setNonce(value)

Sets a value for the nonce claim (nonce).

Kind: instance method of JwsHeader

ParamType
valuestring

jwsHeader.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwsHeader

jwsHeader.clone() ⇒ JwsHeader

Deep clones the object.

Kind: instance method of JwsHeader

JwsHeader.fromJSON(json) ⇒ JwsHeader

Deserializes an instance from a JSON object.

Kind: static method of JwsHeader

ParamType
jsonany

JwsSignatureOptions

Kind: global class

new JwsSignatureOptions([options])

ParamType
[options]IJwsSignatureOptions | undefined

jwsSignatureOptions.setAttachJwk(value)

Replace the value of the attachJwk field.

Kind: instance method of JwsSignatureOptions

ParamType
valueboolean

jwsSignatureOptions.setB64(value)

Replace the value of the b64 field.

Kind: instance method of JwsSignatureOptions

ParamType
valueboolean

jwsSignatureOptions.setTyp(value)

Replace the value of the typ field.

Kind: instance method of JwsSignatureOptions

ParamType
valuestring

jwsSignatureOptions.setCty(value)

Replace the value of the cty field.

Kind: instance method of JwsSignatureOptions

ParamType
valuestring

jwsSignatureOptions.serUrl(value)

Replace the value of the url field.

Kind: instance method of JwsSignatureOptions

ParamType
valuestring

jwsSignatureOptions.setNonce(value)

Replace the value of the nonce field.

Kind: instance method of JwsSignatureOptions

ParamType
valuestring

jwsSignatureOptions.setKid(value)

Replace the value of the kid field.

Kind: instance method of JwsSignatureOptions

ParamType
valuestring

jwsSignatureOptions.setDetachedPayload(value)

Replace the value of the detached_payload field.

Kind: instance method of JwsSignatureOptions

ParamType
valueboolean

jwsSignatureOptions.setCustomHeaderParameters(value)

Add additional header parameters.

Kind: instance method of JwsSignatureOptions

ParamType
valueRecord.<string, any>

jwsSignatureOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwsSignatureOptions

jwsSignatureOptions.clone() ⇒ JwsSignatureOptions

Deep clones the object.

Kind: instance method of JwsSignatureOptions

JwsSignatureOptions.fromJSON(json) ⇒ JwsSignatureOptions

Deserializes an instance from a JSON object.

Kind: static method of JwsSignatureOptions

ParamType
jsonany

JwsVerificationOptions

Kind: global class

new JwsVerificationOptions([options])

Creates a new JwsVerificationOptions from the given fields.

ParamType
[options]IJwsVerificationOptions | undefined

jwsVerificationOptions.setNonce(value)

Set the expected value for the nonce parameter of the protected header.

Kind: instance method of JwsVerificationOptions

ParamType
valuestring

jwsVerificationOptions.setMethodScope(value)

Set the scope of the verification methods that may be used to verify the given JWS.

Kind: instance method of JwsVerificationOptions

ParamType
valueMethodScope

jwsVerificationOptions.setMethodId(value)

Set the DID URl of the method, whose JWK should be used to verify the JWS.

Kind: instance method of JwsVerificationOptions

ParamType
valueDIDUrl

jwsVerificationOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwsVerificationOptions

jwsVerificationOptions.clone() ⇒ JwsVerificationOptions

Deep clones the object.

Kind: instance method of JwsVerificationOptions

JwsVerificationOptions.fromJSON(json) ⇒ JwsVerificationOptions

Deserializes an instance from a JSON object.

Kind: static method of JwsVerificationOptions

ParamType
jsonany

Jwt

A wrapper around a JSON Web Token (JWK).

Kind: global class

new Jwt(jwt_string)

Creates a new Jwt from the given string.

ParamType
jwt_stringstring

jwt.toString() ⇒ string

Returns a clone of the JWT string.

Kind: instance method of Jwt

jwt.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of Jwt

jwt.clone() ⇒ Jwt

Deep clones the object.

Kind: instance method of Jwt

Jwt.fromJSON(json) ⇒ Jwt

Deserializes an instance from a JSON object.

Kind: static method of Jwt

ParamType
jsonany

JwtCredentialValidationOptions

Options to declare validation criteria when validating credentials.

Kind: global class

new JwtCredentialValidationOptions([options])

ParamType
[options]IJwtCredentialValidationOptions | undefined

jwtCredentialValidationOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwtCredentialValidationOptions

jwtCredentialValidationOptions.clone() ⇒ JwtCredentialValidationOptions

Deep clones the object.

Kind: instance method of JwtCredentialValidationOptions

JwtCredentialValidationOptions.fromJSON(json) ⇒ JwtCredentialValidationOptions

Deserializes an instance from a JSON object.

Kind: static method of JwtCredentialValidationOptions

ParamType
jsonany

JwtCredentialValidator

A type for decoding and validating Credential.

Kind: global class

new JwtCredentialValidator(signatureVerifier)

Creates a new JwtCredentialValidator. If a signatureVerifier is provided it will be used when verifying decoded JWS signatures, otherwise the default which is only capable of handling the EdDSA algorithm will be used.

ParamType
signatureVerifierIJwsVerifier

jwtCredentialValidator.validate(credential_jwt, issuer, options, fail_fast) ⇒ DecodedJwtCredential

Decodes and validates a Credential issued as a JWS. A DecodedJwtCredential is returned upon success.

The following properties are validated according to options:

  • the issuer's signature on the JWS,
  • the expiration date,
  • the issuance date,
  • the semantic structure.

Warning

The lack of an error returned from this method is in of itself not enough to conclude that the credential can be trusted. This section contains more information on additional checks that should be carried out before and after calling this method.

The state of the issuer's DID Document

The caller must ensure that issuer represents an up-to-date DID Document.

Properties that are not validated

There are many properties defined in The Verifiable Credentials Data Model that are not validated, such as: proof, credentialStatus, type, credentialSchema, refreshService and more. These should be manually checked after validation, according to your requirements.

Errors

An error is returned whenever a validated condition is not satisfied.

Kind: instance method of JwtCredentialValidator

ParamType
credential_jwtJwt
issuerCoreDocument | IToCoreDocument
optionsJwtCredentialValidationOptions
fail_fastFailFast

jwtCredentialValidator.verifySignature(credential, trustedIssuers, options) ⇒ DecodedJwtCredential

Decode and verify the JWS signature of a Credential issued as a JWT using the DID Document of a trusted issuer.

A DecodedJwtCredential is returned upon success.

Warning

The caller must ensure that the DID Documents of the trusted issuers are up-to-date.

Proofs

Only the JWS signature is verified. If the Credential contains a proof property this will not be verified by this method.

Errors

This method immediately returns an error if the credential issuer' url cannot be parsed to a DID belonging to one of the trusted issuers. Otherwise an attempt to verify the credential's signature will be made and an error is returned upon failure.

Kind: instance method of JwtCredentialValidator

ParamType
credentialJwt
trustedIssuersArray.<(CoreDocument|IToCoreDocument)>
optionsJwsVerificationOptions

JwtCredentialValidator.checkExpiresOnOrAfter(credential, timestamp)

Validate that the credential expires on or after the specified timestamp.

Kind: static method of JwtCredentialValidator

ParamType
credentialCredential
timestampTimestamp

JwtCredentialValidator.checkIssuedOnOrBefore(credential, timestamp)

Validate that the credential is issued on or before the specified timestamp.

Kind: static method of JwtCredentialValidator

ParamType
credentialCredential
timestampTimestamp

JwtCredentialValidator.checkSubjectHolderRelationship(credential, holder, relationship)

Validate that the relationship between the holder and the credential subjects is in accordance with relationship. The holder parameter is expected to be the URL of the holder.

Kind: static method of JwtCredentialValidator

ParamType
credentialCredential
holderstring
relationshipSubjectHolderRelationship

JwtCredentialValidator.checkStatus(credential, trustedIssuers, statusCheck)

Checks whether the credential status has been revoked.

Only supports RevocationBitmap2022.

Kind: static method of JwtCredentialValidator

ParamType
credentialCredential
trustedIssuersArray.<(CoreDocument|IToCoreDocument)>
statusCheckStatusCheck

JwtCredentialValidator.checkStatusWithStatusList2021(credential, status_list, status_check)

Checks wheter the credential status has been revoked using StatusList2021.

Kind: static method of JwtCredentialValidator

ParamType
credentialCredential
status_listStatusList2021Credential
status_checkStatusCheck

JwtCredentialValidator.extractIssuer(credential) ⇒ CoreDID

Utility for extracting the issuer field of a Credential as a DID.

Errors

Fails if the issuer field is not a valid DID.

Kind: static method of JwtCredentialValidator

ParamType
credentialCredential

JwtCredentialValidator.extractIssuerFromJwt(credential) ⇒ CoreDID

Utility for extracting the issuer field of a credential in JWT representation as DID.

Errors

If the JWT decoding fails or the issuer field is not a valid DID.

Kind: static method of JwtCredentialValidator

ParamType
credentialJwt

JwtDomainLinkageValidator

A validator for a Domain Linkage Configuration and Credentials.

Kind: global class

new JwtDomainLinkageValidator(signatureVerifier)

Creates a new JwtDomainLinkageValidator. If a signatureVerifier is provided it will be used when verifying decoded JWS signatures, otherwise the default which is only capable of handling the EdDSA algorithm will be used.

ParamType
signatureVerifierIJwsVerifier

jwtDomainLinkageValidator.validateLinkage(issuer, configuration, domain, options)

Validates the linkage between a domain and a DID. DomainLinkageConfiguration is validated according to DID Configuration Resource Verification.

Linkage is valid if no error is thrown.

Note:

Errors

  • Semantic structure of configuration is invalid.
  • configuration includes multiple credentials issued by issuer.
  • Validation of the matched Domain Linkage Credential fails.

Kind: instance method of JwtDomainLinkageValidator

ParamType
issuerCoreDocument | IToCoreDocument
configurationDomainLinkageConfiguration
domainstring
optionsJwtCredentialValidationOptions

jwtDomainLinkageValidator.validateCredential(issuer, credentialJwt, domain, options)

Validates a Domain Linkage Credential.

Error will be thrown in case the validation fails.

Kind: instance method of JwtDomainLinkageValidator

ParamType
issuerCoreDocument | IToCoreDocument
credentialJwtJwt
domainstring
optionsJwtCredentialValidationOptions

JwtPresentationOptions

Kind: global class

new JwtPresentationOptions([options])

Creates a new JwtPresentationOptions from the given fields.

Throws an error if any of the options are invalid.

ParamType
[options]IJwtPresentationOptions | undefined

jwtPresentationOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwtPresentationOptions

jwtPresentationOptions.clone() ⇒ JwtPresentationOptions

Deep clones the object.

Kind: instance method of JwtPresentationOptions

JwtPresentationOptions.fromJSON(json) ⇒ JwtPresentationOptions

Deserializes an instance from a JSON object.

Kind: static method of JwtPresentationOptions

ParamType
jsonany

JwtPresentationValidationOptions

Options to declare validation criteria when validating presentation.

Kind: global class

new JwtPresentationValidationOptions([options])

Creates a new JwtPresentationValidationOptions from the given fields.

Throws an error if any of the options are invalid.

ParamType
[options]IJwtPresentationValidationOptions | undefined

jwtPresentationValidationOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of JwtPresentationValidationOptions

jwtPresentationValidationOptions.clone() ⇒ JwtPresentationValidationOptions

Deep clones the object.

Kind: instance method of JwtPresentationValidationOptions

JwtPresentationValidationOptions.fromJSON(json) ⇒ JwtPresentationValidationOptions

Deserializes an instance from a JSON object.

Kind: static method of JwtPresentationValidationOptions

ParamType
jsonany

JwtPresentationValidator

Kind: global class

new JwtPresentationValidator(signatureVerifier)

Creates a new JwtPresentationValidator. If a signatureVerifier is provided it will be used when verifying decoded JWS signatures, otherwise the default which is only capable of handling the EdDSA algorithm will be used.

ParamType
signatureVerifierIJwsVerifier

jwtPresentationValidator.validate(presentationJwt, holder, validation_options) ⇒ DecodedJwtPresentation

Validates a Presentation encoded as a Jwt.

The following properties are validated according to options:

  • the JWT can be decoded into a semantically valid presentation.
  • the expiration and issuance date contained in the JWT claims.
  • the holder's signature.

Validation is done with respect to the properties set in options.

Warning

  • This method does NOT validate the constituent credentials and therefore also not the relationship between the credentials' subjects and the presentation holder. This can be done with JwtCredentialValidationOptions.
  • The lack of an error returned from this method is in of itself not enough to conclude that the presentation can be trusted. This section contains more information on additional checks that should be carried out before and after calling this method.

The state of the supplied DID Documents.

The caller must ensure that the DID Documents in holder are up-to-date.

Errors

An error is returned whenever a validated condition is not satisfied or when decoding fails.

Kind: instance method of JwtPresentationValidator

ParamType
presentationJwtJwt
holderCoreDocument | IToCoreDocument
validation_optionsJwtPresentationValidationOptions

JwtPresentationValidator.checkStructure(presentation)

Validates the semantic structure of the Presentation.

Kind: static method of JwtPresentationValidator

ParamType
presentationPresentation

JwtPresentationValidator.extractHolder(presentation) ⇒ CoreDID

Attempt to extract the holder of the presentation.

Errors:

  • If deserialization/decoding of the presentation fails.
  • If the holder can't be parsed as DIDs.

Kind: static method of JwtPresentationValidator

ParamType
presentationJwt

KeyBindingJWTValidationOptions

Options to declare validation criteria when validating credentials.

Kind: global class

new KeyBindingJWTValidationOptions([options])

ParamType
[options]IKeyBindingJWTValidationOptions | undefined

keyBindingJWTValidationOptions.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of KeyBindingJWTValidationOptions

keyBindingJWTValidationOptions.clone() ⇒ KeyBindingJWTValidationOptions

Deep clones the object.

Kind: instance method of KeyBindingJWTValidationOptions

KeyBindingJWTValidationOptions.fromJSON(json) ⇒ KeyBindingJWTValidationOptions

Deserializes an instance from a JSON object.

Kind: static method of KeyBindingJWTValidationOptions

ParamType
jsonany

KeyBindingJwtClaims

Claims set for key binding JWT.

Kind: global class

new KeyBindingJwtClaims(jwt, disclosures, nonce, aud, [issued_at], [custom_properties])

Creates a new [KeyBindingJwtClaims]. When issued_at is left as None, it will automatically default to the current time.

Error

When issued_at is set to None and the system returns time earlier than SystemTime::UNIX_EPOCH.

ParamType
jwtstring
disclosuresArray.<string>
noncestring
audstring
[issued_at]Timestamp | undefined
[custom_properties]Record.<string, any> | undefined

keyBindingJwtClaims.toString() ⇒ string

Returns a string representation of the claims.

Kind: instance method of KeyBindingJwtClaims

keyBindingJwtClaims.iat() ⇒ bigint

Returns a copy of the issued at iat property.

Kind: instance method of KeyBindingJwtClaims

keyBindingJwtClaims.aud() ⇒ string

Returns a copy of the audience aud property.

Kind: instance method of KeyBindingJwtClaims

keyBindingJwtClaims.nonce() ⇒ string

Returns a copy of the nonce property.

Kind: instance method of KeyBindingJwtClaims

keyBindingJwtClaims.sdHash() ⇒ string

Returns a copy of the sd_hash property.

Kind: instance method of KeyBindingJwtClaims

keyBindingJwtClaims.customProperties() ⇒ Record.<string, any>

Returns a copy of the custom properties.

Kind: instance method of KeyBindingJwtClaims

keyBindingJwtClaims.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of KeyBindingJwtClaims

keyBindingJwtClaims.clone() ⇒ KeyBindingJwtClaims

Deep clones the object.

Kind: instance method of KeyBindingJwtClaims

KeyBindingJwtClaims.keyBindingJwtHeaderTyp() ⇒ string

Returns the value of the typ property of the JWT header according to https://www.ietf.org/archive/id/draft-ietf-oauth-selective-disclosure-jwt-07.html#name-key-binding-jwt

Kind: static method of KeyBindingJwtClaims

KeyBindingJwtClaims.fromJSON(json) ⇒ KeyBindingJwtClaims

Deserializes an instance from a JSON object.

Kind: static method of KeyBindingJwtClaims

ParamType
jsonany

LinkedDomainService

Kind: global class

new LinkedDomainService(options)

Constructs a new LinkedDomainService that wraps a spec compliant Linked Domain Service Endpoint.

Domain URLs must include the https scheme in order to pass the domain linkage validation.

ParamType
optionsILinkedDomainService

linkedDomainService.domains() ⇒ Array.<string>

Returns the domains contained in the Linked Domain Service.

Kind: instance method of LinkedDomainService

linkedDomainService.toService() ⇒ Service

Returns the inner service which can be added to a DID Document.

Kind: instance method of LinkedDomainService

linkedDomainService.clone() ⇒ LinkedDomainService

Deep clones the object.

Kind: instance method of LinkedDomainService

LinkedDomainService.fromService(service) ⇒ LinkedDomainService

Creates a new LinkedDomainService from a Service.

Error

Errors if service is not a valid Linked Domain Service.

Kind: static method of LinkedDomainService

ParamType
serviceService

LinkedDomainService.isValid(service) ⇒ boolean

Returns true if a Service is a valid Linked Domain Service.

Kind: static method of LinkedDomainService

ParamType
serviceService

MethodData

Supported verification method data formats.

Kind: global class

methodData.tryCustom() ⇒ CustomMethodData

Returns the wrapped custom method data format is Custom.

Kind: instance method of MethodData

methodData.tryDecode() ⇒ Uint8Array

Returns a Uint8Array containing the decoded bytes of the MethodData.

This is generally a public key identified by a MethodData value.

Errors

Decoding can fail if MethodData has invalid content or cannot be represented as a vector of bytes.

Kind: instance method of MethodData

methodData.tryPublicKeyJwk() ⇒ Jwk

Returns the wrapped Jwk if the format is PublicKeyJwk.

Kind: instance method of MethodData

methodData.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of MethodData

methodData.clone() ⇒ MethodData

Deep clones the object.

Kind: instance method of MethodData

MethodData.newBase58(data) ⇒ MethodData

Creates a new MethodData variant with Base58-BTC encoded content.

Kind: static method of MethodData

ParamType
dataUint8Array

MethodData.newMultibase(data) ⇒ MethodData

Creates a new MethodData variant with Multibase-encoded content.

Kind: static method of MethodData

ParamType
dataUint8Array

MethodData.newJwk(key) ⇒ MethodData

Creates a new MethodData variant consisting of the given key.

Errors

An error is thrown if the given key contains any private components.

Kind: static method of MethodData

ParamType
keyJwk

MethodData.newCustom(name, data) ⇒ MethodData

Creates a new custom MethodData.

Kind: static method of MethodData

ParamType
namestring
dataany

MethodData.fromJSON(json) ⇒ MethodData

Deserializes an instance from a JSON object.

Kind: static method of MethodData

ParamType
jsonany

MethodDigest

Unique identifier of a VerificationMethod.

NOTE: This class does not have a JSON representation, use the methods pack and unpack instead.

Kind: global class

new MethodDigest(verification_method)

ParamType
verification_methodVerificationMethod

methodDigest.pack() ⇒ Uint8Array

Packs MethodDigest into bytes.

Kind: instance method of MethodDigest

methodDigest.clone() ⇒ MethodDigest

Deep clones the object.

Kind: instance method of MethodDigest

MethodDigest.unpack(bytes) ⇒ MethodDigest

Unpacks bytes into MethodDigest.

Kind: static method of MethodDigest

ParamType
bytesUint8Array

MethodScope

Supported verification method types.

Kind: global class

methodScope.toString() ⇒ string

Returns the MethodScope as a string.

Kind: instance method of MethodScope

methodScope.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of MethodScope

methodScope.clone() ⇒ MethodScope

Deep clones the object.

Kind: instance method of MethodScope

MethodScope.VerificationMethod() ⇒ MethodScope

Kind: static method of MethodScope

MethodScope.Authentication() ⇒ MethodScope

Kind: static method of MethodScope

MethodScope.AssertionMethod() ⇒ MethodScope

Kind: static method of MethodScope

MethodScope.KeyAgreement() ⇒ MethodScope

Kind: static method of MethodScope

MethodScope.CapabilityDelegation() ⇒ MethodScope

Kind: static method of MethodScope

MethodScope.CapabilityInvocation() ⇒ MethodScope

Kind: static method of MethodScope

MethodScope.fromJSON(json) ⇒ MethodScope

Deserializes an instance from a JSON object.

Kind: static method of MethodScope

ParamType
jsonany

MethodType

Supported verification method types.

Kind: global class

methodType.toString() ⇒ string

Returns the MethodType as a string.

Kind: instance method of MethodType

methodType.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of MethodType

methodType.clone() ⇒ MethodType

Deep clones the object.

Kind: instance method of MethodType

MethodType.Ed25519VerificationKey2018() ⇒ MethodType

Kind: static method of MethodType

MethodType.X25519KeyAgreementKey2019() ⇒ MethodType

Kind: static method of MethodType

MethodType.JsonWebKey()

Deprecated

Kind: static method of MethodType

MethodType.JsonWebKey2020() ⇒ MethodType

A verification method for use with JWT verification as prescribed by the Jwk in the publicKeyJwk entry.

Kind: static method of MethodType

MethodType.custom(type_) ⇒ MethodType

A custom method.

Kind: static method of MethodType

ParamType
type_string

MethodType.fromJSON(json) ⇒ MethodType

Deserializes an instance from a JSON object.

Kind: static method of MethodType

ParamType
jsonany

PayloadEntry

Kind: global class

payloadEntry.1 ⇒ PayloadType

Kind: instance property of PayloadEntry

payloadEntry.1

Kind: instance property of PayloadEntry

ParamType
arg0PayloadType

payloadEntry.value

Kind: instance property of PayloadEntry

ParamType
valueany

payloadEntry.value ⇒ any

Kind: instance property of PayloadEntry

Payloads

Kind: global class

new Payloads(entries)

ParamType
entriesArray.<PayloadEntry>

payloads.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of Payloads

payloads.clone() ⇒ Payloads

Deep clones the object.

Kind: instance method of Payloads

payloads.getValues() ⇒ Array.<any>

Kind: instance method of Payloads

payloads.getUndisclosedIndexes() ⇒ Uint32Array

Kind: instance method of Payloads

payloads.getDisclosedIndexes() ⇒ Uint32Array

Kind: instance method of Payloads

payloads.getUndisclosedPayloads() ⇒ Array.<any>

Kind: instance method of Payloads

payloads.getDisclosedPayloads() ⇒ Payloads

Kind: instance method of Payloads

payloads.setUndisclosed(index)

Kind: instance method of Payloads

ParamType
indexnumber

payloads.replacePayloadAtIndex(index, value) ⇒ any

Kind: instance method of Payloads

ParamType
indexnumber
valueany

Payloads.fromJSON(json) ⇒ Payloads

Deserializes an instance from a JSON object.

Kind: static method of Payloads

ParamType
jsonany

Payloads.newFromValues(values) ⇒ Payloads

Kind: static method of Payloads

ParamType
valuesArray.<any>

Presentation

Kind: global class

new Presentation(values)

Constructs a new presentation.

ParamType
valuesIPresentation

presentation.context() ⇒ Array.<(string|Record.<string, any>)>

Returns a copy of the JSON-LD context(s) applicable to the presentation.

Kind: instance method of Presentation

presentation.id() ⇒ string | undefined

Returns a copy of the unique URI identifying the presentation.

Kind: instance method of Presentation

presentation.type() ⇒ Array.<string>

Returns a copy of the URIs defining the type of the presentation.

Kind: instance method of Presentation

presentation.verifiableCredential() ⇒ Array.<UnknownCredential>

Returns the JWT credentials expressing the claims of the presentation.

Kind: instance method of Presentation

presentation.holder() ⇒ string

Returns a copy of the URI of the entity that generated the presentation.

Kind: instance method of Presentation

presentation.refreshService() ⇒ Array.<RefreshService>

Returns a copy of the service(s) used to refresh an expired Credential in the presentation.

Kind: instance method of Presentation

presentation.termsOfUse() ⇒ Array.<Policy>

Returns a copy of the terms-of-use specified by the presentation holder

Kind: instance method of Presentation

presentation.proof() ⇒ Proof | undefined

Optional cryptographic proof, unrelated to JWT.

Kind: instance method of Presentation

presentation.setProof([proof])

Sets the proof property of the Presentation.

Note that this proof is not related to JWT.

Kind: instance method of Presentation

ParamType
[proof]Proof | undefined

presentation.properties() ⇒ Map.<string, any>

Returns a copy of the miscellaneous properties on the presentation.

Kind: instance method of Presentation

presentation.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of Presentation

presentation.clone() ⇒ Presentation

Deep clones the object.

Kind: instance method of Presentation

Presentation.BaseContext() ⇒ string

Returns the base JSON-LD context.

Kind: static method of Presentation

Presentation.BaseType() ⇒ string

Returns the base type.

Kind: static method of Presentation

Presentation.fromJSON(json) ⇒ Presentation

Deserializes an instance from a JSON object.

Kind: static method of Presentation

ParamType
jsonany

PresentationProtectedHeader

Kind: global class

presentationProtectedHeader.alg ⇒ PresentationProofAlgorithm

Kind: instance property of PresentationProtectedHeader

presentationProtectedHeader.alg

Kind: instance property of PresentationProtectedHeader

ParamType
arg0PresentationProofAlgorithm

presentationProtectedHeader.kid ⇒ string | undefined

ID for the key used for the JWP.

Kind: instance property of PresentationProtectedHeader

presentationProtectedHeader.kid

ID for the key used for the JWP.

Kind: instance property of PresentationProtectedHeader

ParamType
[arg0]string | undefined

presentationProtectedHeader.aud ⇒ string | undefined

Who have received the JPT.

Kind: instance property of PresentationProtectedHeader

presentationProtectedHeader.aud

Who have received the JPT.

Kind: instance property of PresentationProtectedHeader

ParamType
[arg0]string | undefined

presentationProtectedHeader.nonce ⇒ string | undefined

For replay attacks.

Kind: instance property of PresentationProtectedHeader

presentationProtectedHeader.nonce

For replay attacks.

Kind: instance property of PresentationProtectedHeader

ParamType
[arg0]string | undefined

Proof

Represents a cryptographic proof that can be used to validate verifiable credentials and presentations.

This representation does not inherently implement any standard; instead, it can be utilized to implement standards or user-defined proofs. The presence of the type field is necessary to accommodate different types of cryptographic proofs.

Note that this proof is not related to JWT and can be used in combination or as an alternative to it.

Kind: global class

new Proof(type_, properties)

ParamType
type_string
propertiesany

proof.type() ⇒ string

Returns the type of proof.

Kind: instance method of Proof

proof.properties() ⇒ any

Returns the properties of the proof.

Kind: instance method of Proof

proof.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of Proof

proof.clone() ⇒ Proof

Deep clones the object.

Kind: instance method of Proof

Proof.fromJSON(json) ⇒ Proof

Deserializes an instance from a JSON object.

Kind: static method of Proof

ParamType
jsonany

ProofUpdateCtx

Kind: global class

proofUpdateCtx.old_start_validity_timeframe ⇒ Uint8Array

Old startValidityTimeframe value

Kind: instance property of ProofUpdateCtx

proofUpdateCtx.old_start_validity_timeframe

Old startValidityTimeframe value

Kind: instance property of ProofUpdateCtx

ParamType
arg0Uint8Array

proofUpdateCtx.new_start_validity_timeframe ⇒ Uint8Array

New startValidityTimeframe value to be signed

Kind: instance property of ProofUpdateCtx

proofUpdateCtx.new_start_validity_timeframe

New startValidityTimeframe value to be signed

Kind: instance property of ProofUpdateCtx

ParamType
arg0Uint8Array

proofUpdateCtx.old_end_validity_timeframe ⇒ Uint8Array

Old endValidityTimeframe value

Kind: instance property of ProofUpdateCtx

proofUpdateCtx.old_end_validity_timeframe

Old endValidityTimeframe value

Kind: instance property of ProofUpdateCtx

ParamType
arg0Uint8Array

proofUpdateCtx.new_end_validity_timeframe ⇒ Uint8Array

New endValidityTimeframe value to be signed

Kind: instance property of ProofUpdateCtx

proofUpdateCtx.new_end_validity_timeframe

New endValidityTimeframe value to be signed

Kind: instance property of ProofUpdateCtx

ParamType
arg0Uint8Array

proofUpdateCtx.index_start_validity_timeframe ⇒ number

Index of startValidityTimeframe claim inside the array of Claims

Kind: instance property of ProofUpdateCtx

proofUpdateCtx.index_start_validity_timeframe

Index of startValidityTimeframe claim inside the array of Claims

Kind: instance property of ProofUpdateCtx

ParamType
arg0number

proofUpdateCtx.index_end_validity_timeframe ⇒ number

Index of endValidityTimeframe claim inside the array of Claims

Kind: instance property of ProofUpdateCtx

proofUpdateCtx.index_end_validity_timeframe

Index of endValidityTimeframe claim inside the array of Claims

Kind: instance property of ProofUpdateCtx

ParamType
arg0number

proofUpdateCtx.number_of_signed_messages ⇒ number

Number of signed messages, number of payloads in a JWP

Kind: instance property of ProofUpdateCtx

proofUpdateCtx.number_of_signed_messages

Number of signed messages, number of payloads in a JWP

Kind: instance property of ProofUpdateCtx

ParamType
arg0number

Resolver

Convenience type for resolving DID documents from different DID methods.

Also provides methods for resolving DID Documents associated with verifiable Credentials and Presentations.

Configuration

The resolver will only be able to resolve DID documents for methods it has been configured for in the constructor.

Kind: global class

new Resolver(config)

Constructs a new Resolver.

Errors

If both a client is given and the handlers map contains the "iota" key the construction process will throw an error because the handler for the "iota" method then becomes ambiguous.

ParamType
configResolverConfig

resolver.resolve(did) ⇒ Promise.<(CoreDocument|IToCoreDocument)>

Fetches the DID Document of the given DID.

Errors

Errors if the resolver has not been configured to handle the method corresponding to the given DID or the resolution process itself fails.

Kind: instance method of Resolver

ParamType
didstring

resolver.resolveMultiple(dids) ⇒ Promise.<Array.<(CoreDocument|IToCoreDocument)>>

Concurrently fetches the DID Documents of the multiple given DIDs.

Errors

  • If the resolver has not been configured to handle the method of any of the given DIDs.
  • If the resolution process of any DID fails.

Note

  • The order of the documents in the returned array matches that in dids.
  • If dids contains duplicates, these will be resolved only once and the resolved document is copied into the returned array to match the order of dids.

Kind: instance method of Resolver

ParamType
didsArray.<string>

RevocationBitmap

A compressed bitmap for managing credential revocation.

Kind: global class

new RevocationBitmap()

Creates a new RevocationBitmap instance.

revocationBitmap.isRevoked(index) ⇒ boolean

Returns true if the credential at the given index is revoked.

Kind: instance method of RevocationBitmap

ParamType
indexnumber

revocationBitmap.revoke(index) ⇒ boolean

Mark the given index as revoked.

Returns true if the index was absent from the set.

Kind: instance method of RevocationBitmap

ParamType
indexnumber

revocationBitmap.unrevoke(index) ⇒ boolean

Mark the index as not revoked.

Returns true if the index was present in the set.

Kind: instance method of RevocationBitmap

ParamType
indexnumber

revocationBitmap.len() ⇒ number

Returns the number of revoked credentials.

Kind: instance method of RevocationBitmap

revocationBitmap.toService(serviceId) ⇒ Service

Return a Service with:

  • the service's id set to serviceId,
  • of type RevocationBitmap2022,
  • and with the bitmap embedded in a data url in the service's endpoint.

Kind: instance method of RevocationBitmap

ParamType
serviceIdDIDUrl

RevocationBitmap.type() ⇒ string

The name of the service type.

Kind: static method of RevocationBitmap

RevocationBitmap.fromEndpoint(service) ⇒ RevocationBitmap

Try to construct a RevocationBitmap from a service if it is a valid Revocation Bitmap Service.

Kind: static method of RevocationBitmap

ParamType
serviceService

RevocationTimeframeStatus

Information used to determine the current status of a Credential.

Kind: global class

new RevocationTimeframeStatus(id, index, duration, [start_validity])

Creates a new RevocationTimeframeStatus.

ParamType
idstring
indexnumber
durationDuration
[start_validity]Timestamp | undefined

revocationTimeframeStatus.clone() ⇒ RevocationTimeframeStatus

Deep clones the object.

Kind: instance method of RevocationTimeframeStatus

revocationTimeframeStatus.toJSON() ⇒ any

Serializes this to a JSON object.

Kind: instance method of RevocationTimeframeStatus

revocationTimeframeStatus.startValidityTimeframe() ⇒ Timestamp

Get startValidityTimeframe value.

Kind: instance method of RevocationTimeframeStatus

revocationTimeframeStatus.endValidityTimeframe() ⇒ Timestamp

Get endValidityTimeframe value.

Kind: instance method of RevocationTimeframeStatus

revocationTimeframeStatus.id() ⇒ string

Return the URL fo the RevocationBitmapStatus.

Kind: instance method of RevocationTimeframeStatus

revocationTimeframeStatus.index() ⇒ number | undefined

Return the index of the credential in the issuer's revocation bitmap

Kind: instance method of RevocationTimeframeStatus

RevocationTimeframeStatus.fromJSON(json) ⇒ RevocationTimeframeStatus

Deserializes an instance from a JSON object.

Kind: static method of RevocationTimeframeStatus

ParamType
jsonany

SdJwt

Representation of an SD-JWT of the format <Issuer-signed JWT>~<Disclosure 1>~<Disclosure 2>~...~<Disclosure N>~<optional KB-JWT>.

Kind: global class

new SdJwt(jwt, disclosures, [key_binding_jwt])

Creates a new SdJwt from its components.

ParamType
jwtstring
disclosuresArray.<string>
[key_binding_jwt]string | undefined

sdJwt.presentation() ⇒ string

Serializes the components into the final SD-JWT.

Kind: instance method of SdJwt

sdJwt.toString() ⇒ string

Serializes the components into the final SD-JWT.

Kind: instance method of SdJwt

sdJwt.jwt() ⇒ string

The JWT part.

Kind: instance method of SdJwt

sdJwt.disclosures() ⇒ Array.<string>

The disclosures part.

Kind: instance method of SdJwt

sdJwt.keyBindingJwt() ⇒ string | undefined

The optional key binding JWT.

Kind: instance method of SdJwt

sdJwt.clone() ⇒ SdJwt

Deep clones the object.

Kind: instance method of SdJwt

SdJwt.parse(sd_jwt) ⇒ SdJwt

Parses an SD-JWT into its components as [SdJwt].

Error

Returns DeserializationError if parsing fails.

Kind: static method of SdJwt

ParamType
sd_jwtstring

SdJwtCredentialValidator

A type for decoding and validating Credential.

Kind: global class

new SdJwtCredentialValidator(signatureVerifier)

Creates a new SdJwtCredentialValidator. If a signatureVerifier is provided it will be used when verifying decoded JWS signatures, otherwise the default which is only capable of handling the EdDSA algorithm will be used.

ParamType
signatureVerifierIJwsVerifier

sdJwtCredentialValidator.validateCredential(sd_jwt, issuer, options, fail_fast) ⇒ DecodedJwtCredential

Decodes and validates a Credential issued as an SD-JWT. A DecodedJwtCredential is returned upon success. The credential is constructed by replacing disclosures following the Selective Disclosure for JWTs (SD-JWT) standard.

The following properties are validated according to options:

  • the issuer's signature on the JWS,
  • the expiration date,
  • the issuance date,
  • the semantic structure.

Warning

  • The key binding JWT is not validated. If needed, it must be validated separately using SdJwtValidator::validate_key_binding_jwt.
  • The lack of an error returned from this method is in of itself not enough to conclude that the credential can be trusted. This section contains more information on additional checks that should be carried out before and after calling this method.

The state of the issuer's DID Document

The caller must ensure that issuer represents an up-to-date DID Document.

Properties that are not validated

There are many properties defined in The Verifiable Credentials Data Model that are not validated, such as: proof, credentialStatus, type, credentialSchema, refreshService and more. These should be manually checked after validation, according to your requirements.

Errors

An error is returned whenever a validated condition is not satisfied.

Kind: instance method of SdJwtCredentialValidator

ParamType
sd_jwtSdJwt
issuerCoreDocument | IToCoreDocument
optionsJwtCredentialValidationOptions
fail_fastFailFast

sdJwtCredentialValidator.verifySignature(credential, trustedIssuers, options) ⇒ DecodedJwtCredential

Decode and verify the JWS signature of a Credential issued as an SD-JWT using the DID Document of a trusted issuer and replaces the disclosures.

A DecodedJwtCredential is returned upon success.

Warning

The caller must ensure that the DID Documents of the trusted issuers are up-to-date.

Proofs

Only the JWS signature is verified. If the Credential contains a proof property this will not be verified by this method.

Errors

  • If the issuer' URL cannot be parsed.
  • If Signature verification fails.
  • If SD decoding fails.

Kind: instance method of SdJwtCredentialValidator

ParamType
credentialSdJwt
trustedIssuersArray.<(CoreDocument|IToCoreDocument)>
optionsJwsVerificationOptions

sdJwtCredentialValidator.validateKeyBindingJwt(sdJwt, holder, options) ⇒ KeyBindingJwtClaims

Validates a Key Binding JWT (KB-JWT) according to https://www.ietf.org/archive/id/draft-ietf-oauth-selective-disclosure-jwt-07.html#name-key-binding-jwt. The Validation process includes:

  • Signature validation using public key materials defined in the holder document.
  • typ value in KB-JWT header.
  • sd_hash claim value in the KB-JWT claim.
  • Optional nonce, aud and issuance date validation.

Kind: instance method of SdJwtCredentialValidator

ParamType
sdJwtSdJwt
holderCoreDocument | IToCoreDocument
optionsKeyBindingJWTValidationOptions

SdObjectDecoder

Substitutes digests in an SD-JWT object by their corresponding plaintext values provided by disclosures.

Kind: global class

new SdObjectDecoder()

Creates a new SdObjectDecoder with sha-256 hasher.

sdObjectDecoder.decode(object, disclosures) ⇒ Record.<string, any>

Decodes an SD-JWT object containing by Substituting the digests with their corresponding plaintext values provided by disclosures.

Notes

  • Claims like exp or iat are not validated in the process of decoding.
  • _sd_alg property will be removed if present.

Kind: instance method of SdObjectDecoder

ParamType
objectRecord.<string, any>
disclosuresArray.<string>

SdObjectEncoder

Transforms a JSON object into an SD-JWT object by substituting selected values with their corresponding disclosure digests.

Note: digests are created using the sha-256 algorithm.

Kind: global class

new SdObjectEncoder(object)

Creates a new SdObjectEncoder with sha-256 hash function.

ParamType
objectany

sdObjectEncoder.conceal(path, [salt]) ⇒ Disclosure

Substitutes a value with the digest of its disclosure. If no salt is provided, the disclosure will be created with a random salt value.

path indicates the pointer to the value that will be concealed using the syntax of JSON pointer.

For the following object:

{
"id": "did:value",
"claim1": {
"abc": true
},
"claim2": ["val_1", "val_2"]
}

Path "/id" conceals "id": "did:value" Path "/claim1/abc" conceals "abc": true Path "/claim2/0" conceals val_1


## Errors
* `InvalidPath` if pointer is invalid.
* `DataTypeMismatch` if existing SD format is invalid.

**Kind**: instance method of [<code>SdObjectEncoder</code>](#SdObjectEncoder)

| Param | Type |
| --- | --- |
| path | <code>string</code> |
| [salt] | <code>string</code> \| <code>undefined</code> |

<a name="SdObjectEncoder+addSdAlgProperty"></a>

### sdObjectEncoder.addSdAlgProperty()
Adds the `_sd_alg` property to the top level of the object, with
its value set to "sha-256".

**Kind**: instance method of [<code>SdObjectEncoder</code>](#SdObjectEncoder)
<a name="SdObjectEncoder+encodeToString"></a>

### sdObjectEncoder.encodeToString() ⇒ <code>string</code>
Returns the modified object as a string.

**Kind**: instance method of [<code>SdObjectEncoder</code>](#SdObjectEncoder)
<a name="SdObjectEncoder+toString"></a>

### sdObjectEncoder.toString() ⇒ <code>string</code>
Returns the modified object as a string.

**Kind**: instance method of [<code>SdObjectEncoder</code>](#SdObjectEncoder)
<a name="SdObjectEncoder+encodeToObject"></a>

### sdObjectEncoder.encodeToObject() ⇒ <code>Record.&lt;string, any&gt;</code>
Returns the modified object.

**Kind**: instance method of [<code>SdObjectEncoder</code>](#SdObjectEncoder)
<a name="SdObjectEncoder+toJSON"></a>

### sdObjectEncoder.toJSON() ⇒ <code>any</code>
Returns the modified object.

**Kind**: instance method of [<code>SdObjectEncoder</code>](#SdObjectEncoder)
<a name="SdObjectEncoder+addDecoys"></a>

### sdObjectEncoder.addDecoys(path, number_of_decoys)
Adds a decoy digest to the specified path.
If path is an empty slice, decoys will be added to the top level.

**Kind**: instance method of [<code>SdObjectEncoder</code>](#SdObjectEncoder)

| Param | Type |
| --- | --- |
| path | <code>string</code> |
| number_of_decoys | <code>number</code> |

<a name="SelectiveDisclosurePresentation"></a>

## SelectiveDisclosurePresentation
Used to construct a JwpPresentedBuilder and handle the selective disclosure of attributes
- @context MUST NOT be blinded
- id MUST be blinded
- type MUST NOT be blinded
- issuer MUST NOT be blinded
- issuanceDate MUST be blinded (if Timeframe Revocation mechanism is used)
- expirationDate MUST be blinded (if Timeframe Revocation mechanism is used)
- credentialSubject (User have to choose which attribute must be blinded)
- credentialSchema MUST NOT be blinded
- credentialStatus MUST NOT be blinded
- refreshService MUST NOT be blinded (probably will be used for Timeslot Revocation mechanism)
- termsOfUse NO reason to use it in ZK VC (will be in any case blinded)
- evidence (User have to choose which attribute must be blinded)

**Kind**: global class

* [SelectiveDisclosurePresentation](#SelectiveDisclosurePresentation)
* [new SelectiveDisclosurePresentation(issued_jwp)](#new_SelectiveDisclosurePresentation_new)
* [.concealInSubject(path)](#SelectiveDisclosurePresentation+concealInSubject)
* [.concealInEvidence(path)](#SelectiveDisclosurePresentation+concealInEvidence)
* [.setPresentationHeader(header)](#SelectiveDisclosurePresentation+setPresentationHeader)

<a name="new_SelectiveDisclosurePresentation_new"></a>

### new SelectiveDisclosurePresentation(issued_jwp)
Initialize a presentation starting from an Issued JWP.
The properties `jti`, `nbf`, `issuanceDate`, `expirationDate` and `termsOfUse` are concealed by default.


| Param | Type |
| --- | --- |
| issued_jwp | [<code>JwpIssued</code>](#JwpIssued) |

<a name="SelectiveDisclosurePresentation+concealInSubject"></a>

### selectiveDisclosurePresentation.concealInSubject(path)
Selectively disclose "credentialSubject" attributes.
# Example

{ "id": 1234, "name": "Alice", "mainCourses": ["Object-oriented Programming", "Mathematics"], "degree": { "type": "BachelorDegree", "name": "Bachelor of Science and Arts", }, "GPA": "4.0", }

If you want to undisclose for example the Mathematics course and the name of the degree:

undisclose_subject("mainCourses[1]"); undisclose_subject("degree.name");


**Kind**: instance method of [<code>SelectiveDisclosurePresentation</code>](#SelectiveDisclosurePresentation)

| Param | Type |
| --- | --- |
| path | <code>string</code> |

<a name="SelectiveDisclosurePresentation+concealInEvidence"></a>

### selectiveDisclosurePresentation.concealInEvidence(path)
Undiscloses "evidence" attributes.

**Kind**: instance method of [<code>SelectiveDisclosurePresentation</code>](#SelectiveDisclosurePresentation)

| Param | Type |
| --- | --- |
| path | <code>string</code> |

<a name="SelectiveDisclosurePresentation+setPresentationHeader"></a>

### selectiveDisclosurePresentation.setPresentationHeader(header)
Sets presentation protected header.

**Kind**: instance method of [<code>SelectiveDisclosurePresentation</code>](#SelectiveDisclosurePresentation)

| Param | Type |
| --- | --- |
| header | [<code>PresentationProtectedHeader</code>](#PresentationProtectedHeader) |

<a name="Service"></a>

## Service
A DID Document Service used to enable trusted interactions associated with a DID subject.

**Kind**: global class

* [Service](#Service)
* [new Service(service)](#new_Service_new)
* _instance_
* [.id()](#Service+id) ⇒ [<code>DIDUrl</code>](#DIDUrl)
* [.type()](#Service+type) ⇒ <code>Array.&lt;string&gt;</code>
* [.serviceEndpoint()](#Service+serviceEndpoint) ⇒ <code>string</code> \| <code>Array.&lt;string&gt;</code> \| <code>Map.&lt;string, Array.&lt;string&gt;&gt;</code>
* [.properties()](#Service+properties) ⇒ <code>Map.&lt;string, any&gt;</code>
* [.toJSON()](#Service+toJSON) ⇒ <code>any</code>
* [.clone()](#Service+clone) ⇒ [<code>Service</code>](#Service)
* _static_
* [.fromJSON(json)](#Service.fromJSON) ⇒ [<code>Service</code>](#Service)

<a name="new_Service_new"></a>

### new Service(service)

| Param | Type |
| --- | --- |
| service | <code>IService</code> |

<a name="Service+id"></a>

### service.id() ⇒ [<code>DIDUrl</code>](#DIDUrl)
Returns a copy of the [Service](#Service) id.

**Kind**: instance method of [<code>Service</code>](#Service)
<a name="Service+type"></a>

### service.type() ⇒ <code>Array.&lt;string&gt;</code>
Returns a copy of the [Service](#Service) type.

**Kind**: instance method of [<code>Service</code>](#Service)
<a name="Service+serviceEndpoint"></a>

### service.serviceEndpoint() ⇒ <code>string</code> \| <code>Array.&lt;string&gt;</code> \| <code>Map.&lt;string, Array.&lt;string&gt;&gt;</code>
Returns a copy of the [Service](#Service) endpoint.

**Kind**: instance method of [<code>Service</code>](#Service)
<a name="Service+properties"></a>

### service.properties() ⇒ <code>Map.&lt;string, any&gt;</code>
Returns a copy of the custom properties on the [Service](#Service).

**Kind**: instance method of [<code>Service</code>](#Service)
<a name="Service+toJSON"></a>

### service.toJSON() ⇒ <code>any</code>
Serializes this to a JSON object.

**Kind**: instance method of [<code>Service</code>](#Service)
<a name="Service+clone"></a>

### service.clone() ⇒ [<code>Service</code>](#Service)
Deep clones the object.

**Kind**: instance method of [<code>Service</code>](#Service)
<a name="Service.fromJSON"></a>

### Service.fromJSON(json) ⇒ [<code>Service</code>](#Service)
Deserializes an instance from a JSON object.

**Kind**: static method of [<code>Service</code>](#Service)

| Param | Type |
| --- | --- |
| json | <code>any</code> |

<a name="StatusList2021"></a>

## StatusList2021
StatusList2021 data structure as described in [W3C's VC status list 2021](https://www.w3.org/TR/2023/WD-vc-status-list-20230427/).

**Kind**: global class

* [StatusList2021](#StatusList2021)
* [new StatusList2021([size])](#new_StatusList2021_new)
* _instance_
* [.clone()](#StatusList2021+clone) ⇒ [<code>StatusList2021</code>](#StatusList2021)
* [.len()](#StatusList2021+len) ⇒ <code>number</code>
* [.get(index)](#StatusList2021+get) ⇒ <code>boolean</code>
* [.set(index, value)](#StatusList2021+set)
* [.intoEncodedStr()](#StatusList2021+intoEncodedStr) ⇒ <code>string</code>
* _static_
* [.fromEncodedStr(s)](#StatusList2021.fromEncodedStr) ⇒ [<code>StatusList2021</code>](#StatusList2021)

<a name="new_StatusList2021_new"></a>

### new StatusList2021([size])
Creates a new [StatusList2021](#StatusList2021) of `size` entries.


| Param | Type |
| --- | --- |
| [size] | <code>number</code> \| <code>undefined</code> |

<a name="StatusList2021+clone"></a>

### statusList2021.clone() ⇒ [<code>StatusList2021</code>](#StatusList2021)
Deep clones the object.

**Kind**: instance method of [<code>StatusList2021</code>](#StatusList2021)
<a name="StatusList2021+len"></a>

### statusList2021.len() ⇒ <code>number</code>
Returns the number of entries in this [StatusList2021](#StatusList2021).

**Kind**: instance method of [<code>StatusList2021</code>](#StatusList2021)
<a name="StatusList2021+get"></a>

### statusList2021.get(index) ⇒ <code>boolean</code>
Returns whether the entry at `index` is set.

**Kind**: instance method of [<code>StatusList2021</code>](#StatusList2021)

| Param | Type |
| --- | --- |
| index | <code>number</code> |

<a name="StatusList2021+set"></a>

### statusList2021.set(index, value)
Sets the value of the `index`-th entry.

**Kind**: instance method of [<code>StatusList2021</code>](#StatusList2021)

| Param | Type |
| --- | --- |
| index | <code>number</code> |
| value | <code>boolean</code> |

<a name="StatusList2021+intoEncodedStr"></a>

### statusList2021.intoEncodedStr() ⇒ <code>string</code>
Encodes this [StatusList2021](#StatusList2021) into its compressed
base64 string representation.

**Kind**: instance method of [<code>StatusList2021</code>](#StatusList2021)
<a name="StatusList2021.fromEncodedStr"></a>

### StatusList2021.fromEncodedStr(s) ⇒ [<code>StatusList2021</code>](#StatusList2021)
Attempts to decode a [StatusList2021](#StatusList2021) from a string.

**Kind**: static method of [<code>StatusList2021</code>](#StatusList2021)

| Param | Type |
| --- | --- |
| s | <code>string</code> |

<a name="StatusList2021Credential"></a>

## StatusList2021Credential
A parsed [StatusList2021Credential](https://www.w3.org/TR/2023/WD-vc-status-list-20230427/#statuslist2021credential).

**Kind**: global class

* [StatusList2021Credential](#StatusList2021Credential)
* [new StatusList2021Credential(credential)](#new_StatusList2021Credential_new)
* _instance_
* [.id()](#StatusList2021Credential+id) ⇒ <code>string</code>
* [.setCredentialStatus(credential, index, revoked_or_suspended)](#StatusList2021Credential+setCredentialStatus) ⇒ [<code>StatusList2021Entry</code>](#StatusList2021Entry)
* [.purpose()](#StatusList2021Credential+purpose) ⇒ [<code>StatusPurpose</code>](#StatusPurpose)
* [.entry(index)](#StatusList2021Credential+entry) ⇒ [<code>CredentialStatus</code>](#CredentialStatus)
* [.clone()](#StatusList2021Credential+clone) ⇒ [<code>StatusList2021Credential</code>](#StatusList2021Credential)
* [.toJSON()](#StatusList2021Credential+toJSON) ⇒ <code>any</code>
* _static_
* [.fromJSON(json)](#StatusList2021Credential.fromJSON) ⇒ [<code>StatusList2021Credential</code>](#StatusList2021Credential)

<a name="new_StatusList2021Credential_new"></a>

### new StatusList2021Credential(credential)
Creates a new [StatusList2021Credential](#StatusList2021Credential).


| Param | Type |
| --- | --- |
| credential | [<code>Credential</code>](#Credential) |

<a name="StatusList2021Credential+id"></a>

### statusList2021Credential.id() ⇒ <code>string</code>
**Kind**: instance method of [<code>StatusList2021Credential</code>](#StatusList2021Credential)
<a name="StatusList2021Credential+setCredentialStatus"></a>

### statusList2021Credential.setCredentialStatus(credential, index, revoked_or_suspended) ⇒ [<code>StatusList2021Entry</code>](#StatusList2021Entry)
Sets the given credential's status using the `index`-th entry of this status list.
Returns the created `credentialStatus`.

**Kind**: instance method of [<code>StatusList2021Credential</code>](#StatusList2021Credential)

| Param | Type |
| --- | --- |
| credential | [<code>Credential</code>](#Credential) |
| index | <code>number</code> |
| revoked_or_suspended | <code>boolean</code> |

<a name="StatusList2021Credential+purpose"></a>

### statusList2021Credential.purpose() ⇒ [<code>StatusPurpose</code>](#StatusPurpose)
Returns the [StatusPurpose](#StatusPurpose) of this [StatusList2021Credential](#StatusList2021Credential).

**Kind**: instance method of [<code>StatusList2021Credential</code>](#StatusList2021Credential)
<a name="StatusList2021Credential+entry"></a>

### statusList2021Credential.entry(index) ⇒ [<code>CredentialStatus</code>](#CredentialStatus)
Returns the state of the `index`-th entry, if any.

**Kind**: instance method of [<code>StatusList2021Credential</code>](#StatusList2021Credential)

| Param | Type |
| --- | --- |
| index | <code>number</code> |

<a name="StatusList2021Credential+clone"></a>

### statusList2021Credential.clone() ⇒ [<code>StatusList2021Credential</code>](#StatusList2021Credential)
**Kind**: instance method of [<code>StatusList2021Credential</code>](#StatusList2021Credential)
<a name="StatusList2021Credential+toJSON"></a>

### statusList2021Credential.toJSON() ⇒ <code>any</code>
**Kind**: instance method of [<code>StatusList2021Credential</code>](#StatusList2021Credential)
<a name="StatusList2021Credential.fromJSON"></a>

### StatusList2021Credential.fromJSON(json) ⇒ [<code>StatusList2021Credential</code>](#StatusList2021Credential)
**Kind**: static method of [<code>StatusList2021Credential</code>](#StatusList2021Credential)

| Param | Type |
| --- | --- |
| json | <code>any</code> |

<a name="StatusList2021CredentialBuilder"></a>

## StatusList2021CredentialBuilder
Builder type to construct valid [StatusList2021Credential](#StatusList2021Credential) istances.

**Kind**: global class

* [StatusList2021CredentialBuilder](#StatusList2021CredentialBuilder)
* [new StatusList2021CredentialBuilder([status_list])](#new_StatusList2021CredentialBuilder_new)
* [.purpose(purpose)](#StatusList2021CredentialBuilder+purpose) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
* [.subjectId(id)](#StatusList2021CredentialBuilder+subjectId) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
* [.expirationDate(time)](#StatusList2021CredentialBuilder+expirationDate) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
* [.issuer(issuer)](#StatusList2021CredentialBuilder+issuer) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
* [.context(context)](#StatusList2021CredentialBuilder+context) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
* [.type(t)](#StatusList2021CredentialBuilder+type) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
* [.proof(proof)](#StatusList2021CredentialBuilder+proof) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
* [.build()](#StatusList2021CredentialBuilder+build) ⇒ [<code>StatusList2021Credential</code>](#StatusList2021Credential)

<a name="new_StatusList2021CredentialBuilder_new"></a>

### new StatusList2021CredentialBuilder([status_list])
Creates a new [StatusList2021CredentialBuilder](#StatusList2021CredentialBuilder).


| Param | Type |
| --- | --- |
| [status_list] | [<code>StatusList2021</code>](#StatusList2021) \| <code>undefined</code> |

<a name="StatusList2021CredentialBuilder+purpose"></a>

### statusList2021CredentialBuilder.purpose(purpose) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
Sets the purpose of the [StatusList2021Credential](#StatusList2021Credential) that is being created.

**Kind**: instance method of [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)

| Param | Type |
| --- | --- |
| purpose | [<code>StatusPurpose</code>](#StatusPurpose) |

<a name="StatusList2021CredentialBuilder+subjectId"></a>

### statusList2021CredentialBuilder.subjectId(id) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
Sets `credentialSubject.id`.

**Kind**: instance method of [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)

| Param | Type |
| --- | --- |
| id | <code>string</code> |

<a name="StatusList2021CredentialBuilder+expirationDate"></a>

### statusList2021CredentialBuilder.expirationDate(time) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
Sets the expiration date of the credential.

**Kind**: instance method of [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)

| Param | Type |
| --- | --- |
| time | [<code>Timestamp</code>](#Timestamp) |

<a name="StatusList2021CredentialBuilder+issuer"></a>

### statusList2021CredentialBuilder.issuer(issuer) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
Sets the issuer of the credential.

**Kind**: instance method of [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)

| Param | Type |
| --- | --- |
| issuer | <code>string</code> |

<a name="StatusList2021CredentialBuilder+context"></a>

### statusList2021CredentialBuilder.context(context) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
Sets the context of the credential.

**Kind**: instance method of [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)

| Param | Type |
| --- | --- |
| context | <code>string</code> |

<a name="StatusList2021CredentialBuilder+type"></a>

### statusList2021CredentialBuilder.type(t) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
Adds a credential type.

**Kind**: instance method of [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)

| Param | Type |
| --- | --- |
| t | <code>string</code> |

<a name="StatusList2021CredentialBuilder+proof"></a>

### statusList2021CredentialBuilder.proof(proof) ⇒ [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
Adds a credential's proof.

**Kind**: instance method of [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)

| Param | Type |
| --- | --- |
| proof | [<code>Proof</code>](#Proof) |

<a name="StatusList2021CredentialBuilder+build"></a>

### statusList2021CredentialBuilder.build() ⇒ [<code>StatusList2021Credential</code>](#StatusList2021Credential)
Attempts to build a valid [StatusList2021Credential](#StatusList2021Credential) with the previously provided data.

**Kind**: instance method of [<code>StatusList2021CredentialBuilder</code>](#StatusList2021CredentialBuilder)
<a name="StatusList2021Entry"></a>

## StatusList2021Entry
[StatusList2021Entry](https://www.w3.org/TR/2023/WD-vc-status-list-20230427/#statuslist2021entry) implementation.

**Kind**: global class

* [StatusList2021Entry](#StatusList2021Entry)
* [new StatusList2021Entry(status_list, purpose, index, [id])](#new_StatusList2021Entry_new)
* _instance_
* [.id()](#StatusList2021Entry+id) ⇒ <code>string</code>
* [.purpose()](#StatusList2021Entry+purpose) ⇒ [<code>StatusPurpose</code>](#StatusPurpose)
* [.index()](#StatusList2021Entry+index) ⇒ <code>number</code>
* [.statusListCredential()](#StatusList2021Entry+statusListCredential) ⇒ <code>string</code>
* [.toStatus()](#StatusList2021Entry+toStatus) ⇒ <code>Status</code>
* [.clone()](#StatusList2021Entry+clone) ⇒ [<code>StatusList2021Entry</code>](#StatusList2021Entry)
* [.toJSON()](#StatusList2021Entry+toJSON) ⇒ <code>any</code>
* _static_
* [.fromJSON(json)](#StatusList2021Entry.fromJSON) ⇒ [<code>StatusList2021Entry</code>](#StatusList2021Entry)

<a name="new_StatusList2021Entry_new"></a>

### new StatusList2021Entry(status_list, purpose, index, [id])
Creates a new [StatusList2021Entry](#StatusList2021Entry).


| Param | Type |
| --- | --- |
| status_list | <code>string</code> |
| purpose | [<code>StatusPurpose</code>](#StatusPurpose) |
| index | <code>number</code> |
| [id] | <code>string</code> \| <code>undefined</code> |

<a name="StatusList2021Entry+id"></a>

### statusList2021Entry.id() ⇒ <code>string</code>
Returns this `credentialStatus`'s `id`.

**Kind**: instance method of [<code>StatusList2021Entry</code>](#StatusList2021Entry)
<a name="StatusList2021Entry+purpose"></a>

### statusList2021Entry.purpose() ⇒ [<code>StatusPurpose</code>](#StatusPurpose)
Returns the purpose of this entry.

**Kind**: instance method of [<code>StatusList2021Entry</code>](#StatusList2021Entry)
<a name="StatusList2021Entry+index"></a>

### statusList2021Entry.index() ⇒ <code>number</code>
Returns the index of this entry.

**Kind**: instance method of [<code>StatusList2021Entry</code>](#StatusList2021Entry)
<a name="StatusList2021Entry+statusListCredential"></a>

### statusList2021Entry.statusListCredential() ⇒ <code>string</code>
Returns the referenced [StatusList2021Credential](#StatusList2021Credential)'s url.

**Kind**: instance method of [<code>StatusList2021Entry</code>](#StatusList2021Entry)
<a name="StatusList2021Entry+toStatus"></a>

### statusList2021Entry.toStatus() ⇒ <code>Status</code>
Downcasts [this](this) to [Status](Status)

**Kind**: instance method of [<code>StatusList2021Entry</code>](#StatusList2021Entry)
<a name="StatusList2021Entry+clone"></a>

### statusList2021Entry.clone() ⇒ [<code>StatusList2021Entry</code>](#StatusList2021Entry)
Deep clones the object.

**Kind**: instance method of [<code>StatusList2021Entry</code>](#StatusList2021Entry)
<a name="StatusList2021Entry+toJSON"></a>

### statusList2021Entry.toJSON() ⇒ <code>any</code>
Serializes this to a JSON object.

**Kind**: instance method of [<code>StatusList2021Entry</code>](#StatusList2021Entry)
<a name="StatusList2021Entry.fromJSON"></a>

### StatusList2021Entry.fromJSON(json) ⇒ [<code>StatusList2021Entry</code>](#StatusList2021Entry)
Deserializes an instance from a JSON object.

**Kind**: static method of [<code>StatusList2021Entry</code>](#StatusList2021Entry)

| Param | Type |
| --- | --- |
| json | <code>any</code> |

<a name="Storage"></a>

## Storage
A type wrapping a `JwkStorage` and `KeyIdStorage` that should always be used together when
working with storage backed DID documents.

**Kind**: global class

* [Storage](#Storage)
* [new Storage(jwkStorage, keyIdStorage)](#new_Storage_new)
* [.keyIdStorage()](#Storage+keyIdStorage) ⇒ <code>KeyIdStorage</code>
* [.keyStorage()](#Storage+keyStorage) ⇒ <code>JwkStorage</code>

<a name="new_Storage_new"></a>

### new Storage(jwkStorage, keyIdStorage)
Constructs a new `Storage`.


| Param | Type |
| --- | --- |
| jwkStorage | <code>JwkStorage</code> |
| keyIdStorage | <code>KeyIdStorage</code> |

<a name="Storage+keyIdStorage"></a>

### storage.keyIdStorage() ⇒ <code>KeyIdStorage</code>
Obtain the wrapped `KeyIdStorage`.

**Kind**: instance method of [<code>Storage</code>](#Storage)
<a name="Storage+keyStorage"></a>

### storage.keyStorage() ⇒ <code>JwkStorage</code>
Obtain the wrapped `JwkStorage`.

**Kind**: instance method of [<code>Storage</code>](#Storage)
<a name="Timestamp"></a>

## Timestamp
**Kind**: global class

* [Timestamp](#Timestamp)
* [new Timestamp()](#new_Timestamp_new)
* _instance_
* [.toRFC3339()](#Timestamp+toRFC3339) ⇒ <code>string</code>
* [.checkedAdd(duration)](#Timestamp+checkedAdd) ⇒ [<code>Timestamp</code>](#Timestamp) \| <code>undefined</code>
* [.checkedSub(duration)](#Timestamp+checkedSub) ⇒ [<code>Timestamp</code>](#Timestamp) \| <code>undefined</code>
* [.toJSON()](#Timestamp+toJSON) ⇒ <code>any</code>
* _static_
* [.parse(input)](#Timestamp.parse) ⇒ [<code>Timestamp</code>](#Timestamp)
* [.nowUTC()](#Timestamp.nowUTC) ⇒ [<code>Timestamp</code>](#Timestamp)
* [.fromJSON(json)](#Timestamp.fromJSON) ⇒ [<code>Timestamp</code>](#Timestamp)

<a name="new_Timestamp_new"></a>

### new Timestamp()
Creates a new [Timestamp](#Timestamp) with the current date and time.

<a name="Timestamp+toRFC3339"></a>

### timestamp.toRFC3339() ⇒ <code>string</code>
Returns the [Timestamp](#Timestamp) as an RFC 3339 `String`.

**Kind**: instance method of [<code>Timestamp</code>](#Timestamp)
<a name="Timestamp+checkedAdd"></a>

### timestamp.checkedAdd(duration) ⇒ [<code>Timestamp</code>](#Timestamp) \| <code>undefined</code>
Computes `self + duration`

Returns `null` if the operation leads to a timestamp not in the valid range for [RFC 3339](https://tools.ietf.org/html/rfc3339).

**Kind**: instance method of [<code>Timestamp</code>](#Timestamp)

| Param | Type |
| --- | --- |
| duration | [<code>Duration</code>](#Duration) |

<a name="Timestamp+checkedSub"></a>

### timestamp.checkedSub(duration) ⇒ [<code>Timestamp</code>](#Timestamp) \| <code>undefined</code>
Computes `self - duration`

Returns `null` if the operation leads to a timestamp not in the valid range for [RFC 3339](https://tools.ietf.org/html/rfc3339).

**Kind**: instance method of [<code>Timestamp</code>](#Timestamp)

| Param | Type |
| --- | --- |
| duration | [<code>Duration</code>](#Duration) |

<a name="Timestamp+toJSON"></a>

### timestamp.toJSON() ⇒ <code>any</code>
Serializes this to a JSON object.

**Kind**: instance method of [<code>Timestamp</code>](#Timestamp)
<a name="Timestamp.parse"></a>

### Timestamp.parse(input) ⇒ [<code>Timestamp</code>](#Timestamp)
Parses a [Timestamp](#Timestamp) from the provided input string.

**Kind**: static method of [<code>Timestamp</code>](#Timestamp)

| Param | Type |
| --- | --- |
| input | <code>string</code> |

<a name="Timestamp.nowUTC"></a>

### Timestamp.nowUTC() ⇒ [<code>Timestamp</code>](#Timestamp)
Creates a new [Timestamp](#Timestamp) with the current date and time.

**Kind**: static method of [<code>Timestamp</code>](#Timestamp)
<a name="Timestamp.fromJSON"></a>

### Timestamp.fromJSON(json) ⇒ [<code>Timestamp</code>](#Timestamp)
Deserializes an instance from a JSON object.

**Kind**: static method of [<code>Timestamp</code>](#Timestamp)

| Param | Type |
| --- | --- |
| json | <code>any</code> |

<a name="UnknownCredential"></a>

## UnknownCredential
**Kind**: global class

* [UnknownCredential](#UnknownCredential)
* _instance_
* [.tryIntoJwt()](#UnknownCredential+tryIntoJwt) ⇒ [<code>Jwt</code>](#Jwt) \| <code>undefined</code>
* [.tryIntoCredential()](#UnknownCredential+tryIntoCredential) ⇒ [<code>Credential</code>](#Credential) \| <code>undefined</code>
* [.tryIntoRaw()](#UnknownCredential+tryIntoRaw) ⇒ <code>Record.&lt;string, any&gt;</code> \| <code>undefined</code>
* [.toJSON()](#UnknownCredential+toJSON) ⇒ <code>any</code>
* [.clone()](#UnknownCredential+clone) ⇒ [<code>UnknownCredential</code>](#UnknownCredential)
* _static_
* [.fromJSON(json)](#UnknownCredential.fromJSON) ⇒ [<code>UnknownCredential</code>](#UnknownCredential)

<a name="UnknownCredential+tryIntoJwt"></a>

### unknownCredential.tryIntoJwt() ⇒ [<code>Jwt</code>](#Jwt) \| <code>undefined</code>
Returns a [Jwt](#Jwt) if the credential is of type string, `undefined` otherwise.

**Kind**: instance method of [<code>UnknownCredential</code>](#UnknownCredential)
<a name="UnknownCredential+tryIntoCredential"></a>

### unknownCredential.tryIntoCredential() ⇒ [<code>Credential</code>](#Credential) \| <code>undefined</code>
Returns a [Credential](#Credential) if the credential is of said type, `undefined` otherwise.

**Kind**: instance method of [<code>UnknownCredential</code>](#UnknownCredential)
<a name="UnknownCredential+tryIntoRaw"></a>

### unknownCredential.tryIntoRaw() ⇒ <code>Record.&lt;string, any&gt;</code> \| <code>undefined</code>
Returns the contained value as an Object, if it can be converted, `undefined` otherwise.

**Kind**: instance method of [<code>UnknownCredential</code>](#UnknownCredential)
<a name="UnknownCredential+toJSON"></a>

### unknownCredential.toJSON() ⇒ <code>any</code>
Serializes this to a JSON object.

**Kind**: instance method of [<code>UnknownCredential</code>](#UnknownCredential)
<a name="UnknownCredential+clone"></a>

### unknownCredential.clone() ⇒ [<code>UnknownCredential</code>](#UnknownCredential)
Deep clones the object.

**Kind**: instance method of [<code>UnknownCredential</code>](#UnknownCredential)
<a name="UnknownCredential.fromJSON"></a>

### UnknownCredential.fromJSON(json) ⇒ [<code>UnknownCredential</code>](#UnknownCredential)
Deserializes an instance from a JSON object.

**Kind**: static method of [<code>UnknownCredential</code>](#UnknownCredential)

| Param | Type |
| --- | --- |
| json | <code>any</code> |

<a name="VerificationMethod"></a>

## VerificationMethod
A DID Document Verification Method.

**Kind**: global class

* [VerificationMethod](#VerificationMethod)
* [new VerificationMethod(id, controller, type_, data)](#new_VerificationMethod_new)
* _instance_
* [.id()](#VerificationMethod+id) ⇒ [<code>DIDUrl</code>](#DIDUrl)
* [.setId(id)](#VerificationMethod+setId)
* [.controller()](#VerificationMethod+controller) ⇒ [<code>CoreDID</code>](#CoreDID)
* [.setController(did)](#VerificationMethod+setController)
* [.type()](#VerificationMethod+type) ⇒ [<code>MethodType</code>](#MethodType)
* [.setType(type_)](#VerificationMethod+setType)
* [.data()](#VerificationMethod+data) ⇒ [<code>MethodData</code>](#MethodData)
* [.setData(data)](#VerificationMethod+setData)
* [.properties()](#VerificationMethod+properties) ⇒ <code>Map.&lt;string, any&gt;</code>
* [.setPropertyUnchecked(key, value)](#VerificationMethod+setPropertyUnchecked)
* [.toJSON()](#VerificationMethod+toJSON) ⇒ <code>any</code>
* [.clone()](#VerificationMethod+clone) ⇒ [<code>VerificationMethod</code>](#VerificationMethod)
* _static_
* [.newFromJwk(did, key, [fragment])](#VerificationMethod.newFromJwk) ⇒ [<code>VerificationMethod</code>](#VerificationMethod)
* [.fromJSON(json)](#VerificationMethod.fromJSON) ⇒ [<code>VerificationMethod</code>](#VerificationMethod)

<a name="new_VerificationMethod_new"></a>

### new VerificationMethod(id, controller, type_, data)
Create a custom [VerificationMethod](#VerificationMethod).


| Param | Type |
| --- | --- |
| id | [<code>DIDUrl</code>](#DIDUrl) |
| controller | [<code>CoreDID</code>](#CoreDID) |
| type_ | [<code>MethodType</code>](#MethodType) |
| data | [<code>MethodData</code>](#MethodData) |

<a name="VerificationMethod+id"></a>

### verificationMethod.id() ⇒ [<code>DIDUrl</code>](#DIDUrl)
Returns a copy of the [DIDUrl](#DIDUrl) of the [VerificationMethod](#VerificationMethod)'s `id`.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)
<a name="VerificationMethod+setId"></a>

### verificationMethod.setId(id)
Sets the id of the [VerificationMethod](#VerificationMethod).

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)

| Param | Type |
| --- | --- |
| id | [<code>DIDUrl</code>](#DIDUrl) |

<a name="VerificationMethod+controller"></a>

### verificationMethod.controller() ⇒ [<code>CoreDID</code>](#CoreDID)
Returns a copy of the `controller` `DID` of the [VerificationMethod](#VerificationMethod).

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)
<a name="VerificationMethod+setController"></a>

### verificationMethod.setController(did)
Sets the `controller` `DID` of the [VerificationMethod](#VerificationMethod) object.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)

| Param | Type |
| --- | --- |
| did | [<code>CoreDID</code>](#CoreDID) |

<a name="VerificationMethod+type"></a>

### verificationMethod.type() ⇒ [<code>MethodType</code>](#MethodType)
Returns a copy of the [VerificationMethod](#VerificationMethod) type.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)
<a name="VerificationMethod+setType"></a>

### verificationMethod.setType(type_)
Sets the [VerificationMethod](#VerificationMethod) type.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)

| Param | Type |
| --- | --- |
| type_ | [<code>MethodType</code>](#MethodType) |

<a name="VerificationMethod+data"></a>

### verificationMethod.data() ⇒ [<code>MethodData</code>](#MethodData)
Returns a copy of the [VerificationMethod](#VerificationMethod) public key data.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)
<a name="VerificationMethod+setData"></a>

### verificationMethod.setData(data)
Sets [VerificationMethod](#VerificationMethod) public key data.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)

| Param | Type |
| --- | --- |
| data | [<code>MethodData</code>](#MethodData) |

<a name="VerificationMethod+properties"></a>

### verificationMethod.properties() ⇒ <code>Map.&lt;string, any&gt;</code>
Get custom properties of the Verification Method.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)
<a name="VerificationMethod+setPropertyUnchecked"></a>

### verificationMethod.setPropertyUnchecked(key, value)
Adds a custom property to the Verification Method.
If the value is set to `null`, the custom property will be removed.

### WARNING
This method can overwrite existing properties like `id` and result
in an invalid Verification Method.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)

| Param | Type |
| --- | --- |
| key | <code>string</code> |
| value | <code>any</code> |

<a name="VerificationMethod+toJSON"></a>

### verificationMethod.toJSON() ⇒ <code>any</code>
Serializes this to a JSON object.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)
<a name="VerificationMethod+clone"></a>

### verificationMethod.clone() ⇒ [<code>VerificationMethod</code>](#VerificationMethod)
Deep clones the object.

**Kind**: instance method of [<code>VerificationMethod</code>](#VerificationMethod)
<a name="VerificationMethod.newFromJwk"></a>

### VerificationMethod.newFromJwk(did, key, [fragment]) ⇒ [<code>VerificationMethod</code>](#VerificationMethod)
Creates a new [VerificationMethod](#VerificationMethod) from the given `did` and [Jwk](#Jwk). If `fragment` is not given
the `kid` value of the given `key` will be used, if present, otherwise an error is returned.

### Recommendations
The following recommendations are essentially taken from the `publicKeyJwk` description from the [DID specification](https://www.w3.org/TR/did-core/#dfn-publickeyjwk):
- It is recommended that verification methods that use `Jwks` to represent their public keys use the value of
`kid` as their fragment identifier. This is
done automatically if `None` is passed in as the fragment.
- It is recommended that [Jwk](#Jwk) kid values are set to the public key fingerprint.

**Kind**: static method of [<code>VerificationMethod</code>](#VerificationMethod)

| Param | Type |
| --- | --- |
| did | [<code>CoreDID</code>](#CoreDID) \| <code>IToCoreDID</code> |
| key | [<code>Jwk</code>](#Jwk) |
| [fragment] | <code>string</code> \| <code>undefined</code> |

<a name="VerificationMethod.fromJSON"></a>

### VerificationMethod.fromJSON(json) ⇒ [<code>VerificationMethod</code>](#VerificationMethod)
Deserializes an instance from a JSON object.

**Kind**: static method of [<code>VerificationMethod</code>](#VerificationMethod)

| Param | Type |
| --- | --- |
| json | <code>any</code> |

<a name="StatusCheck"></a>

## StatusCheck
Controls validation behaviour when checking whether or not a credential has been revoked by its
[`credentialStatus`](https://www.w3.org/TR/vc-data-model/#status).

**Kind**: global variable
<a name="Strict"></a>

## Strict
Validate the status if supported, reject any unsupported
[`credentialStatus`](https://www.w3.org/TR/vc-data-model/#status) types.

Only `RevocationBitmap2022` is currently supported.

This is the default.

**Kind**: global variable
<a name="SkipUnsupported"></a>

## SkipUnsupported
Validate the status if supported, skip any unsupported
[`credentialStatus`](https://www.w3.org/TR/vc-data-model/#status) types.

**Kind**: global variable
<a name="SkipAll"></a>

## SkipAll
Skip all status checks.

**Kind**: global variable
<a name="CredentialStatus"></a>

## CredentialStatus
**Kind**: global variable
<a name="PayloadType"></a>

## PayloadType
**Kind**: global variable
<a name="ProofAlgorithm"></a>

## ProofAlgorithm
**Kind**: global variable
<a name="StatusPurpose"></a>

## StatusPurpose
Purpose of a [StatusList2021](#StatusList2021).

**Kind**: global variable
<a name="FailFast"></a>

## FailFast
Declares when validation should return if an error occurs.

**Kind**: global variable
<a name="AllErrors"></a>

## AllErrors
Return all errors that occur during validation.

**Kind**: global variable
<a name="FirstError"></a>

## FirstError
Return after the first error occurs.

**Kind**: global variable
<a name="StateMetadataEncoding"></a>

## StateMetadataEncoding
**Kind**: global variable
<a name="SerializationType"></a>

## SerializationType
**Kind**: global variable
<a name="MethodRelationship"></a>

## MethodRelationship
**Kind**: global variable
<a name="PresentationProofAlgorithm"></a>

## PresentationProofAlgorithm
**Kind**: global variable
<a name="SubjectHolderRelationship"></a>

## SubjectHolderRelationship
Declares how credential subjects must relate to the presentation holder.

See also the [Subject-Holder Relationship](https://www.w3.org/TR/vc-data-model/#subject-holder-relationships) section of the specification.

**Kind**: global variable
<a name="AlwaysSubject"></a>

## AlwaysSubject
The holder must always match the subject on all credentials, regardless of their [`nonTransferable`](https://www.w3.org/TR/vc-data-model/#nontransferable-property) property.
This variant is the default.

**Kind**: global variable
<a name="SubjectOnNonTransferable"></a>

## SubjectOnNonTransferable
The holder must match the subject only for credentials where the [`nonTransferable`](https://www.w3.org/TR/vc-data-model/#nontransferable-property) property is `true`.

**Kind**: global variable
<a name="Any"></a>

## Any
The holder is not required to have any kind of relationship to any credential subject.

**Kind**: global variable
<a name="encodeB64"></a>

## encodeB64(data) ⇒ <code>string</code>
Encode the given bytes in url-safe base64.

**Kind**: global function

| Param | Type |
| --- | --- |
| data | <code>Uint8Array</code> |

<a name="decodeB64"></a>

## decodeB64(data) ⇒ <code>Uint8Array</code>
Decode the given url-safe base64-encoded slice into its raw bytes.

**Kind**: global function

| Param | Type |
| --- | --- |
| data | <code>Uint8Array</code> |

<a name="start"></a>

## start()
Initializes the console error panic hook for better error messages

**Kind**: global function
<a name="verifyEd25519"></a>

## verifyEd25519(alg, signingInput, decodedSignature, publicKey)
Verify a JWS signature secured with the `EdDSA` algorithm and curve `Ed25519`.

This function is useful when one is composing a `IJwsVerifier` that delegates
`EdDSA` verification with curve `Ed25519` to this function.

# Warning

This function does not check whether `alg = EdDSA` in the protected header. Callers are expected to assert this
prior to calling the function.

**Kind**: global function

| Param | Type |
| --- | --- |
| alg | <code>JwsAlgorithm</code> |
| signingInput | <code>Uint8Array</code> |
| decodedSignature | <code>Uint8Array</code> |
| publicKey | [<code>Jwk</code>](#Jwk) |