Domain

Namespaces

Namespace	Description
AgentError	-
ApolloError	-
Backup	-
CastorError	-
CommonError	-
DIDDocument	-
ECConfig	-
ExportableKey	Declaration merge to contain key conversion functions
ImportableKey	-
JWK	JWK definitions based on https://www.iana.org/assignments/jose/jose.xhtml
JWT	-
MercuryError	-
Payload	-
PEM	-
Pluto	-
PlutoError	-
PolluxError	-
Protocols	-
Schema	-
Startable	Define controls for managing entity lifecycle.
StorableKey	-

Enumeration	Description
Curve	-
JWT_ALG	-
KeyProperties	-
KeyTypes	-
MessageDirection	-
Numalgo2Prefix	-
VerificationMaterialFormatDID	-

Class	Description
ApiError	-
ApiRequest	-
ApiResponse	-
AttachmentDescriptor	-
AxesArray	-
BaseVerificationMethod	-
Credential	Storable define properties a Domain object must implement to be compatible with Pluto
CredentialMetadata	Storable define properties a Domain object must implement to be compatible with Pluto
DeprecatedDerivationPath	-
DerivableKey	-
DerivationAxis	-
DerivationPathBase	-
DID	Storable define properties a Domain object must implement to be compatible with Pluto
DIDDocument	-
DIDPair	-
DIDResolver	-
DIDUrl	-
InvitationIsInvalidError	-
Key	-
KeyPair	-
LinkSecret	Storable define properties a Domain object must implement to be compatible with Pluto
Message	Storable define properties a Domain object must implement to be compatible with Pluto
PrismDerivationPath	-
PrismDID	-
PrivateKey	Storable define properties a Domain object must implement to be compatible with Pluto
PublicKey	-
SignableKey	-
ValidationError	-
VerifiableKey	-
VerificationMaterialAgreement	-
VerificationMaterialAuthentication	-
VerificationMaterialPeerDIDWithAgreement	-
VerificationMaterialPeerDIDWithAuthentication	-
VerificationMethodTypeAgreement	-
VerificationMethodTypeAuthentication	-

Interface	Description
Api	Api Dependency
Apollo	-
AttachmentBase64	-
AttachmentHeader	-
AttachmentJws	-
AttachmentJwsData	-
AttachmentLinkData	-
BaseSchema	-
Castor	Building block for creating, resolving, and managing Decentralized Identifiers across multiple DID methods.
Ctor	Constructor for T
KeyCurve	-
KeyRestoration	KeyRestoration protocol defines methods for verifying and restoring cryptographic keys from raw data.
Mediator	-
Mercury	-
Options	Factory options to customise export / import functions
Payload	General purpose struct to pass data around
Pluto	Pluto is a storage interface describing storage requirements of the edge agents which will be implemented using this SDK. Implement this interface using your preferred underlying storage technology, most appropriate for your use case.
ProvableCredential	-
Seed	-
SeedWords	-
Signature	-
StorableCredential	-
StorableKey	-
VerificationMaterialPeerDID	-
VerificationMethodTypeDID	-
VerificationMethodTypePeerDIDWithAgreement	-
VerificationMethodTypePeerDIDWithAuthentication	-

Type Alias	Description
Arrayable	T is either an Array or a single item
AttachmentData	-
AttachmentJsonData	-
Claim	-
DerivationClass	-
DerivationSchema	-
ExportableKey	ExportableKey defines the formats a crypographic key can be converted to Default is all
HttpMethod	-
JsonObj	Construct a Type with a set of string Keys of type T
JsonString	-
JWK	JWK
KeyOptions	-
MnemonicWordList	-
Nil	no value shorthand
Normalize	Flatten intersect to show single interface
OctetPublicKey	-
PrismDIDKeys	Maps PrismDIDKeyUsage member names to arrays of public keys. Used to assign keys to the correct verification relationships when creating a Prism DID.
PrismDIDKeyUsageType	-
RequiredKeys	-
RequiredPrismDIDKeys	-
Schema	-
VerificationMaterial	-
VerificationMaterialPeerDIDType	-

Variable	Description
AnonCredsRecoveryId	-
asJsonObj	-
credential	Schema definition for Backup V0.0.1
DeprecatedDerivationPathSchema	-
did	-
didpair	-
isArray	isArray Typeguard - check a value is an Array
isEmpty	isEmpty Logic - check a given value is considered empty empty depends on typeof value: - null - undefined - array: length = 0 - string: length = 0
isNil	isNullish Typeguard - check a value is undefined or null
isObject	isObject Typeguard - check a value is an object in the conceptual sense not the JS sense excluding JS overlap with: null Arrays Functions
isString	isString TypeGuard to check a value is a string
JWTVerifiableCredentialRecoveryId	-
key	-
linksecret	-
mediator	-
message	-
notEmptyString	notEmptyString Typeguard + Logic - check a value is a string with contents
notNil	notNil Typeguard - check a value is neither undefined or null
PRISM_DID_METHOD	-
PRISM_IDENTIFIER	-
PRISM_WALLET_PURPOSE	-
PrismDerivationPathSchema	-
PrismDIDKeyUsage	Mirrors `io.iohk.atala.prism.protos.KeyUsage` from the auto-generated protobuf code. Defined locally to keep the proto namespace (which contains ES `#private` fields) out of the DTS rollup graph — rollup-plugin-dts cannot handle `#private` inside namespace class declarations.
revocationJsonldDocuments	-
Schema	-
SDJWTVerifiableCredentialRecoveryId	-
validateSafe	validateSafe Typeguard - check a value matches a schema

Function	Description
asArray	asArray convert a value to an array
expect	expect assert a value is notNil and return the value typed as such panic otherwise
validate	validate Type assertion - assert a value matches a schema

Re-exports PeerDID