Skip to content

Latest commit

 

History

History
112 lines (76 loc) · 3.83 KB

README.md

File metadata and controls

112 lines (76 loc) · 3.83 KB
Raw


ColoredCoins
BankBox

ColoredCoins desktop wallet application for digital currency issuance and management.

slack

BankBox is a desktop client of the ColoredCoins protocol on top of the Bitcoin blockchain.
It utilizes ColoredCoins full-node, which in its turn is dependant on Bitcoin-Core, the Bitcoin reference client.
It downloads and maintains a copy of the blockchain locally, coupled with parsed ColoredCoins assets layer of ColoredCoins colored transactions - so it keeps the protocol true peer-to-peer with no dependance on external servers.

Note: A ColoredCoins transaction, just as any other Bitcoin transaction, require some Bitcoins to be transferred with it. Since the BankBox gives full control to the user, it's up to the BankBox client to finance the ColoredCoins transactions.

If you would like to deep dive to our programmatic Node.js (and browser) API for issuance and transfer of digital assets, go to Getting started with ColoredCoins SDK.

       

Prerequisites

Windows installer will download these dependencies for you, but for other OS they should be installed separately.

Install

Download the latest version of BankBox from the GitHub releases page (currently available for windows)

OR

You can run from source.
First you need to download the prerequisites mentioned above, and then use the instructions in the "How to Contribute" section.

Screenshots

screenshot

screenshot

Configuration

BankBox comes with default properties - such as the Bitcoin network (mainnet or testnet), default transaction fee and the configuration for the ColoredCoins full-node server, Bitcoin-Core daemon and Redis.
BankBox properties.conf can be found and edited in:
%APPDATA%\BankBox (windows)
ColoredCoins full-node properties.conf:
%APPDATA%\coloredcoins-full-node (windows)

How to Contribute

Get the code

$ git clone https://github.com/Colored-Coins/BankBox.git
$ cd BankBox
$ npm install

Run the app

$ npm start

Watch the code

Restart the app automatically every time code changes. Useful during development.

$ npm run watch

Package the app

Builds app binaries. Currently, only Windows is available.

$ npm run package -- [options]

For [options] the following optional arguments are available:

  • --sign - Sign the application
  • --package=[type] - Package single output type.
    • exe - Windows installer
    • portable - Windows portable app
    • all - All available package options

Support

You can find support at our Slack channel, or e-mail us to contact@coloredcoins.org.

License

AGPL-3.0