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

Basic Authentication

src/address.js

@@ -11,6 +11,23 @@ class Address {
 
     this.restURL = tmp.restURL
     this.apiToken = tmp.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}`
+        }
+      }
+    }
   }
 
   /**

src/bch-js.js

@@ -55,9 +55,27 @@ class BCHJS {
     else if (process.env.BCHJSTOKEN && process.env.BCHJSTOKEN !== "")
       this.apiToken = process.env.BCHJSTOKEN
 
+    // Retrieve the Basic Authentication password.
+    this.authPass = "" // default value.
+    if (config && config.authPass && config.authPass !== "")
+      this.authPass = config.authPass
+    else if (process.env.BCHJSAUTHPASS && process.env.BCHJSAUTHPASS !== "")
+      this.authPass = process.env.BCHJSAUTHPASS
+
+    // Generate a Basic Authentication token from an auth password
+    this.authToken = ""
+    if (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")
+      this.authToken = `Basic ${base64Credential}`
+    }
+
     const libConfig = {
       restURL: this.restURL,
-      apiToken: this.apiToken
+      apiToken: this.apiToken,
+      authToken: this.authToken
     }
 
     // console.log(`apiToken: ${this.apiToken}`)

src/blockbook.js

@@ -15,12 +15,22 @@ class Blockbook {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    this.authToken = config.authToken
     // console.log(`Blockbook apiToken: ${this.apiToken}`)
 
-    // 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}`
+        }
       }
     }
 

src/blockchain.js

@@ -11,11 +11,21 @@ class Blockchain {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    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}`
+        }
       }
     }
 

src/control.js

@@ -10,11 +10,21 @@ class Control {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    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}`
+        }
       }
     }
 

src/electrumx.js

@@ -11,12 +11,21 @@ class ElectrumX {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    this.authToken = config.authToken
 
-    // Add JWT token to the authorization header.
-    this.axiosOptions = {
-      headers: {
-        authorization: `Token ${this.apiToken}`,
-        timeout: 15000
+    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}`
+        }
       }
     }
 

src/encryption.js

@@ -11,12 +11,21 @@ class Encryption {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
     this.axios = axios
-    // console.log(`Blockbook apiToken: ${this.apiToken}`)
+    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}`
+        }
       }
     }
 

src/generating.js

@@ -6,11 +6,21 @@ class Generating {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    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}`
+        }
       }
     }
 

src/mining.js

@@ -6,11 +6,21 @@ class Mining {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    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}`
+        }
       }
     }
 

src/price.js

@@ -6,15 +6,23 @@ class Price {
   constructor(config) {
     _this = this
 
-    if (config) {
-      this.restURL = config.restURL
-      this.apiToken = config.apiToken
-    }
+    this.restURL = config.restURL
+    this.apiToken = config.apiToken
+    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}`
+        }
       }
     }
 

src/raw-transactions.js

@@ -6,11 +6,21 @@ class RawTransactions {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    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}`
+        }
       }
     }
 

src/schnorr.js

@@ -4,11 +4,21 @@ class Schnorr {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    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}`
+        }
       }
     }
   }

src/slp/slp.js

@@ -18,22 +18,31 @@ const Utils = require("./utils")
 // SLP is a superset of BITBOX
 class SLP {
   constructor(config) {
-    const tmp = {}
-    if (!config || !config.restURL) {
-      tmp.restURL = `https://api.fullstack.cash/v3/`
+    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 {
-      tmp.restURL = config.restURL
-      tmp.apiToken = config.apiToken
+      // Add JWT token to the authorization header.
+      this.axiosOptions = {
+        headers: {
+          authorization: `Token ${this.apiToken}`
+        }
+      }
     }
 
-    this.restURL = tmp.restURL
-    this.apiToken = tmp.apiToken
-
-    this.Address = new Address(tmp)
+    this.Address = new Address(config)
     this.ECPair = ECPair
-    this.TokenType1 = new TokenType1(tmp)
+    this.TokenType1 = new TokenType1(config)
     this.NFT1 = new NFT1(this.restURL)
-    this.Utils = new Utils(tmp)
+    this.Utils = new Utils(config)
   }
 }
 

