Version: 1.2

Wasm Api Reference

Classes

A method-agnostic Decentralized Identifier (DID).

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.

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:

Only the JSON Web Token Proof Format

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.

Jwk

JwkGenOutput

The result of a key generation in JwkStorage.

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.

Presentation

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.

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.

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.

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.

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.

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

MethodRelationship

CredentialStatus

StatusPurpose

Purpose of a StatusList2021.

Functions

start()

Initializes the console error panic hook for better error messages

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.

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
- instance
  - .setMethodName(value)
  - .setMethodId(value)
  - .scheme() ⇒ string
  - .authority() ⇒ string
  - .method() ⇒ string
  - .methodId() ⇒ string
  - .join(segment) ⇒ DIDUrl
  - .toUrl() ⇒ DIDUrl
  - .intoUrl() ⇒ DIDUrl
  - .toString() ⇒ string
  - .toCoreDid() ⇒ CoreDID
  - .toJSON() ⇒ any
  - .clone() ⇒ CoreDID
- static
  - .parse(input) ⇒ CoreDID
  - .validMethodName(value) ⇒ boolean
  - .validMethodId(value) ⇒ boolean
  - .fromJSON(json) ⇒ CoreDID

coreDID.setMethodName(value)

Set the method name of the CoreDID.

Kind: instance method of CoreDID

Param	Type
value	`string`

coreDID.setMethodId(value)

Set the method-specific-id of the DID.

Kind: instance method of CoreDID

Param	Type
value	`string`

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

Param	Type
segment	`string`

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

Param	Type
input	`string`

CoreDID.validMethodName(value) ⇒ `boolean`

Validates whether a string is a valid DID method name.

Kind: static method of CoreDID

Param	Type
value	`string`

CoreDID.validMethodId(value) ⇒ `boolean`

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

Kind: static method of CoreDID

Param	Type
value	`string`

CoreDID.fromJSON(json) ⇒ `CoreDID`

Deserializes an instance from a JSON object.

Kind: static method of CoreDID

Param	Type
json	`any`

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

CoreDocument
- new CoreDocument(values)
- instance
  - .id() ⇒ CoreDID
  - .setId(id)
  - .controller() ⇒ Array.<CoreDID>
  - .setController(controllers)
  - .alsoKnownAs() ⇒ Array.<string>
  - .setAlsoKnownAs(urls)
  - .verificationMethod() ⇒ Array.<VerificationMethod>
  - .authentication() ⇒ Array.<(DIDUrl|VerificationMethod)>
  - .assertionMethod() ⇒ Array.<(DIDUrl|VerificationMethod)>
  - .keyAgreement() ⇒ Array.<(DIDUrl|VerificationMethod)>
  - .capabilityDelegation() ⇒ Array.<(DIDUrl|VerificationMethod)>
  - .capabilityInvocation() ⇒ Array.<(DIDUrl|VerificationMethod)>
  - .properties() ⇒ Map.<string, any>
  - .setPropertyUnchecked(key, value)
  - .service() ⇒ Array.<Service>
  - .insertService(service)
  - .removeService(didUrl) ⇒ Service | undefined
  - .resolveService(query) ⇒ Service | undefined
  - .methods(scope) ⇒ Array.<VerificationMethod>
  - .verificationRelationships() ⇒ Array.<(DIDUrl|VerificationMethod)>
  - .insertMethod(method, scope)
  - .removeMethod(did) ⇒ VerificationMethod | undefined
  - .resolveMethod(query, scope) ⇒ VerificationMethod | undefined
  - .attachMethodRelationship(didUrl, relationship) ⇒ boolean
  - .detachMethodRelationship(didUrl, relationship) ⇒ boolean
  - .verifyJws(jws, options, signatureVerifier, detachedPayload) ⇒ DecodedJws
  - .revokeCredentials(serviceQuery, indices)
  - .unrevokeCredentials(serviceQuery, indices)
  - .clone() ⇒ CoreDocument
  - ._shallowCloneInternal() ⇒ CoreDocument
  - ._strongCountInternal() ⇒ number
  - .toJSON() ⇒ any
  - .generateMethod(storage, keyType, alg, fragment, scope) ⇒ Promise.<string>
  - .purgeMethod(storage, id) ⇒ Promise.<void>
  - .createJws(storage, fragment, payload, options) ⇒ Promise.<Jws>
  - .createCredentialJwt(storage, fragment, credential, options, custom_claims) ⇒ Promise.<Jwt>
  - .createPresentationJwt(storage, fragment, presentation, signature_options, presentation_options) ⇒ Promise.<Jwt>
