DOCSEARCHbyAlgolia
Submit Docs

Veramo API Documentation

website·Indexed 33 days ago

https://veramo.io

Technical documentation for the Veramo framework, covering its API for decentralized identifiers (DID), key management systems (KMS), selective disclosure, and message handling. Includes detailed references for PeerDIDProvider, Web3KeyManagementSystem, and integration tools like Veramo React.

Tokens
209.5K
Snippets
1.5K
Records
2.2K
Agent score
67%

What's inside Veramo

  1. Overview of Veramo's Modular Architecture

    Veramo is designed as a flexible and modular framework for creating agents. It allows developers to create an agent, extend its functionality by adding plugins, and deploy it on either server or mobile environments. Additionally, Veramo agents can be exposed via a REST API for remote interaction.

  2. Overview of Veramo Agent Explorer

    The Agent Explorer is a developer dashboard and front-end for credential wallets designed to make it easier to browse, interact with, and validate Veramo APIs across multiple agents. It uses a modular, widget-based approach that allows developers to create custom dashboard widgets to surface technical information during feature development and data generation for experiments.

  3. Overview of the did-discovery package

    The did-discovery package provides a plugin for the Veramo Agent that adds support for discovering DIDs. Note that much of this API is currently in BETA and may change without a BREAKING CHANGE notice.

  4. Overview of the credential-w3c package

    The credential-w3c package provides functionality to handle W3C Verifiable Credentials and Presentations within a Veramo environment. It includes a plugin for the Veramo Agent that implements the ICredentialIssuer interface and a plugin for the MessageHandler to verify credentials and presentations received in messages.

  5. Overview of the data-store-json package

    The data-store-json package provides a Veramo agent plugin that implements the IDataStore and IDataStoreORM interfaces using a JSON tree as a backend. This backend can be persisted to any JSON-compatible media via a callback that triggers whenever agent data is updated.

  6. Overview of the kms-local package

    The kms-local package provides a libsodium-backed implementation of a Key Management System (KMS) and Secret Box. It is designed to work with the Veramo KeyManager to handle cryptographic operations and private key storage locally.

  7. Overview of the Veramo DID Agent

    The Veramo DID Agent is the primary entry point into the Veramo framework. It uses a modular plugin architecture to implement agent functionality, allowing it to scale and comply with various verifiable data standards while remaining flexible for application-layer development. The Agent acts as the main orchestrator for both core and custom plugins and manages the core event system. Key responsibilities include creating and resolving identifiers, as well as credential issuance, revocation, and exchange.

  8. Overview of the Veramo data-store package

    The data-store package provides TypeORM-backed plugins for the Veramo Agent. It implements the IDataStore and IDataStoreORM interfaces to handle persistent data storage. Specifically, it provides the KeyStore for use with the KeyManager and the DIDStore for use with the DIDManager.

  9. Overview of the Veramo selective-disclosure package

    The selective-disclosure package provides tools for implementing Selective Disclosure flows within Veramo. It includes a plugin for the Veramo Agent to handle the ISelectiveDisclosure interface and a plugin for the MessageHandler to detect and decode Selective Disclosure Requests (SDR) within messages.

  10. Overview of the Veramo Framework

    Veramo is a modular JavaScript framework designed to simplify the integration of cryptographically verifiable data into applications. It provides developers with tools to implement Decentralized Identifiers (DIDs), verifiable credentials, and data-centric protocols. The framework is built to be flexible and scalable, allowing developers to orchestrate custom systems using a variety of standards without being locked into a specific vendor or burdened by rapidly changing specifications.

  11. Overview of the Veramo message-handler package

    The message-handler package provides a plugin for the Veramo Agent that implements the IMessageHandler interface. It is designed to chain multiple IMessageHandler implementations together. When a message is processed, it is passed through the chain; each handler determines if it can interpret the message. If a handler successfully processes the message, it is returned as an IMessage. If no handler in the chain can process the message, an error is thrown.

  12. Use the IDIDComm interface for DIDComm messaging

    The IDIDComm interface is a plugin for the Veramo Agent that enables DID Communication (DIDComm) capabilities.

    Warning: This API is currently in beta preview and may change without a BREAKING CHANGE notice. It is not recommended for production environments.

    export interface IDIDComm extends IPluginMethodMap