Moved lib to bitcore-lib and added bitcore-cli.

bitpay · 2d7d7c4fcc7a34dc5aa9ff29baa5afaddaa1f538 · Braydon Fuller committed Oct 16, 2015 · Oct 16, 2015 · 2d7d7c4
1 parent 2f144d4
commit 2d7d7c4fcc7a34dc5aa9ff29baa5afaddaa1f538
diff --git a/.zuul.yml b/.zuul.yml
@@ -1,12 +0,0 @@
-ui: mocha-bdd
-browsers:
-  - name: chrome
-    version: 30..latest
-  - name: firefox
-    version: 30..latest
-  - name: ie
-    version: latest
-  - name: safari
-    version: latest
-browserify:
-  - transform: brfs
diff --git a/benchmark/block-357238.json b/benchmark/block-357238.json
diff --git a/benchmark/package.json b/benchmark/package.json
@@ -1,8 +0,0 @@
-{
-  "devDependencies": {
-    "bcoin": "0.15.0",
-    "bitcoinjs-lib": "^1.5.7",
-    "fullnode": "^0.9.0",
-    "benchmark": "^1.0.0"
-  }
-}
diff --git a/benchmark/script.js b/benchmark/script.js
@@ -1,85 +0,0 @@
-'use strict';
-
-var benchmark = require('benchmark');
-var bitcore = require('..');
-var async = require('async');
-var blockData = require('./block-357238.json');
-
-var maxTime = 10;
-
-console.log('Benchmarking Script');
-console.log('---------------------------------------');
-
-async.series([
-  function(next) {
-
-    var c = 0;
-    var scripts = [];
-    var block = bitcore.Block.fromString(blockData);
-    for (var i = 0; i < block.transactions.length; i++) {
-      var tx = block.transactions[i];
-      for (var j = 0; j < tx.inputs.length; j++) {
-        var input = tx.inputs[j];
-        if (input.script) {
-          scripts.push(input.script);
-        }
-      }
-      for (var k = 0; k < tx.outputs.length; k++) {
-        var output = tx.outputs[k];
-        if (output.script) {
-          scripts.push(output.script);
-        }
-      }
-    }
-
-    function isPublicKeyOut() {
-      if (c >= scripts.length) {
-        c = 0;
-      }
-      scripts[c].isPublicKeyOut();
-      c++;
-    }
-
-    function isPublicKeyHashIn() {
-      if (c >= scripts.length) {
-        c = 0;
-      }
-      scripts[c].isPublicKeyHashIn();
-      c++;
-    }
-
-    function toAddress() {
-      if (c >= scripts.length) {
-        c = 0;
-      }
-      scripts[c].toAddress();
-      c++;
-    }
-
-    function getAddressInfo() {
-      if (c >= scripts.length) {
-        c = 0;
-      }
-      scripts[c].getAddressInfo();
-      c++;
-    }
-
-    var suite = new benchmark.Suite();
-    suite.add('isPublicKeyHashIn', isPublicKeyHashIn, {maxTime: maxTime});
-    suite.add('isPublicKeyOut', isPublicKeyOut, {maxTime: maxTime});
-    suite.add('toAddress', toAddress, {maxTime: maxTime});
-    suite.add('getAddressInfo', getAddressInfo, {maxTime: maxTime});
-    suite
-      .on('cycle', function(event) {
-        console.log(String(event.target));
-      })
-      .on('complete', function() {
-        console.log('Done');
-        console.log('----------------------------------------------------------------------');
-        next();
-      })
-      .run();
-  }
-], function(err) {
-  console.log('Finished');
-});
diff --git a/benchmark/serialization.js b/benchmark/serialization.js
@@ -1,122 +0,0 @@
-'use strict';
-
-var benchmark = require('benchmark');
-var bitcore = require('..');
-var bitcoinjs = require('bitcoinjs-lib');
-var bcoin = require('bcoin');
-var async = require('async');
-var fullnode = require('fullnode');
-var blockData = require('./block-357238.json');
-
-var maxTime = 20;
-
-console.log('Benchmarking Block/Transaction Serialization');
-console.log('---------------------------------------');
-
-async.series([
-  function(next) {
-
-    var buffers = [];
-    var hashBuffers = [];
-    console.log('Generating Random Test Data...');
-    for (var i = 0; i < 100; i++) {
-
-      // uint64le
-      var br = new bitcore.encoding.BufferWriter();
-      var num = Math.round(Math.random() * 10000000000000);
-      br.writeUInt64LEBN(new bitcore.crypto.BN(num));
-      buffers.push(br.toBuffer());
-
-      // hashes
-      var data = bitcore.crypto.Hash.sha256sha256(new Buffer(32));
-      hashBuffers.push(data);
-    }
-
-    var c = 0;
-    var bn;
-
-    function readUInt64LEBN() {
-      if (c >= buffers.length) {
-        c = 0;
-      }
-      var buf = buffers[c];
-      var br = new bitcore.encoding.BufferReader(buf);
-      bn = br.readUInt64LEBN();
-      c++;
-    }
-
-    var reversed;
-
-    function readReverse() {
-      if (c >= hashBuffers.length) {
-        c = 0;
-      }
-      var buf = hashBuffers[c];
-      var br = new bitcore.encoding.BufferReader(buf);
-      reversed = br.readReverse();
-      c++;
-    }
-
-    console.log('Starting benchmark...');
-
-    var suite = new benchmark.Suite();
-    suite.add('bufferReader.readUInt64LEBN()', readUInt64LEBN, {maxTime: maxTime});
-    suite.add('bufferReader.readReverse()', readReverse, {maxTime: maxTime});
-    suite
-      .on('cycle', function(event) {
-        console.log(String(event.target));
-      })
-      .on('complete', function() {
-        console.log('Done');
-        console.log('----------------------------------------------------------------------');
-        next();
-      })
-      .run();
-  },
-  function(next) {
-
-    var block1;
-    var block2;
-    var block3;
-
-    function bitcoreTest() {
-      block1 = bitcore.Block.fromString(blockData);
-    }
-
-    function bitcoinJSTest() {
-      block2 = bitcoinjs.Block.fromHex(blockData);
-    }
-
-    var parser = new bcoin.protocol.parser();
-
-    function bcoinTest() {
-      var raw = bcoin.utils.toArray(blockData, 'hex');
-      var data = parser.parseBlock(raw);
-      block3 = new bcoin.block(data, 'block');
-    }
-
-    var blockDataMessage = '0000000000000000' + blockData; // add mock leading magic and size
-
-    function fullnodeTest() {
-      fullnode.Block().fromHex(blockDataMessage);
-    }
-
-    var suite = new benchmark.Suite();
-    suite.add('bitcore', bitcoreTest, {maxTime: maxTime});
-    suite.add('bitcoinjs', bitcoinJSTest, {maxTime: maxTime});
-    suite.add('bcoin', bcoinTest, {maxTime: maxTime});
-    suite.add('fullnode', fullnodeTest, {maxTime: maxTime});
-    suite
-      .on('cycle', function(event) {
-        console.log(String(event.target));
-      })
-      .on('complete', function() {
-        console.log('Fastest is ' + this.filter('fastest').pluck('name'));
-        console.log('----------------------------------------------------------------------');
-        next();
-      })
-      .run();
-  }
-], function(err) {
-  console.log('Finished');
-});
diff --git a/bin/bitcore b/bin/bitcore
@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+// vi: ft=javascript -*- mode: JavaScript; -*-
+
+var cli = require('bitcore-cli');
+cli.bitcore();
diff --git a/bin/bitcored b/bin/bitcored
@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+// vi: ft=javascript -*- mode: JavaScript; -*-
+
+var cli = require('bitcore-cli');
+cli.bitcored();
diff --git a/docs/address.md b/docs/address.md
@@ -1,74 +0,0 @@
----
-title: Address
-description: A simple interface to generate and validate a bitcoin address.
----
-# Address
-
-## Description
-
-Represents a bitcoin address. Addresses are the most popular way to make bitcoin transactions. See [the official Bitcoin Wiki](https://en.bitcoin.it/wiki/Address) for technical background information.
-
-## Instantiate an Address
-
-To be able to receive bitcoins an address is needed, but in order to spend them a private key is necessary. Please take a look at the [`PrivateKey`](privatekey.md) docs for more information about exporting and saving a key.  
-
-```javascript
-var privateKey = new PrivateKey();
-var address = privateKey.toAddress();
-```
-
-You can also instantiate an Address from a String, [PublicKey](publickey.md), or [HDPublicKey](hierarchical.md), in case you are not the owner of the private key.
-
-```javascript
-// from a string
-var address = Address.fromString('mwkXG8NnB2snbqWTcpNiK6qqGHm1LebHDc');
-
-// a default network address from a public key
-var publicKey = PublicKey(privateKey);
-var address = new Address(publicKey);
-// alternative interface
-var address = Address.fromPublicKey(publicKey);
-
-// a testnet address from a public key
-var publicKey = new PublicKey(privateKey);
-var address = new Address(publicKey, Networks.testnet);
-```
-
-A pay-to-script-hash multisignature Address can be instantiated from an array of [PublicKeys](publickey.md).
-
-```javascript
-// a 2-of-3 address from public keys
-var p2shAddress = new Address([publicKey1, publicKey2, publicKey3], 2);
-```
-
-## Validating an Address
-
-The main use that we expect you'll have for the `Address` class in Bitcore is validating that an address is a valid one, what type of address it is (you may be interested on knowing if the address is a simple "pay to public key hash" address or a "pay to script hash" address) and what network does the address belong to.
-
-The code to do these validations looks like this:
-
-```javascript
-// validate an address
-if (Address.isValid(input){
-  ...
-}
-
-// validate that an input field is a valid testnet address
-if (Address.isValid(input, Networks.testnet){
-  ...
-}
-
-// validate that an input field is a valid livenet pubkeyhash
-if (Address.isValid(input, Networks.livenet, Address.Pay2PubKeyHash){
-  ...
-}
-
-// get the specific validation error that can occurred
-var error = Address.getValidationError(input, Networks.testnet);
-  if (error) {
-    // handle the error
-  }
-}
-```
-
-The errors are listed in the generated file in the [errors folder](https://github.com/bitpay/bitcore/tree/master/lib/errors). There's a structure to errors defined in the [spec.js file](https://github.com/bitpay/bitcore/tree/master/lib/errors/spec.js).
diff --git a/docs/block.md b/docs/block.md
@@ -1,57 +0,0 @@
----
-title: Block
-description: A simple interface to parse and validate a bitcoin blocks.
----
-# Block
-
-## Description
-
-A Block instance represents the information of a block in the bitcoin network. Given a hexadecimal string representation of the serialization of a block with its transactions, you can instantiate a Block instance. Methods are provided to calculate and check the merkle root hash (if enough data is provided), but transactions won't necessarily be valid spends, and this class won't validate them. A binary representation as a `Buffer` instance is also valid input for a Block's constructor. 
-
-```javascript
-// instantiate a new block instance
-var block = new Block(hexaEncodedBlock);
-
-// will verify that the corresponding block transactions match the header
-assert(block.validMerkleRoot());
-
-// blocks have several properties
-assert(block.header); // an instance of block header, more info below
-assert(block.transactions); // an array of transactions, more info below
-
-```
-
-For detailed technical information about a block please visit [Blocks](https://en.bitcoin.it/wiki/Blocks#Block_structure) on the Bitcoin Wiki.
-
-## Block Header
-
-Each instance of Block has a BlockHeader *(which can be instantiated separately)*. The header has validation methods, to verify that the block.
-
-```javascript
-// will verify that the nonce demonstrates enough proof of work
-assert(block.header.validProofOfWork());
-
-// will verify that timestamp is not too far in the future
-assert(block.header.validTimestamp());
-
-// each header has the following properties
-assert(block.header.version);
-assert(block.header.prevHash);
-assert(block.header.merkleRoot);
-assert(block.header.time);
-assert(block.header.bits);
-assert(block.header.nonce);
-
-```
-For more information about the specific properties of a block header please visit the [Block hashing algorithm](https://en.bitcoin.it/wiki/Block_hashing_algorithm) page on the Bitcoin Wiki.
-
-## Transactions
-
-The set of transactions in a block is an array of instances of [Transaction](transaction.md) and can be explored by iterating on the block's `transactions` member.
-
-```javascript
-for (var i in block.transactions) {
-  var transaction = block.transactions[i];
-}
-```
-