- static
  - .fromJSON(json) ⇒ CoreDocument

new CoreDocument(values)

Creates a new CoreDocument with the given properties.

Param	Type
values	`ICoreDocument`

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

Param	Type
id	`CoreDID`

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

Param	Type
controllers	`CoreDID` \| `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

Param	Type
urls	`string` \| `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

Param	Type
key	`string`
value	`any`

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

Param	Type
service	`Service`

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

Param	Type
didUrl	`DIDUrl`

coreDocument.resolveService(query) ⇒ `Service` | `undefined`

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

Kind: instance method of CoreDocument

Param	Type
query	`DIDUrl` \| `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

Param	Type
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

Param	Type
method	`VerificationMethod`
scope	`MethodScope`

coreDocument.removeMethod(did) ⇒ `VerificationMethod` | `undefined`

Removes all references to the specified Verification Method.

Kind: instance method of CoreDocument

Param	Type
did	`DIDUrl`

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

Param	Type
query	`DIDUrl` \| `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

Param	Type
didUrl	`DIDUrl`
relationship	`number`

coreDocument.detachMethodRelationship(didUrl, relationship) ⇒ `boolean`

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

Kind: instance method of CoreDocument

Param	Type
didUrl	`DIDUrl`
relationship	`number`

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

Param	Type
jws	`Jws`
options	`JwsVerificationOptions`
signatureVerifier	`IJwsVerifier`
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

Param	Type
serviceQuery	`DIDUrl` \| `string`
indices	`number` \| `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

Param	Type
serviceQuery	`DIDUrl` \| `string`
indices	`number` \| `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

Param	Type
storage	`Storage`
keyType	`string`
alg	`JwsAlgorithm`
fragment	`string` \| `undefined`
scope	`MethodScope`

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

Param	Type
storage	`Storage`
id	`DIDUrl`

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

Param	Type
storage	`Storage`
fragment	`string`
payload	`string`
options	`JwsSignatureOptions`

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

Param	Type
storage	`Storage`
fragment	`string`
credential	`Credential`
options	`JwsSignatureOptions`
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.

Kind: instance method of CoreDocument

Param	Type
storage	`Storage`
fragment	`string`
presentation	`Presentation`
signature_options	`JwsSignatureOptions`
presentation_options	`JwtPresentationOptions`

CoreDocument.fromJSON(json) ⇒ `CoreDocument`

Deserializes an instance from a plain JS representation.

Kind: static method of CoreDocument

Param	Type
json	`any`

Credential

Kind: global class

Credential
- new Credential(values)
- instance
  - .context() ⇒ Array.<(string|Record.<string, any>)>
  - .id() ⇒ string | undefined
  - .type() ⇒ Array.<string>
  - .credentialSubject() ⇒ Array.<Subject>
  - .issuer() ⇒ string | Issuer
  - .issuanceDate() ⇒ Timestamp
  - .expirationDate() ⇒ Timestamp | undefined
  - .credentialStatus() ⇒ Array.<Status>
  - .credentialSchema() ⇒ Array.<Schema>
  - .refreshService() ⇒ Array.<RefreshService>
  - .termsOfUse() ⇒ Array.<Policy>
  - .evidence() ⇒ Array.<Evidence>
  - .nonTransferable() ⇒ boolean | undefined
  - .proof() ⇒ Proof | undefined
  - .properties() ⇒ Map.<string, any>
  - .setProof(proof)
  - .toJwtClaims(custom_claims) ⇒ Record.<string, any>
  - .toJSON() ⇒ any
  - .clone() ⇒ Credential
- static
  - .BaseContext() ⇒ string
  - .BaseType() ⇒ string
  - .createDomainLinkageCredential(values) ⇒ Credential
  - .fromJSON(json) ⇒ Credential

new Credential(values)

Constructs a new Credential.

Param	Type
values	`ICredential`

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

Param	Type
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

Param	Type
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

Param	Type
values	`IDomainLinkageCredential`

Credential.fromJSON(json) ⇒ `Credential`

Deserializes an instance from a JSON object.

Kind: static method of Credential

Param	Type
json	`any`

CustomMethodData

A custom verification method data format.

Kind: global class

CustomMethodData
- new CustomMethodData(name, data)
- instance
  - .clone() ⇒ CustomMethodData
  - .toJSON() ⇒ any
