Overview
@hyperledger/identus-sdk v8.0.0
@hyperledger/identus-sdk / overview
overview
Namespaces
| Namespace | Description |
|---|---|
| Connection | - |
| DIDLink | Declaration merge to group Types |
| Domain | - |
| PeerDID | - |
| Plugins | - |
| Pluto | Pluto implementation |
Enumerations
| Enumeration | Description |
|---|---|
| JWT_VC_PROPS | - |
| JWT_VP_PROPS | - |
| ListenerKey | - |
| SDJWT_VP_PROPS | - |
| StorageType | Enumeration of built-in storage types supported by RIDB. |
| UpdateActionType | The kind of mutation an UpdateAction performs on a Prism DID. |
Classes
| Class | Description |
|---|---|
| Agent | Edge agent implementation |
| AgentBackup | - |
| AgentContext | - |
| ApiImpl | Implement API using built in fetch |
| Apollo | Apollo defines the set of cryptographic operations. |
| BackupManager | BackupManager handle the different versions of backup and restore |
| BaseRepository | BaseRepository |
| CancellableTask | - |
| Castor | Castor is a powerful and flexible library for working with DIDs. Whether you are building a decentralised application or a more traditional system requiring secure and private identity management, Castor provides the tools and features you need to easily create, manage, and resolve DIDs. |
| ConnectionsManager | ConnectionsManager is responsible for handling Connections and Mediators |
| CreatePeerDID | Task class for creating and storing new peer DIDs. |
| - | |
| CreatePrismDIDWithKeys | Handle the creation of a PrismDID |
| CredentialMetadataRepository | MapperRepository |
| CredentialRepository | MapperRepository |
| DIDCommDIDResolver | Bridges the SDK's Castor DID resolution to the DIDComm library's DIDResolver interface. |
| DIDCommSecretsResolver | Bridges the SDK's key storage (Pluto) to the DIDComm library's SecretsResolver interface. |
| DIDKeyLinkRepository | LinkRepository |
| DIDLinkRepository | LinkRepository |
| DIDRepository | MapperRepository |
| EventsManager | An extension for the Edge agent that gives it capability of creating listeners for specific events and also emitting or notifying any listener available with the new event. |
| ForwardMessage | - |
| FromJWK | - |
| JobManager | - |
| JWT | - |
| JWTCredential | Storable define properties a Domain object must implement to be compatible with Pluto |
| KeyRepository | MapperRepository |
| LinkRepository | LinkRepository |
| LinkSecretRepository | MapperRepository |
| MapperRepository | MapperRepository |
| Mercury | Mercury is a powerful and flexible library for working with decentralized identifiers and secure communications protocols. Whether you are a developer looking to build a secure and private messaging app or a more complex decentralized system requiring trusted peer-to-peer connections, Mercury provides the tools and features you need to establish, manage, and secure your communications easily. |
| MessageRepository | MapperRepository |
| PeerDID | - |
| PeerDIDMethod | DID method implementation for did:peer (algorithm 2). |
| PeerDIDService | Provides functionality to transfrom peerDIDServices from our interfaces into DIDComm module ones |
| PKInstance | - |
| Plugin | Provide interface to augment the SDK. |
| PluginManager | - |
| Pluto | Orchestration layer for SDK persistence. |
| PrismDIDMethod | DID method implementation for did:prism. |
| PrismKeyPathIndexTask | - |
| SDJWT | - |
| SDJWTCredential | Storable define properties a Domain object must implement to be compatible with Pluto |
| SignWithDID | - |
Interfaces
| Interface | Description |
|---|---|
| Args_RequestCredentialJWT | - |
| Args_RequestCredentialSDJWT | - |
| Claim | A single attribute within an Issuance. |
| CollectionMap | Maps every known table name to its corresponding Model interface. |
| Connection | Define the structure of a Connection |
| CreatePeerDIDArgs | Arguments for creating a new peer DID |
| CreatePrismDIDArgs | - |
| Credential | Definition for Storable Credential model Represents Credential |
| CredentialMetadata | Definition for CredentialMetadata model Represents CredentialMetadata |
| Ctor | Constructor for T |
| DID | Definition for DID model Represents DID |
| DIDCommProtocol | - |
| DIDKeyLink | Definition for DID -> Key relationships |
| DIDLink | Definition for DID -> DID relationships |
| ForwardMessageBody | - |
| FromJWKArgs | - |
| IArgs | RunProtocol exists to bridge the gap between the strong coupling to DIDComm messages and abstracting to Protocols |
| IBackupTask | - |
| IRestoreTask | - |
| Issuance | Model for credential issuance records. |
| JWTCredentialPayload | - |
| JWTPresentationPayload | - |
| Key | Definition for Key model Represents PrivateKey |
| Logger | - |
| Message | Definition for Message model Represents Message |
| PeerDIDEncoded | - |
| PKInstanceArgs | - |
| PrismKeyPathIndexArgs | Task to find the latest Prism DID KeyPathIndex |
| SchemaGenerator | Builder interface used inside schemaFactory callbacks to declaratively define a Model's schema. |
| Settings | Model for persisting arbitrary key-value settings. |
| SignWithDIDArgs | Asyncronously sign with a DID |
Type Aliases
| Type Alias | Description |
|---|---|
| AddKeyActionData | Add a new public key to the DID Document. |
| AddServiceActionData | Add a new service to the DID Document. |
| AgentOptions | - |
| Args_CredentialIssue | - |
| Args_CredentialOffer | - |
| Args_Message | - |
| Args_PresentationRequest | - |
| Args_PresentationVerify | - |
| Args_RequestCredential | - |
| Args_RevocationCheck | - |
| Args_Unknown | - |
| Arrayable | T is either an Array or a single item |
| BackupExclude | define Agent requirements for Backup |
| BackupOptions | - |
| BaseStorage | Abstract base-class for custom storage backends. |
| CollectionCreate | Descriptor for a single RIDB collection. |
| CollectionList | A dictionary of additional (user-defined) collections that can be merged into the default set via makeCollections. |
| Collections | Typed map of all RIDB collections as returned by makeCollections. |
| CollectionSchemas | Maps each collection name to its concrete SchemaType. |
| ConnectionEventArg | - |
| CreateOptions | Options for creating a Pluto instance via Pluto.create. |
| CreatePayload | Options for creating a new Prism DID. |
| CreatePayloadOf | Extract the create payload type from a DID method instance type. |
| CreatePrismDIDWithKeysArgs | - |
| DeactivatePayload | Options for deactivating a Prism DID. |
| DeactivatePayloadOf | Extract the deactivate payload type from a DID method instance type. Resolves to never when the method does not support deactivating. |
| DefaultDIDMethods | Tuple of DID methods Castor always registers by default. User-supplied extras are appended to this tuple. |
| DIDKeys | Optional private-key map for DID creation, keyed by usage name. Every usage except MASTER_KEY is optional and holds an array of PrivateKey instances. |
| DIDMethod | Core abstraction for a pluggable DID method. |
| DIDMethodOperation | Generic wrapper for the return value of lifecycle operations (publish, update, deactivate). By default it resolves to TMetadata itself, but the second type parameter can override the concrete result type. |
| EventCallback | - |
| EventCallbacks | - |
| JsonObj | Construct a Type with a set of string Keys of type T |
| LogLevel | - |
| MasterKey | - |
| MessageEventArg | - |
| Metadata | Serialised Atala object bytes returned after a publish operation. |
| MetadataOf | Extract the metadata type returned by the lifecycle operations of a DID method instance type. Uses publish as the canonical source. |
| MethodMapOf | Build a { methodName: MethodInstance } map from a tuple of DID method instances. When multiple entries share the same method name, later entries override earlier ones (so user-supplied extras can replace the built-in prism / peer implementations at the type level). |
| MethodNameOf | Extract the literal method name from a DID method instance type. Falls back to string when the method field is not a string literal. |
| Model | Base model type shared by every Pluto storable entity. |
| Nil | no value shorthand |
| Normalize | Flatten intersect to show single interface |
| OptionalId | - |
| PlutoRepositories | - |
| ProtocolType | Temporary workaround to smooth transition of internal module splitting and end-user consumables ProtocolType is a merging of all the supported ProtocolIds These have been split internally into Didcomm and OEA modules But we can hide that from our users until full support exists |
| PublishPayload | Options for publishing a Prism DID to the ledger. |
| PublishPayloadOf | Extract the publish payload type from a DID method instance type. Resolves to never when the method does not support publishing. |
| Query | Query type used by Pluto repositories. |
| QueryOptions | - |
| QueryType | - |
| RemoveKeyActionData | Remove an existing public key from the DID Document. |
| RemoveServiceActionData | Remove an existing service from the DID Document. |
| RequiredPrismDIDSecretKeys | Key map that requires a MASTER_KEY entry. Used as the payload for Prism DID creation where a master signing key is mandatory. |
| RevokeEventArg | - |
| SeedFunction | - |
| StartOptions | Options passed to createStore controlling how the database starts. |
| TableName | Union of all valid table names in the Pluto store. |
| Task | - |
| TypedSchema | Fully-typed RIDB schema derived from a Model interface T. |
| UpdateAction | A single, type-safe DID update action. |
| UpdatePayload | Options for updating a Prism DID. |
| UpdatePayloadOf | Extract the update payload type from a DID method instance type. Resolves to never when the method does not support updating. |
| UpdateServiceActionData | Replace an existing service's type and/or endpoints. |
| WithId | - |
| WithOptions | Start options for the default RIDB-backed store. |
| WithStart | Start option that delegates database initialisation to a custom function. |
Variables
| Variable | Description |
|---|---|
| CredentialMetadataSchema | - |
| CredentialMigration | - |
| CredentialSchema | - |
| DIDKeyLinkSchema | - |
| DIDLinkSchema | - |
| DIDSchema | - |
| IssuanceSchema | RIDB schema for the Issuance model. Version 0 — claims stored as an encrypted array of objects. |
| KeyMigration | - |
| KeySchema | - |
| MessageMigration | - |
| MessageSchema | - |
| ProtocolType | - |
| SettingsSchema | RIDB schema for the Settings model. Version 0 — all fields required, value encrypted. |
| Utils | - |
Functions
| Function | Description |
|---|---|
| createStore | Create a default Pluto.Store backed by RIDB. |
| makeCollections | Build the complete map of Pluto collections. |
| repositoryFactory | Factory fn to instantiate all Repositories |