src/util.js

@@ -6,11 +6,21 @@ class Util {
   constructor(config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
+    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

@@ -5,12 +5,17 @@
   To Run Test:
   - Update the RESTURL for bch-api you want to test against.
   - Ensure the BCHJSTOKEN environment variable is set to an empty string.
+  - If working with bch-api locally, eliminate the local IP address from the
+    whitelist in bch-api/src/middleware/route-ratelimit.js
+
+  Run this test with this command:
+  mocha --timeout=30000 anonymous-rate-limits.js
 */
 
 const assert = require("chai").assert
 
-const RESTURL = `https://api.fullstack.cash/v3/`
-// const RESTURL = `http://localhost:3000/v3/`
+// const RESTURL = `https://abc.fullstack.cash/v3/`
+const RESTURL = `http://localhost:3000/v3/`
 
 const BCHJS = require("../../../src/bch-js")
 const bchjs = new BCHJS({ restURL: RESTURL })
@@ -32,7 +37,7 @@ describe("#anonymous rate limits", () => {
 
   it("should throw error when rate limit exceeded", async () => {
     try {
-      for (let i = 0; i < 22; i++) await bchjs.Control.getNetworkInfo()
+      for (let i = 0; i < 35; i++) await bchjs.Control.getNetworkInfo()
 
       assert.fail("Unexpected result")
     } catch (err) {

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

@@ -0,0 +1,55 @@
+/*
+  Mocha test that verifies that the bch-api server is enforcing its
+  access rules for Basic Authentication.
+
+  To Run Test:
+  - Update the restURL for bch-api you want to test against.
+  - Update the PRO_PASS value with a current PRO_PASSES string used by bch-api.
+*/
+
+const assert = require("chai").assert
+
+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/`,
+  authPass: PRO_PASS
+})
+
+describe("#full node 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()
+
+      if (i === 5) {
+        // console.log(`validating 5th call: ${i}`)
+        assert.property(result, "version", "more than 3 calls allowed")
+      }
+
+      if (i === 15) {
+        // console.log(`validating 5th call: ${i}`)
+        assert.property(result, "version", "more than 10 calls allowed")
+      }
+    }
+  }).timeout(45000)
+
+  it("should allow more than 20 RPM to an indexer", async () => {
+    const addr = "bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"
+
+    for (let i = 0; i < 22; i++) {
+      const result = await bchjs.Blockbook.balance(addr)
+
+      if (i === 5) {
+        // console.log(`validating 5th call: ${i}`)
+        assert.property(result, "balance", "more than 3 calls allowed")
+      }
+
+      if (i === 15) {
+        // console.log(`validating 5th call: ${i}`)
+        assert.property(result, "balance", "more than 10 calls allowed")
+      }
+    }
+  }).timeout(45000)
+})

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

@@ -1,4 +1,8 @@
 /*
+  CT 11/11/2020:
+  There is no longer a free tier. These tests have been deprecated.
+
+  --------
   Mocha test that verifies that the bch-api server is enforcing its
   FREE access rules
 

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

@@ -1,4 +1,8 @@
 /*
+  CT 11/11/2020:
+  There is no longer a free tier. These tests have been deprecated.
+
+  ----
   Mocha test that verifies that the bch-api server is enforcing its
   full-node access rules
 

test/unit/bitbox-shim.js

@@ -1,25 +0,0 @@
-const chai = require("chai")
-const assert = chai.assert
-const BCHJS = require("../../src/bch-js")
-
-// Used for debugging and iterrogating JS objects.
-const util = require("util")
-util.inspect.defaultOptions = { depth: 1 }
-
-describe(`#BitboxShim`, () => {
-  it("should create the shim library", () => {
-    const BitboxShim = BCHJS.BitboxShim()
-    const bitbox = new BitboxShim()
-
-    //console.log(`bitbox.Address: ${util.inspect(bitbox.Address)}`)
-
-    assert.hasAnyKeys(bitbox.Address, [
-      // "details",
-      // "utxo",
-      // "unconfirmed",
-      // "transactions",
-      // "toLegacyAddress"
-      "restURL"
-    ])
-  })
-})