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

fix(price): Removing documentation for deprecated endpoint

package.json

@@ -16,7 +16,7 @@
     "test:integration:local": "RESTURL=http://localhost:3000/v3/ mocha --timeout 30000 test/integration",
     "test:integration:local:bchn": "RESTURL=http://localhost:3000/v3/ bash test/integration/test-free-tier-bchn.sh",
     "test:integration:local:testnet": "RESTURL=http://localhost:4000/v3/ mocha --timeout 30000 test/integration/testnet",
-    "test:temp": "mocha --timeout 30000 -g '#Encryption' test/integration/",
+    "test:temp": "RESTURL=http://localhost:3000/v3/ mocha --timeout 30000 -g '#price' test/integration/",
     "test:integration:api": "RESTURL=https://api.fullstack.cash/v3/ mocha --timeout 30000 test/integration",
     "coverage": "nyc report --reporter=text-lcov | coveralls",
     "coverage:report": "nyc --reporter=html mocha --timeout 25000 test/unit/",

src/bch-js.js

@@ -65,7 +65,7 @@ class BCHJS {
     // Generate a Basic Authentication token from an auth password
     this.authToken = ""
     if (this.authPass) {
-      console.log(`bch-js initialized with authPass: ${this.authPass}`)
+      // console.log(`bch-js initialized with authPass: ${this.authPass}`)
       // Generate the header for Basic Authentication.
       const combined = `fullstackcash:${this.authPass}`
       var base64Credential = Buffer.from(combined).toString("base64")

src/price.js

@@ -29,26 +29,7 @@ class Price {
     this.axios = axios
   }
 
-  /**
-   * @api price.current() current()
-   * @apiName Price.
-   * @apiGroup Price
-   * @apiDescription Return current price of BCH in multiple currencies.
-   * This endpoint will be deprecated in favor of getUSD. It uses the Bitcoin.com
-   * price feed.
-   *
-   * @apiExample Example usage:
-   *(async () => {
-   *  try {
-   *    let current = await bchjs.Price.current('usd');
-   *    console.log(current);
-   *  } catch(err) {
-   *   console.err(err)
-   *  }
-   *})()
-   *
-   * // 26681
-   */
+  // This endpoint is deprecated. Documentation removed.
   async current(currency = "usd") {
     try {
       const response = await this.axios.get(
@@ -140,6 +121,41 @@ class Price {
       else throw err
     }
   }
+
+  /**
+   * @api price.getBchaUsd() getBchaUsd()
+   * @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.
+   *
+   * @apiExample Example usage:
+   *(async () => {
+   *  try {
+   *    let current = await bchjs.Price.getBchaUsd();
+   *    console.log(current);
+   *  } catch(err) {
+   *   console.err(err)
+   *  }
+   *})()
+   *
+   * // 18.81
+   */
+  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)}`)
+
+      return response.data.usd
+    } catch (err) {
+      if (err.response && err.response.data) throw err.response.data
+      else throw err
+    }
+  }
 }
 
 module.exports = Price

src/raw-transactions.js

@@ -272,9 +272,7 @@ class RawTransactions {
             txids: txid,
             verbose: verbose
           },
-          headers: {
-            authorization: `Token ${this.apiToken}`
-          }
+          headers: _this.axiosOptions.headers
         }
         const response = await axios(options)
 
@@ -347,9 +345,7 @@ class RawTransactions {
           data: {
             hexes: hex
           },
-          headers: {
-            authorization: `Token ${this.apiToken}`
-          }
+          headers: _this.axiosOptions.headers
         }
         const response = await axios(options)
 

src/slp/tokentype1.js

@@ -18,17 +18,28 @@ class TokenType1 {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    this.authToken = config.authToken
+
+    if (this.authToken) {
+      // Add Basic Authentication token to the authorization header.
+      this.axiosOptions = {
+        headers: {
+          authorization: this.authToken
+        }
+      }
+    } else {
+      // Add JWT token to the authorization header.
+      this.axiosOptions = {
+        headers: {
+          authorization: `Token ${this.apiToken}`
+        }
+      }
+    }
 
     addy = new Address(config)
     this.Script = new Script()
 
     this.axios = axios
-    // Add JWT token to the authorization header.
-    this.axiosOptions = {
-      headers: {
-        authorization: `Token ${this.apiToken}`
-      }
-    }
 
     // Instantiate the transaction builder.
     TransactionBuilder.setAddress(addy)

src/slp/utils.js

@@ -13,11 +13,21 @@ class Utils {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
     this.slpParser = slpParser
+    this.authToken = config.authToken
 
-    // Add JWT token to the authorization header.
-    this.axiosOptions = {
-      headers: {
-        authorization: `Token ${this.apiToken}`
+    if (this.authToken) {
+      // Add Basic Authentication token to the authorization header.
+      this.axiosOptions = {
+        headers: {
+          authorization: this.authToken
+        }
+      }
+    } else {
+      // Add JWT token to the authorization header.
+      this.axiosOptions = {
+        headers: {
+          authorization: `Token ${this.apiToken}`
+        }
       }
     }
 

test/e2e/rate-limits/anonymous-rate-limits.js

@@ -15,7 +15,8 @@
 const assert = require("chai").assert
 
 // const RESTURL = `https://abc.fullstack.cash/v3/`
-const RESTURL = `http://localhost:3000/v3/`
+const RESTURL = `https://bchn.fullstack.cash/v3/`
+// const RESTURL = `http://localhost:3000/v3/`
 
 const BCHJS = require("../../../src/bch-js")
 const bchjs = new BCHJS({ restURL: RESTURL })
@@ -29,7 +30,7 @@ describe("#anonymous rate limits", () => {
 
   it("should allow an anonymous call to an indexer", async () => {
     const addr = "bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"
-    const result = await bchjs.Blockbook.balance(addr)
+    const result = await bchjs.Electrumx.balance(addr)
     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
     assert.property(result, "balance")

test/e2e/rate-limits/basic-auth-rate-limits.js

@@ -13,12 +13,13 @@ const PRO_PASS = "testpassword"
 
 const BCHJS = require("../../../src/bch-js")
 const bchjs = new BCHJS({
-  // restURL: `https://api.fullstack.cash/v3/`,
-  restURL: `http://localhost:3000/v3/`,
+  // restURL: `https://bchn.fullstack.cash/v3/`,
+  restURL: `https://abc.fullstack.cash/v3/`,
+  // restURL: `http://localhost:3000/v3/`,
   authPass: PRO_PASS
 })
 
-describe("#full node rate limits", () => {
+describe("#Basic Authentication rate limits", () => {
   it("should allow more than 20 RPM to full node", async () => {
     for (let i = 0; i < 22; i++) {
       const result = await bchjs.Control.getNetworkInfo()

test/e2e/rate-limits/full-node-rate-limits.js

@@ -18,7 +18,8 @@ const JWT_TOKEN =
 
 const BCHJS = require("../../../src/bch-js")
 const bchjs = new BCHJS({
-  restURL: `https://api.fullstack.cash/v3/`,
+  // restURL: `https://bchn.fullstack.cash/v3/`,
+  restURL: `https:/abc.fullstack.cash/v3/`,
   // restURL: `http://localhost:3000/v3/`,
   apiToken: JWT_TOKEN
 })
@@ -26,7 +27,7 @@ const bchjs = new BCHJS({
 describe("#full node rate limits", () => {
   it("should allow an free call to an indexer", async () => {
     const addr = "bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"
-    const result = await bchjs.Blockbook.balance(addr)
+    const result = await bchjs.Electrumx.balance(addr)
     // console.log(`result: ${JSON.stringify(result, null, 2)}`)
 
     assert.property(result, "balance")

test/e2e/rate-limits/indexer-rate-limits.js

@@ -14,12 +14,13 @@ const JWT_TOKEN =
 
 const BCHJS = require("../../../src/bch-js")
 const bchjs = new BCHJS({
-  restURL: `https://api.fullstack.cash/v3/`,
+  // restURL: `https://bchn.fullstack.cash/v3/`,
+  restURL: `https://abc.fullstack.cash/v3/`,
   // restURL: `http://localhost:3000/v3/`,
   apiToken: JWT_TOKEN
 })
 
-describe("#full node rate limits", () => {
+describe("#Indexer rate limits", () => {
   it("should allow more than 20 RPM to full node", async () => {
     for (let i = 0; i < 22; i++) {
       const result = await bchjs.Control.getNetworkInfo()
@@ -40,7 +41,7 @@ describe("#full node rate limits", () => {
     const addr = "bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"
 
     for (let i = 0; i < 22; i++) {
-      const result = await bchjs.Blockbook.balance(addr)
+      const result = await bchjs.Electrumx.balance(addr)
 
       if (i === 5) {
         // console.log(`validating 5th call: ${i}`)

test/integration/bchn/price.js

@@ -21,6 +21,15 @@ describe("#price", () => {
     })
   })
 
+  describe("#getBchaUsd", () => {
+    it("should get the USD price of BCHA", async () => {
+      const result = await bchjs.Price.getBchaUsd()
+      console.log(result)
+
+      assert.isNumber(result)
+    })
+  })
+
   describe("#rates", () => {
     it("should get the price of BCH in several currencies", async () => {
       const result = await bchjs.Price.rates()

test/integration/price.js

@@ -25,6 +25,15 @@ describe("#price", () => {
     })
   })
 
+  describe("#getBchaUsd", () => {
+    it("should get the USD price of BCHA", async () => {
+      const result = await bchjs.Price.getBchaUsd()
+      console.log(result)
+
+      assert.isNumber(result)
+    })
+  })
+
   describe("#rates", () => {
     it("should get the price of BCH in several currencies", async () => {
       const result = await bchjs.Price.rates()

test/unit/price.js

@@ -5,7 +5,7 @@ const sinon = require("sinon")
 const mockDataLib = require("./fixtures/price-mocks")
 let mockData
 
-describe("#Price", () => {
+describe("#price", () => {
   let sandbox
   let bchjs
 
@@ -56,4 +56,15 @@ describe("#Price", () => {
       assert.property(result, "CAD")
     })
   })
+
+  describe("#getBchaUsd", () => {
+    it("should get the USD price of BCHA", async () => {
+      sandbox.stub(bchjs.Price.axios, "get").resolves({ data: { usd: 18.87 } })
+
+      const result = await bchjs.Price.getBchaUsd()
+      // console.log(result)
+
+      assert.isNumber(result)
+    })
+  })
 })