Merge pull request #262 from dcousens/wallref

processTx considered harmful followup
This commit is contained in:
Wei Lu 2014-09-06 22:25:43 +08:00
commit cc98600154
5 changed files with 343 additions and 251 deletions

View file

@ -159,11 +159,18 @@ function writeVarInt(buffer, number, offset) {
return size
}
function reverse(buffer) {
var buffer2 = new Buffer(buffer)
Array.prototype.reverse.call(buffer2)
return buffer2
}
module.exports = {
pushDataSize: pushDataSize,
readPushDataInt: readPushDataInt,
readUInt64LE: readUInt64LE,
readVarInt: readVarInt,
reverse: reverse,
varIntSize: varIntSize,
writePushDataInt: writePushDataInt,
writeUInt64LE: writeUInt64LE,

View file

@ -37,10 +37,8 @@ Transaction.prototype.addInput = function(tx, index, sequence) {
var hash
if (typeof tx === 'string') {
hash = new Buffer(tx, 'hex')
// TxId hex is big-endian, we need little-endian
Array.prototype.reverse.call(hash)
hash = bufferutils.reverse(new Buffer(tx, 'hex'))
} else if (tx instanceof Transaction) {
hash = tx.getHash()
@ -212,12 +210,8 @@ Transaction.prototype.getHash = function () {
}
Transaction.prototype.getId = function () {
var buffer = this.getHash()
// Big-endian is used for TxHash
Array.prototype.reverse.call(buffer)
return buffer.toString('hex')
// TxHash is little-endian, we need big-endian
return bufferutils.reverse(this.getHash()).toString('hex')
}
Transaction.prototype.clone = function () {

View file

@ -1,4 +1,5 @@
var assert = require('assert')
var bufferutils = require('./bufferutils')
var crypto = require('crypto')
var networks = require('./networks')
@ -7,7 +8,7 @@ var HDNode = require('./hdnode')
var TransactionBuilder = require('./transaction_builder')
var Script = require('./script')
function Wallet(seed, network, unspents) {
function Wallet(seed, network) {
seed = seed || crypto.randomBytes(32)
network = network || networks.bitcoin
@ -23,9 +24,12 @@ function Wallet(seed, network, unspents) {
this.addresses = []
this.changeAddresses = []
this.network = network
this.outputs = unspents ? processUnspentOutputs(unspents) : {}
this.unspents = []
// FIXME: remove in 2.x.y
// FIXME: remove in 2.0.0
this.unspentMap = {}
// FIXME: remove in 2.0.0
var me = this
this.newMasterKey = function(seed) {
console.warn('newMasterKey is deprecated, please make a new Wallet instance instead')
@ -40,7 +44,8 @@ function Wallet(seed, network, unspents) {
me.addresses = []
me.changeAddresses = []
me.outputs = {}
me.unspents = []
me.unspentMap = {}
}
this.getMasterKey = function() { return masterKey }
@ -49,28 +54,54 @@ function Wallet(seed, network, unspents) {
this.getInternalAccount = function() { return internalAccount }
}
Wallet.prototype.createTx = function(to, value, fixedFee, changeAddress) {
Wallet.prototype.createTransaction = function(to, value, options) {
// FIXME: remove in 2.0.0
if (typeof options !== 'object') {
if (options !== undefined) {
console.warn('Non options object parameters are deprecated, use options object instead')
options = {
fixedFee: arguments[2],
changeAddress: arguments[3]
}
}
}
options = options || {}
assert(value > this.network.dustThreshold, value + ' must be above dust threshold (' + this.network.dustThreshold + ' Satoshis)')
var utxos = getCandidateOutputs(this.outputs, value)
var changeAddress = options.changeAddress
var fixedFee = options.fixedFee
var minConf = options.minConf === undefined ? 0 : options.minConf // FIXME: change minConf:1 by default in 2.0.0
// filter by minConf, then pending and sort by descending value
var unspents = this.unspents.filter(function(unspent) {
return unspent.confirmations >= minConf
}).filter(function(unspent) {
return !unspent.pending
}).sort(function(o1, o2) {
return o2.value - o1.value
})
var accum = 0
var subTotal = value
var addresses = []
var subTotal = value
var txb = new TransactionBuilder()
txb.addOutput(to, value)
for (var i = 0; i < utxos.length; ++i) {
var utxo = utxos[i]
addresses.push(utxo.address)
for (var i = 0; i < unspents.length; ++i) {
var unspent = unspents[i]
addresses.push(unspent.address)
var outpoint = utxo.from.split(':')
txb.addInput(outpoint[0], parseInt(outpoint[1]))
txb.addInput(unspent.txHash, unspent.index)
var fee = fixedFee === undefined ? estimatePaddedFee(txb.buildIncomplete(), this.network) : fixedFee
accum += utxo.value
accum += unspent.value
subTotal = value + fee
if (accum >= subTotal) {
var change = accum - subTotal
@ -87,16 +118,22 @@ Wallet.prototype.createTx = function(to, value, fixedFee, changeAddress) {
return this.signWith(txb, addresses).build()
}
// FIXME: remove in 2.0.0
Wallet.prototype.processPendingTx = function(tx){
this.__processTx(tx, true)
}
// FIXME: remove in 2.0.0
Wallet.prototype.processConfirmedTx = function(tx){
this.__processTx(tx, false)
}
// FIXME: remove in 2.0.0
Wallet.prototype.__processTx = function(tx, isPending) {
var txid = tx.getId()
console.warn('processTransaction is considered harmful, see issue #260 for more information')
var txId = tx.getId()
var txHash = tx.getHash()
tx.outs.forEach(function(txOut, i) {
var address
@ -109,32 +146,44 @@ Wallet.prototype.__processTx = function(tx, isPending) {
var myAddresses = this.addresses.concat(this.changeAddresses)
if (myAddresses.indexOf(address) > -1) {
var output = txid + ':' + i
var lookup = txId + ':' + i
if (lookup in this.unspentMap) return
this.outputs[output] = {
from: output,
value: txOut.value,
// its unique, add it
var unspent = {
address: address,
confirmations: 0, // no way to determine this without more information
index: i,
txHash: txHash,
txId: txId,
value: txOut.value,
pending: isPending
}
this.unspentMap[lookup] = unspent
this.unspents.push(unspent)
}
}, this)
tx.ins.forEach(function(txIn, i) {
// copy and convert to big-endian hex
var txinId = new Buffer(txIn.hash)
Array.prototype.reverse.call(txinId)
txinId = txinId.toString('hex')
var txInId = bufferutils.reverse(txIn.hash).toString('hex')
var output = txinId + ':' + txIn.index
var lookup = txInId + ':' + txIn.index
if (!(lookup in this.unspentMap)) return
if (!(output in this.outputs)) return
var unspent = this.unspentMap[lookup]
if (isPending) {
this.outputs[output].to = txid + ':' + i
this.outputs[output].pending = true
unspent.pending = true
unspent.spent = true
} else {
delete this.outputs[output]
delete this.unspentMap[lookup]
this.unspents = this.unspents.filter(function(unspent2) {
return unspent !== unspent2
})
}
}, this)
}
@ -157,9 +206,25 @@ Wallet.prototype.generateChangeAddress = function() {
return this.getChangeAddress()
}
Wallet.prototype.getBalance = function() {
return this.getUnspentOutputs().reduce(function(accum, output) {
return accum + output.value
Wallet.prototype.getAddress = function() {
if (this.addresses.length === 0) {
this.generateAddress()
}
return this.addresses[this.addresses.length - 1]
}
Wallet.prototype.getBalance = function(minConf) {
minConf = minConf || 0
return this.unspents.filter(function(unspent) {
return unspent.confirmations >= minConf
// FIXME: remove spent filter in 2.0.0
}).filter(function(unspent) {
return !unspent.spent
}).reduce(function(accum, unspent) {
return accum + unspent.value
}, 0)
}
@ -193,51 +258,88 @@ Wallet.prototype.getPrivateKeyForAddress = function(address) {
assert(false, 'Unknown address. Make sure the address is from the keychain and has been generated')
}
Wallet.prototype.getReceiveAddress = function() {
if (this.addresses.length === 0) {
this.generateAddress()
Wallet.prototype.getUnspentOutputs = function(minConf) {
minConf = minConf || 0
return this.unspents.filter(function(unspent) {
return unspent.confirmations >= minConf
// FIXME: remove spent filter in 2.0.0
}).filter(function(unspent) {
return !unspent.spent
}).map(function(unspent) {
return {
address: unspent.address,
confirmations: unspent.confirmations,
index: unspent.index,
txId: unspent.txId,
value: unspent.value,
// FIXME: remove in 2.0.0
hash: unspent.txId,
pending: unspent.pending
}
})
}
return this.addresses[this.addresses.length - 1]
Wallet.prototype.setUnspentOutputs = function(unspents) {
this.unspentMap = {}
this.unspents = unspents.map(function(unspent) {
// FIXME: remove unspent.hash in 2.0.0
var txId = unspent.txId || unspent.hash
var index = unspent.index
// FIXME: remove in 2.0.0
if (unspent.hash !== undefined) {
console.warn('unspent.hash is deprecated, use unspent.txId instead')
}
Wallet.prototype.getUnspentOutputs = function() {
var utxo = []
for(var key in this.outputs){
var output = this.outputs[key]
if(!output.to) utxo.push(outputToUnspentOutput(output))
// FIXME: remove in 2.0.0
if (index === undefined) {
console.warn('unspent.outputIndex is deprecated, use unspent.index instead')
index = utxo.outputIndex
}
return utxo
assert.equal(typeof txId, 'string', 'Expected txId, got ' + txId)
assert.equal(txId.length, 64, 'Expected valid txId, got ' + txId)
assert.doesNotThrow(function() { Address.fromBase58Check(unspent.address) }, 'Expected Base58 Address, got ' + unspent.address)
assert.equal(typeof index, 'number', 'Expected number index, got ' + index)
assert.equal(typeof unspent.value, 'number', 'Expected number value, got ' + unspent.value)
// FIXME: remove branch in 2.0.0
if (unspent.confirmations !== undefined) {
assert.equal(typeof unspent.confirmations, 'number', 'Expected number confirmations, got ' + unspent.confirmations)
}
Wallet.prototype.setUnspentOutputs = function(utxo) {
console.warn('setUnspentOutputs is deprecated, please use the constructor option instead')
var txHash = bufferutils.reverse(new Buffer(txId, 'hex'))
this.outputs = processUnspentOutputs(utxo)
var unspent = {
address: unspent.address,
confirmations: unspent.confirmations || 0,
index: index,
txHash: txHash,
txId: txId,
value: unspent.value,
// FIXME: remove in 2.0.0
pending: unspent.pending || false
}
Wallet.prototype.signWith = function(txb, addresses) {
// FIXME: remove in 2.0.0
this.unspentMap[txId + ':' + index] = unspent
return unspent
}, this)
}
Wallet.prototype.signWith = function(tx, addresses) {
addresses.forEach(function(address, i) {
var privKey = this.getPrivateKeyForAddress(address)
txb.sign(i, privKey)
tx.sign(i, privKey)
}, this)
return txb
}
function outputToUnspentOutput(output){
var hashAndIndex = output.from.split(":")
return {
hash: hashAndIndex[0],
index: parseInt(hashAndIndex[1]),
address: output.address,
value: output.value,
pending: output.pending
}
return tx
}
function estimatePaddedFee(tx, network) {
@ -247,49 +349,8 @@ function estimatePaddedFee(tx, network) {
return network.estimateFee(tmpTx)
}
function processUnspentOutputs(utxos) {
var outputs = {}
utxos.forEach(function(utxo){
var hash = new Buffer(utxo.hash, 'hex')
var index = utxo.index
var address = utxo.address
var value = utxo.value
// FIXME: remove alternative in 2.x.y
if (index === undefined) index = utxo.outputIndex
assert.equal(hash.length, 32, 'Expected hash length of 32, got ' + hash.length)
assert.equal(typeof index, 'number', 'Expected number index, got ' + index)
assert.doesNotThrow(function() { Address.fromBase58Check(address) }, 'Expected Base58 Address, got ' + address)
assert.equal(typeof value, 'number', 'Expected number value, got ' + value)
var key = utxo.hash + ':' + utxo.index
outputs[key] = {
from: key,
address: address,
value: value,
pending: utxo.pending
}
})
return outputs
}
function getCandidateOutputs(outputs/*, value*/) {
var unspent = []
for (var key in outputs) {
var output = outputs[key]
if (!output.pending) unspent.push(output)
}
var sortByValueDesc = unspent.sort(function(o1, o2){
return o2.value - o1.value
})
return sortByValueDesc
}
// FIXME: 1.0.0 shims, remove in 2.0.0
Wallet.prototype.getReceiveAddress = Wallet.prototype.getAddress
Wallet.prototype.createTx = Wallet.prototype.createTransaction
module.exports = Wallet

View file

@ -75,6 +75,19 @@ describe('bufferutils', function() {
})
})
describe('reverse', function() {
fixtures.valid.forEach(function(f) {
it('reverses ' + f.hex64 + ' correctly', function() {
var buffer = new Buffer(f.hex64, 'hex')
var buffer2 = bufferutils.reverse(buffer)
Array.prototype.reverse.call(buffer)
assert.deepEqual(buffer, buffer2)
})
})
})
describe('varIntSize', function() {
fixtures.valid.forEach(function(f) {
it('determines the varIntSize of ' + f.dec + ' correctly', function() {

View file

@ -1,4 +1,5 @@
var assert = require('assert')
var bufferutils = require('../src/bufferutils')
var crypto = require('../src/crypto')
var networks = require('../src/networks')
var sinon = require('sinon')
@ -201,26 +202,25 @@ describe('Wallet', function() {
beforeEach(function() {
utxo = {
"address" : "1AZpKpcfCzKDUeTFBQUL4MokQai3m3HMXv",
"hash": fakeTxId(6),
"confirmations": 1,
"index": 0,
"pending": true,
"value": 20000
"txId": fakeTxId(6),
"value": 20000,
"pending": false
}
expectedOutputKey = utxo.hash + ":" + utxo.index
})
describe('on construction', function() {
beforeEach(function() {
wallet = new Wallet(seed, networks.bitcoin, [utxo])
wallet = new Wallet(seed, networks.bitcoin)
wallet.setUnspentOutputs([utxo])
})
it('matches the expected behaviour', function() {
var output = wallet.outputs[expectedOutputKey]
var output = wallet.unspents[0]
assert(output)
assert.equal(output.value, utxo.value)
assert.equal(output.address, utxo.address)
assert.equal(output.value, utxo.value)
})
})
@ -229,7 +229,8 @@ describe('Wallet', function() {
var utxo1 = cloneObject(utxo)
utxo1.hash = fakeTxId(5)
wallet = new Wallet(seed, networks.bitcoin, [utxo, utxo1])
wallet = new Wallet(seed, networks.bitcoin)
wallet.setUnspentOutputs([utxo, utxo1])
})
it('sums over utxo values', function() {
@ -239,23 +240,36 @@ describe('Wallet', function() {
describe('getUnspentOutputs', function() {
beforeEach(function() {
wallet = new Wallet(seed, networks.bitcoin, [utxo])
wallet = new Wallet(seed, networks.bitcoin)
wallet.setUnspentOutputs([utxo])
})
it('parses wallet outputs to the expected format', function(){
assert.deepEqual(wallet.getUnspentOutputs(), [utxo])
it('parses wallet unspents to the expected format', function() {
var outputs = wallet.getUnspentOutputs()
var output = outputs[0]
assert.equal(utxo.address, output.address)
assert.equal(utxo.index, output.index)
assert.equal(utxo.value, output.value)
// FIXME: remove in 2.0.0
assert.equal(utxo.txId, output.hash)
assert.equal(utxo.pending, output.pending)
// new in 2.0.0
assert.equal(utxo.txId, output.txId)
assert.equal(utxo.confirmations, output.confirmations)
})
it("ignores pending spending outputs (outputs with 'to' property)", function(){
var output = wallet.outputs[expectedOutputKey]
output.to = fakeTxId(0) + ':' + 0
output.pending = true
it("ignores spent unspents (outputs with 'spent' property)", function() {
var unspent = wallet.unspents[0]
unspent.pending = true
unspent.spent = true
assert.deepEqual(wallet.getUnspentOutputs(), [])
})
})
})
// FIXME: remove in 2.x.y
describe('setUnspentOutputs', function() {
var utxo
var expectedOutputKey
@ -268,16 +282,13 @@ describe('Wallet', function() {
value: 500000
}
expectedOutputKey = utxo.hash + ":" + utxo.index
wallet = new Wallet(seed, networks.bitcoin)
})
it('matches the expected behaviour', function() {
wallet.setUnspentOutputs([utxo])
var output = wallet.outputs[expectedOutputKey]
assert(output)
var output = wallet.unspents[0]
assert.equal(output.value, utxo.value)
assert.equal(output.address, utxo.address)
})
@ -331,18 +342,18 @@ describe('Wallet', function() {
spendTx = Transaction.fromHex(fixtureTx2Hex)
})
it("outgoing: sets the pending flag and 'to' on output", function(){
it("outgoing: sets the pending flag and 'spent' on output", function() {
var txIn = spendTx.ins[0]
var txInId = new Buffer(txIn.hash)
Array.prototype.reverse.call(txInId)
txInId = txInId.toString('hex')
var key = txInId + ':' + txIn.index
assert(!wallet.outputs[key].pending)
var unspent = wallet.unspents[0]
assert(!unspent.pending)
wallet.processPendingTx(spendTx)
assert(wallet.outputs[key].pending)
assert.equal(wallet.outputs[key].to, spendTx.getId() + ':' + 0)
assert(unspent.pending)
assert(unspent.spent, true)
})
})
})
@ -359,7 +370,7 @@ describe('Wallet', function() {
wallet.processConfirmedTx(tx2)
})
describe("when tx outs contains an address owned by the wallet, an 'output' gets added to wallet.outputs", function(){
describe("when tx outs contains an address owned by the wallet, an 'output' gets added to wallet.unspentMap", function() {
it("works for receive address", function() {
var totalOuts = outputCount()
@ -381,11 +392,11 @@ describe('Wallet', function() {
})
function outputCount() {
return Object.keys(wallet.outputs).length
return Object.keys(wallet.unspentMap).length
}
})
describe("when tx ins outpoint contains a known txhash:i", function(){
describe("when tx ins contains a known txhash:i", function() {
var spendTx
beforeEach(function() {
wallet.addresses = [addresses[0]] // the address fixtureTx2 used as input
@ -394,36 +405,36 @@ describe('Wallet', function() {
spendTx = Transaction.fromHex(fixtureTx2Hex)
})
it("does not add to wallet.outputs", function(){
it("does not add to wallet.unspentMap", function() {
wallet.processConfirmedTx(spendTx)
assert.deepEqual(wallet.outputs, {})
assert.deepEqual(wallet.unspentMap, {})
})
it("deletes corresponding 'output'", function(){
it("deletes corresponding 'unspent'", function() {
var txIn = spendTx.ins[0]
var txInId = new Buffer(txIn.hash)
Array.prototype.reverse.call(txInId)
txInId = txInId.toString('hex')
var txInId = bufferutils.reverse(txIn.hash).toString('hex')
var expected = txInId + ':' + txIn.index
assert(expected in wallet.outputs)
assert(expected in wallet.unspentMap)
wallet.processConfirmedTx(spendTx)
assert(!(expected in wallet.outputs))
assert(!(expected in wallet.unspentMap))
})
})
})
it("does nothing when none of the involved addresses belong to the wallet", function() {
wallet.processConfirmedTx(tx)
assert.deepEqual(wallet.outputs, {})
})
assert.deepEqual(wallet.unspentMap, {})
})
function verifyOutputAdded(index, pending) {
var txOut = tx.outs[index]
var key = tx.getId() + ":" + index
var output = wallet.outputs[key]
assert.equal(output.from, key)
var output = wallet.unspentMap[key]
assert.deepEqual(output.txHash, tx.getHash())
assert.equal(output.value, txOut.value)
assert.equal(output.pending, pending)
@ -447,26 +458,27 @@ describe('Wallet', function() {
// set up 3 utxos
var utxos = [
{
"hash": fakeTxId(1),
"txId": fakeTxId(1),
"index": 0,
"address": address1,
"value": 400000 // not enough for value
},
{
"hash": fakeTxId(2),
"txId": fakeTxId(2),
"index": 1,
"address": address1,
"value": 500000 // enough for only value
},
{
"hash": fakeTxId(3),
"txId": fakeTxId(3),
"index": 0,
"address" : address2,
"value": 510000 // enough for value and fee
}
]
wallet = new Wallet(seed, networks.testnet, utxos)
wallet = new Wallet(seed, networks.testnet)
wallet.setUnspentOutputs(utxos)
wallet.generateAddress()
wallet.generateAddress()
})
@ -474,7 +486,7 @@ describe('Wallet', function() {
describe('transaction fee', function() {
it('allows fee to be specified', function() {
var fee = 30000
var tx = wallet.createTx(to, value, fee)
var tx = wallet.createTx(to, value, { fixedFee: fee })
assert.equal(getFee(wallet, tx), fee)
})
@ -482,20 +494,21 @@ describe('Wallet', function() {
it('allows fee to be set to zero', function() {
value = 510000
var fee = 0
var tx = wallet.createTx(to, value, fee)
var tx = wallet.createTx(to, value, { fixedFee: fee })
assert.equal(getFee(wallet, tx), fee)
})
it('does not overestimate fees when network has dustSoftThreshold', function() {
var utxo = {
hash: fakeTxId(0),
txId: fakeTxId(0),
index: 0,
address: "LeyySKbQrRRwodKEj1W4a8y3YQupPLw5os",
value: 500000
}
var wallet = new Wallet(seed, networks.litecoin, [utxo])
var wallet = new Wallet(seed, networks.litecoin)
wallet.setUnspentOutputs([utxo])
wallet.generateAddress()
value = 200000
@ -505,13 +518,14 @@ describe('Wallet', function() {
})
function getFee(wallet, tx) {
var inputValue = tx.ins.reduce(function(memo, input){
var id = Array.prototype.reverse.call(input.hash).toString('hex')
return memo + wallet.outputs[id + ':' + input.index].value
var inputValue = tx.ins.reduce(function(accum, input) {
var txId = bufferutils.reverse(input.hash).toString('hex')
return accum + wallet.unspentMap[txId + ':' + input.index].value
}, 0)
return tx.outs.reduce(function(memo, output){
return memo - output.value
return tx.outs.reduce(function(accum, output) {
return accum - output.value
}, inputValue)
}
})
@ -559,7 +573,10 @@ describe('Wallet', function() {
var toValue = fromValue / 2
var fee = 1e3
var tx = wallet.createTx(to, toValue, fee, changeAddress)
var tx = wallet.createTx(to, toValue, {
fixedFee: fee,
changeAddress: changeAddress
})
assert.equal(tx.outs.length, 2)
var outAddress0 = Address.fromOutputScript(tx.outs[0].script, networks.testnet)
@ -590,7 +607,7 @@ describe('Wallet', function() {
var fee = 0
wallet.generateChangeAddress()
wallet.generateChangeAddress()
var tx = wallet.createTx(to, value, fee)
var tx = wallet.createTx(to, value, { fixedFee: fee })
assert.equal(tx.outs.length, 2)
var out = tx.outs[1]
@ -604,7 +621,7 @@ describe('Wallet', function() {
var fee = 0
assert.equal(wallet.changeAddresses.length, 0)
var tx = wallet.createTx(to, value, fee)
var tx = wallet.createTx(to, value, { fixedFee: fee })
assert.equal(wallet.changeAddresses.length, 1)
var out = tx.outs[1]
@ -631,7 +648,7 @@ describe('Wallet', function() {
var fee = 30000
sinon.spy(TransactionBuilder.prototype, "sign")
var tx = wallet.createTx(to, value, fee)
var tx = wallet.createTx(to, value, { fixedFee: fee })
assert(TransactionBuilder.prototype.sign.calledWith(0, wallet.getPrivateKeyForAddress(address2)))
assert(TransactionBuilder.prototype.sign.calledWith(1, wallet.getPrivateKeyForAddress(address1)))