Colored-Coins SDK for issuing and transferring digital assets using blockchain technology
JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
client
lib
src
test
.babelrc
.gitignore
.travis.yml
README.md
package.json

README.md

Colored-Coins SDK

Build Status Coverage Status npm version Slack channel

Standard - JavaScript Style Guide

Easy to use SDK for issuing and transferring digital assets using Colored-Coins protocol on top of blockchain technology. Coupled with state-of-the-art BIP32 & BIP44 hierarchical deterministic wallet to hold your assets.

Installation

$ npm i coloredcoins-sdk

Usage

var ColoredCoins = require('coloredcoins-sdk')
var cc = new ColoredCoins()
cc.init(function (err) {
  // Colored-Coins SDK is now ready
})

Testing

$ mocha

Note: without some configuration, some tests (all those which actually need funding) will fail.
In order for all the tests to pass, you'll need to have some funds, i.e. Bitcoins (or testnet-coins when network is 'testnet').
Do this by creating a JSON file, which includes privateSeed \ mnemonic where which the address in the BIP44 path m/44'/0'/0'/0/0 for mainnet (m/44'/1'/0'/0/0 for tetsnet) has enough Bitcoins (or testnet-coins):

$ cd /path/to/coloredcoins-sdk
$ echo '{"network":"testnet", "privateSeed":"YourPrivateSeed"}' >> test/settings.json
$ mocha

License

Apache-2.0