fix(/electrumx/balance/:address): Implemented with unit and integration tests

test/v3/a01-electrumx.js

@@ -106,6 +106,64 @@ describe('#ElectrumX Router', () => {
     })
   })
 
+  describe('#_utxosFromElectrumx', () => {
+    it('should throw error for invalid address', async () => {
+      try {
+        // Address has invalid checksum.
+        const address = 'bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur2'
+
+        // Call the details API.
+        await electrumxRoute._utxosFromElectrumx(address)
+
+        assert.equal(true, false, 'Unexpected code path')
+      } catch (err) {
+        assert.include(err.message, 'Invalid checksum')
+      }
+    })
+
+    it('should return empty array for address with no utxos', async () => {
+      // Address has invalid checksum.
+      const address = 'bchtest:qqtmlpspjakqlvywae226esrcdrj9auynuwadh55uf'
+
+      // Mock unit tests to prevent live network calls.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox.stub(electrumxRoute.electrumx, 'request').resolves([])
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute._utxosFromElectrumx(address)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isArray(result)
+      assert.equal(result.length, 0)
+    })
+
+    it('should get balance for a single address', async () => {
+      const address = 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+
+      // Mock unit tests to prevent live network calls.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox
+          .stub(electrumxRoute.electrumx, 'request')
+          .resolves(mockData.utxos)
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute._utxosFromElectrumx(address)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.isArray(result)
+      assert.property(result[0], 'height')
+      assert.property(result[0], 'tx_hash')
+      assert.property(result[0], 'tx_pos')
+      assert.property(result[0], 'value')
+    })
+  })
+
   describe('#getUtxos', () => {
     it('should throw 400 if address is empty', async () => {
       const result = await electrumxRoute.getUtxos(req, res)
@@ -220,64 +278,6 @@ describe('#ElectrumX Router', () => {
     })
   })
 
-  describe('#_utxosFromElectrumx', () => {
-    it('should throw error for invalid address', async () => {
-      try {
-        // Address has invalid checksum.
-        const address = 'bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur2'
-
-        // Call the details API.
-        await electrumxRoute._utxosFromElectrumx(address)
-
-        assert.equal(true, false, 'Unexpected code path')
-      } catch (err) {
-        assert.include(err.message, 'Invalid checksum')
-      }
-    })
-
-    it('should return empty array for address with no utxos', async () => {
-      // Address has invalid checksum.
-      const address = 'bchtest:qqtmlpspjakqlvywae226esrcdrj9auynuwadh55uf'
-
-      // Mock unit tests to prevent live network calls.
-      if (process.env.TEST === 'unit') {
-        electrumxRoute.isReady = true // Force flag.
-
-        sandbox.stub(electrumxRoute.electrumx, 'request').resolves([])
-      }
-
-      // Call the details API.
-      const result = await electrumxRoute._utxosFromElectrumx(address)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.equal(result.length, 0)
-    })
-
-    it('should get balance for a single address', async () => {
-      const address = 'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
-
-      // Mock unit tests to prevent live network calls.
-      if (process.env.TEST === 'unit') {
-        electrumxRoute.isReady = true // Force flag.
-
-        sandbox
-          .stub(electrumxRoute.electrumx, 'request')
-          .resolves(mockData.utxos)
-      }
-
-      // Call the details API.
-      const result = await electrumxRoute._utxosFromElectrumx(address)
-      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
-
-      assert.isArray(result)
-      assert.property(result[0], 'height')
-      assert.property(result[0], 'tx_hash')
-      assert.property(result[0], 'tx_pos')
-      assert.property(result[0], 'value')
-    })
-  })
-
   describe('#_balanceFromElectrumx', () => {
     it('should throw error for invalid address', async () => {
       try {
@@ -344,6 +344,116 @@ describe('#ElectrumX Router', () => {
     })
   })
 
+  describe('#getBalance', () => {
+    it('should throw 400 if address is empty', async () => {
+      const result = await electrumxRoute.getBalance(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'Unsupported address format')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+    })
+
+    it('should throw 400 on array input', async () => {
+      req.params.address = ['qzs02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c']
+
+      const result = await electrumxRoute.getBalance(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'address can not be an array')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+    })
+
+    it('should throw an error for an invalid address', async () => {
+      req.params.address = '02v05l7qs5s24srqju498qu55dwuj0cx5ehjm2c'
+
+      const result = await electrumxRoute.getBalance(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'Unsupported address format')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+    })
+
+    it('should detect a network mismatch', async () => {
+      req.params.address = 'bchtest:qq89kjkeqz9mngp8kl3dpmu43y2wztdjqu500gn4c4'
+
+      const result = await electrumxRoute.getBalance(req, res)
+      // console.log(`result: ${util.inspect(result)}`)
+
+      assert.equal(res.statusCode, 400, 'Expect 400 status code')
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'Invalid network', 'Proper error message')
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+    })
+
+    it('should pass errors from ElectrumX to user', async () => {
+      // Address has invalid checksum.
+      req.params.address =
+        'bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur2'
+
+      // Mock unit tests to prevent live network calls.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox
+          .stub(electrumxRoute.electrumx, 'request')
+          .resolves(mockData.balance)
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute.getBalance(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'success')
+      assert.equal(result.success, false)
+
+      assert.property(result, 'error')
+      assert.include(result.error, 'Unsupported address format')
+    })
+
+    it('should get balance for a single address', async () => {
+      req.params.address =
+        'bitcoincash:qp3sn6vlwz28ntmf3wmyra7jqttfx7z6zgtkygjhc7'
+
+      // Mock unit tests to prevent live network calls.
+      if (process.env.TEST === 'unit') {
+        electrumxRoute.isReady = true // Force flag.
+
+        sandbox
+          .stub(electrumxRoute, '_balanceFromElectrumx')
+          .resolves(mockData.balance)
+      }
+
+      // Call the details API.
+      const result = await electrumxRoute.getBalance(req, res)
+      // console.log(`result: ${JSON.stringify(result, null, 2)}`)
+
+      assert.property(result, 'success')
+      assert.equal(result.success, true)
+
+      assert.property(result, 'balance')
+      assert.property(result.balance, 'confirmed')
+      assert.property(result.balance, 'unconfirmed')
+    })
+  })
+
   describe('#_transactionsFromElectrumx', () => {
     it('should throw error for invalid address', async () => {
       try {