README

@hyperledger/identus-sdk v7.0.0

---

@hyperledger/identus-sdk / overview

overview

Namespaces

Namespace	Description
Connection	-
DIDLink	Declaration merge to group Types
Domain	-
Payload	-
PeerDID	-
Plugins	-
Pluto	Pluto implementation
Utils	-

Enumerations

Enumeration	Description
AnonCredsCredentialProperties	-
JWT_VC_PROPS	-
JWT_VP_PROPS	-
ListenerKey	-
SDJWT_VP_PROPS	-

Classes

Class	Description
Agent	Edge agent implementation
AgentBackup	-
AgentContext	Context is provided to running tasks it optimistically provides access to Modules
AnonCredsCredential	Storable define properties a Domain object must implement to be compatible with Pluto
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
CreateOOBOffer	Task class for creating out-of-band (OOB) credential offer invitations.
CreateOOBPresentationRequest	Task class for creating out-of-band (OOB) presentation request invitations.
CreatePresentation	-
CreatePresentationRequest	-
CreatePrismDID	Handle the creation of a PrismDID
CredentialMetadataRepository	MapperRepository
CredentialRepository	MapperRepository
DIDCommWrapper	-
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	-
JobManager	-
JWT	used to enable Modules to propagate the Context and have access to runTask
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	-
PeerDIDService	Provides functionality to transfrom peerDIDServices from our interfaces into DIDComm module ones
PKInstance	A Task encapsulates a unit of work
Plugin	Provide interface to augment the SDK.
PluginManager	-
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.
RunProtocol	Find and execute a task registered by plugins for the given pid (protocol identifier)
SDJWT	used to enable Modules to propagate the Context and have access to runTask
SDJWTCredential	Storable define properties a Domain object must implement to be compatible with Pluto

Interfaces

Interface	Description
Args_RequestCredentialJWT	-
Args_RequestCredentialSDJWT	-
Connection	Define the structure of a Connection
CreateOOBOfferArgs	Arguments for creating an out-of-band (OOB) offer invitation
CreateOOBPresentationRequestArgs	Arguments for creating an out-of-band (OOB) presentation request invitation
CreatePresentationArgs	Asyncronously create a verifiablePresentation from a valid stored verifiableCredential This is used when the verified requests a specific verifiable credential, this will create the actual instance of the presentation which we can share with the verifier.
CreatePresentationRequestArgs	-
CreatePrismDIDArgs	-
Credential	Definition for Storable Credential model Represents Credential
CredentialMetadata	Definition for CredentialMetadata model Represents CredentialMetadata
DID	Definition for DID model Represents DID
DIDCommProtocol	-
DIDKeyLink	Definition for DID -> Key relationships
DIDLink	Definition for DID -> DID relationships
ForwardMessageBody	-
IArgs	RunProtocol exists to bridge the gap between the strong coupling to DIDComm messages and abstracting to Protocols
IBackupTask	-
IRestoreTask	-
JWTCredentialPayload	-
JWTPresentationPayload	-
Key	Definition for Key model Represents PrivateKey
Message	Definition for Message model Represents Message
Payload	General purpose struct to pass data around
PeerDIDEncoded	-
PKInstanceArgs	-
QueryOperators	-
SchemaGenerator	-

Type Aliases

Type Alias	Description
AgentOptions	-
Args_CredentialIssue	-
Args_CredentialOffer	-
Args_Message	-
Args_PresentationRequest	-
Args_PresentationVerify	-
Args_RequestCredential	-
Args_RevocationCheck	-
Args_Unknown	-
BackupAgent	define Agent requirements for Backup
BackupExclude	-
BackupOptions	-
CollectionCreate	-
CollectionList	-
ConnectionEventArg	-
EventCallback	-
EventCallbacks	-
ExtractModelProperties	-
ExtraResolver	-
InvitationType	-
Join	-
KeysFor	-
KeysOf	-
MasterKey	-
MessageEventArg	-
MigrationStrategies	-
MigrationStrategy	-
Model	Define common properties
ModelOptionalKeys	-
ModelPropertyNames	-
ModelRequiredKeys	-
OptionalId	-
OptionalKeys	-
OptionalTypeToSchemaType	-
Paths	-
PlutoRepositories	-
Prev	-
PropertyType	-
PropertyTypes	-
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
Query	Query type for Pluto
QueryNoLimit	-
QuerySelector	-
QuerySelectorAndIndex	-
QuerySortDirection	-
QuerySortPart	-
RequiredKeys	-
RequiredTypeToSchemaType	-
RevokeEventArg	-
RunProtocolArgs	-
StringKeys	-
Task	-
TaskContext	-
TypedSchema	-
WithId	-

Variables

Variable	Description
AnonCredsRecoveryId	-
CredentialMetadataSchema	-
CredentialMigration	-
CredentialSchema	-
DIDKeyLinkSchema	-
DIDLinkSchema	-
DIDSchema	-
JWTVerifiableCredentialRecoveryId	-
KeySchema	-
MessageSchema	-
ProtocolType	-
SDJWTVerifiableCredentialRecoveryId	-
Tasks	-

Functions

Function	Description
makeCollections	-
repositoryFactory	Factory fn to instantiate all Repositories
schemaFactory	helper for creating Schemas handle repetitive and improve type safety

References

BasicMessage

Re-exports BasicMessage

---

BasicMessageBody

Re-exports BasicMessageBody

---

CredentialFormat

Re-exports CredentialFormat

---

DIDCommConnection

Re-exports DIDCommConnection

---

HandshakeRequest

Re-exports HandshakeRequest

---

HandshakeRequestBody

Re-exports HandshakeRequestBody

---

IssueCredential

Re-exports IssueCredential

---

IssueCredentialBody

Re-exports IssueCredentialBody

---

KeyProperties

Re-exports KeyProperties

---

OfferCredential

Re-exports OfferCredential

---

OfferCredentialBody

Re-exports OfferCredentialBody

---

OutOfBandInvitation

Re-exports OutOfBandInvitation

---

OutOfBandInvitationBody

Re-exports OutOfBandInvitationBody

---

Presentation

Re-exports Presentation

---

PresentationBody

Re-exports PresentationBody

---

ProposePresentation

Re-exports ProposePresentation

---

ProposePresentationBody

Re-exports ProposePresentationBody

---

RequestCredential

Re-exports RequestCredential

---

RequestPresentation

Re-exports RequestPresentation

---

RequestPresentationBody

Re-exports RequestPresentationBody