Merge pull request #173 from Permissionless-Software-Foundation/feat/ecash-price

Feat/ecash price

README.md

@@ -33,9 +33,6 @@ Here are two YouTube walk-through videos to help you get started:
 ```
 const BCHJS = require("@psf/bch-js")
 let bchjs = new BCHJS() // Defaults to BCHN network.
-
-// testnet
-bchjs = new BCHJS({ restURL: 'https://testnet3.fullstack.cash/v5/' })
 ```
 
 This library is intended to be paired with
@@ -43,7 +40,6 @@ the [bch-api](https://github.com/Permissionless-Software-Foundation/bch-api) RES
 
 - BCHN Mainnet REST API server: https://bchn.fullstack.cash/v5/
 - ABC Mainnet REST API server: https://abc.fullstack.cash/v5/
-- Testnet3 REST API server: https://testnet3.fullstack.cash/v5/
 - Check server status: https://metrics.fullstack.cash
 
 ### API Key

package-lock.json

@@ -5699,6 +5699,7 @@
       "version": "3.0.1",
       "resolved": "https://registry.npmjs.org/keccak/-/keccak-3.0.1.tgz",
       "integrity": "sha512-epq90L9jlFWCW7+pQa6JOnKn2Xgl2mtI664seYR6MHskvI9agt7AnDqmAlp9TqU4/caMYbA08Hi5DMZAl5zdkA==",
+      "hasInstallScript": true,
       "dependencies": {
         "node-addon-api": "^2.0.0",
         "node-gyp-build": "^4.2.0"
@@ -6989,11 +6990,10 @@
       }
     },
     "node_modules/npm": {
-      "version": "6.14.13",
-      "resolved": "https://registry.npmjs.org/npm/-/npm-6.14.13.tgz",
-      "integrity": "sha512-SRl4jJi0EBHY2xKuu98FLRMo3VhYQSA6otyLnjSEiHoSG/9shXCFNJy9tivpUJvtkN9s6VDdItHa5Rn+fNBzag==",
+      "version": "6.14.14",
+      "resolved": "https://registry.npmjs.org/npm/-/npm-6.14.14.tgz",
+      "integrity": "sha512-4TnYPV3rvwk9m92ON0iFrdXtRyMhrNkGdI8sr3dy1HVE3pVNxR9FyWYbjAw/HjfmHvmHUbxTVbmjAMv8NhIa6Q==",
       "bundleDependencies": [
-        "JSONStream",
         "abbrev",
         "ansicolors",
         "ansistyles",
@@ -7034,6 +7034,7 @@
         "init-package-json",
         "is-cidr",
         "json-parse-better-errors",
+        "JSONStream",
         "lazy-property",
         "libcipm",
         "libnpm",
@@ -7084,11 +7085,11 @@
         "qrcode-terminal",
         "query-string",
         "qw",
-        "read",
         "read-cmd-shim",
         "read-installed",
         "read-package-json",
         "read-package-tree",
+        "read",
         "readable-stream",
         "readdir-scoped-modules",
         "request",
@@ -7228,7 +7229,7 @@
         "sorted-union-stream": "~2.1.3",
         "ssri": "^6.0.2",
         "stringify-package": "^1.0.1",
-        "tar": "^4.4.13",
+        "tar": "^4.4.15",
         "text-table": "~0.2.0",
         "tiny-relative-date": "^1.3.0",
         "uid-number": "0.0.6",
@@ -10983,7 +10984,7 @@
       }
     },
     "node_modules/npm/node_modules/tar": {
-      "version": "4.4.13",
+      "version": "4.4.15",
       "dev": true,
       "inBundle": true,
       "license": "ISC",
@@ -13457,6 +13458,7 @@
       "version": "3.8.0",
       "resolved": "https://registry.npmjs.org/secp256k1/-/secp256k1-3.8.0.tgz",
       "integrity": "sha512-k5ke5avRZbtl9Tqx/SA7CbY3NF6Ro+Sj9cZxezFzuBlLDmyqPiL8hJJ+EmzD8Ig4LUDByHJ3/iPOVoRixs/hmw==",
+      "hasInstallScript": true,
       "dependencies": {
         "bindings": "^1.5.0",
         "bip66": "^1.1.5",
@@ -21818,9 +21820,9 @@
       "dev": true
     },
     "npm": {
-      "version": "6.14.13",
-      "resolved": "https://registry.npmjs.org/npm/-/npm-6.14.13.tgz",
-      "integrity": "sha512-SRl4jJi0EBHY2xKuu98FLRMo3VhYQSA6otyLnjSEiHoSG/9shXCFNJy9tivpUJvtkN9s6VDdItHa5Rn+fNBzag==",
+      "version": "6.14.14",
+      "resolved": "https://registry.npmjs.org/npm/-/npm-6.14.14.tgz",
+      "integrity": "sha512-4TnYPV3rvwk9m92ON0iFrdXtRyMhrNkGdI8sr3dy1HVE3pVNxR9FyWYbjAw/HjfmHvmHUbxTVbmjAMv8NhIa6Q==",
       "dev": true,
       "requires": {
         "abbrev": "~1.1.1",
@@ -21932,7 +21934,7 @@
         "sorted-union-stream": "~2.1.3",
         "ssri": "^6.0.2",
         "stringify-package": "^1.0.1",
-        "tar": "^4.4.13",
+        "tar": "^4.4.15",
         "text-table": "~0.2.0",
         "tiny-relative-date": "^1.3.0",
         "uid-number": "0.0.6",
@@ -24863,7 +24865,7 @@
           }
         },
         "tar": {
-          "version": "4.4.13",
+          "version": "4.4.15",
           "bundled": true,
           "dev": true,
           "requires": {

src/price.js

@@ -127,8 +127,9 @@ class Price {
    * @apiName Price getBchaUsd()
    * @apiGroup Price
    * @apiDescription Return current price of BCHA in USD.
-   * This endpoint gets the USD price of BCHA from the Coinex API. The price
-   * comes from bch-api, so it has a better chance of working in Tor.
+   * This endpoint gets the USD price of XEC from the Coinex API. The price
+   * denominated in BCHA comes from bch-api, so it has a better chance of 
+   * working in Tor.
    *
    * @apiExample Example usage:
    *(async () => {
@@ -140,9 +141,47 @@ class Price {
    *  }
    *})()
    *
-   * // 18.81
+   * // 212.34
    */
   async getBchaUsd () {
+    try {
+      const response = await this.axios.get(
+        `${this.restURL}price/bchausd`,
+        this.axiosOptions
+      )
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+      
+      const bchaPrice = response.data.usd * 1000000
+      // Convert XEC denomination to BCHA denomination
+
+      return bchaPrice
+    } catch (err) {
+      if (err.response && err.response.data) throw err.response.data
+      else throw err
+    }
+  }
+
+    /**
+   * @api price.getXecUsd() getXecUsd()
+   * @apiName Price getXecUsd()
+   * @apiGroup Price
+   * @apiDescription Return current price of XEC in USD.
+   * This endpoint gets the USD price of XEC from the Coinex API. The price
+   * comes from bch-api, so it has a better chance of working in Tor.
+   *
+   * @apiExample Example usage:
+   *(async () => {
+   *  try {
+   *    let current = await bchjs.Price.getXecUsd();
+   *    console.log(current);
+   *  } catch(err) {
+   *   console.err(err)
+   *  }
+   *})()
+   *
+   * // 0.00021234 
+   */
+   async getXecUsd () {
     try {
       const response = await this.axios.get(
         `${this.restURL}price/bchausd`,

src/slp/utils.js

@@ -1588,31 +1588,25 @@ class Utils {
       // Note: validateTxid3() has the same output as validateTxid().
       // validateTxid2() uses slp-validate, which has a different output format.
 
-      // If the whitelist SLPDB is having issues, the try/catch will skip it
-      // and continue execution.
-      try {
-        // Validate against the whitelist SLPDB first.
-        const whitelistResult = await this.validateTxid3(txid, usrObj)
-        // console.log(
-        //   `whitelist-SLPDB for ${txid}: ${JSON.stringify(
-        //     whitelistResult,
-        //     null,
-        //     2
-        //   )}`
-        // )
+      // Validate against the whitelist SLPDB first.
+      const whitelistResult = await this.validateTxid3(txid, usrObj)
+      // console.log(
+      //   `whitelist-SLPDB for ${txid}: ${JSON.stringify(
+      //     whitelistResult,
+      //     null,
+      //     2
+      //   )}`
+      // )
 
-        // Safely retrieve the returned value.
-        if (whitelistResult[0] !== null) isValid = whitelistResult[0].valid
+      // Safely retrieve the returned value.
+      if (whitelistResult[0] !== null) isValid = whitelistResult[0].valid
 
-        // Exit if isValid is not null.
-        if (isValid !== null) {
-          // Save to the cache.
-          cachedTxValidation[txid] = isValid
+      // Exit if isValid is not null.
+      if (isValid !== null) {
+        // Save to the cache.
+        cachedTxValidation[txid] = isValid
 
-          return isValid
-        }
-      } catch {
-        /* exit quietly */
+        return isValid
       }
 
       // Try the general SLPDB, if the whitelist returned null.

test/integration/chains/testnet/ninsight.js

@@ -1,149 +0,0 @@
-// const chai = require('chai')
-// const assert = chai.assert
-const sinon = require('sinon')
-
-// const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ ninsightURL: 'https://trest.bitcoin.com/v2' })
-
-describe('#Ninsight', () => {
-  let sandbox
-
-  beforeEach(async () => {
-    if (process.env.IS_USING_FREE_TIER) await sleep(1500)
-
-    sandbox = sinon.createSandbox()
-  })
-
-  afterEach(() => sandbox.restore())
-
-  // describe('#utxo', () => {
-  //   it('should GET utxos for a single address', async () => {
-  //     const addr = 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr'
-  //
-  //     const result = await bchjs.Ninsight.utxo(addr)
-  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-  //
-  //     assert.property(result[0], 'utxos')
-  //     assert.property(result[0], 'legacyAddress')
-  //     assert.property(result[0], 'cashAddress')
-  //     assert.property(result[0], 'slpAddress')
-  //     assert.property(result[0], 'scriptPubKey')
-  //     assert.property(result[0], 'asm')
-  //
-  //     assert.isArray(result[0].utxos)
-  //
-  //     assert.property(result[0].utxos[0], 'txid')
-  //     assert.property(result[0].utxos[0], 'vout')
-  //     assert.property(result[0].utxos[0], 'amount')
-  //     assert.property(result[0].utxos[0], 'satoshis')
-  //     assert.property(result[0].utxos[0], 'height')
-  //     assert.property(result[0].utxos[0], 'confirmations')
-  //   })
-  //
-  //   it('should POST utxo details for an array of addresses', async () => {
-  //     const addr = [
-  //       'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
-  //       'bchtest:qp6hgvevf4gzz6l7pgcte3gaaud9km0l459fa23dul'
-  //     ]
-  //
-  //     const result = await bchjs.Ninsight.utxo(addr)
-  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-  //
-  //     assert.isArray(result)
-  //     assert.isArray(result[0].utxos)
-  //
-  //     assert.property(result[0], 'utxos')
-  //     assert.property(result[0], 'legacyAddress')
-  //     assert.property(result[0], 'cashAddress')
-  //     assert.property(result[0], 'slpAddress')
-  //     assert.property(result[0], 'scriptPubKey')
-  //     assert.property(result[0], 'asm')
-  //
-  //     // assert.hasAnyKeys(result[0][0], [
-  //     //   "txid",
-  //     //   "vout",
-  //     //   "value",
-  //     //   "height",
-  //     //   "confirmations"
-  //     // ])
-  //   })
-  // })
-  //
-  // describe('#transactions', () => {
-  //   it('should POST transactions history for a single address', async () => {
-  //     const addr = 'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr'
-  //
-  //     const result = await bchjs.Ninsight.transactions(addr)
-  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-  //
-  //     assert.isArray(result)
-  //     assert.property(result[0], 'cashAddress')
-  //     assert.property(result[0], 'legacyAddress')
-  //     assert.property(result[0], 'txs')
-  //     assert.isArray(result[0].txs)
-  //     assert.property(result[0].txs[0], 'txid')
-  //     assert.property(result[0].txs[0], 'vin')
-  //     assert.property(result[0].txs[0], 'vout')
-  //   })
-  //   it('should POST transactions history for an array of addresses', async () => {
-  //     const addr = [
-  //       'bchtest:qzjtnzcvzxx7s0na88yrg3zl28wwvfp97538sgrrmr',
-  //       'bchtest:qp6hgvevf4gzz6l7pgcte3gaaud9km0l459fa23dul'
-  //     ]
-  //
-  //     const result = await bchjs.Ninsight.transactions(addr)
-  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-  //
-  //     assert.isArray(result)
-  //     assert.property(result[0], 'cashAddress')
-  //     assert.property(result[0], 'legacyAddress')
-  //     assert.property(result[0], 'txs')
-  //     assert.isArray(result[0].txs)
-  //     assert.property(result[0].txs[0], 'txid')
-  //     assert.property(result[0].txs[0], 'vin')
-  //     assert.property(result[0].txs[0], 'vout')
-  //   })
-  // })
-  //
-  // describe('#txDetails', () => {
-  //   it('should POST transactions details for a single address', async () => {
-  //     const txid =
-  //       '76856d82e00b2696acd8d989e1fa6c46b431005046a285ce905814cac0ff8fea'
-  //
-  //     const result = await bchjs.Ninsight.txDetails(txid)
-  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-  //
-  //     assert.isArray(result)
-  //     assert.property(result[0], 'txid')
-  //     assert.property(result[0], 'version')
-  //     assert.property(result[0], 'locktime')
-  //     assert.property(result[0], 'vin')
-  //     assert.property(result[0], 'vout')
-  //     assert.property(result[0], 'blockhash')
-  //     assert.property(result[0], 'blockheight')
-  //     assert.property(result[0], 'confirmations')
-  //     assert.property(result[0], 'time')
-  //     assert.property(result[0], 'blocktime')
-  //     assert.property(result[0], 'valueOut')
-  //     assert.property(result[0], 'size')
-  //   })
-  //   it('should POST transactions details for an array of addresses', async () => {
-  //     const txid = [
-  //       'f191d1062789d7071da6f2168ba306869a829294f6b1c09d03492db4ca3a8e77',
-  //       '76856d82e00b2696acd8d989e1fa6c46b431005046a285ce905814cac0ff8fea'
-  //     ]
-  //
-  //     const result = await bchjs.Ninsight.txDetails(txid)
-  //     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-  //
-  //     assert.isArray(result)
-  //     assert.property(result[0], 'txid')
-  //     assert.property(result[0], 'vin')
-  //     assert.property(result[0], 'vout')
-  //   })
-  // })
-})
-
-function sleep (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}

test/integration/ninsight.js

@@ -1,138 +0,0 @@
-const chai = require('chai')
-const assert = chai.assert
-const sinon = require('sinon')
-
-const BCHJS = require('../../src/bch-js')
-const bchjs = new BCHJS({ ninsightURL: 'https://rest.bitcoin.com/v2' })
-
-describe('#Ninsight', () => {
-  let sandbox
-
-  beforeEach(async () => {
-    sandbox = sinon.createSandbox()
-
-    if (process.env.IS_USING_FREE_TIER) await sleep(1500)
-  })
-
-  afterEach(() => sandbox.restore())
-
-  describe('#utxo', () => {
-    it('should GET utxos for a single address', async () => {
-      const addr = 'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
-
-      const result = await bchjs.Ninsight.utxo(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.property(result[0], 'utxos')
-      assert.property(result[0], 'legacyAddress')
-      assert.property(result[0], 'cashAddress')
-      assert.property(result[0], 'slpAddress')
-      assert.property(result[0], 'scriptPubKey')
-      assert.property(result[0], 'asm')
-
-      assert.isArray(result[0].utxos)
-
-      assert.property(result[0].utxos[0], 'txid')
-      assert.property(result[0].utxos[0], 'vout')
-      assert.property(result[0].utxos[0], 'amount')
-      assert.property(result[0].utxos[0], 'satoshis')
-      assert.property(result[0].utxos[0], 'height')
-      assert.property(result[0].utxos[0], 'confirmations')
-    })
-
-    it('should POST utxo details for an array of addresses', async () => {
-      const addr = [
-        'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7',
-        'bitcoincash:qz0us0z6ucpqt07jgpad0shgh7xmwxyr3ynlcsq0wr'
-      ]
-
-      const result = await bchjs.Ninsight.utxo(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.isArray(result[0].utxos)
-
-      assert.property(result[0], 'utxos')
-      assert.property(result[0], 'legacyAddress')
-      assert.property(result[0], 'cashAddress')
-      assert.property(result[0], 'slpAddress')
-      assert.property(result[0], 'scriptPubKey')
-      assert.property(result[0], 'asm')
-    })
-  })
-  describe('#transactions', () => {
-    it('should POST transactions history for a single address', async () => {
-      const addr = 'bitcoincash:qqh793x9au6ehvh7r2zflzguanlme760wuzehgzjh9'
-
-      const result = await bchjs.Ninsight.transactions(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'cashAddress')
-      assert.property(result[0], 'legacyAddress')
-      assert.property(result[0], 'txs')
-      assert.isArray(result[0].txs)
-      assert.property(result[0].txs[0], 'txid')
-      assert.property(result[0].txs[0], 'vin')
-      assert.property(result[0].txs[0], 'vout')
-    })
-    it('should POST transactions history for an array of addresses', async () => {
-      const addr = [
-        'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7',
-        'bitcoincash:qz0us0z6ucpqt07jgpad0shgh7xmwxyr3ynlcsq0wr'
-      ]
-
-      const result = await bchjs.Ninsight.transactions(addr)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'cashAddress')
-      assert.property(result[0], 'legacyAddress')
-      assert.property(result[0], 'txs')
-      assert.isArray(result[0].txs)
-      assert.property(result[0].txs[0], 'txid')
-      assert.property(result[0].txs[0], 'vin')
-      assert.property(result[0].txs[0], 'vout')
-    })
-  })
-  describe('#txDetails', () => {
-    it('should POST transactions details for a single address', async () => {
-      const txid = 'fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33'
-
-      const result = await bchjs.Ninsight.txDetails(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'txid')
-      assert.property(result[0], 'version')
-      assert.property(result[0], 'locktime')
-      assert.property(result[0], 'vin')
-      assert.property(result[0], 'vout')
-      assert.property(result[0], 'blockhash')
-      assert.property(result[0], 'blockheight')
-      assert.property(result[0], 'confirmations')
-      assert.property(result[0], 'time')
-      assert.property(result[0], 'blocktime')
-      assert.property(result[0], 'valueOut')
-      assert.property(result[0], 'size')
-    })
-    it('should POST transactions details for an array of addresses', async () => {
-      const txid = [
-        'fe28050b93faea61fa88c4c630f0e1f0a1c24d0082dd0e10d369e13212128f33',
-        '4db095f34d632a4daf942142c291f1f2abb5ba2e1ccac919d85bdc2f671fb251'
-      ]
-
-      const result = await bchjs.Ninsight.txDetails(txid)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'txid')
-      assert.property(result[0], 'vin')
-      assert.property(result[0], 'vout')
-    })
-  })
-})
-
-function sleep (ms) {
-  return new Promise(resolve => setTimeout(resolve, ms))
-}