API Reference

Packages

PackageDescription
@veramo/coreProvides Agent implementation and defines IResolver, IDIDManager, IKeyManager, IDataStore, IMessageHandler plugin interfaces
@veramo/credential-ldProvides a plugin for the Agent that implements ICredentialIssuerLD interface.This plugin adds support for working with JSON-LD credentials. When installed, this plugin will be automatically used by CredentialPlugin if the user requests the credential to be signed by one of the installed signature suites.
@veramo/credential-status
@veramo/credential-w3cProvides a plugin for the Agent that implements ICredentialIssuer interface.Provides a plugin for the MessageHandler that verifies Credentials and Presentations in a message.
@veramo/data-storeTypeORM backed plugins. Agent plugin that implements IDataStore interface. Agent plugin that implements IDataStoreORM interface. Provides KeyStore for KeyManager and DIDStore for DIDManager
@veramo/data-store-jsonAgent plugin that implements IDataStore and IDataStoreORMinterfaces and uses a JSON tree as a backend.The JSON tree backend can be persisted to any JSON compatible media using a callback that gets called when the agent data is updated.
@veramo/did-commProvides a plugin for the Agent that implements IDIDComm interface. Provides a plugin for the MessageHandler that decrypts messages.
@veramo/did-discoveryProvides a plugin for the Agent
@veramo/did-jwtProvides a plugin for the MessageHandler that finds and verifies a JWT in a message.
@veramo/did-managerProvides a plugin for the Agent that implements IDIDManager interface.
@veramo/did-provider-ethrProvides did:ethr identifier provider for the DIDManager
@veramo/did-provider-keyProvides did:key identifier provider for the DIDManager
@veramo/did-provider-webProvides did:web identifier provider for the DIDManager
@veramo/did-resolverProvides a plugin for the Agent that implements IResolver interface.
@veramo/key-managerProvides a plugin for the Agent that implements IKeyManager interface
@veramo/kms-localProvides a libsodium backed key management system and secret box for the KeyManager
@veramo/kms-web3Provides a web3 wallet backed key management system for the KeyManager
@veramo/message-handlerProvides a plugin for the Agent that implements IMessageHandler interface.
@veramo/remote-clientProvides a plugin for the Agent that can proxy method execution over HTTPS
@veramo/remote-serverExpress router for exposing @veramo/remote-client OpenAPI schema
@veramo/selective-disclosureProvides a plugin for the Agent that implements SelectiveDisclosure interface.Provides a plugin for the MessageHandler that detects Selective Disclosure Request in a message
@veramo/url-handlerProvides a plugin for the MessageHandler that can extract a raw message from a URL query string or by fetching.
@veramo/utilsContains helper methods for Veramo plugins.