RanchiMall/fcoin
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

root: update readme.

Browse Source
This commit is contained in:
Christopher Jeffrey 2016-12-11 09:05:27 -08:00
parent d4cb8d82a2
commit dcef9beed5
No known key found for this signature in database
GPG Key ID: 8962AB9DE6666BBD
1 changed files with 30 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
README.md
View File

@ -397,10 +397,7 @@ var cb = new bcoin.mtx();
// Add a typical coinbase input // Add a typical coinbase input
cb.addInput({ cb.addInput({
prevout: { prevout: new bcoin.outpoint(),
hash: constants.NULL_HASH,
index: 0
},
script: new bcoin.script(), script: new bcoin.script(),
sequence: 0xffffffff sequence: 0xffffffff
}); });
@ -412,28 +409,34 @@ cb.addOutput({
}); });
// Create our redeeming transaction. // Create our redeeming transaction.
var tx = new bcoin.mtx(); var mtx = new bcoin.mtx();
// Add output 0 from our coinbase. // Add output 0 from our coinbase.
tx.addInput(cb, 0); mtx.addInput(cb, 0);
// Send 10,000 satoshis to ourself, // Send 10,000 satoshis to ourself,
// creating a fee of 40,000 satoshis. // creating a fee of 40,000 satoshis.
tx.addOutput({ mtx.addOutput({
address: keyring.getAddress(), address: keyring.getAddress(),
value: 10000 value: 10000
}); });
// Sign input 0: pass in our keyring. // Sign input 0: pass in our keyring.
tx.sign(keyring); mtx.sign(keyring);
// The transaction should now verify.
assert(mtx.verify());
assert(tx.getFee() === 40000);
// Commit our transaction and make it immutable. // Commit our transaction and make it immutable.
// This turns it from an MTX into a TX object. // This turns it from an MTX into a TX object.
tx = tx.toTX(); var tx = mtx.toTX();
// The transaction should now verify. // The transaction should still verify.
assert(tx.verify()); // Regular transactions require a coin
assert(tx.getFee() === 40000); // viewpoint to be passed in.
assert(tx.verify(mtx.view));
assert(tx.getFee(mtx.view) === 40000);
``` ```
### Coin Selection ### Coin Selection
@ -455,10 +458,7 @@ var keyring = new bcoin.keyring(key.privateKey);
var cb = new bcoin.mtx(); var cb = new bcoin.mtx();
cb.addInput({ cb.addInput({
prevout: { prevout: new bcoin.outpoint(),
hash: constants.NULL_HASH,
index: 0
},
script: new bcoin.script(), script: new bcoin.script(),
sequence: 0xffffffff sequence: 0xffffffff
}); });
@ -479,10 +479,10 @@ var coin = bcoin.coin.fromTX(cb, 0);
coins.push(coin); coins.push(coin);
// Create our redeeming transaction. // Create our redeeming transaction.
var tx = new bcoin.mtx(); var mtx = new bcoin.mtx();
// Send 10,000 satoshis to ourself. // Send 10,000 satoshis to ourself.
tx.addOutput({ mtx.addOutput({
address: keyring.getAddress(), address: keyring.getAddress(),
value: 10000 value: 10000
}); });
@ -493,7 +493,7 @@ tx.addOutput({
// Select coins from our array and add inputs. // Select coins from our array and add inputs.
// Calculate fee and add a change output. // Calculate fee and add a change output.
tx.fund(coins, { mtx.fund(coins, {
// Use a rate of 10,000 satoshis per kb. // Use a rate of 10,000 satoshis per kb.
// With the `fullnode` object, you can // With the `fullnode` object, you can
// use the fee estimator for this instead // use the fee estimator for this instead
@ -504,14 +504,20 @@ tx.fund(coins, {
}); });
// Sign input 0 // Sign input 0
tx.sign(keyring); mtx.sign(keyring);
// The transaction should now verify.
assert(mtx.verify());
// Commit our transaction and make it immutable. // Commit our transaction and make it immutable.
// This turns it from an MTX into a TX. // This turns it from an MTX into a TX.
tx = tx.toTX(); var tx = mtx.toTX();
// The transaction should still verify.
// Regular transactions require a coin
// viewpoint to be passed in.
assert(tx.verify(mtx.view));
// The transaction should now verify.
assert(tx.verify());
``` ```
## Scripting ## Scripting
@ -658,7 +664,7 @@ assembly, but it's still usable.
The real feature of javascript is that your code will run almost anywhere. With The real feature of javascript is that your code will run almost anywhere. With
bcoin, we now have a full node that will run on almost any browser, on laptops, bcoin, we now have a full node that will run on almost any browser, on laptops,
on servers, on smartphones, on most devices you can imagine, even by simply on servers, on smartphones, on most devices you can imagine, even by simply
visting a webpage. visiting a webpage.
## Disclaimer ## Disclaimer