lukechilds
/
bitcoincashjs
mirror of https://github.com/lukechilds/bitcoincashjs.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

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

Fix and test examples
patch-2
Ryan X. Charles 11 years ago
parent
25c95cdb47 1732ec2ced
commit
e702f1813b
9 changed files with 372 additions and 264 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 129
      README.md
  2. 13
      examples/Address.js
  3. 31
      examples/PeerManager.js
  4. 21
      examples/Rpc.js
  5. 52
      examples/Script.js
  6. 43
      examples/SendTx.js
  7. 17
      test/mute.js
  8. 25
      test/test.examples.js
  9. 9
      util/log.js

129
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,36 +49,31 @@ 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();
@ -91,37 +87,65 @@ peerman.on('connection', function(conn) {
}); });
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,7 +153,6 @@ 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);
@ -155,61 +178,30 @@ 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 = [];
@ -238,14 +230,15 @@ Gets an address strings from a ScriptPubKey Buffer
}); });
break; break;
case Script.TX_UNKNOWN: case Script.TX_UNKNOWN:
console.log('tx type unkown');
break; 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

13
examples/Address.js
View File

@ -1,8 +1,10 @@
'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',
@ -17,3 +19,10 @@ 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();
}

31
examples/PeerManager.js
View File

@ -1,37 +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 util = require('util'); var bitcore = require('../bitcore');
var networks = require('../networks'); var networks = bitcore.networks;
var Peer = require('../Peer'); var Peer = bitcore.Peer;
var PeerManager = require('soop').load('../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();
@ -45,3 +40,9 @@ peerman.on('connection', function(conn) {
}); });
peerman.start(); peerman.start();
};
module.exports.run = run;
if (require.main === module) {
run();
}

21
examples/Rpc.js
View File

@ -1,10 +1,10 @@
'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 util = require('util'); var bitcore = require('../bitcore');
var RpcClient = require('../RpcClient'); var RpcClient = bitcore.RpcClient;
var hash = process.argv[2] || '0000000000b6288775bbd326bedf324ca8717a15191da58391535408205aada4'; var hash = '0000000000b6288775bbd326bedf324ca8717a15191da58391535408205aada4';
var config = { var config = {
protocol: 'http', protocol: 'http',
@ -17,13 +17,16 @@ var hash = process.argv[2] || '0000000000b6288775bbd326bedf324ca8717a15191d
var rpc = new RpcClient(config); var rpc = new RpcClient(config);
rpc.getBlock(hash, function(err, ret) { rpc.getBlock(hash, function(err, ret) {
if (err) { if (err) {
console.error("An error occured fetching block", hash); console.error('An error occured fetching block', hash);
console.error(err); console.error(err);
return; return;
} }
console.log(ret); console.log(ret);
}); });
};
module.exports.run = run;
if (require.main === module) {
run();
}

52
examples/Script.js
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();
}

43
examples/SendTx.js
View File

@ -1,28 +1,30 @@
'use strict';
// Replace '..' with 'bitcore' if you plan on using this code elsewhere.
var run = function() {
var networks = require('../networks'); // Replace '../bitcore' with 'bitcore' if you use this code elsewhere.
var Peer = require('../Peer'); var bitcore = require('../bitcore');
var Transaction = require('../Transaction'); var networks = bitcore.networks;
var Address = require('../Address'); var Peer = bitcore.Peer;
var Script = require('../Script'); var Transaction = bitcore.Transaction;
var coinUtil = require('../util/util'); var Address = bitcore.Address;
var PeerManager = require('soop').load('../PeerManager', var Script = bitcore.Script;
{network: networks.testnet}); var coinUtil = bitcore.util;
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
@ -30,7 +32,6 @@ 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);
@ -56,18 +57,20 @@ 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();
};
module.exports.run = run;
if (require.main === module) {
run();
}

17
test/mute.js
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
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');

Write Preview
Loading…
Cancel
Save