Obyte.js was designed to work both in the browser and in Node.js.
To install Obyte.js on Node.js, open your terminal and run:
npm i obyte --save
You can create an index.html file and include Obyte.js with:
<script src="https://cdn.jsdelivr.net/npm/obyte"></script>
Ways to initiate WebSocket client:
const obyte = require('obyte');// Connect to mainnet official node 'wss://obyte.org/bb'const client = new obyte.Client();// Connect to a custom nodeconst client = new obyte.Client('wss://obyte.org/bb');// Connect to testnetconst options = { testnet: true };const client = new obyte.Client('wss://obyte.org/bb-test', options);
Close the client:
client.close();
All API methods follow this pattern:
// If the last argument is a function it is treated as a callbackclient.api.getJoint('oj8yEksX9Ubq7lLc+p6F2uyHUuynugeVq4+ikT67X6E=', function(err, result) {console.log(err, result);});// If a callback is not provided, a Promise is returnedclient.api.getJoint('oj8yEksX9Ubq7lLc+p6F2uyHUuynugeVq4+ikT67X6E=').then(function(result) {console.log(result);});
To compose and post unit you need first to create a Obyte wallet and fund it with the native currency ‘bytes’. The generated WIF will be used on Obyte.js. Click on the link below to learn more:
Sending a payment:
const wif = '5JBFvTeSY5...'; // WIF string generated (private key)const params = {outputs: [{address: 'NX2BTV43XN6BOTCYZUUFU6TK7DVOC4LU', // The Obyte address of the recipientamount: 1000 // The amount he receives}]};client.post.payment(params, wif, function(err, result) {console.log(result); // The unit hash is returned});