🌐💰 SPV Bitcoin client for Node.js and the browser
Clone or download
Pull request Compare This branch is 17 commits behind mappum:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
bin
img
lib
test
.gitignore
.travis.yml
README.md
index.js
package.json

README.md

Webcoin

A Bitcoin client for Node.js and the browser

Build Status Dependency Status npm version Join the chat at https://gitter.im/mappum/webcoin


Webcoin is a Bitcoin client that works in Node.js and the browser. In the browser, it uses WebRTC to make P2P connections rather than relying on a centralized server to get data (like all the other JS Bitcoin libraries). It's kind of like the Bitcoin equivalent of WebTorrent.

You can use Webcoin to add Bitcoin payments to your application, without the need to hold your users' funds, and without making them trust any third-parties with their money. Webcoin is an SPV light client, so it only uses a minimal amount of bandwidth and storage; it even works great on mobile devices!

Status

Much of Webcoin is already written and works well, including:

  • Downloading block headers from peers
  • Verifying block headers
  • Creating HD wallets
  • Filtering transactions with Bloom filters
  • Detecting incoming transactions confirmed in blocks

I am currently making some major refactors to the codebase, and documenting all of it. Much of the code in this repo is being broken out into smaller modules, each with comprehensive tests and docs.

Modules

Webcoin is made up of many small modules, most of which can each be used independently.

module version tests issues description
webcoin SPV Bitcoin client for Node and the browser (this module)
peer-exchange Decentralized p2p signalling and discovery
blockchain-spv Stores blockchain headers and verifies with SPV
bitcoin-util Utility functions for Bitcoin hashes and targets
bitcoin-merkle-proof Verify bitcoin Merkle proofs
bitcoin-filter Bloom filtering (BIP37)
bitcoin-wallet Sends and receives coins
bitcoin-net High-level Bitcoin networking
bitcoin-protocol Bitcoin network protocol streams
webcoin-bridge A proxy that bridges the Bitcoin TCP and WebRTC networks
webcoin-params Abstract parameters, used for supporting other cryptocurrencies
webcoin-param-tests Tests for parameters
electron-webrtc WebRTC for Node via a hidden Electron process

Parameters

Webcoin was built from the ground-up with multiple cryptocurrencies in mind. The following modules are parameters which can be plugged in to Webcoin in order to support other currency networks.

network module version tests
Bitcoin webcoin-bitcoin
Bitcoin Testnet webcoin-bitcoin-testnet
Litecoin webcoin-litecoin (UNFINISHED)
Zcash Alpha webcoin-zcash-alpha (UNFINISHED)

License (MIT)

Copyright 2015 Matt Bell

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.