Merge pull request #381 from bitcoinjs/networkexhaust

Remove exhaustive network functionality
10 years ago · 03f3ccf06e
3 changed files with 41 additions and 264 deletions
--- a/src/networks.js
+++ b/src/networks.js
@ -1,7 +1,7 @@
 // https://en.bitcoin.it/wiki/List_of_address_prefixes
 // Dogecoin BIP32 is a proposed standard: https://bitcointalk.org/index.php?topic=409731

-var networks = {
+module.exports = {
  bitcoin: {
    magic: 0xd9b4bef9,
    messagePrefix: '\x18Bitcoin Signed Message:\n',
@ -12,8 +12,7 @@ var networks = {
    pubKeyHash: 0x00,
    scriptHash: 0x05,
    wif: 0x80,
-    dustThreshold: 546, // https://github.com/bitcoin/bitcoin/blob/v0.9.2/src/core.h#L151-L162
-    feePerKb: 10000 // https://github.com/bitcoin/bitcoin/blob/v0.9.2/src/main.cpp#L53
+    dustThreshold: 546 // https://github.com/bitcoin/bitcoin/blob/v0.9.2/src/core.h#L151-L162
  },
  testnet: {
    magic: 0xd9b4bef9,
@ -25,8 +24,7 @@ var networks = {
    pubKeyHash: 0x6f,
    scriptHash: 0xc4,
    wif: 0xef,
-    dustThreshold: 546,
-    feePerKb: 10000
+    dustThreshold: 546
  },
  litecoin: {
    magic: 0xd9b4bef9,
@ -38,9 +36,7 @@ var networks = {
    pubKeyHash: 0x30,
    scriptHash: 0x05,
    wif: 0xb0,
-    dustThreshold: 0, // https://github.com/litecoin-project/litecoin/blob/v0.8.7.2/src/main.cpp#L360-L365
-    dustSoftThreshold: 100000, // https://github.com/litecoin-project/litecoin/blob/v0.8.7.2/src/main.h#L53
-    feePerKb: 100000 // https://github.com/litecoin-project/litecoin/blob/v0.8.7.2/src/main.cpp#L56
+    dustThreshold: 0 // https://github.com/litecoin-project/litecoin/blob/v0.8.7.2/src/main.cpp#L360-L365
  },
  dogecoin: {
    messagePrefix: '\x19Dogecoin Signed Message:\n',
@ -51,101 +47,6 @@ var networks = {
    pubKeyHash: 0x1e,
    scriptHash: 0x16,
    wif: 0x9e,
-    dustThreshold: 0, // https://github.com/dogecoin/dogecoin/blob/v1.7.1/src/core.h#L155-L160
-    dustSoftThreshold: 100000000, // https://github.com/dogecoin/dogecoin/blob/v1.7.1/src/main.h#L62
-    feePerKb: 100000000 // https://github.com/dogecoin/dogecoin/blob/v1.7.1/src/main.cpp#L58
-  },
-  viacoin: {
-    messagePrefix: '\x18Viacoin Signed Message:\n',
-    bip32: {
-      public: 0x0488b21e,
-      private: 0x0488ade4
-    },
-    pubKeyHash: 0x47,
-    scriptHash: 0x21,
-    wif: 0xc7,
-    dustThreshold: 560,
-    dustSoftThreshold: 100000,
-    feePerKb: 100000
-  },
-  viacointestnet: {
-    messagePrefix: '\x18Viacoin Signed Message:\n',
-    bip32: {
-      public: 0x043587cf,
-      private: 0x04358394
-    },
-    pubKeyHash: 0x7f,
-    scriptHash: 0xc4,
-    wif: 0xff,
-    dustThreshold: 560,
-    dustSoftThreshold: 100000,
-    feePerKb: 100000
-  },
-  gamerscoin: {
-    messagePrefix: '\x19Gamerscoin Signed Message:\n',
-    bip32: {
-      public: 0x019da462,
-      private: 0x019d9cfe
-    },
-    pubKeyHash: 0x26,
-    scriptHash: 0x05,
-    wif: 0xA6,
-    dustThreshold: 0, // https://github.com/gamers-coin/gamers-coinv3/blob/master/src/main.cpp#L358-L363
-    dustSoftThreshold: 100000, // https://github.com/gamers-coin/gamers-coinv3/blob/master/src/main.cpp#L51
-    feePerKb: 100000 // https://github.com/gamers-coin/gamers-coinv3/blob/master/src/main.cpp#L54
-  },
-  jumbucks: {
-    messagePrefix: '\x19Jumbucks Signed Message:\n',
-    bip32: {
-      public: 0x037a689a,
-      private: 0x037a6460
-    },
-    pubKeyHash: 0x2b,
-    scriptHash: 0x05,
-    wif: 0xab,
-    dustThreshold: 0,
-    dustSoftThreshold: 10000,
-    feePerKb: 10000
-  },
-  zetacoin: {
-    messagePrefix: '\x18Zetacoin Signed Message:\n',
-    bip32: {
-      public: 0x0488b21e,
-      private: 0x0488ade4
-    },
-    pubKeyHash: 0x50,
-    scriptHash: 0x09,
-    wif: 0xe0,
-    dustThreshold: 546, // https://github.com/zetacoin/zetacoin/blob/master/src/core.h#L159
-    feePerKb: 10000 // https://github.com/zetacoin/zetacoin/blob/master/src/main.cpp#L54
+    dustThreshold: 0 // https://github.com/dogecoin/dogecoin/blob/v1.7.1/src/core.h#L155-L160
  }
 }
-
-function estimateFee (tx, network) {
-  var baseFee = network.feePerKb
-  var byteSize = tx.byteLength()
-
-  var fee = baseFee * Math.ceil(byteSize / 1000)
-  if (network.dustSoftThreshold === undefined) return fee
-
-  tx.outs.forEach(function (output) {
-    if (output.value < network.dustSoftThreshold) {
-      fee += baseFee
-    }
-  })
-
-  return fee
-}
-
-// FIXME: 1.5.3 compatibility patch(s)
-function patchEstimateFee (network, tx) {
-  return estimateFee(tx, network)
-}
-
-for (var networkName in networks) {
-  var network = networks[networkName]
-
-  network.estimateFee = patchEstimateFee.bind(null, network)
-}
-
-module.exports = networks
--- a/test/fixtures/network.json
+++ b/test/fixtures/network.json
@ -1,6 +1,4 @@
-{
-  "valid": {
-    "constants": [
+[
  {
    "network": "bitcoin",
    "bip32": {
@ -28,96 +26,5 @@
      "private": "dgpv51eADS3spNJh9Gjth94XcPwAczvQaDJs9rqx11kvxKs6r3Ek8AgERHhjLs6mzXQFHRzQqGwqdeoDkZmr8jQMBfi43b7sT3sx3cCSk5fGeUR",
      "public": "dgub8kXBZ7ymNWy2S8Q3jNgVjFUm5ZJ3QLLaSTdAA89ukSv7Q6MSXwE14b7Nv6eDpE9JJXinTKc8LeLVu19uDPrm5uJuhpKNzV2kAgncwo6bNpP"
    }
-      },
-      {
-        "network": "jumbucks",
-        "bip32": {
-          "private": "jprv5eCacBgN4Bz4zYxgVQ7RDt1a3eREhEaj8KjAcJ7YwogxGo2rmBF5kvAQS53JwZpo5wnUmJ9Q7kB6b2gQ1MzC6yaTc188hr6hXZ5t8Ruria1",
-          "public": "jpub1sBw1hDFtZYND339bReRb1xJbgFj6hJaVYemQgXAW9Dw9bN1JiZLJiUtHLgcTTEs1UgRGFAYm3XQPYsYJbpqj1aYPhrMsNcJHfgdAhvFZBB"
-        }
-      }
-    ],
-    "estimateFee": [
-      {
-        "description": "when txSize < 1kb",
-        "network": "bitcoin",
-        "txSize": 1,
-        "fee": 10000
-      },
-      {
-        "description": "when txSize >= 1kb",
-        "network": "bitcoin",
-        "txSize": 1000,
-        "fee": 10000
-      },
-      {
-        "description": "rounding",
-        "network": "bitcoin",
-        "txSize": 2800,
-        "fee": 30000
-      },
-      {
-        "description": "when outputs.value > DUST_SOFT_LIMIT, feePerKb is used",
-        "network": "dogecoin",
-        "txSize": 1000,
-        "outputs": [
-          {
-            "value": 100000000
-          }
-        ],
-        "fee": 100000000
-      },
-      {
-        "description": "when not every outputs.value > DUST_SOFT_LIMIT",
-        "network": "dogecoin",
-        "txSize": 1000,
-        "outputs": [
-          {
-            "value": 99999999
-          },
-          {
-            "value": 99999999
-          }
-        ],
-        "fee": 300000000
-      },
-      {
-        "description": "rounding",
-        "network": "dogecoin",
-        "txSize": 2800,
-        "fee": 300000000
-      },
-      {
-        "description": "when outputs.value > DUST_SOFT_LIMIT, feePerKb is used",
-        "network": "litecoin",
-        "txSize": 1000,
-        "outputs": [
-          {
-            "value": 100000
-          }
-        ],
-        "fee": 100000
-      },
-      {
-        "description": "when not every outputs.value > DUST_SOFT_LIMIT",
-        "network": "litecoin",
-        "txSize": 1000,
-        "outputs": [
-          {
-            "value": 99999
-          },
-          {
-            "value": 99999
-          }
-        ],
-        "fee": 300000
-      },
-      {
-        "description": "rounding",
-        "network": "litecoin",
-        "txSize": 2800,
-        "fee": 300000
  }
 ]
-  }
-}
--- a/test/networks.js
+++ b/test/networks.js
@ -1,53 +1,22 @@
-/* global describe, it, before, after */
+/* global describe, it */

 var assert = require('assert')
 var networks = require('../src/networks')
-var sinon = require('sinon')

 var HDNode = require('../src/hdnode')
-var Transaction = require('../src/transaction')

 var fixtures = require('./fixtures/network')

 describe('networks', function () {
-  var txByteLength
-  before(function () {
-    txByteLength = sinon.stub(Transaction.prototype, 'byteLength')
-  })
-
-  after(function () {
-    Transaction.prototype.byteLength.restore()
-  })
-
-  describe('constants', function () {
-    fixtures.valid.constants.forEach(function (f) {
+  fixtures.forEach(function (f) {
    var network = networks[f.network]

    Object.keys(f.bip32).forEach(function (name) {
      var extb58 = f.bip32[name]

-        it('resolves ' + extb58 + ' to ' + f.network, function () {
+      it(extb58 + ' auto-detects ' + f.network, function () {
        assert.equal(HDNode.fromBase58(extb58).network, network)
      })
    })
  })
 })
-
-  describe('estimateFee', function () {
-    fixtures.valid.estimateFee.forEach(function (f) {
-      describe('(' + f.network + ')', function () {
-        var network = networks[f.network]
-
-        it('calculates the fee correctly for ' + f.description, function () {
-          txByteLength.returns(f.txSize)
-
-          var estimateFee = network.estimateFee
-          var tx = new Transaction()
-          tx.outs = f.outputs || []
-
-          assert.equal(estimateFee(tx), f.fee)
-        })
-      })
-    })
-  })
-})