This is pre-alpha software and only intended for use on Bitcoin Testnet. Please use at your own risk. Expect breaking changes.
- ⚙️ Installation
- ⚡️ Setup & Connect
- 🧰 Methods
- Get Connection Info (obdapi.getInfo)
- Get Funding Address (obdapi.getFundingAddress)
- Get Connect URI (obdapi.getConnectUri)
- Parse Connect URI (parseOmniboltUri)
- Create Channel (obdapi.createChannel)
- Get Omnibolt Channels (obdapi.getMyChannels)
- Send Asset (obdapi.sendOmniAsset)
- Close Channel (obdapi.closeChannel)
- Get Asset Info By ID (obdapi.getProperty)
- 📖 API Documentation
- 🤖 Debugging Tool
- 📝️ License [MIT]
yarn add https://github.com/synonymdev/omnibolt-js.git
or
npm i -S https://github.com/synonymdev/omnibolt-js.git
import { ObdApi } from "omnibolt-js";
import { defaultDataShape } from "omnibolt-js/lib/shapes.js";
import { parseOmniboltUri } from "omnibolt-js/src/utils";
import storage from 'node-persist';
import WebSocket from 'ws';
await storage.init();
// This is the passphrase used to login to the omnibolt server.
const loginPhrase = 'snow evidence basic rally wing flock room mountain monitor page sail betray steel major fall pioneer summer tenant pact bargain lucky joy lab parrot';
/*
This is the mnemonic phrase used for signing and transferring
assets and should be stored securely and separately
from the other data.
*/
const mnemonic = 'table panda praise oyster benefit ticket bonus capital silly burger fatal use oyster cream feel wine trap focus planet sail atom approve album valid';
// Omnibolt server to connect to.
const url = '62.234.216.108:60020/wstest';
const selectedNetwork = 'bitcoinTestnet'; //'bitcoin' | 'bitcoinTestnet'
/*
This is used to save the address signing data.
It keeps track of funds and the next available
addresses for signing.
*/
const saveData = async (data) => {
await storage.setItem('omnibolt', JSON.stringify(data));
console.log('Data saved...', data);
};
/*
This method is used to retrieve the previously stored
data from the "saveData" method in your application.
If no data is available, just pass in an empty object {} or the defaultDataShape object.
*/
const getData = async (key = 'omnibolt') => {
try {
return JSON.parse(await storage.getItem(key)) ?? { ...defaultDataShape };
} catch {
return { ...defaultDataShape };
}
}
// Retrieve data, if any.
const data = await getData();
// Create OBD instance.
const obdapi = new ObdApi({ websocket: WebSocket });
// Connect to the specified server and setup env params.
const connectResponse = await obdapi.connect({
loginPhrase,
mnemonic,
url,
selectedNetwork,
saveData,
data,
});
if (connectResponse.isErr()) {
console.log(connectResponse.error.message);
return;
}
const info = obdapi.getInfo();
This is the address used to fund a given channel with Bitcoin and Omni assets.
const fundingAddress = await obdapi.getFundingAddress({ index: 0 });
This method returns a string that provides the information necessary for others to connect and open channels to you.
const connectUri = obdapi.getConnectUri();
if (connectUri.isErr()) {
console.log(connectUri.error.message);
return;
}
console.log(connectUri.value);
This helper method parses a provided omnibolt uri. In this case, we're parsing the connect uri string where it will provide us with the given action ("connect") along with the embedded data that's expected with a connect action ("remote_node_address" & "recipient_user_peer_id").
const parsedConnectUri = parseOmniboltUri(connectUri);
if (parsedConnectUri.isErr()) {
console.log(parsedConnectUri.error.message);
return;
}
const { action } = parsedConnectUri.value;
const { remote_node_address, recipient_user_peer_id } = parsedConnectUri.value.data;
There are three pre-requisites to successfully create, fund and open an omnibolt channel:
- The peer you're attempting to open a channel with must be online.
- The funding address must have a sufficient Bitcoin balance in order to cover the fees for channel opening (amount_to_fund + miner_fee) * 3.
- The funding address must have a balance of the specified omni asset (
asset_id) greater than the amount you intend to create a channel with (asset_amount).
In the following example, we're assuming that the fundingAddressIndex of 0 has a Bitcoin balance greater than (0.0001 + 0.00005) * 3 and an omni asset balance >= 5.
const createChannelResponse = await obdapi.createChannel({
remote_node_address,
recipient_user_peer_id,
info: {
fundingAddressIndex: 0,
asset_id: 137,
asset_amount: 5,
amount_to_fund: 0.0001,
miner_fee: 0.00005,
},
});
if (createChannelResponse.isErr()) {
console.log(createChannelResponse.error.message);
} else {
console.log(createChannelResponse.value);
}
const channelResponse = await obdapi.getMyChannels();
await obdapi.sendOmniAsset({
channelId,
amount,
recipient_node_peer_id,
recipient_user_peer_id,
});
await obdapi.closeChannel(
recipient_node_peer_id,
recipient_user_peer_id,
channelId,
);
const id = '137';
const assetInfo = await obdapi.getProperty(id);