package
ILP virtual ledger plugin for directly transacting connectors
npm install ilp-plugin-virtualGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
ILP virtual ledger plugin for directly transacting connectors
The current version of ilp-plugin-virtual is designed to be used in ILP
Kit. An HTTP server is required in
order to pass RPC calls to the plugin, and to perform authorization on RPC calls.
npm install --save ilp-plugin-virtualYou can test out the ledger plugin by running npm test on your machine. To
include debug information during the test, run DEBUG=ilp* npm test.
When instantiating the plugin, make sure to pass in an object with the right fields:
{
"maxBalance": "highest balance allowed",
"prefix": "prefix for ilp address",
"secret": "your secret. your peer must know the corresponding public key.",
"peerPublicKey": "base64url encoded public key of your peer",
"rpcUri": "https://example.com/rpc", // this is used to communicate with your peer (see below)
"_store": { /* this object will be created by the connector */ },
"info": { /* the object to be returned by getInfo */ }
}In order to use plugin virtual, you need an HTTP endpoint that passes calls to the plugin.
The url must take one query parameter (method), as well as a JSON body. The method parameter
and parsed body must be passed to the plugin like so:
plugin.receive(method, body)If you want to generate a trustline prefix from a secret key, peer's public key, and currency, you can access the method through the token class:
const Token = require('ilp-plugin-virtual/src/util/token')
const prefix = Token.prefix({
secretKey: 'o9Lt0oZFek1ArM_A0HUAq8M8edRuoSeLjX8i10sVUiY',
peerPublicKey: 'KRixgcBCBdyQln7IBYiopjuNO78QSFtXgOwP1sbsCSk',
currency: 'USD'
})bosbaber
dabatla@gmail.com
Estimated unpacked size across 36 packages.
2.8 MB
Includes dependencies.
9 direct · 8 outdated
^2.2.0
4.4.3
^1.0.0
2.0.3
^2.0.0
3.0.1
^0.14.5
1.0.3
^1.0.0
1.0.0
6.4.9
^6.0.0
8.0.2