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

fix(decodeOpReturn): replacing ip with usrObj

package.json

@@ -16,8 +16,10 @@
     "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/",
+    "test:temp4": "export RESTURL=http://localhost:3000/v4/ && mocha --timeout 30000 -g '#decodeOpReturn' 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 +39,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 +50,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 +76,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/tokentype1.js

@@ -118,11 +118,11 @@ class TokenType1 {
 
         // Convert the send quantity to the format expected by slp-mdm.
         const baseQty = sendQtyBig.toString()
-        console.log('baseQty: ', baseQty)
+        // console.log('baseQty: ', baseQty)
 
         // Convert the change quantity to the format expected by slp-mdm.
         const baseChange = change.toString()
-        console.log('baseChange: ', baseChange)
+        // console.log('baseChange: ', baseChange)
 
         // Check for potential burns
         const outputQty = new BigNumber(baseChange).plus(

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, usrObj = null) {
     const path = `${this.restURL}slp/validateTxid`
 
     // console.log(`txid: ${JSON.stringify(txid, null, 2)}`)
+    console.log(`validateTxid usrObj: ${JSON.stringify(usrObj, null, 2)}`)
 
     // Handle a single TXID or an array of TXIDs.
     let txids
@@ -450,7 +451,8 @@ class Utils {
       const response = await _this.axios.post(
         path,
         {
-          txids: txids
+          txids: txids,
+          usrObj
         },
         _this.axiosOptions
       )
@@ -649,11 +651,12 @@ class Utils {
    *     '00ea27261196a411776f81029c0ebe34362936b4a9847deb1f7a40a02b3a1476',
    *    valid: true } ]
    */
-  async validateTxid3 (txid) {
+  async validateTxid3 (txid, usrObj = 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('validateTxid3 usrObj: ', usrObj)
 
     // Handle a single TXID or an array of TXIDs.
     let txids
@@ -664,7 +667,8 @@ class Utils {
       const response = await _this.axios.post(
         path,
         {
-          txids: txids
+          txids: txids,
+          usrObj
         },
         _this.axiosOptions
       )
@@ -922,7 +926,7 @@ class Utils {
    *
    */
   // Reimplementation of decodeOpReturn() using slp-parser.
-  async decodeOpReturn (txid, cache = null) {
+  async decodeOpReturn (txid, cache = null, usrObj = null) {
     // The cache object is an in-memory cache (JS Object) that can be passed
     // into this function. It helps if multiple vouts from the same TXID are
     // being evaluated. In that case, it can significantly reduce the number
@@ -939,16 +943,32 @@ class Utils {
       if (cachedVal) return cachedVal
     }
 
+    console.log(`decodeOpReturn usrObj: ${JSON.stringify(usrObj, null, 2)}`)
+
     try {
       // Validate the txid input.
       if (!txid || txid === '' || typeof txid !== 'string') {
         throw new Error('txid string must be included.')
       }
 
+      // CT: 2/24/21 Deprected GET in favor of POST, to pass IP address.
       // Retrieve the transaction object from the full node.
-      const path = `${this.restURL}rawtransactions/getRawTransaction/${txid}?verbose=true`
-      const response = await _this.axios.get(path, _this.axiosOptions)
-      const txDetails = response.data
+      // const path = `${this.restURL}rawtransactions/getRawTransaction/${txid}?verbose=true`
+      // const response = await _this.axios.get(path, _this.axiosOptions)
+      // const txDetails = response.data
+
+      const path = `${this.restURL}rawtransactions/getRawTransaction`
+      const response = await _this.axios.post(
+        path,
+        {
+          verbose: true,
+          txids: [txid],
+          usrObj
+        },
+        _this.axiosOptions
+      )
+      const txDetails = response.data[0]
+
       // console.log(`txDetails: ${JSON.stringify(txDetails, null, 2)}`)
 
       // SLP spec expects OP_RETURN to be the first output of the transaction.
@@ -1019,6 +1039,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,11 +1081,13 @@ 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, usrObj = null) {
     try {
       // Throw error if input is not an array.
       if (!Array.isArray(utxos)) throw new Error('Input must be an array.')
 
+      console.log(`tokenUtxoDetails usrObj: ${JSON.stringify(usrObj, null, 2)}`)
+
       // Loop through each element in the array and validate the input before
       // further processing.
       for (let i = 0; i < utxos.length; i++) {
@@ -1094,7 +1119,7 @@ class Utils {
       }
 
       // Hydrate each UTXO with data from SLP OP_REUTRNs.
-      const outAry = await this._hydrateUtxo(utxos)
+      const outAry = await this._hydrateUtxo(utxos, usrObj)
       // console.log(`outAry: ${JSON.stringify(outAry, null, 2)}`)
 
       // *After* each UTXO has been hydrated with SLP data,
@@ -1110,7 +1135,7 @@ class Utils {
           // information.
 
           // Validate using a 'waterfall' of validators.
-          utxo.isValid = await this.waterfallValidateTxid(utxo.txid)
+          utxo.isValid = await this.waterfallValidateTxid(utxo.txid, usrObj)
           // console.log(`isValid: ${JSON.stringify(utxo.isValid, null, 2)}`)
         }
       }
@@ -1214,10 +1239,12 @@ class Utils {
   // This is a private function that is called by tokenUtxoDetails().
   // It loops through an array of UTXOs and tries to hydrate them with SLP
   // token information from the OP_RETURN data.
-  async _hydrateUtxo (utxos) {
+  async _hydrateUtxo (utxos, usrObj = null) {
     try {
       const decodeOpReturnCache = {}
 
+      console.log(`_hydrateUtxo usrObj: ${JSON.stringify(usrObj, null, 2)}`)
+
       // Output Array
       const outAry = []
 
@@ -1230,7 +1257,11 @@ class Utils {
         // If there is no OP_RETURN, mark the UTXO as false.
         let slpData = false
         try {
-          slpData = await this.decodeOpReturn(utxo.txid, decodeOpReturnCache)
+          slpData = await this.decodeOpReturn(
+            utxo.txid,
+            decodeOpReturnCache,
+            usrObj
+          )
           // console.log(`slpData: ${JSON.stringify(slpData, null, 2)}`)
         } catch (err) {
           // console.log(`error from decodeOpReturn(${utxo.txid}): `, err)
@@ -1320,7 +1351,8 @@ class Utils {
 
             const genesisData = await this.decodeOpReturn(
               slpData.tokenId,
-              decodeOpReturnCache
+              decodeOpReturnCache,
+              usrObj
             )
             // console.log(`genesisData: ${JSON.stringify(genesisData, null, 2)}`)
 
@@ -1372,7 +1404,8 @@ class Utils {
 
             const genesisData = await this.decodeOpReturn(
               slpData.tokenId,
-              decodeOpReturnCache
+              decodeOpReturnCache,
+              usrObj
             )
             // console.log(`genesisData: ${JSON.stringify(genesisData, null, 2)}`)
 
@@ -1447,8 +1480,7 @@ class Utils {
    * // returns
    * true
    */
-
-  async waterfallValidateTxid (txid) {
+  async waterfallValidateTxid (txid, usrObj = null) {
     try {
       // console.log('txid: ', txid)
 
@@ -1480,7 +1512,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, usrObj)
       // console.log(
       //   `whitelist-SLPDB for ${txid}: ${JSON.stringify(
       //     whitelistResult,
@@ -1501,7 +1533,7 @@ class Utils {
       }
 
       // Try the general SLPDB, if the whitelist returned null.
-      const generalResult = await this.validateTxid(txid)
+      const generalResult = await this.validateTxid(txid, usrObj)
       // console.log(
       //   `validateTxid() isValid: ${JSON.stringify(generalResult, null, 2)}`
       // )
@@ -1563,11 +1595,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)

test/unit/slp-utils.js

@@ -273,8 +273,8 @@ describe('#SLP Utils', () => {
       try {
         // Mock the call to the REST API
         sandbox
-          .stub(uut.Utils.axios, 'get')
-          .resolves({ data: mockData.nonSLPTxDetailsWithoutOpReturn })
+          .stub(uut.Utils.axios, 'post')
+          .resolves({ data: [mockData.nonSLPTxDetailsWithoutOpReturn] })
 
         const txid =
           '3793d4906654f648e659f384c0f40b19c8f10c1e9fb72232a9b8edd61abaa1ec'
@@ -292,8 +292,8 @@ describe('#SLP Utils', () => {
       try {
         // Mock the call to the REST API
         sandbox
-          .stub(uut.Utils.axios, 'get')
-          .resolves({ data: mockData.nonSLPTxDetailsWithOpReturn })
+          .stub(uut.Utils.axios, 'post')
+          .resolves({ data: [mockData.nonSLPTxDetailsWithOpReturn] })
 
         const txid =
           '2ff74c48a5d657cf45f699601990bffbbe7a2a516d5480674cbf6c6a4497908f'
@@ -310,8 +310,8 @@ describe('#SLP Utils', () => {
     it('should decode a genesis transaction', async () => {
       // Mock the call to the REST API
       sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.txDetailsSLPGenesis })
+        .stub(uut.Utils.axios, 'post')
+        .resolves({ data: [mockData.txDetailsSLPGenesis] })
 
       const txid =
         'bd158c564dd4ef54305b14f44f8e94c44b649f246dab14bcb42fb0d0078b8a90'
@@ -336,8 +336,8 @@ describe('#SLP Utils', () => {
     it('should decode a mint transaction', async () => {
       // Mock the call to the REST API
       sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.txDetailsSLPMint })
+        .stub(uut.Utils.axios, 'post')
+        .resolves({ data: [mockData.txDetailsSLPMint] })
 
       const txid =
         '65f21bbfcd545e5eb515e38e861a9dfe2378aaa2c4e458eb9e59e4d40e38f3a4'
@@ -357,8 +357,8 @@ describe('#SLP Utils', () => {
     it('should decode a send transaction', async () => {
       // Mock the call to the REST API
       sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.txDetailsSLPSend })
+        .stub(uut.Utils.axios, 'post')
+        .resolves({ data: [mockData.txDetailsSLPSend] })
 
       const txid =
         '4f922565af664b6fdf0a1ba3924487344be721b3d8815c62cafc8a51e04a8afa'
@@ -372,8 +372,8 @@ describe('#SLP Utils', () => {
     it('should properly decode a Genesis transaction with no minting baton', async () => {
       // Mock the call to the REST API.
       sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.txDetailsSLPGenesisNoBaton })
+        .stub(uut.Utils.axios, 'post')
+        .resolves({ data: [mockData.txDetailsSLPGenesisNoBaton] })
 
       const txid =
         '497291b8a1dfe69c8daea50677a3d31a5ef0e9484d8bebb610dac64bbc202fb7'
@@ -387,8 +387,8 @@ describe('#SLP Utils', () => {
     it('should decode a send transaction with alternate encoding', async () => {
       // Mock the call to the REST API
       sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.txDetailsSLPSendAlt })
+        .stub(uut.Utils.axios, 'post')
+        .resolves({ data: [mockData.txDetailsSLPSendAlt] })
 
       const txid =
         'd94357179775425ebc59c93173bd6dc9854095f090a2eb9dcfe9797398bc8eae'
@@ -411,8 +411,8 @@ describe('#SLP Utils', () => {
       try {
         // Mock the call to the REST API
         sandbox
-          .stub(uut.Utils.axios, 'get')
-          .resolves({ data: mockData.mockInvalidSlpSend })
+          .stub(uut.Utils.axios, 'post')
+          .resolves({ data: [mockData.mockInvalidSlpSend] })
 
         const txid =
           'a60a522cc11ad7011b74e57fbabbd99296e4b9346bcb175dcf84efb737030415'
@@ -428,8 +428,8 @@ describe('#SLP Utils', () => {
     it('should decode a NFT Parent transaction', async () => {
       // Mock the call to the REST API.
       sandbox
-        .stub(uut.Utils.axios, 'get')
-        .resolves({ data: mockData.txDetailsSLPNftGenesis })
+        .stub(uut.Utils.axios, 'post')
+        .resolves({ data: [mockData.txDetailsSLPNftGenesis] })
 
       const txid =
         '4ef6eb92950a13a69e97c2c02c7967d806aa874c0e2a6b5546a8880f2cd14bc4'