BTCPrivate
/
bitcore
mirror of https://github.com/BTCPrivate/bitcore.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Merge pull request #141 from maraoz/bug/fix-examples 

Fix and test examples
This commit is contained in:
Ryan X. Charles 2014-03-12 15:10:35 -04:00
parent 25c95cdb47 1732ec2ced
commit e702f1813b
9 changed files with 369 additions and 261 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

221
README.md
View File

@ -29,7 +29,8 @@ Some examples are provided at the [examples](/examples) path. Here are some snip
## Validating an address ## Validating an address
Validating a Bitcoin address: Validating a Bitcoin address:
```js ```js
var Address = require('bitcore/Address'); var bitcore = require('bitcore');
var Address = bitcore.Address;
var addrs = [ var addrs = [
'1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa', '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
@ -48,80 +49,103 @@ addrs.forEach(function(addr) {
## Monitoring Blocks and Transactions ## Monitoring Blocks and Transactions
For this example you need a running bitcoind instance with RPC enabled. For this example you need a running bitcoind instance with RPC enabled.
```js ```js
var util = require('util'); var bitcore = require('bitcore');
var networks = require('bitcore/networks'); var networks = bitcore.networks;
var Peer = require('bitcore/Peer'); var Peer = bitcore.Peer;
var PeerManager = require('soop').load('bitcore/PeerManager', var PeerManager = require('soop').load('../PeerManager', {
{network: networks.testnet}); network: networks.testnet
});
var handleBlock = function(info) { var handleBlock = function(info) {
console.log('** Block Received **'); console.log('** Block Received **');
console.log(info.message); console.log(info.message);
}; };
var handleTx = function(info) { var handleTx = function(info) {
var tx = info.message.tx.getStandardizedObject(); var tx = info.message.tx.getStandardizedObject();
console.log('** Block TX **'); console.log('** TX Received **');
console.log(tx); console.log(tx);
}; };
var handleInv = function(info) { var handleInv = function(info) {
console.log('** Inv **');
console.log('** Block Inv **');
console.log(info.message); console.log(info.message);
var invs = info.message.invs; var invs = info.message.invs;
info.conn.sendGetData(invs); info.conn.sendGetData(invs);
}; };
var peerman = new PeerManager(); var peerman = new PeerManager();
peerman.addPeer( new Peer('127.0.0.1', 18333) ); peerman.addPeer(new Peer('127.0.0.1', 18333));
peerman.on('connection', function(conn) { peerman.on('connection', function(conn) {
conn.on('inv', handleInv); conn.on('inv', handleInv);
conn.on('block', handleBlock); conn.on('block', handleBlock);
conn.on('tx', handleTx); conn.on('tx', handleTx);
}); });
peerman.start(); peerman.start();
``` ```
PeerManager will emit the following events: 'version', 'verack', 'addr', 'getaddr', 'error' 'disconnect'; and will relay events like: 'tx', 'block', 'inv'. Please see [PeerManager.js](PeerManager.js), [Peer.js](Peer.js) and [Connection.js](Connection.js) PeerManager will emit the following events: 'version', 'verack', 'addr', 'getaddr', 'error' 'disconnect'; and will relay events like: 'tx', 'block', 'inv'. Please see [PeerManager.js](PeerManager.js), [Peer.js](Peer.js) and [Connection.js](Connection.js)
## Consuming bitcoind RPC
For this example you need a running bitcoind instance with RPC enabled.
```js
var bitcore = require('bitcore');
var RpcClient = bitcore.RpcClient;
var hash = '0000000000b6288775bbd326bedf324ca8717a15191da58391535408205aada4';
var config = {
protocol: 'http',
user: 'user',
pass: 'pass',
host: '127.0.0.1',
port: '18332',
};
var rpc = new RpcClient(config);
rpc.getBlock(hash, function(err, ret) {
if (err) {
console.error('An error occured fetching block', hash);
console.error(err);
return;
}
console.log(ret);
});
```
Check the list of all supported RPC call at [RpcClient.js](RpcClient.js)
## Creating and sending a Transaction through P2P ## Creating and sending a Transaction through P2P
For this example you need a running bitcoind instance with RPC enabled. For this example you need a running bitcoind instance with RPC enabled.
```js ```js
var networks = require('bitcore/networks'); var bitcore = require('bitcore');
var Peer = require('bitcore/Peer'); var networks = bitcore.networks;
var Transaction = require('bitcore/Transaction'); var Peer = bitcore.Peer;
var Address = require('bitcore/Address'); var Transaction = bitcore.Transaction;
var Script = require('bitcore/Script'); var Address = bitcore.Address;
var coinUtil = require('bitcore/util/util'); var Script = bitcore.Script;
var PeerManager = require('soop').load('bitcore/PeerManager', var coinUtil = bitcore.util;
{network: networks.testnet}); var PeerManager = require('soop').load('../PeerManager', {
network: networks.testnet
});
var createTx = function() { var createTx = function() {
var TXIN = 'd05f35e0bbc495f6dcab03e599c8f5e32a07cdb4bc76964de201d06a2a7d8265';
var TXIN = 'd05f35e0bbc495f6dcab03e599c8f5e32a07cdb4bc76964de201d06a2a7d8265';
var TXIN_N = 0; var TXIN_N = 0;
var ADDR = 'muHct3YZ9Nd5Pq7uLYYhXRAxeW4EnpcaLz'; var ADDR = 'muHct3YZ9Nd5Pq7uLYYhXRAxeW4EnpcaLz';
var VAL = '1.234'; var VAL = '0.001';
var txobj = { var txobj = {
version: 1, version: 1,
lock_time: 0, lock_time: 0,
ins: [], ins: [],
outs: [] outs: []
} };
var txin = { var txin = {
s: coinUtil.EMPTY_BUFFER, // Add signature s: coinUtil.EMPTY_BUFFER, // Add signature
@ -129,18 +153,17 @@ var createTx = function() {
}; };
var hash = new Buffer(TXIN.split('').reverse(), 'hex'); var hash = new Buffer(TXIN.split('').reverse(), 'hex');
var vout = parseInt(TXIN_N);
var vout = parseInt(TXIN_N);
var voutBuf = new Buffer(4); var voutBuf = new Buffer(4);
voutBuf.writeUInt32LE(vout, 0); voutBuf.writeUInt32LE(vout, 0);
txin.o = Buffer.concat([hash, voutBuf]); txin.o = Buffer.concat([hash, voutBuf]);
txobj.ins.push(txin); txobj.ins.push(txin);
var addr = new Address(ADDR); var addr = new Address(ADDR);
var script = Script.createPubKeyHashOut(addr.payload()); var script = Script.createPubKeyHashOut(addr.payload());
var valueNum = coinUtil.parseValue(VAL); var valueNum = coinUtil.parseValue(VAL);
var value = coinUtil.bigIntToValue(valueNum); var value = coinUtil.bigIntToValue(valueNum);
var txout = { var txout = {
v: value, v: value,
@ -155,97 +178,67 @@ var createTx = function() {
var peerman = new PeerManager(); var peerman = new PeerManager();
peerman.addPeer(new Peer('127.0.0.1', 18333)); peerman.addPeer(new Peer('127.0.0.1', 18333));
peerman.on('connect', function(conn) { peerman.on('connect', function() {
var conn = peerman.getActiveConnection(); var conn = peerman.getActiveConnection();
if (conn) { if (conn) {
conn.sendTx(createTx()); conn.sendTx(createTx());
} }
conn.on('reject', function() {
conn.on('reject', function () { console.log('Transaction Rejected');
console.log('Transaction Rejected');
}); });
}); });
peerman.start(); peerman.start();
``` ```
## Consuming bitcoind RPC
For this example you need a running bitcoind instance with RPC enabled.
```js
var util = require('util');
var RpcClient = require('bitcore/RpcClient');
var hash = process.argv[2] || '0000000000b6288775bbd326bedf324ca8717a15191da58391535408205aada4';
var config = {
protocol: 'http',
user: 'user',
pass: 'pass',
host: '127.0.0.1',
port: '18332',
};
var rpc = new RpcClient(config);
rpc.getBlock(hash, function(err, ret) {
if(err) {
console.error("An error occured fetching block", hash);
console.error(err);
return;
}
console.log(ret);
});
```
Check the list of all supported RPC call at [RpcClient.js](RpcClient.js)
## Parsing a Script ## Parsing a Script
Gets an address strings from a ScriptPubKey Buffer Gets an address strings from a ScriptPubKey Buffer
``` ```js
var Address = require('bitcore/Address'); var bitcore = require('bitcore');
var coinUtil= require('bitcore/util/util'); var Address = bitcore.Address;
var coinUtil = bitcore.util;
var Script = bitcore.Script;
var network = bitcore.networks.testnet;
var getAddrStr = function(s) { var getAddrStr = function(s) {
var addrStrs = []; var addrStrs = [];
var type = s.classify(); var type = s.classify();
var addr; var addr;
switch (type) { switch (type) {
case Script.TX_PUBKEY: case Script.TX_PUBKEY:
var chunk = s.captureOne(); var chunk = s.captureOne();
addr = new Address(network.addressPubkey, coinUtil.sha256ripe160(chunk)); addr = new Address(network.addressPubkey, coinUtil.sha256ripe160(chunk));
addrStrs.push(addr.toString()); addrStrs.push(addr.toString());
break; break;
case Script.TX_PUBKEYHASH: case Script.TX_PUBKEYHASH:
addr = new Address(network.addressPubkey, s.captureOne()); addr = new Address(network.addressPubkey, s.captureOne());
addrStrs.push(addr.toString()); addrStrs.push(addr.toString());
break; break;
case Script.TX_SCRIPTHASH: case Script.TX_SCRIPTHASH:
addr = new Address(network.addressScript, s.captureOne()); addr = new Address(network.addressScript, s.captureOne());
addrStrs.push(addr.toString()); addrStrs.push(addr.toString());
break; break;
case Script.TX_MULTISIG: case Script.TX_MULTISIG:
var chunks = s.capture(); var chunks = s.capture();
chunks.forEach(function(chunk) { chunks.forEach(function(chunk) {
var a = new Address(network.addressPubkey, coinUtil.sha256ripe160(chunk)); var a = new Address(network.addressPubkey, coinUtil.sha256ripe160(chunk));
addrStrs.push(a.toString()); addrStrs.push(a.toString());
}); });
break; break;
case Script.TX_UNKNOWN: case Script.TX_UNKNOWN:
break; console.log('tx type unkown');
} break;
return addrStrs; }
}; return addrStrs;
};
var s = new Script(scriptBuffer); var script = 'DUP HASH160 0x14 0x3744841e13b90b4aca16fe793a7f88da3a23cc71 EQUALVERIFY CHECKSIG';
console.log(getAddrStr(s); var s = Script.fromHumanReadable(script);
console.log(getAddrStr(s)[0]); // mkZBYBiq6DNoQEKakpMJegyDbw2YiNQnHT
``` ```
#Security #Security

37
examples/Address.js
View File

@ -1,19 +1,28 @@
'use strict'; 'use strict';
// Replace '..' with 'bitcore' if you plan on using this code elsewhere.
var Address = require('../Address'); var run = function() {
// Replace '../bitcore' with 'bitcore' if you use this code elsewhere.
var bitcore = require('../bitcore');
var Address = bitcore.Address;
var addrs = [ var addrs = [
'1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa', '1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
'1A1zP1eP5QGefi2DMPTfTL5SLmv7Dixxxx', '1A1zP1eP5QGefi2DMPTfTL5SLmv7Dixxxx',
'A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa', 'A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa',
'1600 Pennsylvania Ave NW', '1600 Pennsylvania Ave NW',
].map(function(addr) { ].map(function(addr) {
return new Address(addr); return new Address(addr);
}); });
addrs.forEach(function(addr) { addrs.forEach(function(addr) {
var valid = addr.isValid(); var valid = addr.isValid();
console.log(addr.data + ' is ' + (valid ? '' : 'not ') + 'valid'); console.log(addr.data + ' is ' + (valid ? '' : 'not ') + 'valid');
}); });
};
module.exports.run = run;
if (require.main === module) {
run();
}

79
examples/PeerManager.js
View File

@ -1,47 +1,48 @@
'use strict'; 'use strict';
// Replace '..' with 'bitcore' if you plan on using this code elsewhere. var run = function() {
// Replace '../bitcore' with 'bitcore' if you use this code elsewhere.
var bitcore = require('../bitcore');
var networks = bitcore.networks;
var Peer = bitcore.Peer;
var PeerManager = require('soop').load('../PeerManager', {
network: networks.testnet
});
var util = require('util'); var handleBlock = function(info) {
var networks = require('../networks'); console.log('** Block Received **');
var Peer = require('../Peer'); console.log(info.message);
var PeerManager = require('soop').load('../PeerManager', };
{network: networks.testnet});
var handleBlock = function(info) { var handleTx = function(info) {
var tx = info.message.tx.getStandardizedObject();
console.log('** Block Received **'); console.log('** TX Received **');
console.log(info.message); console.log(tx);
};
var handleInv = function(info) {
console.log('** Inv **');
console.log(info.message);
var invs = info.message.invs;
info.conn.sendGetData(invs);
};
var peerman = new PeerManager();
peerman.addPeer(new Peer('127.0.0.1', 18333));
peerman.on('connection', function(conn) {
conn.on('inv', handleInv);
conn.on('block', handleBlock);
conn.on('tx', handleTx);
});
peerman.start();
}; };
var handleTx = function(info) { module.exports.run = run;
if (require.main === module) {
var tx = info.message.tx.getStandardizedObject(); run();
}
console.log('** Block TX **');
console.log(tx);
};
var handleInv = function(info) {
console.log('** Block Inv **');
console.log(info.message);
var invs = info.message.invs;
info.conn.sendGetData(invs);
};
var peerman = new PeerManager();
peerman.addPeer( new Peer('127.0.0.1', 18333) );
peerman.on('connection', function(conn) {
conn.on('inv', handleInv);
conn.on('block', handleBlock);
conn.on('tx', handleTx);
});
peerman.start();

49
examples/Rpc.js
View File

@ -1,29 +1,32 @@
'use strict'; 'use strict';
// Replace '..' with 'bitcore' if you plan on using this code elsewhere. var run = function() {
// Replace '../bitcore' with 'bitcore' if you use this code elsewhere.
var bitcore = require('../bitcore');
var RpcClient = bitcore.RpcClient;
var hash = '0000000000b6288775bbd326bedf324ca8717a15191da58391535408205aada4';
var util = require('util'); var config = {
var RpcClient = require('../RpcClient'); protocol: 'http',
var hash = process.argv[2] || '0000000000b6288775bbd326bedf324ca8717a15191da58391535408205aada4'; user: 'user',
pass: 'pass',
host: '127.0.0.1',
port: '18332',
};
var config = { var rpc = new RpcClient(config);
protocol: 'http',
user: 'user', rpc.getBlock(hash, function(err, ret) {
pass: 'pass', if (err) {
host: '127.0.0.1', console.error('An error occured fetching block', hash);
port: '18332', console.error(err);
return;
}
console.log(ret);
});
}; };
var rpc = new RpcClient(config);
rpc.getBlock(hash, function(err, ret) { module.exports.run = run;
if (require.main === module) {
if(err) { run();
console.error("An error occured fetching block", hash); }
console.error(err);
return;
}
console.log(ret);
});

52
examples/Script.js Normal file
View File

@ -0,0 +1,52 @@
'use strict';
var run = function() {
// Replace '../bitcore' with 'bitcore' if you use this code elsewhere.
var bitcore = require('../bitcore');
var Address = bitcore.Address;
var coinUtil = bitcore.util;
var Script = bitcore.Script;
var network = bitcore.networks.testnet;
var getAddrStr = function(s) {
var addrStrs = [];
var type = s.classify();
var addr;
switch (type) {
case Script.TX_PUBKEY:
var chunk = s.captureOne();
addr = new Address(network.addressPubkey, coinUtil.sha256ripe160(chunk));
addrStrs.push(addr.toString());
break;
case Script.TX_PUBKEYHASH:
addr = new Address(network.addressPubkey, s.captureOne());
addrStrs.push(addr.toString());
break;
case Script.TX_SCRIPTHASH:
addr = new Address(network.addressScript, s.captureOne());
addrStrs.push(addr.toString());
break;
case Script.TX_MULTISIG:
var chunks = s.capture();
chunks.forEach(function(chunk) {
var a = new Address(network.addressPubkey, coinUtil.sha256ripe160(chunk));
addrStrs.push(a.toString());
});
break;
case Script.TX_UNKNOWN:
console.log('tx type unkown');
break;
}
return addrStrs;
};
var script = 'DUP HASH160 0x14 0x3744841e13b90b4aca16fe793a7f88da3a23cc71 EQUALVERIFY CHECKSIG';
var s = Script.fromHumanReadable(script);
console.log(getAddrStr(s)[0]); // mkZBYBiq6DNoQEKakpMJegyDbw2YiNQnHT
};
module.exports.run = run;
if (require.main === module) {
run();
}

141
examples/SendTx.js
View File

@ -1,73 +1,76 @@
'use strict';
// Replace '..' with 'bitcore' if you plan on using this code elsewhere. var run = function() {
// Replace '../bitcore' with 'bitcore' if you use this code elsewhere.
var networks = require('../networks'); var bitcore = require('../bitcore');
var Peer = require('../Peer'); var networks = bitcore.networks;
var Transaction = require('../Transaction'); var Peer = bitcore.Peer;
var Address = require('../Address'); var Transaction = bitcore.Transaction;
var Script = require('../Script'); var Address = bitcore.Address;
var coinUtil = require('../util/util'); var Script = bitcore.Script;
var PeerManager = require('soop').load('../PeerManager', var coinUtil = bitcore.util;
{network: networks.testnet}); var PeerManager = require('soop').load('../PeerManager', {
network: networks.testnet
var createTx = function() {
var TXIN = 'd05f35e0bbc495f6dcab03e599c8f5e32a07cdb4bc76964de201d06a2a7d8265';
var TXIN_N = 0;
var ADDR = 'muHct3YZ9Nd5Pq7uLYYhXRAxeW4EnpcaLz';
var VAL = '1.234';
var txobj = {
version: 1,
lock_time: 0,
ins: [],
outs: []
}
var txin = {
s: coinUtil.EMPTY_BUFFER, // Add signature
q: 0xffffffff
};
var hash = new Buffer(TXIN.split('').reverse(), 'hex');
var vout = parseInt(TXIN_N);
var voutBuf = new Buffer(4);
voutBuf.writeUInt32LE(vout, 0);
txin.o = Buffer.concat([hash, voutBuf]);
txobj.ins.push(txin);
var addr = new Address(ADDR);
var script = Script.createPubKeyHashOut(addr.payload());
var valueNum = coinUtil.parseValue(VAL);
var value = coinUtil.bigIntToValue(valueNum);
var txout = {
v: value,
s: script.getBuffer(),
};
txobj.outs.push(txout);
return new Transaction(txobj);
};
var peerman = new PeerManager();
peerman.addPeer(new Peer('127.0.0.1', 18333));
peerman.on('connect', function(conn) {
var conn = peerman.getActiveConnection();
if (conn) {
conn.sendTx(createTx());
}
conn.on('reject', function () {
console.log('Transaction Rejected');
}); });
}); var createTx = function() {
var TXIN = 'd05f35e0bbc495f6dcab03e599c8f5e32a07cdb4bc76964de201d06a2a7d8265';
var TXIN_N = 0;
var ADDR = 'muHct3YZ9Nd5Pq7uLYYhXRAxeW4EnpcaLz';
var VAL = '0.001';
peerman.start(); var txobj = {
version: 1,
lock_time: 0,
ins: [],
outs: []
};
var txin = {
s: coinUtil.EMPTY_BUFFER, // Add signature
q: 0xffffffff
};
var hash = new Buffer(TXIN.split('').reverse(), 'hex');
var vout = parseInt(TXIN_N);
var voutBuf = new Buffer(4);
voutBuf.writeUInt32LE(vout, 0);
txin.o = Buffer.concat([hash, voutBuf]);
txobj.ins.push(txin);
var addr = new Address(ADDR);
var script = Script.createPubKeyHashOut(addr.payload());
var valueNum = coinUtil.parseValue(VAL);
var value = coinUtil.bigIntToValue(valueNum);
var txout = {
v: value,
s: script.getBuffer(),
};
txobj.outs.push(txout);
return new Transaction(txobj);
};
var peerman = new PeerManager();
peerman.addPeer(new Peer('127.0.0.1', 18333));
peerman.on('connect', function() {
var conn = peerman.getActiveConnection();
if (conn) {
conn.sendTx(createTx());
}
conn.on('reject', function() {
console.log('Transaction Rejected');
});
});
peerman.start();
};
module.exports.run = run;
if (require.main === module) {
run();
}

17
test/mute.js Normal file
View File

@ -0,0 +1,17 @@
'use strict';
var backup = console.log;
var ebackup = console.error;
var nop = function() {};
var mute = function() {
console.log = nop;
console.error = nop;
};
var unmute = function() {
console.log = backup;
console.error = ebackup;
};
module.exports.mute = mute;
module.exports.unmute = unmute;

25
test/test.examples.js Normal file
View File

@ -0,0 +1,25 @@
'use strict';
var chai = chai || require('chai');
var should = chai.should();
var mute = require('./mute').mute;
var unmute = require('./mute').unmute;
var examples = [
'Address',
'PeerManager',
'Rpc',
'SendTx',
'Script',
];
describe('Examples', function() {
before(mute);
after(unmute);
examples.forEach(function(example) {
it('valid '+example, function() {
var ex = require('../examples/'+example);
ex.run.should.not.throw();
});
});
});

9
util/log.js
View File

@ -1,9 +1,14 @@
'use strict';
var noop = function() {}; var noop = function() {};
var cl = function() {
console.log(arguments);
};
var loggers = { var loggers = {
none: {info: noop, warn: noop, err: noop, debug: noop}, none: {info: noop, warn: noop, err: noop, debug: noop},
normal: {info: console.log, warn: console.log, err: console.log, debug: noop}, normal: {info: cl, warn: cl, err: cl, debug: noop},
debug: {info: console.log, warn: console.log, err: console.log, debug: console.log}, debug: {info: cl, warn: cl, err: cl, debug: cl},
}; };
var config = require('../config'); var config = require('../config');