Merge pull request #111 from Permissionless-Software-Foundation/ct-unstable

fix(ip): Renaming origin to ip

package.json

@@ -16,8 +16,9 @@
     "test:integration:local:abc": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 test/integration && mocha --timeout 30000 test/integration/chains/abc/",
     "test:integration:local:bchn": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 test/integration/ && mocha --timeout 30000 test/integration/chains/bchn/",
     "test:integration:local:testnet": "RESTURL=http://localhost:4000/v4/ mocha --timeout 30000 test/integration/chains/testnet",
-    "test:temp": "export RESTURL=https://bchn.fullstack.cash/v4/ && mocha --timeout 30000 -g '#UTXO' test/integration/chains/bchn/",
+    "test:temp": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 -g '#hydrateUtxos' test/integration/",
     "test:temp2": "mocha --timeout=30000 -g '#Util' test/unit/",
+    "test:temp3": "export RESTURL=https://bchn.fullstack.cash/v4/ && mocha --timeout 30000 -g '#hydrateUtxos' test/integration/",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
     "coverage:report": "nyc --reporter=html mocha --timeout 25000 test/unit/",
     "docs": "./node_modules/.bin/apidoc -i src/ -o docs",
@@ -37,7 +38,6 @@
     "@psf/coininfo": "^4.0.0",
     "@uppy/core": "^1.10.4",
     "@uppy/tus": "^1.5.12",
-    "assert": "^2.0.0",
     "axios": "^0.21.1",
     "bc-bip68": "^1.0.5",
     "bchaddrjs-slp": "^0.2.5",
@@ -49,33 +49,18 @@
     "bip66": "^1.1.5",
     "bitcoinjs-message": "^2.0.0",
     "bs58": "^4.0.1",
-    "buffer": "^5.1.0",
     "cashaddrjs": "^0.3.3",
-    "chalk": "^2.3.0",
-    "clear": "0.1.0",
-    "commander": "^3.0.0",
-    "cp-file": "^7.0.0",
-    "ecurve": "^1.0.6",
-    "figlet": "^1.2.0",
-    "git-clone": "^0.1.0",
     "ini": "^1.3.8",
-    "mkdirp": "^0.5.1",
-    "node-cmd": "^3.0.0",
-    "node-emoji": "^1.8.1",
-    "qrcode": "^1.4.1",
     "randombytes": "^2.0.6",
-    "repl.history": "^0.1.4",
     "safe-buffer": "^5.1.2",
     "satoshi-bitcoin": "^1.0.4",
     "slp-mdm": "0.0.6",
     "slp-parser": "0.0.4",
-    "socket.io": "^2.1.1",
-    "socket.io-client": "^2.1.1",
-    "touch": "^3.1.0",
     "wif": "^2.0.6"
   },
   "devDependencies": {
     "apidoc": "^0.17.7",
+    "assert": "^2.0.0",
     "chai": "^4.1.2",
     "coveralls": "^3.0.2",
     "eslint": "5.16.0",
@@ -90,7 +75,7 @@
     "node-mocks-http": "^1.7.0",
     "nyc": "^14.1.0",
     "prettier": "^1.18.2",
-    "semantic-release": "^17.3.1",
+    "semantic-release": "^17.3.9",
     "sinon": "^7.3.2",
     "standard": "^16.0.3"
   },

src/bch-js.js

@@ -26,7 +26,6 @@ const TransactionBuilder = require('./transaction-builder')
 const ECPair = require('./ecpair')
 const Script = require('./script')
 const Price = require('./price')
-const Socket = require('./socket')
 const Schnorr = require('./schnorr')
 const SLP = require('./slp/slp')
 const IPFS = require('./ipfs')