- static
  - .fromJSON(json) ⇒ CustomMethodData

new CustomMethodData(name, data)

Param	Type
name	`string`
data	`any`

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

Param	Type
json	`any`

DIDUrl

A method agnostic DID Url.

Kind: global class

DIDUrl
- instance
  - .did() ⇒ CoreDID
  - .urlStr() ⇒ string
  - .fragment() ⇒ string | undefined
  - .setFragment(value)
  - .path() ⇒ string | undefined
  - .setPath(value)
  - .query() ⇒ string | undefined
  - .setQuery(value)
  - .join(segment) ⇒ DIDUrl
  - .toString() ⇒ string
  - .toJSON() ⇒ any
  - .clone() ⇒ DIDUrl
- static
  - .parse(input) ⇒ DIDUrl
  - .fromJSON(json) ⇒ DIDUrl

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

Param	Type
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

Param	Type
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

Param	Type
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

Param	Type
segment	`string`

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

Param	Type
input	`string`

DIDUrl.fromJSON(json) ⇒ `DIDUrl`

Deserializes an instance from a JSON object.

Kind: static method of DIDUrl

Param	Type
json	`any`

DecodedJws

A cryptographically verified decoded token from a JWS.

Contains the decoded headers and the raw claims.

Kind: global class

DecodedJws
- .claims() ⇒ string
- .claimsBytes() ⇒ Uint8Array
- .protectedHeader() ⇒ JwsHeader
- .clone() ⇒ DecodedJws
- .toJSON() ⇒ any

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
- .protectedHeader() ⇒ JwsHeader
- .customClaims() ⇒ Record.<string, any> | undefined
- .intoCredential() ⇒ Credential

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
- .protectedHeader() ⇒ JwsHeader
- .intoPresentation() ⇒ Presentation
- .expirationDate() ⇒ Timestamp | undefined
- .issuanceDate() ⇒ Timestamp | undefined
- .audience() ⇒ string | undefined
- .customClaims() ⇒ Record.<string, any> | undefined

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

Disclosure
- new Disclosure(salt, claim_name, claim_value)
- instance
  - .disclosure() ⇒ string
  - .toEncodedString() ⇒ string
  - .toString() ⇒ string
  - .salt() ⇒ string
  - .claimName() ⇒ string | undefined
  - .claimValue() ⇒ any
  - .toJSON() ⇒ any
- static
  - .parse(disclosure) ⇒ Disclosure
  - .fromJSON(json) ⇒ Disclosure

new Disclosure(salt, claim_name, claim_value)

Param	Type
salt	`string`
claim_name	`string` \| `undefined`
claim_value	`any`

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

Param	Type
disclosure	`string`

Disclosure.fromJSON(json) ⇒ `Disclosure`

Deserializes an instance from a JSON object.

Kind: static method of Disclosure

Param	Type
json	`any`

DomainLinkageConfiguration

Note:

Only the JSON Web Token Proof Format

Kind: global class

DomainLinkageConfiguration
- new DomainLinkageConfiguration(linkedDids)
- instance
  - .linkedDids() ⇒ Array.<Jwt>
  - .issuers() ⇒ Array.<CoreDID>
  - .toJSON() ⇒ any
  - .clone() ⇒ DomainLinkageConfiguration
- static
  - .fromJSON(json) ⇒ DomainLinkageConfiguration

new DomainLinkageConfiguration(linkedDids)

Constructs a new DomainLinkageConfiguration.

