feat(tests): Added manual e2e tests

fix(broadcast): Fixing bug in broadcast JSON RPC

.gitignore

@@ -64,6 +64,8 @@ database/
 system-user-*.json
 orbitdb
 ipfsdata
+.ipfsdata
 ipfs-service-provider.sh
+start-bch-wallet-service.sh
 
 !README.md

config/about.js

@@ -1,15 +0,0 @@
-/*
-  This file should be customized for your app. The string in this file is
-  displayed when a user makes the 'about' JSON RPC call.
-*/
-
-module.exports = `
-This is the about string for the ipfs-service-provider repository:
-https://github.com/Permissionless-Software-Foundation/ipfs-service-provider
-
-Brought to you by the Permissionless Software Foundation:
-https://PSFoundation.cash
-
-Documentation: 
-https://ipfs-service-provider.fullstack.cash/
-`

config/env/common.js

@@ -5,6 +5,10 @@
 
 /* eslint  no-unneeded-ternary:0 */
 
+// Get the version from the package.json file.
+const pkgInfo = require('../../package.json')
+const version = pkgInfo.version
+
 const ipfsCoordName = process.env.COORD_NAME
   ? process.env.COORD_NAME
   : 'ipfs-bch-wallet-service'
@@ -52,6 +56,8 @@ module.exports = {
     '@context': 'https://schema.org/',
     '@type': 'WebAPI',
     name: ipfsCoordName,
+    version,
+    protocol: 'bch-wallet',
     description:
       'IPFS service providing BCH blockchain access needed by a wallet.',
     documentation: 'https://ipfs-bch-wallet-service.fullstack.cash/',

package.json

@@ -1,6 +1,6 @@
 {
   "name": "ipfs-bch-wallet-service",
-  "version": "1.0.0",
+  "version": "1.9.1",
   "description": "IPFS and REST service providing blockchain access needed by a wallet. ",
   "main": "index.js",
   "scripts": {
@@ -28,7 +28,7 @@
     "bcryptjs": "^2.4.3",
     "glob": "^7.1.6",
     "ipfs": "^0.54.4",
-    "ipfs-coord": "^4.0.1",
+    "ipfs-coord": "^5.0.0",
     "jsonrpc-lite": "^2.2.0",
     "jsonwebtoken": "^8.5.1",
     "jwt-bch-lib": "^1.3.0",

src/adapters/ipfs/ipfs-coord.js

@@ -58,7 +58,11 @@ class IpfsCoordAdapter {
     if (!process.env.E2ETEST) {
       // Wait for the ipfs-coord library to signal that it is ready.
       await this.ipfsCoord.ipfs.start()
-      await this.ipfsCoord.isReady()
+
+      // some ipfs-coord versions do not have this function
+      if (this.ipfsCoord.isReady) {
+        await this.ipfsCoord.isReady()
+      }
     }
 
     // Signal that this adapter is ready.

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

@@ -6,7 +6,7 @@
 const jsonrpc = require('jsonrpc-lite')
 
 // Local libraries
-const aboutStr = require('../../../../config/about')
+const config = require('../../../../config')
 
 class AboutRPC {
   constructor (localConfig) {
@@ -36,7 +36,8 @@ class AboutRPC {
     return {
       success: true,
       status: 200,
-      message: aboutStr,
+      // message: aboutStr,
+      message: JSON.stringify(config.announceJsonLd),
       endpoint: 'about'
     }
   }

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

@@ -146,7 +146,7 @@ class BCHRPC {
 
       return retObj
     } catch (err) {
-      // console.error('Error in createUser()')
+      console.error('Error in JSON RPC BCH transactions()')
       // throw err
 
       // Return an error response
@@ -223,7 +223,7 @@ class BCHRPC {
 
       return retObj
     } catch (err) {
-      // console.error('Error in createUser()')
+      console.error('Error in JSON RPC BCH balance()')
       // throw err
 
       // Return an error response
@@ -336,7 +336,8 @@ class BCHRPC {
 
       return retObj
     } catch (err) {
-      // console.error('Error in createUser()')
+      console.error('Error in JSON RPC BCH utxos()')
+      console.error('Error in JSON RPC utxos(): ', err)
       // throw err
 
       // Return an error response
@@ -388,12 +389,17 @@ class BCHRPC {
       const data = await this.bchjs.RawTransactions.sendRawTransaction(hex)
       // console.log(`data: ${JSON.stringify(data, null, 2)}`)
 
-      const retObj = data
-      retObj.status = 200
+      const retObj = {
+        success: true,
+        status: 200,
+        endpoint: 'broadcast',
+        txid: data
+      }
+      // retObj.status = 200
 
       return retObj
     } catch (err) {
-      // console.error('Error in createUser()')
+      console.error('Error in JSON RPC BCH broadcast()')
       // throw err
 
       // Return an error response
@@ -514,7 +520,7 @@ class BCHRPC {
 
       return retObj
     } catch (err) {
-      // console.error('Error in createUser()')
+      console.error('Error in JSON RPC BCH transaction()')
       // throw err
 
       // Return an error response

test/e2e/manual/consumer/consumer.e2e.js

@@ -20,6 +20,10 @@ async function startTest () {
 
     await testUtils.testTransaction(testData.uutId)
 
+    await testUtils.testTransactions(testData.uutId)
+
+    await testUtils.testUtxos(testData.uutId)
+
     console.log('E2E TEST: Tests completed successfully!')
     process.exit()
   } catch (err) {

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

@@ -99,7 +99,10 @@ class TestUtils {
         announceJsonLd: announceJsonLd
       })
       await this.ipfsCoord.ipfs.start()
-      await this.ipfsCoord.isReady()
+      // some ipfs-coord versions do not have this function
+      if (this.ipfsCoord.isReady) {
+        await this.ipfsCoord.isReady()
+      }
 
       // Wait to let ipfs-coord connect to subnet peers.
       await this.bchjs.Util.sleep(30000)
@@ -195,6 +198,69 @@ class TestUtils {
     }
   }
 
+  // Get the info a on transaction over JSON RPC.
+  async testTransactions (ipfsId) {
+    try {
+      // Generate the JSON RPC command
+      const id = uid()
+      const cmd = jsonrpc.request(id, 'bch', {
+        endpoint: 'transactions',
+        addresses: ['bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj']
+      })
+      const cmdStr = JSON.stringify(cmd)
+
+      // console.log(`Publishing message to ${ipfsId}`)
+
+      console.log('E2E TEST: Sending Transactions command...')
+      const result = await this.sendRPC(ipfsId, cmdStr)
+      // console.log('result: ', result)
+
+      if (result.result.value.status && Array.isArray(result.result.value.transactions)) {
+        console.log('E2E TEST: transactions test passed.')
+        return true
+      } else {
+        console.log('E2E TEST: transactions test failed.')
+        this.failTest()
+      }
+    } catch (err) {
+      console.error('Error in testTransactions()')
+      throw err
+    }
+  }
+
+  // Get the utxos for a BCH address over JSON RPC.
+  async testUtxos (ipfsId) {
+    try {
+      // Generate the JSON RPC command
+      const id = uid()
+      const cmd = jsonrpc.request(id, 'bch', {
+        endpoint: 'utxos',
+        address: 'bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj'
+      })
+      const cmdStr = JSON.stringify(cmd)
+
+      // console.log(`Publishing message to ${ipfsId}`)
+
+      console.log('E2E TEST: Sending Utxos command...')
+      const result = await this.sendRPC(ipfsId, cmdStr)
+      // console.log('result', result.result.value)
+
+      const bchUtxos = result.result.value[0].bchUtxos
+      const slpUtxos = result.result.value[0].slpUtxos
+
+      if (result.result.value && bchUtxos && slpUtxos) {
+        console.log('E2E TEST: utxos test passed.')
+        return true
+      } else {
+        console.log('E2E TEST: utxos test failed.')
+        this.failTest()
+      }
+    } catch (err) {
+      console.error('Error in testUtxos()')
+      throw err
+    }
+  }
+
   failTest () {
     console.log('Exiting test program.')
     process.exit()

test/e2e/manual/consumer/test-data.json

@@ -1,4 +1,4 @@
 {
-  "uutAddr": "/ip4/127.0.0.1/tcp/5668/p2p/QmZSyLnRQWMBknVNjUroLQnrcmDnUVAUU4pMQ2LGhh6b9v",
-  "uutId": "QmZSyLnRQWMBknVNjUroLQnrcmDnUVAUU4pMQ2LGhh6b9v"
+  "uutAddr": "/ip4/192.168.43.115/tcp/5668/p2p/QmVBWvFxao7smhRjUUh1q8rNAEwMqbg4X3dqsQDMSjUpmx",
+  "uutId": "QmfUjMqUeXSCzNkFGrzvf79yvV62dtjsnwtBSYKx3wegXw"
 }