Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/colored-coins/colored-coins-sdk

Colored-Coins SDK for issuing and transferring digital assets using blockchain technology
https://github.com/colored-coins/colored-coins-sdk

Last synced: 2 months ago
JSON representation

Colored-Coins SDK for issuing and transferring digital assets using blockchain technology

Host: GitHub
URL: https://github.com/colored-coins/colored-coins-sdk
Owner: Colored-Coins
Created: 2017-02-08T14:57:13.000Z (almost 8 years ago)
Default Branch: master
Last Pushed: 2017-06-04T22:41:55.000Z (over 7 years ago)
Last Synced: 2024-04-28T22:20:17.493Z (10 months ago)
Language: JavaScript
Size: 2.78 MB
Stars: 21
Watchers: 9
Forks: 25
Open Issues: 5
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

        # Colored-Coins SDK

[![Build Status](https://travis-ci.org/Colored-Coins/colored-coins-sdk.svg?branch=master)](https://travis-ci.org/Colored-Coins/colored-coins-sdk)

[![Coverage Status](https://coveralls.io/repos/github/Colored-Coins/colored-coins-sdk/badge.svg?branch=master)](https://coveralls.io/github/Colored-Coins/colored-coins-sdk?branch=master)

[![npm version](https://badge.fury.io/js/coloredcoins-sdk.svg)](http://badge.fury.io/js/coloredcoins-sdk)

[![Slack channel](http://slack.coloredcoins.org/badge.svg)](http://slack.coloredcoins.org)

[![Standard - JavaScript Style Guide](https://cdn.rawgit.com/feross/standard/master/badge.svg)](https://github.com/feross/standard)

Easy to use SDK for issuing and transferring digital assets using [Colored-Coins protocol](https://github.com/Colored-Coins/Colored-Coins-Protocol-Specification) on top of blockchain technology.

Coupled with state-of-the-art [BIP32](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki) & [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) hierarchical deterministic wallet to hold your assets.

## Installation

```sh

$ npm i coloredcoins-sdk

```

## Usage

```js

var ColoredCoins = require('coloredcoins-sdk')

var cc = new ColoredCoins()

cc.init(function (err) {

  // Colored-Coins SDK is now ready

})

```

## Testing

```shell

$ 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](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki) path m/44'/0'/0'/0/0 for mainnet (m/44'/1'/0'/0/0 for tetsnet) has enough Bitcoins (or testnet-coins):

```shell

$ cd /path/to/coloredcoins-sdk

$ echo '{"network":"testnet", "privateSeed":"YourPrivateSeed"}' >> test/settings.json

$ mocha

```

## License

[Apache-2.0](http://www.apache.org/licenses/LICENSE-2.0)