Param	Type
linkedDids	`Array.<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

Param	Type
json	`any`

Duration

A span of time.

Kind: global class

Duration
- instance
  - .toJSON() ⇒ any
- static
  - .seconds(seconds) ⇒ Duration
  - .minutes(minutes) ⇒ Duration
  - .hours(hours) ⇒ Duration
  - .days(days) ⇒ Duration
  - .weeks(weeks) ⇒ Duration
  - .fromJSON(json) ⇒ Duration

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

Param	Type
seconds	`number`

Duration.minutes(minutes) ⇒ `Duration`

Create a new Duration with the given number of minutes.

Kind: static method of Duration

Param	Type
minutes	`number`

Duration.hours(hours) ⇒ `Duration`

Create a new Duration with the given number of hours.

Kind: static method of Duration

Param	Type
hours	`number`

Duration.days(days) ⇒ `Duration`

Create a new Duration with the given number of days.

Kind: static method of Duration

Param	Type
days	`number`

Duration.weeks(weeks) ⇒ `Duration`

Create a new Duration with the given number of weeks.

Kind: static method of Duration

Param	Type
weeks	`number`

Duration.fromJSON(json) ⇒ `Duration`

Deserializes an instance from a JSON object.

Kind: static method of Duration

Param	Type
json	`any`

EdDSAJwsVerifier

An implementor of IJwsVerifier that can handle the EdDSA algorithm.

Kind: global class

EdDSAJwsVerifier
- new EdDSAJwsVerifier()
- .verify(alg, signingInput, decodedSignature, publicKey)

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

Param	Type
alg	`JwsAlgorithm`
signingInput	`Uint8Array`
decodedSignature	`Uint8Array`
publicKey	`Jwk`

IotaDID

A DID conforming to the IOTA DID method specification.

Kind: global class

IotaDID
- new IotaDID(bytes, network)
- instance
  - .network() ⇒ string
  - .tag() ⇒ string
  - .toCoreDid() ⇒ CoreDID
  - .scheme() ⇒ string
  - .authority() ⇒ string
  - .method() ⇒ string
  - .methodId() ⇒ string
  - .join(segment) ⇒ DIDUrl
  - .toUrl() ⇒ DIDUrl
  - .toAliasId() ⇒ string
  - .intoUrl() ⇒ DIDUrl
  - .toString() ⇒ string
  - .toJSON() ⇒ any
  - .clone() ⇒ IotaDID
- static
  - .METHOD ⇒ string
  - .DEFAULT_NETWORK ⇒ string
  - .fromAliasId(aliasId, network) ⇒ IotaDID
  - .placeholder(network) ⇒ IotaDID
  - .parse(input) ⇒ IotaDID
  - .fromJSON(json) ⇒ IotaDID

new IotaDID(bytes, network)

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

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

Param	Type
segment	`string`

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

Param	Type
aliasId	`string`
network	`string`

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

Param	Type
network	`string`

IotaDID.parse(input) ⇒ `IotaDID`

Parses a IotaDID from the input string.

Kind: static method of IotaDID

Param	Type
input	`string`

IotaDID.fromJSON(json) ⇒ `IotaDID`

Deserializes an instance from a JSON object.

Kind: static method of IotaDID

Param	Type
json	`any`

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

IotaDocument
- new IotaDocument(network)
- instance
  - .id() ⇒ IotaDID
  - .controller() ⇒ Array.<IotaDID>
  - .setController(controller)
  - .alsoKnownAs() ⇒ Array.<string>
  - .setAlsoKnownAs(urls)
  - .properties() ⇒ Map.<string, any>
  - .setPropertyUnchecked(key, value)
  - .service() ⇒ Array.<Service>
  - .insertService(service)
  - .removeService(did) ⇒ Service | undefined
  - .resolveService(query) ⇒ Service | undefined
  - .methods(scope) ⇒ Array.<VerificationMethod>
  - .insertMethod(method, scope)
  - .removeMethod(did) ⇒ VerificationMethod | undefined
  - .resolveMethod(query, scope) ⇒ VerificationMethod | undefined
  - .attachMethodRelationship(didUrl, relationship) ⇒ boolean
  - .detachMethodRelationship(didUrl, relationship) ⇒ boolean
  - .verifyJws(jws, options, signatureVerifier, detachedPayload) ⇒ DecodedJws
  - .pack() ⇒ Uint8Array
  - .packWithEncoding(encoding) ⇒ Uint8Array
  - .metadata() ⇒ IotaDocumentMetadata
  - .metadataCreated() ⇒ Timestamp | undefined
  - .setMetadataCreated(timestamp)
  - .metadataUpdated() ⇒ Timestamp | undefined
  - .setMetadataUpdated(timestamp)
  - .metadataDeactivated() ⇒ boolean | undefined
  - .setMetadataDeactivated(deactivated)
  - .metadataStateControllerAddress() ⇒ string | undefined
  - .metadataGovernorAddress() ⇒ string | undefined
  - .setMetadataPropertyUnchecked(key, value)
  - .revokeCredentials(serviceQuery, indices)
  - .unrevokeCredentials(serviceQuery, indices)
  - .clone() ⇒ IotaDocument
  - ._shallowCloneInternal() ⇒ IotaDocument
  - ._strongCountInternal() ⇒ number
  - .toJSON() ⇒ any
  - .toCoreDocument() ⇒ CoreDocument
  - .generateMethod(storage, keyType, alg, fragment, scope) ⇒ Promise.<string>
  - .purgeMethod(storage, id) ⇒ Promise.<void>
  - ~~.createJwt(storage, fragment, payload, options) ⇒ Promise.<Jws>~~
  - .createJws(storage, fragment, payload, options) ⇒ Promise.<Jws>
  - .createCredentialJwt(storage, fragment, credential, options, custom_claims) ⇒ Promise.<Jwt>
  - .createPresentationJwt(storage, fragment, presentation, signature_options, presentation_options) ⇒ Promise.<Jwt>
- static

new IotaDocument(network)

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

Param	Type
network	`string`

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

Param	Type
controller	`Array.<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

