README
@hyperledger/identus-sdk v7.0.0
@hyperledger/identus-sdk / overview / Domain
Domain
Namespaces
| Namespace | Description |
|---|---|
| AgentError | - |
| ApolloError | - |
| Backup | - |
| CastorError | - |
| CommonError | - |
| DIDDocument | - |
| ExportableKey | Declaration merge to contain key conversion functions |
| ImportableKey | - |
| JWK | JWK definitions based on https://www.iana.org/assignments/jose/jose.xhtml |
| JWT | - |
| MercuryError | - |
| Message | - |
| Models | - |
| PEM | - |
| Pluto | - |
| PlutoError | - |
| PolluxError | - |
| Protocols | - |
| Schema | - |
| Startable | Define controls for managing entity lifecycle. |
| StorableKey | - |
Enumerations
| Enumeration | Description |
|---|---|
| CredentialType | - |
| Curve | - |
| JWT_ALG | - |
| KeyProperties | - |
| KeyTypes | - |
| MessageDirection | - |
Classes
| Class | Description |
|---|---|
| ApiError | - |
| ApiRequest | - |
| ApiResponse | - |
| AttachmentDescriptor | - |
| 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 |
| DerivableKey | - |
| DID | Storable define properties a Domain object must implement to be compatible with Pluto |
| DIDDocument | - |
| DIDPair | - |
| DIDResolver | - |
| DIDUrl | - |
| 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 |
| PrismDID | - |
| PrivateKey | Storable define properties a Domain object must implement to be compatible with Pluto |
| PublicKey | - |
| SignableKey | - |
| VerifiableKey | - |
Interfaces
| Interface | Description |
|---|---|
| Api | Api Dependency |
| Apollo | - |
| AttachmentBase64 | - |
| AttachmentHeader | - |
| AttachmentJws | - |
| AttachmentJwsData | - |
| AttachmentLinkData | - |
| Castor | - |
| 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 |
| 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 | - |
Type Aliases
| Type Alias | Description |
|---|---|
| AttachmentData | - |
| AttachmentJsonData | - |
| Claim | - |
| ExportableKey | ExportableKey defines the formats a crypographic key can be converted to Default is all |
| HttpMethod | - |
| JsonString | - |
| JWK | JWK |
| MnemonicWordList | - |
| PresentationClaims | - |
| Schema | - |
| W3CVerifiableCredential | - |
| W3CVerifiablePresentation | - |
| W3CVerifiablePresentationProof | - |
Variables
| Variable | Description |
|---|---|
| credential | - |
| did | - |
| didpair | - |
| key | - |
| linksecret | - |
| mediator | - |
| message | - |
| Schema | - |