Updating README

fix(Transactions.get()): Adding extra error handling for rate limits

README.md

@@ -35,15 +35,15 @@ const BCHJS = require("@psf/bch-js")
 let bchjs = new BCHJS() // Defaults to BCHN network.
 
 // testnet
-bchjs = new BCHJS({ restURL: 'https://testnet3.fullstack.cash/v4/' })
+bchjs = new BCHJS({ restURL: 'https://testnet3.fullstack.cash/v5/' })
 ```
 
 This library is intended to be paired with
 the [bch-api](https://github.com/Permissionless-Software-Foundation/bch-api) REST API, and the infrastructure provided by [FullStack.cash](https://fullstack.cash). The `restURL` property can be changed to work with different Bitcoin Cash networks:
 
-- BCHN Mainnet REST API server: https://bchn.fullstack.cash/v4/
-- ABC Mainnet REST API server: https://abc.fullstack.cash/v4/
-- Testnet3 REST API server: https://testnet3.fullstack.cash/v4/
+- BCHN Mainnet REST API server: https://bchn.fullstack.cash/v5/
+- ABC Mainnet REST API server: https://abc.fullstack.cash/v5/
+- Testnet3 REST API server: https://testnet3.fullstack.cash/v5/
 - Check server status: https://metrics.fullstack.cash
 
 ### API Key
@@ -57,7 +57,7 @@ rate limits when interacting with the back end server. See [this article](https:
 ```
 const BCHJS = require("@psf/bch-js")
 let bchjs = new BCHJS({
-  restURL: 'https://bchn.fullstack.cash/v3/',
+  restURL: 'https://bchn.fullstack.cash/v5/',
   apiToken: 'eyJhbGciO...' // Your JWT token here.
 })
 ```

src/dsproof.js

@@ -2,7 +2,7 @@ const axios = require('axios')
 
 let _this
 
-class Mining {
+class DSProof {
   constructor (config) {
     this.restURL = config.restURL
     this.apiToken = config.apiToken
@@ -28,6 +28,36 @@ class Mining {
     _this = this
   }
 
+  /**
+   * @api DSProof.getDSProof() getDSProof()
+   * @apiName getDSProof
+   * @apiGroup DSProof
+   * @apiDescription Checks if a transaction generated a double-spend proof.
+   *
+   * If a double-spend is attempted, one of the transactions will generate a
+   * 'double spend proof'. This call can be used to check if a transaction
+   * generated such a proof.
+   *
+   * Merchants should wait 3-5 seconds after receiving notification of a
+   * transaction before calling this endpoint, to see if the TXID generated a
+   * proof. If this method returns no data, then the TX can be considered 'safe'
+   * and not a double spend. If proof data is returned by this method, then
+   * the transaction generated a proof and can be considered a 'double spend'.
+   *
+   * @apiExample Example usage:
+   * (async () => {
+   *   try {
+   *     const txid = 'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
+   *     const result = await bchjs.DSProof.getDSProof(txid)
+   *     console.log(result);
+   *   } catch(error) {
+   *    console.error(error)
+   *   }
+   * })()
+   *
+   * // returns
+   * null
+   */
   async getDSProof (txid) {
     try {
       if (!txid) {
@@ -48,4 +78,4 @@ class Mining {
   }
 }
 
-module.exports = Mining
+module.exports = DSProof

src/raw-transactions.js

@@ -1,6 +1,6 @@
 const axios = require('axios')
 
-let _this
+// let _this
 
 class RawTransactions {
   constructor (config) {
@@ -27,7 +27,7 @@ class RawTransactions {
     // Encapsulate dependencies
     this.axios = axios
 
-    _this = this
+    // this = this
   }
 
   /**
@@ -98,7 +98,7 @@ class RawTransactions {
       if (typeof hex === 'string') {
         const response = await axios.get(
           `${this.restURL}rawtransactions/decodeRawTransaction/${hex}`,
-          _this.axiosOptions
+          this.axiosOptions
         )
 
         return response.data
@@ -111,7 +111,7 @@ class RawTransactions {
           data: {
             hexes: hex
           },
-          headers: _this.axiosOptions.headers
+          headers: this.axiosOptions.headers
         }
         const response = await axios(options)
 
@@ -166,7 +166,7 @@ class RawTransactions {
       if (typeof script === 'string') {
         const response = await axios.get(
           `${this.restURL}rawtransactions/decodeScript/${script}`,
-          _this.axiosOptions
+          this.axiosOptions
         )
 
         return response.data
@@ -177,7 +177,7 @@ class RawTransactions {
           data: {
             hexes: script
           },
-          headers: _this.axiosOptions.headers
+          headers: this.axiosOptions.headers
         }
         const response = await axios(options)
 
@@ -261,7 +261,7 @@ class RawTransactions {
       if (typeof txid === 'string') {
         const response = await axios.get(
           `${this.restURL}rawtransactions/getRawTransaction/${txid}?verbose=${verbose}`,
-          _this.axiosOptions
+          this.axiosOptions
         )
 
         return response.data
@@ -274,7 +274,7 @@ class RawTransactions {
             verbose: verbose,
             usrObj // pass user data when making an internal call.
           },
-          headers: _this.axiosOptions.headers
+          headers: this.axiosOptions.headers
         }
         const response = await axios(options)
 
@@ -365,7 +365,9 @@ class RawTransactions {
   async getTxData (txid) {
     try {
       if (typeof txid !== 'string') {
-        throw new Error('Input must be a string or array of strings.')
+        throw new Error(
+          'Input to raw-transaction.js/getTxData() must be a string containg a TXID.'
+        )
       }
 
       // Get the TX details for the transaction under consideration.
@@ -427,7 +429,7 @@ class RawTransactions {
       if (typeof hex === 'string') {
         const response = await this.axios.get(
           `${this.restURL}rawtransactions/sendRawTransaction/${hex}`,
-          _this.axiosOptions
+          this.axiosOptions
         )
 
         if (response.data === '66: insufficient priority') {
@@ -448,9 +450,9 @@ class RawTransactions {
           data: {
             hexes: hex
           },
-          headers: _this.axiosOptions.headers
+          headers: this.axiosOptions.headers
         }
-        const response = await _this.axios(options)
+        const response = await this.axios(options)
 
         return response.data
       }

src/slp/utils.js

@@ -680,6 +680,14 @@ class Utils {
 
       return validatedTxids
     } catch (error) {
+      // console.log('validateTxid3 error: ', error)
+
+      // This case handles rate limit errors.
+      if (error.response && error.response.data && error.response.data.error) {
+        throw new Error(error.response.data.error)
+      }
+
+      // Not sure if this can be safely deprecated?
       if (error.response && error.response.data) throw error.response.data
       throw error
     }

src/transaction.js

@@ -37,7 +37,9 @@ class Transaction {
   async get (txid) {
     try {
       if (typeof txid !== 'string') {
-        throw new Error('Input must be a string or array of strings.')
+        throw new Error(
+          'Input to Transaction.get() must be a string containing a TXID.'
+        )
       }
 
       const txDetails = await this.rawTransaction.getTxData(txid)
@@ -129,6 +131,11 @@ class Transaction {
       } catch (err) {
         // console.log('Error: ', err)
 
+        // This case handles rate limit errors.
+        if (err.response && err.response.data && err.response.data.error) {
+          throw new Error(err.response.data.error)
+        }
+
         // If decoding the op_return fails, then it's not an SLP transaction,
         // and the non-hyrated TX details can be returned.
         return txDetails
@@ -136,7 +143,12 @@ class Transaction {
 
       return txDetails
     } catch (err) {
-      console.error('Error in transactions.js/get()')
+      // console.error('Error in transactions.js/get(): ', err)
+
+      // This case handles rate limit errors.
+      if (err.response && err.response.data && err.response.data.error) {
+        throw new Error(err.response.data.error)
+      }
 
       if (err.error) throw new Error(err.error)
       throw err

test/integration/chains/bchn/dsproof.js

@@ -2,6 +2,8 @@
   Integration tests for bchjs dsproof library.
 */
 
+const assert = require('chai').assert
+
 const BCHJS = require('../../../../src/bch-js')
 const bchjs = new BCHJS()
 
@@ -15,7 +17,9 @@ describe('#DSProof', () => {
       const txid =
         'ee0df780b58f6f24467605b2589c44c3a50fc849fb8f91b89669a4ae0d86bc7e'
       const result = await bchjs.DSProof.getDSProof(txid)
-      console.log(`result: ${JSON.stringify(result, null, 2)}`)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result, null)
     })
   })
 })

test/unit/raw-tranactions.js

@@ -171,10 +171,15 @@ describe('#RawTransactions', () => {
   describe('#getTxData', () => {
     it('should return tx data with input addresses', async () => {
       // Mock dependencies
-      sandbox.stub(bchjs.RawTransactions, 'getRawTransaction').resolves(mockData.mockTx)
-      sandbox.stub(bchjs.RawTransactions, '_getInputAddrs').resolves(mockData.mockGetInputAddrsOutput)
+      sandbox
+        .stub(bchjs.RawTransactions, 'getRawTransaction')
+        .resolves(mockData.mockTx)
+      sandbox
+        .stub(bchjs.RawTransactions, '_getInputAddrs')
+        .resolves(mockData.mockGetInputAddrsOutput)
 
-      const txid = '05f7d4a4e25f53d63a360434eb54f221abf159112b7fffc91da1072a079cded3'
+      const txid =
+        '05f7d4a4e25f53d63a360434eb54f221abf159112b7fffc91da1072a079cded3'
 
       const result = await bchjs.RawTransactions.getTxData(txid)
       // console.log(`result: ${JSON.stringify(result, null, 2)}`)
@@ -190,7 +195,10 @@ describe('#RawTransactions', () => {
       } catch (err) {
         // console.log(err)
 
-        assert2.include(err.message, 'Input must be a string or array of strings')
+        assert2.include(
+          err.message,
+          'Input to raw-transaction.js/getTxData() must be a string containg a TXID.'
+        )
       }
     })
 
@@ -201,7 +209,8 @@ describe('#RawTransactions', () => {
           .stub(bchjs.RawTransactions, 'getRawTransaction')
           .rejects(new Error('test error'))
 
-        const txid = '05f7d4a4e25f53d63a360434eb54f221abf159112b7fffc91da1072a079cded3'
+        const txid =
+          '05f7d4a4e25f53d63a360434eb54f221abf159112b7fffc91da1072a079cded3'
 
         await bchjs.RawTransactions.getTxData(txid)
 

test/unit/transaction-unit.js

@@ -25,7 +25,7 @@ describe('#TransactionLib', () => {
       } catch (err) {
         assert.include(
           err.message,
-          'Input must be a string or array of strings.'
+          'Input to Transaction.get() must be a string containing a TXID.'
         )
       }
     })