Param	Type
urls	`string` \| `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

Param	Type
key	`string`
value	`any`

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

Param	Type
service	`Service`

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

Param	Type
did	`DIDUrl`

iotaDocument.resolveService(query) ⇒ `Service` | `undefined`

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

Kind: instance method of IotaDocument

Param	Type
query	`DIDUrl` \| `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

Param	Type
scope	`MethodScope` \| `undefined`

iotaDocument.insertMethod(method, scope)

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

Kind: instance method of IotaDocument

Param	Type
method	`VerificationMethod`
scope	`MethodScope`

iotaDocument.removeMethod(did) ⇒ `VerificationMethod` | `undefined`

Removes all references to the specified Verification Method.

Kind: instance method of IotaDocument

Param	Type
did	`DIDUrl`

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

Param	Type
query	`DIDUrl` \| `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

Param	Type
didUrl	`DIDUrl`
relationship	`number`

iotaDocument.detachMethodRelationship(didUrl, relationship) ⇒ `boolean`

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

Kind: instance method of IotaDocument

Param	Type
didUrl	`DIDUrl`
relationship	`number`

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

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

Param	Type
jws	`Jws`
options	`JwsVerificationOptions`
signatureVerifier	`IJwsVerifier`
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

Param	Type
encoding	`number`

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

Param	Type
timestamp	`Timestamp` \| `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

Param	Type
timestamp	`Timestamp` \| `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

Param	Type
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

Param	Type
key	`string`
value	`any`

iotaDocument.revokeCredentials(serviceQuery, indices)

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

Kind: instance method of IotaDocument

Param	Type
serviceQuery	`DIDUrl` \| `string`
indices	`number` \| `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

