dollar.js - Bitdollar JavaScript API

This is the Bitdollar Javascript API which connects to Dollar protocol.

You need to run a local or remote Bitdollar node to use this library.

Installation

Node

npm install @bitdollar/dollar

Yarn

yarn add @bitdollar/dollar

Meteor

Note: works only in the Browser for now. (PR welcome).

meteor add bitdollar:dollar

In the Browser

Use the prebuild dist/dollar.min.js, or build using the dollar.js repository:

npm run-script build

Then include dist/dollar.js in your html file. This will expose Dollar on the window object.

Usage

// Currently only supporting use as vanilla JS
// Please move and use the dist/dollar-signer.min.js file.

// require('@bitdollar/dollar') only necessary for NodeJS
// var Dollar = require('@bitdollar/dollar');

// Moving dist/dollar.min.js to your folder and after starting dollar client,

var dollar = new Dollar(new Dollar.providers.HttpProvider('http://localhost:8545'));
console.log(dollar);

Additionally you can set a provider using dollar.setProvider() (e.g. WebsocketProvider)

dollar.setProvider('http://localhost:8545');
// Or
dollar.setProvider(new Dollar.providers.HttpProvider('http://localhost:8545'));

There you go, now you can use it:

dollar.btd.getAccounts()
.then(console.log);

Please note: If you have any issue with dollar.js please create an issue here.

Documentation

Documentation can be found at read the docs

Building

Requirements

• Node.js
• npm

sudo apt-get update
sudo apt-get install nodejs
sudo apt-get install npm

Building (gulp)

Build only the dollar.js package

npm run-script build

Or build all sub packages as well

npm run-script build-all

This will put all the browser build files into the dist folder.

Testing (mocha)

npm test

Contributing

• All contributions have to go into develop branch
• Please follow the code style of the other files.
• Please use 4 spaces as tabs.

Community

• Gitter
• Forum