Plugins

Functionality in Veramo is added to the agent via the plugin system. Writing and configuring plugins is where almost all of the custom work will happen when building applications on Veramo. Your custom plugins can just live in a directory, private repository or on npm where they can be shared with others. We encourage developers to follow some best practices when writing plugins to ensure we have an ecosystem of highly interoperable functions.

Plugins Architecture

This diagram shows the high level relationship between the core agent, interfaces, plugins and external protocols. This is one simple configuration of many.

img

Core Plugins

@veramo/did-manager

API Reference

@veramo/did-provider-ethr

API Reference

@veramo/did-provider-web

API Reference

@veramo/key-manager

API Reference

@veramo/kms-local

API Reference

@veramo/did-resolver

API Reference

@veramo/did-comm

API Reference

This plugin provides a method of creating an encrypted message according to the initial DIDComm-js implementation. See the API Reference for more info.

@veramo/did-jwt

API Reference

@veramo/message-handler

API Reference

@veramo/url-handler

API Reference

@veramo/selective-disclosure

API Reference

@veramo/credential-w3c

API Reference

@veramo/remote-server

API Reference

@veramo/data-store

API Reference

@veramo/remote-client

API Reference