feat(utxoBulk): Created JSON RPC endpoint for bulk UTXO lookup

test/unit/controllers/json-rpc/bch.json-rpc.controller.unit.js

@@ -118,6 +118,25 @@ describe('#BCHRPC', () => {
       assert.equal(result, true)
     })
 
+    it('should route to the utxosBulk method', async () => {
+      // Mock dependencies
+      sandbox.stub(uut, 'utxosBulk').resolves(true)
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const txCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk'
+      })
+      const jsonStr = JSON.stringify(txCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+      rpcData.from = 'Origin request'
+
+      const result = await uut.bchRouter(rpcData)
+
+      assert.equal(result, true)
+    })
+
     it('should route to the broadcast method', async () => {
       // Mock dependencies
       sandbox.stub(uut, 'broadcast').resolves(true)
@@ -301,7 +320,7 @@ describe('#BCHRPC', () => {
       const id = uid()
       const rpcCall = jsonrpc.request(id, 'bch', {
         endpoint: 'utxos',
-        addresses: 'testAddr'
+        address: 'testAddr'
       })
       const jsonStr = JSON.stringify(rpcCall, null, 2)
       const rpcData = jsonrpc.parse(jsonStr)
@@ -322,7 +341,7 @@ describe('#BCHRPC', () => {
       const id = uid()
       const rpcCall = jsonrpc.request(id, 'bch', {
         endpoint: 'utxos',
-        addresses: 'testAddr'
+        address: 'testAddr'
       })
       const jsonStr = JSON.stringify(rpcCall, null, 2)
       const rpcData = jsonrpc.parse(jsonStr)
@@ -337,6 +356,98 @@ describe('#BCHRPC', () => {
     })
   })
 
+  describe('#utxosBulk', () => {
+    it('should return UTXO data from bchjs for multiple addresses', async () => {
+      // Mock dependencies
+      sandbox.stub(uut.bchjs.Utxo, 'get').resolves({ success: true })
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk',
+        addresses: ['testAddr1', 'testAddr2']
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.utxosBulk(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, true)
+      assert.equal(response.status, 200)
+    })
+
+    it('should return an error for invalid address', async () => {
+      // Force an error
+      sandbox.stub(uut.bchjs.Utxo, 'get').rejects(new Error('Invalid address'))
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk',
+        addresses: ['testAddr1', 'testAddr2']
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.utxosBulk(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, false)
+      assert.equal(response.status, 422)
+      assert.equal(response.message, 'Invalid address')
+      assert.equal(response.endpoint, 'utxosBulk')
+    })
+
+    it('should throw error if input is not an array', async () => {
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk',
+        addresses: 'singleAddress'
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.utxosBulk(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, false)
+      assert.equal(response.status, 422)
+      assert.equal(response.message, 'addresses parameter must be an array')
+      assert.equal(response.endpoint, 'utxosBulk')
+    })
+
+    it('should throw error if input array is larger than 20 elements', async () => {
+      // Generate an array larger than 20 elements
+      const inputArray = []
+      for(let i=0; i < 25; i++) {
+        inputArray.push(i)
+      }
+
+      // Generate the parsed data that the main router would pass to this
+      // endpoint.
+      const id = uid()
+      const rpcCall = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxosBulk',
+        addresses: inputArray
+      })
+      const jsonStr = JSON.stringify(rpcCall, null, 2)
+      const rpcData = jsonrpc.parse(jsonStr)
+
+      const response = await uut.utxosBulk(rpcData)
+      // console.log('response: ', response)
+
+      assert.equal(response.success, false)
+      assert.equal(response.status, 422)
+      assert.equal(response.message, 'addresses parameter must not exceed 20 elements')
+      assert.equal(response.endpoint, 'utxosBulk')
+    })
+  })
+
   describe('#broadcast', () => {
     it('should return data from bchjs', async () => {
       // Mock dependencies