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

feat(/v5 REST API): Using the new v5 route in bch-api

src/address.js

@@ -6,7 +6,7 @@ const coininfo = require('@psf/coininfo')
 class Address {
   constructor (config) {
     const tmp = {}
-    if (!config || !config.restURL) tmp.restURL = 'https://api.bchjs.cash/v4/'
+    if (!config || !config.restURL) tmp.restURL = 'https://api.bchjs.cash/v5/'
     else tmp.restURL = config.restURL
 
     this.restURL = tmp.restURL

src/bch-js.js

@@ -7,8 +7,8 @@
 */
 
 // bch-api mainnet.
-const DEFAULT_REST_API = 'https://api.fullstack.cash/v4/'
-// const DEFAULT_REST_API = "http://localhost:3000/v4/"
+const DEFAULT_REST_API = 'https://api.fullstack.cash/v5/'
+// const DEFAULT_REST_API = "http://localhost:3000/v5/"
 
 // local deps
 const BitcoinCash = require('./bitcoincash')

src/slp/nft1.js

@@ -421,9 +421,9 @@ class Nft1 {
   }
 
   /**
-   * @api SLP.Nft1.listNFTGroupChildren() listNFTGroupChildren()
+   * @api SLP.NFT1.listNFTGroupChildren() listNFTGroupChildren()
    * @apiName listNFTGroupChildren
-   * @apiGroup SLP Nft1
+   * @apiGroup SLP NFT1
    * @apiDescription Return list of NFT children tokens in a NFT Group.
    * It's assumed provided groupId parameter is for an NFT Group token (type=129)
    *
@@ -460,9 +460,9 @@ class Nft1 {
   }
 
   /**
-   * @api SLP.Nft1.parentNFTGroup() parentNFTGroup()
+   * @api SLP.NFT1.parentNFTGroup() parentNFTGroup()
    * @apiName parentNFTGroup
-   * @apiGroup SLP Nft1
+   * @apiGroup SLP NFT1
    * @apiDescription Return parent NFT Group information for a given NFT child token.
    * It's assumed provided groupId parameter is for an NFT Child token (type=65)
    *

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

@@ -14,9 +14,9 @@
 
 const assert = require('chai').assert
 
-// const RESTURL = `https://abc.fullstack.cash/v4/`
-const RESTURL = 'https://bchn.fullstack.cash/v4/'
-// const RESTURL = `http://localhost:3000/v4/`
+// const RESTURL = `https://abc.fullstack.cash/v5/`
+const RESTURL = 'https://bchn.fullstack.cash/v5/'
+// const RESTURL = `http://localhost:3000/v5/`
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({ restURL: RESTURL })

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

@@ -13,9 +13,9 @@ const PRO_PASS = 'testpassword'
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({
-  // restURL: `https://bchn.fullstack.cash/v4/`,
-  restURL: 'https://abc.fullstack.cash/v4/',
-  // restURL: `http://localhost:3000/v4/`,
+  // restURL: `https://bchn.fullstack.cash/v5/`,
+  restURL: 'https://abc.fullstack.cash/v5/',
+  // restURL: `http://localhost:3000/v5/`,
   authPass: PRO_PASS
 })
 

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

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

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

@@ -18,9 +18,9 @@ const JWT_TOKEN =
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({
-  // restURL: `https://bchn.fullstack.cash/v4/`,
-  restURL: 'https:/abc.fullstack.cash/v4/',
-  // restURL: `http://localhost:3000/v4/`,
+  // restURL: `https://bchn.fullstack.cash/v5/`,
+  restURL: 'https:/abc.fullstack.cash/v5/',
+  // restURL: `http://localhost:3000/v5/`,
   apiToken: JWT_TOKEN
 })
 
@@ -65,7 +65,7 @@ describe('#full node rate limits', () => {
 
   it('should throw error for more than 100 RPM to fullnode', async () => {
     try {
-      console.log('This test usually doesn\'t pass, because of latency.')
+      console.log("This test usually doesn't pass, because of latency.")
       for (let i = 0; i < 100; i++) await bchjs.Control.getNetworkInfo()
     } catch (err) {
       // console.log(`validating after 10th call`)

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

@@ -14,9 +14,9 @@ const JWT_TOKEN =
 
 const BCHJS = require('../../../src/bch-js')
 const bchjs = new BCHJS({
-  // restURL: `https://bchn.fullstack.cash/v4/`,
-  restURL: 'https://abc.fullstack.cash/v4/',
-  // restURL: `http://localhost:3000/v4/`,
+  // restURL: `https://bchn.fullstack.cash/v5/`,
+  restURL: 'https://abc.fullstack.cash/v5/',
+  // restURL: `http://localhost:3000/v5/`,
   apiToken: JWT_TOKEN
 })
 

test/integration/chains/testnet/blockchain.js

@@ -12,11 +12,11 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 // if (process.env.RESTURL) RESTURL = process.env.RESTURL
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v4/` })
+// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v5/` })
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
 
 // Inspect utility used for debugging.

test/integration/chains/testnet/control.js

@@ -7,7 +7,7 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 
 const BCHJS = require('../../../../src/bch-js')
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })

test/integration/chains/testnet/electrumx.js

@@ -5,7 +5,7 @@ const util = require('util')
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 
 const BCHJS = require('../../../../src/bch-js')
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })

test/integration/chains/testnet/ninsight.js

@@ -1,9 +1,9 @@
-const chai = require('chai')
-const assert = chai.assert
+// 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' })
+// const BCHJS = require('../../../../src/bch-js')
+// const bchjs = new BCHJS({ ninsightURL: 'https://trest.bitcoin.com/v2' })
 
 describe('#Ninsight', () => {
   let sandbox
@@ -16,130 +16,132 @@ describe('#Ninsight', () => {
 
   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')
-    })
-  })
+  // 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) {

test/integration/chains/testnet/rawtransaction.js

@@ -10,11 +10,11 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 // if (process.env.RESTURL) RESTURL = process.env.RESTURL
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v4/` })
+// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v5/` })
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
 
 // Inspect utility used for debugging.

test/integration/chains/testnet/slp.js

@@ -7,11 +7,11 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 // if (process.env.RESTURL) RESTURL = process.env.RESTURL
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v4/` })
+// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v5/` })
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
 
 // Inspect utility used for debugging.

test/integration/chains/testnet/test-free-tier.sh

@@ -1,6 +1,6 @@
 #!/bin/bash
 
-export RESTURL=https://free-test.fullstack.cash/v4/
+export RESTURL=https://free-test.fullstack.cash/v5/
 export NETWORK=testnet
 export IS_USING_FREE_TIER=true
 

test/integration/chains/testnet/util.js

@@ -8,11 +8,11 @@ const assert = chai.assert
 
 const RESTURL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://testnet3.fullstack.cash/v4/'
+  : 'https://testnet3.fullstack.cash/v5/'
 // if (process.env.RESTURL) RESTURL = process.env.RESTURL
 
 const BCHJS = require('../../../../src/bch-js')
-// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v4/` })
+// const bchjs = new BCHJS({ restURL: `https://testnet.bchjs.cash/v5/` })
 const bchjs = new BCHJS({ restURL: RESTURL, apiToken: process.env.BCHJSTOKEN })
 
 // Inspect utility used for debugging.

test/unit/slp-utils.js

@@ -10,7 +10,7 @@ let uut
 
 const REST_URL = process.env.RESTURL
   ? process.env.RESTURL
-  : 'https://bchn.fullstack.cash/v4/'
+  : 'https://bchn.fullstack.cash/v5/'
 
 // Mock data used for unit tests
 const mockDataLib = require('./fixtures/slp/mock-utils')