@@ -107,7 +106,6 @@ class BCHJS {
     this.TransactionBuilder = TransactionBuilder
     this.TransactionBuilder.setAddress(this.Address)
     this.Util = new Util(libConfig)
-    this.Socket = Socket
     this.Schnorr = new Schnorr(libConfig)
 
     this.SLP = new SLP(libConfig)

src/slp/utils.js

@@ -436,10 +436,11 @@ class Utils {
   // will be like the examples above. If SLPDB has fallen behind real-time
   // processing, it will return this output:
   // [ null ]
-  async validateTxid (txid) {
+  async validateTxid (txid, ip = null) {
     const path = `${this.restURL}slp/validateTxid`
 
     // console.log(`txid: ${JSON.stringify(txid, null, 2)}`)
+    console.log('validateTxid ip: ', ip)
 
     // Handle a single TXID or an array of TXIDs.
     let txids
@@ -649,11 +650,12 @@ class Utils {
    *     '00ea27261196a411776f81029c0ebe34362936b4a9847deb1f7a40a02b3a1476',
    *    valid: true } ]
    */
-  async validateTxid3 (txid) {
+  async validateTxid3 (txid, ip = null) {
     const path = `${this.restURL}slp/validateTxid3`
 
     // console.log(`txid: ${JSON.stringify(txid, null, 2)}`)
     // console.log(`path: ${JSON.stringify(path, null, 2)}`)
+    console.log('ip: ', ip)
 
     // Handle a single TXID or an array of TXIDs.
     let txids
@@ -664,7 +666,8 @@ class Utils {
       const response = await _this.axios.post(
         path,
         {
-          txids: txids
+          txids: txids,
+          ip
         },
         _this.axiosOptions
       )
@@ -1019,6 +1022,9 @@ class Utils {
    * then SLPDB has not yet processed that txid and validity has not been confirmed,
    * or a 429 rate-limit error was enountered during the processing of the request.
    *
+   * This is an API-heavy call. If you get a lot of null values, then slow down
+   * the calls or request info on fewer UTXOs at a time.
+   *
    * @apiExample Example usage:
    *
    * (async () => {
@@ -1058,7 +1064,7 @@ class Utils {
   // https://github.com/Bitcoin-com/slp-sdk/issues/84
 
   // CT 5/31/20: Refactored to use slp-parse library.
-  async tokenUtxoDetails (utxos) {
+  async tokenUtxoDetails (utxos, ip = null) {
     try {
       // Throw error if input is not an array.
       if (!Array.isArray(utxos)) throw new Error('Input must be an array.')
@@ -1110,7 +1116,7 @@ class Utils {
           // information.
 
           // Validate using a 'waterfall' of validators.
-          utxo.isValid = await this.waterfallValidateTxid(utxo.txid)
+          utxo.isValid = await this.waterfallValidateTxid(utxo.txid, ip)
           // console.log(`isValid: ${JSON.stringify(utxo.isValid, null, 2)}`)
         }
       }
@@ -1447,8 +1453,7 @@ class Utils {
    * // returns
    * true
    */
-
-  async waterfallValidateTxid (txid) {
+  async waterfallValidateTxid (txid, ip = null) {
     try {
       // console.log('txid: ', txid)
 
@@ -1480,7 +1485,7 @@ class Utils {
       // validateTxid2() uses slp-validate, which has a different output format.
 
       // Validate against the whitelist SLPDB first.
-      const whitelistResult = await this.validateTxid3(txid)
+      const whitelistResult = await this.validateTxid3(txid, ip)
       // console.log(
       //   `whitelist-SLPDB for ${txid}: ${JSON.stringify(
       //     whitelistResult,
@@ -1501,7 +1506,7 @@ class Utils {
       }
 
       // Try the general SLPDB, if the whitelist returned null.
-      const generalResult = await this.validateTxid(txid)
+      const generalResult = await this.validateTxid(txid, ip)
       // console.log(
       //   `validateTxid() isValid: ${JSON.stringify(generalResult, null, 2)}`
       // )
@@ -1563,11 +1568,14 @@ class Utils {
    * set to false.
    * If the UTXO is part of an SLP transaction, it will return the UTXO object
    * with additional SLP information attached. An `isValid` property will be included.
-   * If its value is true, the UTXO is a valid SLP UTXO. \
+   * If its value is true, the UTXO is a valid SLP UTXO.
    * If the isValid value is null,
    * then SLPDB has not yet processed that txid and validity has not been confirmed,
    * or a 429 rate-limit error was enountered during the processing of the request.
    *
+   * This is an API-heavy call. If you get a lot of null values, then slow down
+   * the calls or request info on fewer UTXOs at a time.
+   *
    * @apiExample Example usage:
    *
    * (async () => {

src/socket.js

@@ -1,28 +0,0 @@
-const io = require('socket.io-client')
-
-class Socket {
-  constructor (config = {}) {
-    if (typeof config === 'string') {
-      // TODO remove this check in v2.0
-      this.socket = io(`${config}`)
-    } else {
-      if (config.restURL) {
-        this.socket = io(`${config.restURL}`)
-      } else {
-        const restURL = 'https://rest.bitcoin.com'
-        this.socket = io(`${restURL}`)
-      }
-
-      if (config.callback) config.callback()
-    }
-  }
-
-  listen (endpoint, cb) {
-    this.socket.emit(endpoint)
-
-    if (endpoint === 'blocks') this.socket.on('blocks', msg => cb(msg))
-    else if (endpoint === 'transactions') { this.socket.on('transactions', msg => cb(msg)) }
-  }
-}
-
-module.exports = Socket

src/util.js

@@ -150,6 +150,30 @@ class Util {
     }
   }
 
+  /**
+   * @api util.sleep() sleep()
+   * @apiName sleep
+   * @apiGroup Util
+   * @apiDescription Promise-based delay.
+   * Expects an integer as input, which represents milliseconds. This function
+   * will return a Promise that resolves that many milliseconds later.
+   *
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   *   try {
+   *     const tenSeconds = 10000
+   *     await bchjs.Util.sleep(tenSeconds)
+   *   } catch(error) {
+   *    console.error(error)
+   *   }
+   * })()
+   *
+   */
+  sleep (ms) {
+    return new Promise(resolve => setTimeout(resolve, ms))
+  }
+
   /**
    * @api util.validateAddress() validateAddress()
    * @apiName Validate Address.

test/integration/chains/abc/utxo-integration.js

@@ -22,9 +22,13 @@ describe('#UTXO', () => {
       const result = await bchjs.Utxo.get(addr)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
-      assert.isArray(result.bchUtxos)
-      assert.isArray(result.slpUtxos)
-      assert.isArray(result.nullUtxos)
+      assert.isArray(result)
+      assert.property(result[0], 'address')
+      assert.property(result[0], 'bchUtxos')
+      assert.property(result[0], 'nullUtxos')
+      assert.property(result[0], 'slpUtxos')
+      assert.isArray(result[0].bchUtxos)
+      assert.isArray(result[0].nullUtxos)
     })
   })
 })

test/integration/chains/bchn/utxo-integration.js

@@ -112,7 +112,7 @@ describe('#UTXO', () => {
       // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
 
       const result = bchjs.Utxo.findBiggestUtxo(utxos[0].bchUtxos)
-      console.log(`result: ${JSON.stringify(result, null, 2)}`)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
       assert.property(result, 'satoshis')
       assert.equal(result.satoshis, 800)