feat(transactions): Refactored JSON RPC transactions endpoint

package.json

@@ -24,7 +24,7 @@
   },
   "repository": "Permissionless-Software-Foundation/ipfs-bch-wallet-service",
   "dependencies": {
-    "@psf/bch-js": "5.2.2",
+    "@psf/bch-js": "../bch-js",
     "axios": "0.25.0",
     "bcryptjs": "2.4.3",
     "glob": "7.1.6",

src/controllers/json-rpc/bch/index.js

@@ -50,7 +50,7 @@ class BCHRPC {
       switch (endpoint) {
         case 'transactions':
           await this.rateLimit.limiter(rpcData.from)
-          return await this.transactions(rpcData)
+          return await this.transactions3(rpcData)
 
         case 'balance':
           await this.rateLimit.limiter(rpcData.from)
@@ -162,6 +162,30 @@ class BCHRPC {
     }
   }
 
+  async transactions3 (rpcData) {
+    try {
+      // console.log('createUser rpcData: ', rpcData)
+
+      const addr = rpcData.payload.params.address
+      const sortOrder = rpcData.payload.params.sortOrder
+
+      const data = await this.useCases.bch.getTransactions(addr, sortOrder)
+
+      return data
+    } catch (err) {
+      console.error('Error in JSON RPC BCH transactions3()')
+      // throw err
+
+      // Return an error response
+      return {
+        success: false,
+        status: 422,
+        message: err.message,
+        endpoint: 'transactions'
+      }
+    }
+  }
+
   // A replacement for transactions(). This version will automatically sort
   // the transactions.
   async transactions2 (rpcData) {

src/use-cases/bch/index.js

@@ -18,9 +18,54 @@ class BCHUseCases {
 
   // Get transaction history for an address, sorted by block height.
   async getTransactions (rpcData) {
-    const addrs = rpcData.payload.params.addresses
+    try {
+      // console.log('createUser rpcData: ', rpcData)
 
-    return addrs
+      // Get the list of addresses.
+      const addr = rpcData.payload.params.address
+
+      // Default to descending sorting.
+      let sortOrder = rpcData.payload.params.sortOrder
+      if (!sortOrder) sortOrder = 'DESCENDING'
+      // console.log('sortOrder: ', sortOrder)
+
+      // Get the transaction history for the list of addresses.
+      const data = await this.bchjs.Electrumx.transactions([addr])
+      // console.log(`data: ${JSON.stringify(data, null, 2)}`)
+
+      if (!data.success) {
+        throw new Error('Could not query Fulcrum indexer.')
+      }
+      // console.log(`transactions: ${JSON.stringify(transactions, null, 2)}`);
+
+      // Sort the transactions.
+      const txsArr = await this.bchjs.Electrumx.sortAllTxs(
+        data.transactions[0].transactions,
+        sortOrder
+      )
+      // console.log(`txsArr: ${JSON.stringify(txsArr, null, 2)}`)
+
+      const retObj = {
+        address: data.transactions[0].address,
+        txs: txsArr,
+        status: 200,
+        success: true
+      }
+      // console.log(`retObj: ${JSON.stringify(retObj, null, 2)}`)
+
+      return retObj
+    } catch (err) {
+      console.error('Error in JSON RPC BCH transactions()')
+      // throw err
+
+      // Return an error response
+      return {
+        success: false,
+        status: 422,
+        message: err.message,
+        endpoint: 'transactions'
+      }
+    }
   }
 }
 

test/e2e/manual/consumer/lib/test-utils.js

@@ -214,7 +214,7 @@ class TestUtils {
       const id = uid()
       const cmd = jsonrpc.request(id, 'bch', {
         endpoint: 'transactions',
-        addresses: ['bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj']
+        address: 'bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj'
       })
       const cmdStr = JSON.stringify(cmd)
 

test/integration/use-cases/bch/index-bch.use-cases.integration.js

@@ -2,6 +2,9 @@
   Integration tests for the BCH Use Cases library
 */
 
+// Global npm libraries
+const assert = require('chai').assert
+
 // Local libraries
 const BCHUseCases = require('../../../../src/use-cases/bch')
 const Adapters = require('../../../../src/adapters')
@@ -17,17 +20,66 @@ describe('#BCH', () => {
   })
 
   describe('#getTransactions', () => {
-    it('should get transactions for an address', async () => {
+    it('should get transactions for an address, with default descending sorting', async () => {
       const rpcData = {
         payload: {
           params: {
-            addresses: ['bitcoincash:thing']
+            address: 'bitcoincash:qpdh9s677ya8tnx7zdhfrn8qfyvy22wj4qa7nwqa5v'
           }
         }
       }
 
       const result = await uut.getTransactions(rpcData)
-      console.log('result: ', result)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.success, true)
+      assert.equal(result.status, 200)
+      assert.isArray(result.txs)
+
+      // Assert descending sort order.
+      assert.isAbove(result.txs[0].height, result.txs[1].height)
+    })
+
+    it('should get transactions for an address, with explicit descending sorting', async () => {
+      const rpcData = {
+        payload: {
+          params: {
+            address: 'bitcoincash:qpdh9s677ya8tnx7zdhfrn8qfyvy22wj4qa7nwqa5v',
+            sortOrder: 'DESCENDING'
+          }
+        }
+      }
+
+      const result = await uut.getTransactions(rpcData)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.success, true)
+      assert.equal(result.status, 200)
+      assert.isArray(result.txs)
+
+      // Assert descending sort order.
+      assert.isAbove(result.txs[0].height, result.txs[1].height)
+    })
+
+    it('should sort in ascending order', async () => {
+      const rpcData = {
+        payload: {
+          params: {
+            address: 'bitcoincash:qpdh9s677ya8tnx7zdhfrn8qfyvy22wj4qa7nwqa5v',
+            sortOrder: 'ASCENDING'
+          }
+        }
+      }
+
+      const result = await uut.getTransactions(rpcData)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.equal(result.success, true)
+      assert.equal(result.status, 200)
+      assert.isArray(result.txs)
+
+      // Assert descending sort order.
+      assert.isAbove(result.txs[1].height, result.txs[0].height)
     })
   })
 })