!npm
!CircleCI

Obyte.js

A pure and powerful JavaScript Obyte library.

Documentation

Getting started

To install and run Obyte.js, follow this quick start guide

$3

Obyte.js was designed to work both in the browser and in Node.js.

#### Node.js
To install Obyte.js on Node.js, open your terminal and run:
``
npm i obyte --save
`

#### Browser

You can create an index.html file and include Obyte.js with:

`html

`

$3

Ways to initiate WebSocket client:

`js
const obyte = require('obyte');

// Connect to mainnet official node 'wss://obyte.org/bb'
const client = new obyte.Client();

// Connect to a custom node
const client = new obyte.Client('wss://obyte.org/bb');

// Connect to testnet
const options = { testnet: true };
const client = new obyte.Client('wss://obyte.org/bb-test', options);
`

Close the client:
`js
client.close();
`

All API methods follow this pattern:
`js
// If the last argument is a function it is treated as a callback
client.api.getJoint('oj8yEksX9Ubq7lLc+p6F2uyHUuynugeVq4+ikT67X6E=', function(err, result) {
console.log(err, result);
});

// If a callback is not provided, a Promise is returned
client.api.getJoint('oj8yEksX9Ubq7lLc+p6F2uyHUuynugeVq4+ikT67X6E=').then(function(result) {
console.log(result);
});
`

$3

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:

Generate a random address

Sending a payment:
`js
const wif = '5JBFvTeSY5...'; // WIF string generated (private key)

const params = {
outputs: [
{
address: 'NX2BTV43XN6BOTCYZUUFU6TK7DVOC4LU', // The Obyte address of the recipient
amount: 1000 // The amount he receives
}
]
};

client.post.payment(params, wif, function(err, result) {
console.log(result); // The unit hash is returned
});
``

License

MIT.