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

/*
  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

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

const assert = require('chai').assert

const JWT_TOKEN =
  'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlODhhY2YyMDIyMWMxMDAxMmFkOTQwMSIsImVtYWlsIjoiZGVtb0BkZW1vLmNvbSIsImFwaUxldmVsIjoxMCwicmF0ZUxpbWl0IjozLCJpYXQiOjE2MDQ4NTQ2OTEsImV4cCI6MTYwNzQ0NjY5MX0.iwse0z0KDKHx9graCxcOwj6lSlfKQAb1zLhmjvygvts'

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

describe('#free 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 allow up to 10 RPM to indexer, then throw error', async () => {
    try {
      const addr = 'bitcoincash:qrehqueqhw629p6e57994436w730t4rzasnly00ht0'

      for (let i = 0; i < 15; i++) {
        const result = await await bchjs.Blockbook.balance(addr)

        if (i === 5) {
          // console.log(`validating 5th call: ${i}`)
          assert.property(result, 'address', 'more than 3 calls allowed')
        }
      }
    } catch (err) {
      // console.log(`err: `, err)
      assert.include(
        err.error,
        'currently 10 requests',
        'more than 10 not allowed'
      )
      assert.include(err.error, 10)
      assert.notInclude(err.error, 3)
    }
  }).timeout(20000)

  it('should allow up to 10 RPM to full node, then throw error', async () => {
    try {
      for (let i = 0; i < 15; 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')
        }
      }
    } catch (err) {
      // console.log(`validating after 10th call`)
      // console.log(`err: `, err)
      assert.include(
        err.error,
        'currently 10 requests',
        'more than 10 not allowed'
      )
      assert.include(err.error, 10)
      assert.notInclude(err.error, 3)
    }
  }).timeout(20000)

  it('should throw error when rate limit exceeded 20 RPM for indexer endpoints', async () => {
    try {
      for (let i = 0; i < 22; i++) await bchjs.Control.getNetworkInfo()

      assert.fail('unexpected result')
    } catch (err) {
      // console.log(`err: `, err)
      assert.include(err.error, 'Too many requests')
    }
  }).timeout(20000)
})