forked from chromaway/blockchainjs
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
3 changed files
with
39 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,102 +1,54 @@ | ||
| # blockchainjs <sup>[](https://www.npmjs.org/package/blockchainjs/)</sup> | ||
| # blockchainjs | ||
|
|
||
| [](http://travis-ci.org/chromaway/blockchainjs) | ||
| [](https://www.npmjs.org/package/blockchainjs) | ||
| [](https://travis-ci.org/chromaway/blockchainjs) | ||
| [](https://coveralls.io/r/chromaway/blockchainjs) | ||
| [](https://github.com/feross/standard) | ||
| [](https://david-dm.org/chromaway/blockchainjs#info=dependencies) | ||
| [](https://david-dm.org/chromaway/blockchainjs#info=devDependencies) | ||
|
|
||
| [](https://www.npmjs.com/package/blockchainjs) | ||
| [](https://github.com/feross/standard) | ||
|
|
||
| A pure JavaScript library for node.js and browsers for easy data exchange between wallets and bitcoin network. | ||
|
|
||
| ## What is include blockchainjs? | ||
|
|
||
| blockchainjs have two abstraction level: Connector and Blockchain | ||
|
|
||
| Connector implements a common interface for remote service. For now available only one provider: [chromanode](https://github.com/chromaway/chromanode). | ||
|
|
||
| Blockchain implements a common interface between connector and your wallet. You can use Naive (trust all data from remove service) or Verified (SPV implementation). | ||
|
|
||
| In addition to Verified blockchainjs has Storage interface for store headers. Memory and LocalStorage available for now. | ||
|
|
||
| ## API | ||
|
|
||
| * [Connector](docs/connector.md) | ||
| * [Chromanode](docs/connector.md#chromanode) | ||
| * [Blockchain](docs/blockchainapi.md) | ||
| * [Naive](docs/blockchainapi.md#naive) | ||
| * [Verified](docs/blockchainapi.md#verified) | ||
| * [Storage](docs/storageapi.md) | ||
| * [Memory](docs/storageapi.md#memory) | ||
| * [LocalStorage](docs/storageapi.md#localstorage) | ||
| Bitcoin Blockchain on JavaScript. | ||
|
|
||
| ## Examples | ||
|
|
||
| ### Show UTXO on address touched | ||
| ### Show new transactions for address | ||
| ```js | ||
| var blockchainjs = require('blockchainjs') | ||
| var connector = new blockchainjs.connector.Chromanode({networkName: 'testnet'}) | ||
| var address = 'mp8XoMWnJzQwovninMdChQutPuhyHokJNc' | ||
| import blockchainjs from 'blockchainjs' | ||
|
|
||
| function showUTXO(address) { | ||
| connector.addressesQuery([address], {status: 'unspent'}) | ||
| .then(function (result) { | ||
| console.log('UTXO for ' + address + ':') | ||
| result.transactions.forEach(function (unspent) { | ||
| // var txOut = unspent.txid + ':' + unspent.outIndex | ||
| // console.log(txOut + ' has ' + unspent.value + ' satoshi') | ||
| // sorry, only txid and height available now | ||
| console.log('Unspent in txid: ' + unspent.txid) | ||
| }) | ||
| if (result.transactions.length === 0) { | ||
| console.log('nothing...') | ||
| } | ||
| console.log('') | ||
| }) | ||
| } | ||
| let address = '...' | ||
|
|
||
| connector.on(address, showUTXO) | ||
| connector.connect() | ||
| connector.subscribe({event: 'touchAddress', address: address}) | ||
| showUTXO(address) | ||
| let network = new blockchainjs.network.Chromanode({ | ||
| url: blockchainjs.network.Chromanode.getSources('testnet') | ||
| }) | ||
|
|
||
| network.on('connect', () => console.log('connected')) | ||
| network.on('newTx', (payload) => { | ||
| console.log(`${payload.address}: ${payload.txId}`) | ||
| }) | ||
|
|
||
| network.subscribe('newTx', {address: address}) | ||
| network.connect() | ||
| ``` | ||
|
|
||
| ### Show last header upon completion of sync process | ||
| ### Blockchain syncing progress | ||
| ```js | ||
| var blockchainjs = require('blockchainjs') | ||
|
|
||
| var connector = new blockchainjs.connector.Chromanode({networkName: 'testnet'}) | ||
| connector.connect() | ||
| import blockchainjs from 'blockchainjs' | ||
|
|
||
| var storage = new blockchainjs.storage.Memory({ | ||
| networkName: 'testnet', | ||
| compactMode: true | ||
| let network = new blockchainjs.network.Chromanode({ | ||
| url: blockchainjs.network.Chromanode.getSources('testnet') | ||
| }) | ||
| let blockchain = new blockchain.blockchain.Verified(network, { | ||
| storage: new blockchainjs.storage.Memory(), | ||
| testnet: true | ||
| }) | ||
|
|
||
| var blockchain = new blockchainjs.blockchain.Verified(connector, { | ||
| storage: storage, | ||
| networkName: 'testnet', | ||
| testnet: true, | ||
| compactMode: true, | ||
| chunkHashes: blockchainjs.chunkHashes.testnet | ||
| network.on('connect', () => console.log('connected')) | ||
| blockchain.on('newBlock', (payload) => { | ||
| console.log(`New height ${payload.height} (${payload.hash})`) | ||
| }) | ||
|
|
||
| blockchain.on('syncStop', blockchainjs.util.makeSerial(function () { | ||
| return blockchain.getHeader(blockchain.latest.hash) | ||
| .then(function (header) { | ||
| console.log('Current header: ', header) | ||
| }) | ||
| })) | ||
| network.connect() | ||
| ``` | ||
|
|
||
| ## License | ||
|
|
||
| Code released under [the MIT license](LICENSE). | ||
|
|
||
| Copyright 2015 Chromaway AB | ||
|
|
||
| ## Todo | ||
|
|
||
| * migrate to bitcore (in tests) | ||
| * add https://github.com/visionmedia/debug | ||
| This software is licensed under the MIT License. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters