Veramo Core

Provides Agent implementation and defines IResolver , IDIDManager, IKeyManager, IDataStore, IMessageHandler plugin interfaces

Classes

Class	Description
Agent	Provides a common context for all plugin methods. This is the main entry point into the API of the DID Agent Framework. When plugins are installed, they extend the API of the agent and the methods they provide can all use the common context so that plugins can build on top of each other and create a richer experience.
ValidationError

Functions

Function	Description
createAgent(options)	Helper function to create a new instance of the Agent class with correct type

Interfaces

Interface	Description
EcdsaSignature
IAgent	Agent that can execute methods
IAgentBase	Agent base interface
IAgentContext	Standard plugin method context interface
IAgentOptions	Agent configuration options. This interface is used to describe the constellation of plugins that this agent will use and provide.You will use this to attach plugins, to setup overrides for their methods and to explicitly set the methods that this agent instance is allowed to call. This permissioning method is also used for internal calls made by plugin code.
IAgentPlugin	Agent plugin interface
IAgentPluginSchema	Agent plugin schema
IDataStore	Basic data store interface
IDataStoreGetMessageArgs	Input arguments for dataStoreGetMessage
IDataStoreGetVerifiableCredentialArgs	Input arguments for dataStoreGetVerifiableCredential
IDataStoreGetVerifiablePresentationArgs	Input arguments for dataStoreGetVerifiablePresentation
IDataStoreSaveMessageArgs	Input arguments for dataStoreSaveMessage
IDataStoreSaveVerifiableCredentialArgs	Input arguments for dataStoreSaveVerifiableCredential
IDataStoreSaveVerifiablePresentationArgs	Input arguments for dataStoreSaveVerifiablePresentation
IDIDManager	Identifier manager interface
IDIDManagerAddKeyArgs	Input arguments for didManagerAddKey
IDIDManagerAddServiceArgs	Input arguments for didManagerAddService
IDIDManagerCreateArgs	Input arguments for didManagerCreate
IDIDManagerDeleteArgs	Input arguments for didManagerDelete
IDIDManagerFindArgs	Input arguments for didManagerFind
IDIDManagerGetArgs	Input arguments for didManagerGet
IDIDManagerGetByAliasArgs	Input arguments for didManagerGetByAlias
IDIDManagerGetOrCreateArgs	Input arguments for didManagerGetOrCreate
IDIDManagerRemoveKeyArgs	Input arguments for didManagerRemoveKey
IDIDManagerRemoveServiceArgs	Input arguments for didManagerRemoveService
IDIDManagerSetAliasArgs	Input arguments for didManagerSetAlias
IEventListener	Describes a listener interface that needs to be implemented by components interested in listening to events emitted by an agent.
IHandleMessageArgs	Input arguments for handleMessage
IIdentifier	Identifier interface
IKey	Cryptographic key
IKeyManager	Key manager interface
IKeyManagerCreateArgs	Input arguments for keyManagerCreate
IKeyManagerDecryptJWEArgs	(BETA) Input arguments for keyManagerDecryptJWE
IKeyManagerDeleteArgs	Input arguments for keyManagerDelete
IKeyManagerEncryptJWEArgs	(BETA) Input arguments for keyManagerEncryptJWE
IKeyManagerGetArgs	Input arguments for keyManagerGet
IKeyManagerSignEthTXArgs	Input arguments for keyManagerSignEthTX
IKeyManagerSignJWTArgs	Input arguments for keyManagerSignJWT
IMessage	DIDComm message
IMessageHandler	Message handler interface
IMetaData	Message meta data
IPluginMethod	Agent plugin method interface
IPluginMethodMap	Plugin method map interface
IResolver	DID Resolver interface
IService	Identifier service
RemoveContext	Removes context parameter from plugin method interface
ResolveDidArgs	Input arguments for resolveDid
VerifiableCredential	Verifiable Credential https://github.com/decentralized-identifier/did-jwt-vc
VerifiablePresentation	Verifiable Presentation https://github.com/decentralized-identifier/did-jwt-vc
W3CCredential	W3CCredential https://github.com/decentralized-identifier/did-jwt-vc
W3CPresentation	W3CPresentation https://github.com/decentralized-identifier/did-jwt-vc

Variables

Variable	Description
CoreEvents	This collection defines the core event types.
schema

Type Aliases

Type Alias	Description
TAgent	Utility type for constructing agent type that has a list of available methods
TKeyType	Cryptographic key type