Param	Type
serviceQuery	`DIDUrl` \| `string`
indices	`number` \| `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

Param	Type
storage	`Storage`
keyType	`string`
alg	`JwsAlgorithm`
fragment	`string` \| `undefined`
scope	`MethodScope`

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

Param	Type
storage	`Storage`
id	`DIDUrl`

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

Param	Type
storage	`Storage`
fragment	`string`
payload	`string`
options	`JwsSignatureOptions`

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

Param	Type
storage	`Storage`
fragment	`string`
payload	`string`
options	`JwsSignatureOptions`

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.

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

Kind: instance method of IotaDocument

Param	Type
storage	`Storage`
fragment	`string`
credential	`Credential`
options	`JwsSignatureOptions`
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.

Kind: instance method of IotaDocument

Param	Type
storage	`Storage`
fragment	`string`
presentation	`Presentation`
signature_options	`JwsSignatureOptions`
presentation_options	`JwtPresentationOptions`

IotaDocument.newWithId(id) ⇒ `IotaDocument`

Constructs an empty DID Document with the given identifier.

Kind: static method of IotaDocument

Param	Type
id	`IotaDID`

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

Param	Type
did	`IotaDID`
aliasOutput	`AliasOutputBuilderParams`
allowEmpty	`boolean`

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

Param	Type
network	`string`
block	`Block`

IotaDocument.fromJSON(json) ⇒ `IotaDocument`

Deserializes an instance from a plain JS representation.

Kind: static method of IotaDocument

Param	Type
json	`any`

IotaDocumentMetadata

Additional attributes related to an IOTA DID Document.

Kind: global class

IotaDocumentMetadata
- instance
  - .created() ⇒ Timestamp | undefined
  - .updated() ⇒ Timestamp | undefined
  - .deactivated() ⇒ boolean | undefined
  - .stateControllerAddress() ⇒ string | undefined
  - .governorAddress() ⇒ string | undefined
  - .properties() ⇒ Map.<string, any>
  - .toJSON() ⇒ any
  - .clone() ⇒ IotaDocumentMetadata
- static
  - .fromJSON(json) ⇒ IotaDocumentMetadata

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

Param	Type
json	`any`

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>
- .updateDidOutput(client, document) ⇒ Promise.<AliasOutputBuilderParams>
- .deactivateDidOutput(client, did) ⇒ Promise.<AliasOutputBuilderParams>
- .resolveDid(client, did) ⇒ Promise.<IotaDocument>
- .resolveDidOutput(client, did) ⇒ Promise.<AliasOutputBuilderParams>

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

Param	Type
client	`IIotaIdentityClient`
address	`Address`
document	`IotaDocument`
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

Param	Type
client	`IIotaIdentityClient`
document	`IotaDocument`

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

Param	Type
client	`IIotaIdentityClient`
did	`IotaDID`

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

Param	Type
client	`IIotaIdentityClient`
did	`IotaDID`

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

Fetches the IAliasOutput associated with the given DID.

Kind: static method of IotaIdentityClientExt

Param	Type
client	`IIotaIdentityClient`
did	`IotaDID`

Jwk

Kind: global class

Jwk
- new Jwk(jwk)
- instance
  - .kty() ⇒ JwkType
  - .use() ⇒ JwkUse | undefined
  - .keyOps() ⇒ Array.<JwkOperation>
  - .alg() ⇒ JwsAlgorithm | undefined
  - .kid() ⇒ string | undefined
  - .x5u() ⇒ string | undefined
  - .x5c() ⇒ Array.<string>
  - .x5t() ⇒ string | undefined
  - .x5t256() ⇒ string | undefined
  - .paramsEc() ⇒ JwkParamsEc | undefined
  - .paramsOkp() ⇒ JwkParamsOkp | undefined
  - .paramsOct() ⇒ JwkParamsOct | undefined
  - .paramsRsa() ⇒ JwkParamsRsa | undefined
  - .toPublic() ⇒ Jwk | undefined
  - .isPublic() ⇒ boolean
  - .isPrivate() ⇒ boolean
  - .toJSON() ⇒ any
  - .clone() ⇒ Jwk
- static
  - .fromJSON(json) ⇒ Jwk

new Jwk(jwk)

Param	Type
jwk	`IJwkParams`

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

Param	Type
json	`any`

JwkGenOutput

The result of a key generation in JwkStorage.

Kind: global class

JwkGenOutput
- new JwkGenOutput(key_id, jwk)
- instance
  - .jwk() ⇒ Jwk
  - .keyId() ⇒ string
  - .toJSON() ⇒ any
  - .clone() ⇒ JwkGenOutput
- static
  - .fromJSON(json) ⇒ JwkGenOutput

new JwkGenOutput(key_id, jwk)

Param	Type
key_id	`string`
jwk	`Jwk`

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

Param	Type
json	`any`

Jws

A wrapper around a JSON Web Signature (JWS).

Kind: global class

Jws
- new Jws(jws_string)
- .toString() ⇒ string

new Jws(jws_string)

Creates a new Jws from the given string.

Param	Type
jws_string	`string`

jws.toString() ⇒ `string`

Returns a clone of the JWS string.

Kind: instance method of Jws

JwsHeader

Kind: global class

JwsHeader
- new JwsHeader()
- instance
  - .alg() ⇒ JwsAlgorithm | undefined
  - .setAlg(value)
  - .b64() ⇒ boolean | undefined
  - .setB64(value)
  - .custom() ⇒ Record.<string, any> | undefined
  - .has(claim) ⇒ boolean
  - .isDisjoint(other) ⇒ boolean
  - .jku() ⇒ string | undefined
  - .setJku(value)
  - .jwk() ⇒ Jwk | undefined
  - .setJwk(value)
  - .kid() ⇒ string | undefined
  - .setKid(value)
  - .x5u() ⇒ string | undefined
  - .setX5u(value)
  - .x5c() ⇒ Array.<string>
  - .setX5c(value)
  - .x5t() ⇒ string | undefined
  - .setX5t(value)
  - .x5tS256() ⇒ string | undefined
  - .setX5tS256(value)
  - .typ() ⇒ string | undefined
  - .setTyp(value)
  - .cty() ⇒ string | undefined
  - .setCty(value)
  - .crit() ⇒ Array.<string>
  - .setCrit(value)
  - .url() ⇒ string | undefined
  - .setUrl(value)
  - .nonce() ⇒ string | undefined
  - .setNonce(value)
  - .toJSON() ⇒ any
  - .clone() ⇒ JwsHeader
- static
  - .fromJSON(json) ⇒ JwsHeader