xrpl-api
/
2.3.3
xrpl-api 2.3.3
Install from the command line:
Learn more about npm packages
$ npm install @bithomp/xrpl-api@2.3.3
Install via package.json:
"@bithomp/xrpl-api": "2.3.3"
About this version
A Bithomp JavaScript/TypeScript library for interacting with the XRP Ledger Library designed to be a single point of access to the XRP Ledger. It uses multiple connections to the XRP Ledger and selects the best one for the request. If the connection is lost, the library will automatically reconnect.
The library also supports the creation of a validator list.
In an existing project (with package.json), install @bithomp/xrpl-api:
# add github registry to .npmrc file for @bithomp packages
echo @bithomp:registry=https://npm.pkg.github.com >> .npmrc
# install package
$ npm install --save @bithomp/xrpl-apiconst BithompXRPL = require("@bithomp/xrpl-api");
// setup connection
const config = [
{
"url": "wss://xrplcluster.com",
"type": "regular,history,gateway_balances,last_close,manifest",
"connectionTimeout": 10000
},
{
"url": "wss://s2.ripple.com",
"type": "regular,history",
"connectionTimeout": 10000
},
{
"url": "wss://s1.ripple.com",
"type": "regular,clio",
"connectionTimeout": 10000
}
];
// Global setup for all connections, if you have multiple connections, like in example, the library will use them by type and(or) by better response time
BithompXRPL.Client.setup(config);
// connect to all servers
await BithompXRPL.Client.connect();
// send request
const accountInfo = await BithompXRPL.Client.getAccountInfo("rsuUjfWxrACCAwGQDsNeZUhpzXf1n1NK5Z");
// when complete, disconnect
BithompXRPL.Client.disconnect();Setup connection, it is required to get validators details from the ledger.
const BithompXRPL = require("@bithomp/xrpl-api");
// setup connection
const config = [
{
"url": "wss://xrplcluster.com",
"connectionTimeout": 10000
}
];
BithompXRPL.Client.setup(config);
// connect
await BithompXRPL.Client.connect();
// validator secrets
const vk = {
privateKey: "p__________________________",
publicKey: "ED________________________________",
};
// signing secrets
const sk = {
privateKey: "p__________________________",
publicKey: "03_______________________________",
};
// validator list, public addresses, they have to be avalable on the ledger for accessing to manifest
const validators = ["nHBidG3pZK11zQD6kpNDoAhDxH6WLGui6ZxSbUx7LSqLHsgzMPec"];
const sequence = 1; // sequence number
const expiration = 1696508603; // in unixtime (seconds)
const vl = await BithompXRPL.Client.createVL(vk, sk, sequence, expiration, validators);
// vl will contain the signed validator list with
// {
// "blob": "...",
// "manifest": "...", // signed with vk.privateKey and sk.privateKey
// "signature": "...", // signed with sk.privateKey
// "version": 1,
// "public_key": "..." // vk.publicKey
// }
// disconnect
BithompXRPL.Client.disconnect();