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

/*
  Mocha test that verifies that the bch-api server is enforcing its
  full-node access rules

  To Run Test:
  - Update the restURL for bch-api you want to test against.
  - Update the JWT_TOKEN value with a current full-node-level JWT token.
*/

const assert = require("chai").assert

const JWT_TOKEN =
  "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVkYmY4MjA1YTYwODliMjliYTlhZjc1OSIsImlhdCI6MTU3MjgzMTgzOSwiZXhwIjoxNTc1NDIzODM5fQ.sFFS4AF04U2aUwmKkBIfnMQIUoygzV9UMVzzQuwctpY"

const BCHJS = require("../../../src/bch-js")
const bchjs = new BCHJS({
  restURL: `https://api.bchjs.cash/v3/`,
  // restURL: `http://localhost:3000/v3/`,
  apiToken: JWT_TOKEN
})

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)
    // console.log(`result: ${JSON.stringify(result, null, 2)}`)

    assert.property(result, "balance")
  }).timeout(5000)

  it("should throw error when rate limit exceeded 3 RPM for indexer endpoints", async () => {
    const addr = "bitcoincash:qrdka2205f4hyukutc2g0s6lykperc8nsu5u2ddpqf"

    try {
      for (let i = 0; i < 5; i++) await bchjs.Blockbook.balance(addr)

      assert.equal(true, false, "unexpected result")
    } catch (err) {
      // console.log(`err: `, err)
      assert.include(err.error, "Too many requests")
    }
  }).timeout(10000)

  it("should allow more than 10 RPM to full node", async () => {
    for (let i = 0; i < 20; 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(10000)

  it("should throw error for more than 100 RPM to fullnode", async () => {
    try {
      for (let i = 0; i < 100; i++) await bchjs.Control.getNetworkInfo()
    } catch (err) {
      // console.log(`validating after 10th call`)
      // console.log(`err: `, err)
      assert.include(err.error, "Too many requests")
      assert.include(err.error, 100)
    }
  }).timeout(30000)
})