Pure JavaScript Potcoin Library for node.js and browsers
JavaScript
Latest commit 3c71d8a Jul 20, 2015 @potcoin Minor bug fix

README.md

PotcoinJS (potcoinjs-lib)

The pure JavaScript Potcoin library for node.js and browsers. A continued implementation of the original 0.1.3 version of BitcoinJS used by over a million wallet users; the backbone for almost all Bitcoin web wallets in production today.

PotcoinJS is a modified version of BitcoinJS 1.x. PotcoinJS is a javascript library that can handle most of the functionality necessary to build a Potcoin app. It contains routines to parse, convert, encode and decode various formats like base58check and wif, build transaction, and wrangle scripts. Most significantly, it does all the nasty ECDSA-cryptography heavy lifting necessary to sign and verify transactions.

However, PocoinJS does not talk to potcoin nodes or handle the blockchain in any way. That means, in order to create a wallet, your app will need to communicate with a potcoin node or blockchain (ex: potchain.net API) from which your app can retrieve unspent transaction outputs, propogate transactions and verify them.

Features

  • Clean: Pure JavaScript, concise code, easy to read.
  • Compatible: Works on Node.js and all modern browsers.
  • Powerful: Support for advanced features, such as multi-sig, HD Wallets.
  • Secure: Strong random number generation, PGP signed releases.
  • Principled: No support for browsers with crap RNG (IE < 11)
  • Standardized: Node community coding style, Browserify, Node's stdlib and Buffers.
  • Fast: Optimized code, uses typed arrays instead of byte arrays for performance.

Installation

npm install potcoinjs-lib

OR

Use the potcoinjs.min.js library for any browser

Setup

Node.js

var potcoin = require('potcoinjs-lib')

Browser

If you're familiar with how to use browserify, ignore this and proceed normally. These steps are advisory only and allow you to use the API to its full extent.

Browserify is assumed to be installed for these steps.

From your repository, create a foobar.js file

var foobar = {
  base58: require('bs58'),
  bitcoin: require('bitcoinjs-lib'),
  ecurve: require('ecurve'),
  BigInteger: require('bigi'),
  Buffer: require('buffer')
}

module.exports = foobar

Each of these included packages are seperate to potcoinjs-lib, and must be installed separately. They are however used in the potcoinjs-lib public API.

Using browserify, compile foobar.js for use in the browser:

$ browserify foobar.js -s foobar > foobar.js

You will then be able to load foobar.js into your browser, with each of the dependencies above accessible from the global foobar object.

NOTE: See our package.json for the currently supported version of browserify used by this repository.

Examples

Projects utilizing PotcoinJS

Contributors

Stefan Thomas is the inventor and creator of this BitcoinJS. His pioneering work made Bitcoin web wallets possible.

Since then, many people have contributed. Click here to see the comprehensive list.

Daniel Cousens, Wei Lu, JP Richardson and Kyle Drake lead the major refactor of the library from 0.1.3 to 1.0.0.

Potcoin is the maintaining entity for this PotcoinJS project.

Contributing

We are always accepting of Pull requests, but we do adhere to specific standards in regards to coding style, test driven development and commit messages.

Please make your best effort to adhere to these when contributing to save on trivial corrections.

Complementing Libraries

  • BIP39 - Mnemonic code for generating deterministic keys
  • BIP38 - Passphrase-protected private keys
  • BCoin - BIP37 / Bloom Filters / SPV client
  • insight - A bitcoin blockchain API for web wallets.

License

This library is free and open-source software released under the MIT license.

Copyright

BitcoinJS (c) 2011-2014 Bitcoinjs-lib contributors PotcoinJS (c) 2015 Potcoinjs-lib contributors Released under MIT license