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

fix(slp-api): Adding increased rate limits for slp-api

README.md

@@ -1,6 +1,5 @@
 # bch-api
 
-[![Greenkeeper badge](https://badges.greenkeeper.io/christroutner/bch-api.svg)](https://greenkeeper.io/)
 
 [![Build Status](https://travis-ci.org/christroutner/bch-api.svg?branch=master)](https://travis-ci.org/christroutner/bch-api)
 
@@ -16,9 +15,8 @@ of [BITBOX SDK](https://github.com/Bitcoin-com/bitbox-sdk).
 Both bch-api and bch-js are part of the
 [full stack of BCH software](https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer).
 
-- [API Documentation](https://api.bchjs.cash/docs/)
-- [BCH Example Applications](https://github.com/Permissionless-Software-Foundation/bch-js-examples)
-- [slp-cli-wallet](https://github.com/christroutner/slp-cli-wallet): a hacker-friendly, command-line BCH and SLP token wallet using this REST API.
+- [API Documentation](https://fullstack.cash/documentation)
+- [Example Code](https://fullstack.cash/examples)
 
 Have questions? Need help? Join our community support
 [Telegram channel](https://t.me/bch_js_toolkit)

deploy-production.sh

@@ -11,5 +11,7 @@ export DATA="{\"ref\":\"$DEPLOY_SECRET\"}"
 
 curl -X POST http://fullstack.cash:9000/hooks/bch-api-mainnet -H "Content-Type: application/json" -d $DATA
 curl -X POST http://fullstack.cash:9000/hooks/bch-api-testnet -H "Content-Type: application/json" -d $DATA
+curl -X POST http://$FREE_SERVER:9000/hooks/bch-api-testnet -H "Content-Type: application/json" -d $DATA
+curl -X POST http://$FREE_SERVER:9000/hooks/bch-api-mainnet -H "Content-Type: application/json" -d $DATA
 
 echo "...Finished deploying to production."

docker/mainnet/Dockerfile

@@ -16,9 +16,9 @@ USER safeuser
 
 # Clone the repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/christroutner/bch-api
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-api
 WORKDIR /home/safeuser/bch-api
-RUN npm install
+RUN npm install --silent
 
 # Generate documentation
 RUN npm run docs

docker/testnet/Dockerfile

@@ -13,9 +13,9 @@ USER safeuser
 
 # Clone the repository
 WORKDIR /home/safeuser
-RUN git clone https://github.com/christroutner/bch-api
+RUN git clone https://github.com/Permissionless-Software-Foundation/bch-api
 WORKDIR /home/safeuser/bch-api
-RUN npm install
+RUN npm install --silent
 
 # Generate documentation
 RUN npm run docs

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "bch-api",
-  "version": "1.0.0",
+  "version": "1.16.0",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {
@@ -2332,6 +2332,11 @@
           "version": "2.0.1",
           "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz",
           "integrity": "sha1-sX0I0ya0Qj5Wjv9xn5GwscvfafE="
+        },
+        "lodash": {
+          "version": "4.17.15",
+          "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
+          "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
         }
       }
     },
@@ -2367,6 +2372,11 @@
           "version": "2.0.1",
           "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.1.tgz",
           "integrity": "sha1-sX0I0ya0Qj5Wjv9xn5GwscvfafE="
+        },
+        "lodash": {
+          "version": "4.17.15",
+          "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
+          "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
         }
       }
     },
@@ -3248,24 +3258,13 @@
       "integrity": "sha1-3dgA2gxmEnOTzKWVDqloo6rxJTs="
     },
     "compare-func": {
-      "version": "1.3.2",
-      "resolved": "https://registry.npmjs.org/compare-func/-/compare-func-1.3.2.tgz",
-      "integrity": "sha1-md0LpFfh+bxyKxLAjsM+6rMfpkg=",
+      "version": "2.0.0",
+      "resolved": "https://registry.npmjs.org/compare-func/-/compare-func-2.0.0.tgz",
+      "integrity": "sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==",
       "dev": true,
       "requires": {
         "array-ify": "^1.0.0",
-        "dot-prop": "^3.0.0"
-      },
-      "dependencies": {
-        "dot-prop": {
-          "version": "3.0.0",
-          "resolved": "https://registry.npmjs.org/dot-prop/-/dot-prop-3.0.0.tgz",
-          "integrity": "sha1-G3CK8JSknJoOfbyteQq6U52sEXc=",
-          "dev": true,
-          "requires": {
-            "is-obj": "^1.0.0"
-          }
-        }
+        "dot-prop": "^5.1.0"
       }
     },
     "component-bind": {
@@ -3387,22 +3386,34 @@
       "integrity": "sha512-hIP3EEPs8tB9AT1L+NUqtwOAps4mk2Zob89MWXMHjHWg9milF/j4osnnQLXBCBFBk/tvIG/tUc9mOUJiPBhPXA=="
     },
     "conventional-changelog-angular": {
-      "version": "5.0.6",
-      "resolved": "https://registry.npmjs.org/conventional-changelog-angular/-/conventional-changelog-angular-5.0.6.tgz",
-      "integrity": "sha512-QDEmLa+7qdhVIv8sFZfVxU1VSyVvnXPsxq8Vam49mKUcO1Z8VTLEJk9uI21uiJUsnmm0I4Hrsdc9TgkOQo9WSA==",
+      "version": "5.0.11",
+      "resolved": "https://registry.npmjs.org/conventional-changelog-angular/-/conventional-changelog-angular-5.0.11.tgz",
+      "integrity": "sha512-nSLypht/1yEflhuTogC03i7DX7sOrXGsRn14g131Potqi6cbGbGEE9PSDEHKldabB6N76HiSyw9Ph+kLmC04Qw==",
       "dev": true,
       "requires": {
-        "compare-func": "^1.3.1",
+        "compare-func": "^2.0.0",
         "q": "^1.5.1"
+      },
+      "dependencies": {
+        "compare-func": {
+          "version": "2.0.0",
+          "resolved": "https://registry.npmjs.org/compare-func/-/compare-func-2.0.0.tgz",
+          "integrity": "sha512-zHig5N+tPWARooBnb0Zx1MFcdfpyJrfTJ3Y5L+IFvUm8rM74hHz66z0gw0x4tijh5CorKkKUCnW82R2vmpeCRA==",
+          "dev": true,
+          "requires": {
+            "array-ify": "^1.0.0",
+            "dot-prop": "^5.1.0"
+          }
+        }
       }
     },
     "conventional-changelog-writer": {
-      "version": "4.0.16",
-      "resolved": "https://registry.npmjs.org/conventional-changelog-writer/-/conventional-changelog-writer-4.0.16.tgz",
-      "integrity": "sha512-jmU1sDJDZpm/dkuFxBeRXvyNcJQeKhGtVcFFkwTphUAzyYWcwz2j36Wcv+Mv2hU3tpvLMkysOPXJTLO55AUrYQ==",
+      "version": "4.0.17",
+      "resolved": "https://registry.npmjs.org/conventional-changelog-writer/-/conventional-changelog-writer-4.0.17.tgz",
+      "integrity": "sha512-IKQuK3bib/n032KWaSb8YlBFds+aLmzENtnKtxJy3+HqDq5kohu3g/UdNbIHeJWygfnEbZjnCKFxAW0y7ArZAw==",
       "dev": true,
       "requires": {
-        "compare-func": "^1.3.1",
+        "compare-func": "^2.0.0",
         "conventional-commits-filter": "^2.0.6",
         "dateformat": "^3.0.0",
         "handlebars": "^4.7.6",
@@ -3431,11 +3442,12 @@
           "dev": true
         },
         "through2": {
-          "version": "3.0.1",
-          "resolved": "https://registry.npmjs.org/through2/-/through2-3.0.1.tgz",
-          "integrity": "sha512-M96dvTalPT3YbYLaKaCuwu+j06D/8Jfib0o/PxbVt6Amhv3dUAtW6rTV1jPgJSBG83I/e04Y6xkVdVhSRhi0ww==",
+          "version": "3.0.2",
+          "resolved": "https://registry.npmjs.org/through2/-/through2-3.0.2.tgz",
+          "integrity": "sha512-enaDQ4MUyP2W6ZyT6EsMzqBPZaM/avg8iuo+l2d3QCs0J+6RaqkHV/2/lOwDTueBHeJ/2LG9lrLW3d5rWPucuQ==",
           "dev": true,
           "requires": {
+            "inherits": "^2.0.4",
             "readable-stream": "2 || 3"
           }
         }
@@ -4420,9 +4432,9 @@
       }
     },
     "elliptic": {
-      "version": "6.5.2",
-      "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.2.tgz",
-      "integrity": "sha512-f4x70okzZbIQl/NSRLkI/+tteV/9WqL98zx+SQ69KbXxmVrmjwsNUPn/gYJJ0sHvEak24cZgHIPegRePAtA/xw==",
+      "version": "6.5.3",
+      "resolved": "https://registry.npmjs.org/elliptic/-/elliptic-6.5.3.tgz",
+      "integrity": "sha512-IMqzv5wNQf+E6aHeIqATs0tOLeOTwj1QKbRcS3jBbYkl5oLAserA8yJTT7/VyHUYG91PRmPyeQDObKLPpeS4dw==",
       "requires": {
         "bn.js": "^4.4.0",
         "brorand": "^1.0.1",
@@ -5056,6 +5068,12 @@
           "integrity": "sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg==",
           "dev": true
         },
+        "lodash": {
+          "version": "4.17.19",
+          "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
+          "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ==",
+          "dev": true
+        },
         "minimist": {
           "version": "1.2.5",
           "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
@@ -7315,12 +7333,6 @@
       "resolved": "https://registry.npmjs.org/is-number-object/-/is-number-object-1.0.4.tgz",
       "integrity": "sha512-zohwelOAur+5uXtk8O3GPQ1eAcu4ZX3UwxQhUlfFFMNpUd83gXgjbhJh6HmB6LUNV/ieOLQuDwJO3dWJosUeMw=="
     },
-    "is-obj": {
-      "version": "1.0.1",
-      "resolved": "https://registry.npmjs.org/is-obj/-/is-obj-1.0.1.tgz",
-      "integrity": "sha1-PkcprB9f3gJc19g6iW2rn09n2w8=",
-      "dev": true
-    },
     "is-object": {
       "version": "1.0.1",
       "resolved": "https://registry.npmjs.org/is-object/-/is-object-1.0.1.tgz",
@@ -8040,9 +8052,9 @@
       }
     },
     "lodash": {
-      "version": "4.17.15",
-      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.15.tgz",
-      "integrity": "sha512-8xOcRHvCjnocdS5cpwXQXVzmmh5e5+saE2QGoeQmbKmRS6J3VQppPOIt0MnmE+4xlZoumy0GPG0D0MVIQbNA1A=="
+      "version": "4.17.19",
+      "resolved": "https://registry.npmjs.org/lodash/-/lodash-4.17.19.tgz",
+      "integrity": "sha512-JNvd8XER9GQX0v2qJgsaN/mzFCNA5BRe/j8JN9d+tWyGLSodKQHKFicdwNYzWwI3wjRnaKPsGj1XkBjx/F96DQ=="
     },
     "lodash._baseiteratee": {
       "version": "4.7.0",

package.json

@@ -17,7 +17,7 @@
     "test": "npm run lint && npm run test-v3",
     "lint": "standard --env mocha --fix",
     "test-v3": "export NETWORK=mainnet && nyc --reporter=text mocha --timeout 60000 test/v3/",
-    "test:temp": "export NETWORK=mainnet && mocha --timeout 25000 test/v3/integration/slp.js",
+    "test:temp": "export NETWORK=mainnet && mocha --timeout 25000 test/v3/a01-electrumx.js",
     "test:integration": "mocha test/v3/integration",
     "test:integration:slpdb": "mocha --timeout 25000 test/v3/integration/slp*.js",
     "coverage": "nyc report --reporter=text-lcov | coveralls",

src/middleware/route-ratelimit.js

@@ -116,13 +116,20 @@ class RateLimits {
         let pointsToConsume = _this.calcPoints(decoded)
         res.locals.pointsToConsume = pointsToConsume // Feedback for tests.
 
+        // Retrieve the origin.
+        let origin = req.get('origin')
+        if (origin === undefined && key.indexOf('10.0.0.5') > -1) {
+          origin = 'slp-api'
+        }
+        wlogger.info(`origin: ${origin}`)
+
         // If the request originates from one of the approved wallet apps, then
         // apply paid-access rate limits.
-        const origin = req.get('origin')
         if (
           origin &&
           (origin.toString().indexOf('wallet.fullstack.cash') > -1 ||
-            origin.toString().indexOf('sandbox.fullstack.cash') > -1)
+            origin.toString().indexOf('sandbox.fullstack.cash') > -1 ||
+            origin === 'slp-api')
         ) {
           pointsToConsume = 1
           res.locals.pointsToConsume = pointsToConsume // Feedback for tests.

src/public/index.html

@@ -23,24 +23,24 @@
         target="_blank"
         >REST API</a
       >, allowing modern applications to interact with the Bitcoin Cash (BCH)
-      blockchain. New to the BCH blockchain? Start by reading more about
+      blockchain. New to the BCH blockchain? Check out these
       <a
-        href="https://troutsblog.com/research/bitcoin-cash/how-to-bch-full-stack-developer"
+        href="https://fullstack.cash/documentation"
         target="_blank"
-        >building full stack applications on BCH</a
+        >educational resources</a
       >.
     </p><br />
     <p>
       A REST API can work with any programming language, but bch-api is intended
       to be paired with the
       <a
-        href="https://www.npmjs.com/package/@chris.troutner/bch-js"
+        href="https://www.npmjs.com/package/@psf/bch-js"
         target="_blank"
         >npm bch-js</a
       >
       JavaScript library.
       <a
-        href="https://github.com/Permissionless-Software-Foundation/bch-js-examples"
+        href="https://fullstack.cash/examples"
         target="_blank"
         >Here is example code</a
       >
@@ -53,7 +53,7 @@
     </p><br />
     <p>
       While you'll be able to run through the examples without one, you should
-      <a href="https://account.bchjs.cash/" target="_blank"
+      <a href="https://fullstack.cash/login" target="_blank"
         >sign-up for a free API key</a
       >
       in order to unlock higher rate limits.
@@ -66,7 +66,7 @@
         <h3>bch-api</h3>
         <ul>
           <li>
-            <a href="https://account.bchjs.cash" target="_blank">
+            <a href="https://fullstack.cash/login" target="_blank">
               Get an API key to increase rate limits
             </a>
           </li>
@@ -80,14 +80,14 @@
           <br />
 
           <li>
-            <a href="https://tapi.bchjs.cash">
+            <a href="https://tapi.fullstack.cash">
               testnet REST API
             </a>
           </li>
           <br />
 
           <li>
-            <a href="https://github.com/christroutner/bch-api" target="_blank">
+            <a href="https://github.com/Permissionless-Software-Foundation/bch-api" target="_blank">
               bch-api GitHub repository
             </a>
           </li>
@@ -114,14 +114,14 @@
           </li>
           <br />
           <li>
-            <a href="https://bchjs.cash/" target="_blank">
+            <a href="https://fullstack.cash/cashstrap" target="_blank">
               Run your own infrastructure
             </a>
           </li>
           <br />
 
           <li>
-            <a href="https://github.com/bitcoinbook/bitcoinbook#chapters" target="_blank">
+            <a href="https://fullstack.cash/documentation" target="_blank">
               Mastering Bitcoin (great free reference)
             </a>
           </li>
@@ -135,7 +135,7 @@
           <br />
 
           <li>
-            <a href="https://developer.bitcoin.com/faucets/bch/" target="_blank">
+            <a href="https://fullstack.cash/faucet/" target="_blank">
               Testnet Faucet
             </a>
           </li>
@@ -148,7 +148,7 @@
         <h3>bch-js</h3>
         <ul>
           <li>
-            <a href="https://www.npmjs.com/package/@chris.troutner/bch-js"
+            <a href="https://www.npmjs.com/package/@psf/bch-js"
             target="_blank">
               npm library
             </a>
@@ -163,7 +163,7 @@
           <br />
 
           <li>
-            <a href="https://github.com/christroutner/bch-js" target="_blank">
+            <a href="https://github.com/Permissionless-Software-Foundation/bch-js" target="_blank">
               GitHub code repository
             </a>
           </li>

src/routes/v3/electrumx.js

@@ -54,6 +54,8 @@ class Electrum {
     _this.router.post('/balance', _this.balanceBulk)
     _this.router.get('/transactions/:address', _this.getTransactions)
     _this.router.post('/transactions', _this.transactionsBulk)
+    _this.router.get('/unconfirmed/:address', _this.getMempool)
+    _this.router.post('/unconfirmed', _this.mempoolBulk)
   }
 
   // Initializes a connection to electrum servers.
@@ -708,6 +710,199 @@ class Electrum {
     }
   }
 
+  // Returns a promise that resolves to unconfirmed UTXO data (mempool) for an address.
+  // Expects input to be a cash address, and input validation to have
+  // already been done by parent, calling function.
+  async _mempoolFromElectrumx (address) {
+    try {
+      // Convert the address to a scripthash.
+      const scripthash = _this.addressToScripthash(address)
+
+      if (!_this.isReady) {
+        throw new Error(
+          'ElectrumX server connection is not ready. Call await connectToServer() first.'
+        )
+      }
+
+      // Query the unconfirmed utxos from the ElectrumX server.
+      const electrumResponse = await _this.electrumx.request(
+        'blockchain.scripthash.get_mempool',
+        scripthash
+      )
+      // console.log(
+      //   `electrumResponse: ${JSON.stringify(electrumResponse, null, 2)}`
+      // )
+
+      return electrumResponse
+    } catch (err) {
+      // console.log('err: ', err)
+
+      // Write out error to error log.
+      wlogger.error('Error in elecrumx.js/_mempoolFromElectrumx(): ', err)
+      throw err
+    }
+  }
+
+  /**
+   * @api {get} /electrumx/unconfirmed/{addr} Get unconfirmed utxos for a single address.
+   * @apiName Unconfirmed UTXOs for a single address
+   * @apiGroup ElectrumX / Fulcrum
+   * @apiDescription Returns an object with unconfirmed UTXOs associated with an address.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v3/electrumx/unconfirmed/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
+   *
+   */
+  // GET handler for single balance
+  async getMempool (req, res, next) {
+    try {
+      const address = req.params.address
+
+      // Reject if address is an array.
+      if (Array.isArray(address)) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'address can not be an array. Use POST for bulk upload.'
+        })
+      }
+
+      // Ensure the address is in cash address format.
+      const cashAddr = _this.bchjs.Address.toCashAddress(address)
+
+      // Prevent a common user error. Ensure they are using the correct network address.
+      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
+      if (!networkIsValid) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error:
+            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
+        })
+      }
+
+      wlogger.debug(
+        'Executing electrumx/getMempool with this address: ',
+        cashAddr
+      )
+
+      // Get data from ElectrumX server.
+      const electrumResponse = await _this._mempoolFromElectrumx(cashAddr)
+      // console.log(`_mempoolFromElectrumx(): ${JSON.stringify(electrumResponse, null, 2)}`)
+
+      // Pass the error message if ElectrumX reports an error.
+      if (Object.prototype.hasOwnProperty.call(electrumResponse, 'code')) {
+        res.status(400)
+        return res.json({
+          success: false,
+          message: electrumResponse.message
+        })
+      }
+
+      res.status(200)
+      return res.json({
+        success: true,
+        utxos: electrumResponse
+      })
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in elecrumx.js/getMempool().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  /**
+   * @api {post} /electrumx/unconfirmed Get unconfirmed utxos for an array of addresses.
+   * @apiName  Unconfirmed UTXOs for an array of addresses
+   * @apiGroup ElectrumX / Fulcrum
+   * @apiDescription Returns an array of objects with unconfirmed UTXOs associated with an address.
+   * Limited to 20 items per request.
+   *
+   * @apiExample Example usage:
+   * curl -X POST "https://api.fullstack.cash/v3/electrumx/unconfirmed" -H "accept: application/json" -H "Content-Type: application/json" -d '{"addresses":["bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf","bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"]}'
+   *
+   *
+   */
+  // POST handler for bulk queries on address details
+  async mempoolBulk (req, res, next) {
+    try {
+      let addresses = req.body.addresses
+
+      // Reject if addresses is not an array.
+      if (!Array.isArray(addresses)) {
+        res.status(400)
+        return res.json({
+          error: 'addresses needs to be an array. Use GET for single address.'
+        })
+      }
+
+      // Enforce array size rate limits
+      if (!_this.routeUtils.validateArraySize(req, addresses)) {
+        res.status(429) // https://github.com/Bitcoin-com/rest.bitcoin.com/issues/330
+        return res.json({
+          error: 'Array too large.'
+        })
+      }
+
+      wlogger.debug(
+        'Executing electrumx.js/mempoolBulk with these addresses: ',
+        addresses
+      )
+
+      // Validate each element in the address array.
+      for (let i = 0; i < addresses.length; i++) {
+        const thisAddress = addresses[i]
+
+        // Ensure the input is a valid BCH address.
+        try {
+          _this.bchjs.Address.toLegacyAddress(thisAddress)
+        } catch (err) {
+          res.status(400)
+          return res.json({
+            error: `Invalid BCH address. Double check your address is valid: ${thisAddress}`
+          })
+        }
+
+        // Prevent a common user error. Ensure they are using the correct network address.
+        const networkIsValid = _this.routeUtils.validateNetwork(thisAddress)
+        if (!networkIsValid) {
+          res.status(400)
+          return res.json({
+            error: `Invalid network for address ${thisAddress}. Trying to use a testnet address on mainnet, or vice versa.`
+          })
+        }
+      }
+
+      // Loops through each address and creates an array of Promises, querying
+      // Insight API in parallel.
+      addresses = addresses.map(async (address, index) => {
+        // console.log(`address: ${address}`)
+        const utxos = await _this._mempoolFromElectrumx(address)
+
+        return {
+          utxos,
+          address
+        }
+      })
+
+      // Wait for all parallel Insight requests to return.
+      const result = await Promise.all(addresses)
+
+      // Return the array of retrieved address information.
+      res.status(200)
+      return res.json({
+        success: true,
+        utxos: result
+      })
+    } catch (err) {
+      wlogger.error('Error in electrumx.js/mempoolBulk().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
   // Convert a 'bitcoincash:...' address to a script hash used by ElectrumX.
   addressToScripthash (addrStr) {
     try {

src/routes/v3/slp.js

@@ -64,10 +64,6 @@ class Slp {
     _this.router.get('/balancesForAddress/:address', _this.balancesForAddress)
     _this.router.post('/balancesForAddress', _this.balancesForAddressBulk)
     _this.router.get('/balancesForToken/:tokenId', _this.balancesForTokenSingle)
-    _this.router.get(
-      '/balance/:address/:tokenId',
-      _this.balancesForAddressByTokenID
-    )
     _this.router.get('/convert/:address', _this.convertAddressSingle)
     _this.router.post('/convert', _this.convertAddressBulk)
     _this.router.post('/validateTxid', _this.validateBulk)
@@ -830,170 +826,6 @@ class Slp {
     }
   }
 
-  /**
-   * @api {get} /slp/balance/{address}/{TokenId}  List single slp token balance for address.
-   * @apiName List single slp token balance for address.
-   * @apiGroup SLP
-   * @apiDescription Returns List single slp token balance for address.
-   *
-   *
-   * @apiExample Example usage:
-   * curl -X GET "https://api.fullstack.cash/v3/slp/balance/simpleledger:qz9tzs6d5097ejpg279rg0rnlhz546q4fsnck9wh5m/1cda254d0a995c713b7955298ed246822bee487458cd9747a91d9e81d9d28125" -H "accept:application/json"
-   *
-   *
-   */
-  // Retrieve token balances for a single token class, for a single address.
-  async balancesForAddressByTokenID (req, res, next) {
-    try {
-      // Validate input data.
-      const address = req.params.address
-      if (!address || address === '') {
-        res.status(400)
-        return res.json({ error: 'address can not be empty' })
-      }
-
-      const tokenId = req.params.tokenId
-      if (!tokenId || tokenId === '') {
-        res.status(400)
-        return res.json({ error: 'tokenId can not be empty' })
-      }
-
-      // Ensure the input is a valid BCH address.
-      try {
-        _this.bchjs.SLP.Address.toCashAddress(address)
-      } catch (err) {
-        res.status(400)
-        return res.json({
-          error: `Invalid BCH address. Double check your address is valid: ${address}`
-        })
-      }
-
-      // Prevent a common user error. Ensure they are using the correct network address.
-      const cashAddr = _this.bchjs.SLP.Address.toCashAddress(address)
-      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
-      if (!networkIsValid) {
-        res.status(400)
-        return res.json({
-          error:
-            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
-        })
-      }
-
-      // Convert input to an simpleledger: address.
-      const slpAddr = _this.bchjs.SLP.Address.toSlpAddress(req.params.address)
-
-      const query = {
-        v: 3,
-        q: {
-          db: ['g'],
-          aggregate: [
-            {
-              $match: {
-                'graphTxn.outputs': {
-                  $elemMatch: {
-                    address: slpAddr,
-                    status: 'UNSPENT',
-                    slpAmount: { $gte: 0 }
-                  }
-                }
-              }
-            },
-            {
-              $unwind: '$graphTxn.outputs'
-            },
-            {
-              $match: {
-                'graphTxn.outputs.address': slpAddr,
-                'graphTxn.outputs.status': 'UNSPENT',
-                'graphTxn.outputs.slpAmount': { $gte: 0 }
-              }
-            },
-            {
-              $project: {
-                amount: '$graphTxn.outputs.slpAmount',
-                address: '$graphTxn.outputs.address',
-                txid: '$graphTxn.txid',
-                vout: '$graphTxn.outputs.vout',
-                tokenId: '$tokenDetails.tokenIdHex'
-              }
-            },
-            {
-              $group: {
-                _id: '$tokenId',
-                balanceString: {
-                  $sum: '$amount'
-                },
-                slpAddress: {
-                  $first: '$address'
-                }
-              }
-            }
-          ],
-          limit: 10000
-        }
-      }
-
-      const options = _this.generateCredentials()
-
-      const s = JSON.stringify(query)
-      const b64 = Buffer.from(s).toString('base64')
-      const url = `${process.env.SLPDB_URL}q/${b64}`
-
-      // Get data from SLPDB.
-      const opt = {
-        method: 'get',
-        baseURL: url,
-        headers: options.headers,
-        timeout: options.timeout
-      }
-      const tokenRes = await _this.axios.request(opt)
-      console.log(`tokenRes.data: ${JSON.stringify(tokenRes.data, null, 2)}`)
-
-      let resVal = {
-        cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
-        legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
-        slpAddress: slpAddr,
-        tokenId: tokenId,
-        balance: 0,
-        balanceString: '0'
-      }
-
-      if (tokenRes.data.g.length > 0) {
-        tokenRes.data.g.forEach(async (token) => {
-          if (token._id === tokenId) {
-            resVal = {
-              cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
-              legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
-              slpAddress: slpAddr,
-              tokenId: token._id,
-              balance: parseFloat(token.balanceString),
-              balanceString: token.balanceString
-            }
-          }
-        })
-      } else {
-        resVal = {
-          cashAddress: _this.bchjs.SLP.Address.toCashAddress(slpAddr),
-          legacyAddress: _this.bchjs.SLP.Address.toLegacyAddress(slpAddr),
-          slpAddress: slpAddr,
-          tokenId: tokenId,
-          balance: 0,
-          balanceString: '0'
-        }
-      }
-
-      res.status(200)
-      return res.json(resVal)
-    } catch (err) {
-      wlogger.error('Error in slp.ts/balancesForAddressByTokenID().', err)
-
-      return _this.errorHandler(err, res)
-      // return res.json({
-      //   error: `Error in /balance/:address/:tokenId: ${err.message}`
-      // })
-    }
-  }
-
   /**
    * @api {get} /slp/convert/{address}  Convert address to slpAddr, cashAddr and legacy.
    * @apiName Convert address to slpAddr, cashAddr and legacy.

test/v3/a01-electrumx.js

@@ -753,9 +753,7 @@ describe('#ElectrumX Router', () => {
       if (process.env.TEST === 'unit') {
         electrumxRoute.isReady = true // Force flag.
 
-        sandbox
-          .stub(electrumxRoute.electrumx, 'request')
-          .resolves([])
+        sandbox.stub(electrumxRoute.electrumx, 'request').resolves([])
       }
 
       // Call the details API.
@@ -999,4 +997,318 @@ describe('#ElectrumX Router', () => {
       assert.equal(result.transactions.length, 2, '2 outputs for 2 inputs')
     })
   })
+
+  describe('#_mempoolFromElectrumx', () => {
+    it('should throw error for invalid address', async () => {
+      try {
+        // Address has invalid checksum.
+        const address = 'bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur2'
+
+        // Call the details API.
+        await electrumxRoute._mempoolFromElectrumx(address)
+
+        assert.equal(true, false, 'Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'Invalid checksum')
+      }
+    })
+
+    it('should return empty array for address with no unconfirmed utxos', async () => {
+      // Address has invalid checksum.
+      const address = 'bchtest:qqtmlpspjakqlvywae226esrcdrj9auynuwadh55uf'
+
+      // Mock unit tests to prevent live network calls.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox.stub(electrumxRoute.electrumx, 'request').resolves([])
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute._mempoolFromElectrumx(address)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isArray(result)
+      assert.equal(result.length, 0)
+    })
+
+    it('should get mempool for a single address', async () => {
+      const address = 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+
+      // Mock unit tests to prevent live network calls.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox
+          .stub(electrumxRoute.electrumx, 'request')
+          .resolves(mockData.mempool)
+      } else {
+        // Skip this test for integrations. Unconfirmed UTXOs are transient and
+        // not easy to test in real-time.
+        assert.equal(true, true)
+        return
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute._mempoolFromElectrumx(address)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isArray(result)
+      assert.property(result[0], 'height')
+      assert.property(result[0], 'tx_hash')
+      assert.property(result[0], 'fee')
+    })
+  })
+
+  describe('#getMempool', () => {
+    it('should throw 400 if address is empty', async () => {
+      const result = await electrumxRoute.getMempool(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'Unsupported address format')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+    })
+
+    it('should throw 400 on array input', async () => {
+      req.params.address = ['qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c']
+
+      const result = await electrumxRoute.getMempool(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'address can not be an array')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+    })
+
+    it('should throw an error for an invalid address', async () => {
+      req.params.address = '02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c'
+
+      const result = await electrumxRoute.getMempool(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'Unsupported address format')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+    })
+
+    it('should detect a network mismatch', async () => {
+      req.params.address = 'bchtest:qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4'
+
+      const result = await electrumxRoute.getMempool(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'Invalid network', 'Proper error message')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+    })
+
+    it('should pass errors from electrum-cash to user', async () => {
+      // Address has invalid checksum.
+      req.params.address =
+        'bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur2'
+
+      // Call the details API.
+      const result = await electrumxRoute.getMempool(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'Unsupported address format')
+    })
+
+    it('should get mempool for a single address', async () => {
+      req.params.address =
+        'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+
+      // Mock unit tests to prevent live network calls.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox
+          .stub(electrumxRoute, '_mempoolFromElectrumx')
+          .resolves(mockData.mempool)
+      } else {
+        // Skip this test for integrations. Unconfirmed UTXOs are transient and
+        // not easy to test in real-time.
+        assert.equal(true, true)
+        return
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute.getMempool(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'success')
+      assert.equal(result.success, true)
+
+      assert.property(result, 'utxos')
+      assert.isArray(result.utxos)
+
+      assert.property(result.utxos[0], 'height')
+      assert.property(result.utxos[0], 'tx_hash')
+      assert.property(result.utxos[0], 'fee')
+    })
+  })
+
+  describe('#mempoolBulk', () => {
+    it('should throw an error for an empty body', async () => {
+      req.body = {}
+
+      const result = await electrumxRoute.mempoolBulk(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
+      assert.include(
+        result.error,
+        'addresses needs to be an array',
+        'Proper error message'
+      )
+    })
+
+    it('should error on non-array single address', async () => {
+      req.body = {
+        address: 'qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c'
+      }
+
+      const result = await electrumxRoute.mempoolBulk(req, res)
+
+      assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
+      assert.include(
+        result.error,
+        'addresses needs to be an array',
+        'Proper error message'
+      )
+    })
+
+    it('should throw 400 error if addresses array is too large', async () => {
+      const testArray = []
+      for (var i = 0; i < 25; i++) testArray.push('')
+
+      req.body.addresses = testArray
+
+      const result = await electrumxRoute.mempoolBulk(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.hasAllKeys(result, ['error'])
+      assert.include(result.error, 'Array too large')
+    })
+
+    it('should throw an error for an invalid address', async () => {
+      req.body = {
+        addresses: ['02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c']
+      }
+
+      const result = await electrumxRoute.mempoolBulk(req, res)
+
+      assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
+      assert.include(
+        result.error,
+        'Invalid BCH address',
+        'Proper error message'
+      )
+    })
+
+    it('should detect a network mismatch', async () => {
+      req.body = {
+        addresses: ['bchtest:qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4']
+      }
+
+      const result = await electrumxRoute.mempoolBulk(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'HTTP status code 400 expected.')
+      assert.include(result.error, 'Invalid network', 'Proper error message')
+    })
+
+    it('should get mempool details for a single address', async () => {
+      req.body = {
+        addresses: ['bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7']
+      }
+
+      // Mock the Insight URL for unit tests.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox
+          .stub(electrumxRoute, '_mempoolFromElectrumx')
+          .resolves(mockData.mempool)
+      } else {
+        // Skip this test for integrations. Unconfirmed UTXOs are transient and
+        // not easy to test in real-time.
+        assert.equal(true, true)
+        return
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute.mempoolBulk(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'success')
+      assert.equal(result.success, true)
+
+      assert.property(result, 'utxos')
+      assert.isArray(result.utxos)
+
+      assert.property(result.utxos[0], 'address')
+      assert.property(result.utxos[0], 'utxos')
+
+      assert.isArray(result.utxos[0].utxos)
+      assert.property(result.utxos[0].utxos[0], 'height')
+      assert.property(result.utxos[0].utxos[0], 'tx_hash')
+      assert.property(result.utxos[0].utxos[0], 'fee')
+    })
+
+    it('should get mempool for multiple addresses', async () => {
+      req.body = {
+        addresses: [
+          'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf',
+          'bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf'
+        ]
+      }
+
+      // Mock the Insight URL for unit tests.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox
+          .stub(electrumxRoute, '_mempoolFromElectrumx')
+          .resolves(mockData.mempool)
+      } else {
+        // Skip this test for integrations. Unconfirmed UTXOs are transient and
+        // not easy to test in real-time.
+        assert.equal(true, true)
+        return
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute.mempoolBulk(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'success')
+      assert.equal(result.success, true)
+
+      assert.isArray(result.utxos)
+      assert.isArray(result.utxos[0].utxos)
+      assert.equal(result.utxos.length, 2, '2 outputs for 2 inputs')
+    })
+  })
 })

test/v3/mocks/electrumx-mock.js

@@ -31,8 +31,17 @@ const txHistory = [
   }
 ]
 
+const mempool = [
+  {
+    tx_hash: '45381031132c57b2ff1cbe8d8d3920cf9ed25efd9a0beb764bdb2f24c7d1c7e3',
+    height: 0,
+    fee: 24310
+  }
+]
+
 module.exports = {
   utxos,
   balance,
-  txHistory
+  txHistory,
+  mempool
 }