Skip to main content

remote-client package

Provides a plugin for the Agent that can proxy method execution over HTTPS

Classes

ClassDescription
AgentRestClient

This plugin can be used to access the methods of a remote Veramo agent as if they were implemented locally.

The remote agent should be provided by AgentRouter, or a similar implementation of this API.

The schema of the remote agent is usually provided by ApiSchemaRouter.

Functions

FunctionDescription
getOpenApiSchema(agent, basePath, exposedMethods, name, version)This method can be used to generate an OpenAPIv3 schema to describe how the methods of a Veramo agent can be called remotely.