Merge pull request #19 from Permissionless-Software-Foundation/ct-unstable

Adding /price/usd REST endpoint

README.md

@@ -8,13 +8,17 @@ When started, this web server starts an [IPFS](https://ipfs.io) node and connect
 
 ## Requirements
 
-- node **^14.17.0**
-- npm **^7.13.0**
+- node **^14.18.2**
+- npm **^8.3.0**
+- Docker **^20.10.8**
+- Docker Compose **^1.27.4**
 
 ## Installation
 
 ### Development Environment
 
+**Note:** This software now uses an external go-ipfs IPFS node. The instructions below have not been updated to reflect this.
+
 A development environment will allow you modify the code on-the-fly and contribute to the code base of this repository. [PM2](https://www.npmjs.com/package/pm2) is recommended for running this code base as an IPFS Circuit Relay.
 
 - [Video: Installing ipfs-service-provider](https://youtu.be/Z0NsboIVN44)
@@ -31,17 +35,27 @@ npm install
 
 ### Production Environment
 
-The [docker](./production/docker) directory contains a Dockerfile for building a production deployment. However, there is currently [a bug](https://github.com/Permissionless-Software-Foundation/ipfs-service-provider/issues/38) preventing the Docker container from being used as a Circuit Relay.
+The [docker](./production/docker) directory contains a Dockerfile for building a production deployment.
 
 ```
 docker-compose build --no-cache
 docker-compose up -d
 ```
 
+- Bring the containers up once, then take them back down with `docker-compose down`.
+- Copy the [swarm.key](./swarm.key) file to `ipfs-service-provider/production/data/go-ipfs/data/swarm.key`.
+- Bring the containers back up with `docker-compose up -d`.
+
 ### Operation Notes
 
 - There is a memory leak in the version of js-ipfs. The app is currently configured to shut down every 8 hours to flush memory. It relies on a process manager like pm2, Docker, or systemd to restart the app after it shuts down, in order to ensure continuous operation.
 
+- The PSF network operates as a private network. It does not connect or interact with the wider PSF network, relying instead on gateways to bridge the two networks, when they need to share content. This improves the performance and experience for everyone in the PSF network. To join the network, you'll need to add the [swarm.key](./swarm.key) file to the IPFS data folder.
+
+- [Instructions on setting up IPFS private networks.](https://github.com/ipfs/go-ipfs/blob/master/docs/experimental-features.md#private-networks)
+- For external installations, the swarm.key file will typically go in `~/.ipfs/swarm.key`
+- For production Docker containers, the key would go in `ipfs-service-provider/production/data/go-ipfs/data/swarm.key`
+
 ## Structure
 
 The file layout of this repository differs from the koa-api-boilerplate. Instead, it follows the file layout of [Clean Architecture](troutsblog.com/blog/clean-architecture).

bin/server.js

@@ -70,6 +70,7 @@ class Server {
 
       // Enable CORS for testing
       // THIS IS A SECURITY RISK. COMMENT OUT FOR PRODUCTION
+      // Dev Note: This line must come BEFORE controllers.attachRESTControllers()
       app.use(cors({ origin: '*' }))
 
       // Attach REST API and JSON RPC controllers to the app.
@@ -91,15 +92,11 @@ class Server {
       const success = await this.adminLib.createSystemUser()
       if (success) console.log('System admin user created.')
 
-      // Attach the other IPFS controllers
-      await controllers.attachControllers(app)
-
-      // ipfs-coord has a memory leak. This app shuts down after 4 hours. It
-      // expects to be run by Docker or pm2, which can automatically restart
-      // the app.
-      setTimeout(function () {
-        process.exit(0)
-      }, 60000 * 60 * 2) // 2 hours
+      // Attach the other IPFS controllers.
+      // Skip if this is a test environment.
+      if (config.env !== 'test') {
+        await controllers.attachControllers(app)
+      }
 
       return app
     } catch (err) {

package-lock.json

@@ -14,7 +14,7 @@
         "bcryptjs": "2.4.3",
         "glob": "7.1.6",
         "ipfs": "0.60.0",
-        "ipfs-coord": "6.8.10",
+        "ipfs-coord": "6.8.12",
         "ipfs-http-client": "55.0.0",
         "jsonrpc-lite": "2.2.0",
         "jsonwebtoken": "8.5.1",
@@ -9768,10 +9768,9 @@
       }
     },
     "node_modules/ipfs-coord": {
-      "version": "6.8.10",
-      "resolved": "http://94.130.170.209:4873/ipfs-coord/-/ipfs-coord-6.8.10.tgz",
-      "integrity": "sha512-04nlX4AkfqLuuLzpMcHnpv++iOETLRkzFA2GfAmY90r99HynfHt3DypP6loVdAnD34iWgD+tLhKNQ7QQM7cgfQ==",
-      "license": "MIT",
+      "version": "6.8.12",
+      "resolved": "https://registry.npmjs.org/ipfs-coord/-/ipfs-coord-6.8.12.tgz",
+      "integrity": "sha512-EeehCH8Xl8ZyxlO7F8PBSTJL8HBgBMieQckop2keEL6pkEkzsJEV+sq1RN2lrLUGvr2B/IFWwyenkdgZ3gjgMg==",
       "dependencies": {
         "axios": "0.21.4",
         "bch-encrypt-lib": "2.0.0",
@@ -32948,9 +32947,9 @@
       }
     },
     "ipfs-coord": {
-      "version": "6.8.10",
-      "resolved": "http://94.130.170.209:4873/ipfs-coord/-/ipfs-coord-6.8.10.tgz",
-      "integrity": "sha512-04nlX4AkfqLuuLzpMcHnpv++iOETLRkzFA2GfAmY90r99HynfHt3DypP6loVdAnD34iWgD+tLhKNQ7QQM7cgfQ==",
+      "version": "6.8.12",
+      "resolved": "https://registry.npmjs.org/ipfs-coord/-/ipfs-coord-6.8.12.tgz",
+      "integrity": "sha512-EeehCH8Xl8ZyxlO7F8PBSTJL8HBgBMieQckop2keEL6pkEkzsJEV+sq1RN2lrLUGvr2B/IFWwyenkdgZ3gjgMg==",
       "requires": {
         "axios": "0.21.4",
         "bch-encrypt-lib": "2.0.0",

package.json

@@ -28,7 +28,7 @@
     "bcryptjs": "2.4.3",
     "glob": "7.1.6",
     "ipfs": "0.60.0",
-    "ipfs-coord": "6.8.10",
+    "ipfs-coord": "6.8.12",
     "ipfs-http-client": "55.0.0",
     "jsonrpc-lite": "2.2.0",
     "jsonwebtoken": "8.5.1",

production/docker/.env

@@ -0,0 +1 @@
+COMPOSE_PROJECT_NAME=bch-wallet-consumer

src/adapters/bch/index.js

@@ -250,8 +250,11 @@ class BchAdapter {
     }
   }
 
-  async getTransactions (address) {
+  // Get the transaction history for an address.
+  async getTransactions (address, sortOrder = 'DESCENDING', page = 0) {
     try {
+      console.log('Executing getTransaction() bch adapter')
+
       // Throw an error if this IPFS node has not yet made a connection to a
       // wallet service provider.
       const selectedProvider =
@@ -261,8 +264,10 @@ class BchAdapter {
       }
 
       const rpcData = {
-        endpoint: 'transactions',
-        addresses: [address]
+        endpoint: 'txHistory',
+        address: address,
+        sortOrder,
+        page
       }
 
       // Generate a UUID for the call.
@@ -271,7 +276,7 @@ class BchAdapter {
       // Generate a JSON RPC command.
       const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
       const cmdStr = JSON.stringify(cmd)
-      // console.log('cmdStr: ', cmdStr)
+      console.log('cmdStr: ', cmdStr)
 
       // Send the RPC command to selected wallet service.
       const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
@@ -292,8 +297,13 @@ class BchAdapter {
     }
   }
 
-  async getTransaction (txid) {
+  // Get details on an array of TXIDs.
+  async getTransaction (txids) {
     try {
+      console.log(
+        `Getting txData on these txids: ${JSON.stringify(txids, null, 2)}`
+      )
+
       // Throw an error if this IPFS node has not yet made a connection to a
       // wallet service provider.
       const selectedProvider =
@@ -303,8 +313,8 @@ class BchAdapter {
       }
 
       const rpcData = {
-        endpoint: 'transaction',
-        txid
+        endpoint: 'txData',
+        txids
       }
 
       // Generate a UUID for the call.
@@ -313,7 +323,7 @@ class BchAdapter {
       // Generate a JSON RPC command.
       const cmd = this.jsonrpc.request(rpcId, 'bch', rpcData)
       const cmdStr = JSON.stringify(cmd)
-      // console.log('cmdStr: ', cmdStr)
+      console.log('cmdStr: ', cmdStr)
 
       // Send the RPC command to selected wallet service.
       const thisNode = this.ipfs.ipfsCoordAdapter.ipfsCoord.thisNode
@@ -325,11 +335,12 @@ class BchAdapter {
 
       // Wait for data to come back from the wallet service.
       const data = await this.waitForRPCResponse(rpcId)
+      console.log(`data: ${JSON.stringify(data, null, 2)}`)
 
       return data
     } catch (err) {
       // console.log('createUser() error: ', err)
-      wlogger.error('Error in adapters/bch.js/transaction()')
+      wlogger.error('Error in adapters/bch.js/getTransaction()')
       throw err
     }
   }

src/adapters/fullstack-jwt.js

@@ -52,12 +52,6 @@ class FullStackJWT {
   // Get's a JWT token from FullStack.cash.
   async getJWT () {
     try {
-      // Skip connecting FullStack.cash auth server to the network if this is an E2E test.
-      if (process.env.TEST_TYPE === 'e2e') {
-        this.apiToken = 'faketoken'
-        return this.apiToken
-      }
-
       // Log into the auth server.
       await this.jwtLib.register()
 

src/controllers/rest-api/bch/controller.js

@@ -271,10 +271,17 @@ class BchRESTControllerLib {
 
   /**
    *
-   * @api {post} /bch/transactions Transactions
-   * @apiName Transactions
+   * @api {post} /bch/txHistory TX History
+   * @apiName TX History
    * @apiGroup REST BCH
    * @apiDescription This endpoint wraps the bchjs.Electrumx.transactions([]) function.
+   * It returns the transaction history for an address. This list of TXIDs is
+   * sorted and paginated.
+   *
+   * There are three possible inputs:
+   * - address: (required) the address to query for a transaction history
+   * - sortOrder: (optional) will sort results in 'DECENDING' (default) or 'ASCENDING' order.
+   * - page: (optional) will return a 'page' of 100 results. Default is 0
    *
    *  Given the 'addresses' property returns an array of objects
    *  with the following properties
@@ -289,7 +296,7 @@ class BchRESTControllerLib {
    *  Note: For a single address pass the 'addresses' of string type
    *
    * @apiExample Example usage:
-   * curl -H "Content-Type: application/json" -X POST -d '{ "addresses": ["bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj"] }' localhost:5001/bch/transactions
+   * curl -H "Content-Type: application/json" -X POST -d '{ "address": "bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj" }' localhost:5001/bch/txHistory
    *
    * @apiSuccessExample {json} Success-Response:
    *     HTTP/1.1 200 OK
@@ -317,11 +324,20 @@ class BchRESTControllerLib {
    *       "error": "Unprocessable Entity"
    *     }
    */
-  async transactions (ctx) {
+  async txHistory (ctx) {
     try {
-      const addr = ctx.request.body.address
+      // console.log('transactions REST API handler called.')
+      // console.log(`body: ${JSON.stringify(ctx.request.body, null, 2)}`)
 
-      const data = await this.adapters.bch.getTransactions(addr)
+      const addr = ctx.request.body.address
+      const sortOrder = ctx.request.body.sortOrder
+      const page = ctx.request.body.page
+
+      const data = await this.adapters.bch.getTransactions(
+        addr,
+        sortOrder,
+        page
+      )
       // console.log(`data: ${JSON.stringify(data, null, 2)}`)
 
       ctx.body = data
@@ -331,11 +347,14 @@ class BchRESTControllerLib {
   }
 
   /**
-   * @api {post} /bch/transaction Transaction
-   * @apiName Transaction
+   * @api {post} /bch/txData TX Data
+   * @apiName txData
    * @apiGroup REST BCH
-   * @apiDescription Get data about a specific transaction.
-   * Given a transaction id this endpoint will return an object
+   * @apiDescription Get expanded transaction data for an array of transaction
+   * IDs. Each call is limited to 20 TXIDs or less.
+   *
+   * Get data about specific transactions.
+   * Given an array of transaction IDs this endpoint will return an array of objects
    * with the following properties
    *
    * - txid: "" - Transaction ID
@@ -353,11 +372,11 @@ class BchRESTControllerLib {
    * - isValidSLPTx: - Determines if the transaction was under SLP
    *
    * @apiExample Example usage:
-   * curl -H "Content-Type: application/json" -X POST -d '{ "txid": "01517ff1587fa5ffe6f5eb91c99cf3f2d22330cd7ee847e928ce90ca95bf781b" }' localhost:5001/bch/transaction
+   * curl -H "Content-Type: application/json" -X POST -d '{ "txids": ["01517ff1587fa5ffe6f5eb91c99cf3f2d22330cd7ee847e928ce90ca95bf781b"] }' localhost:5001/bch/transaction
    *
    * @apiSuccessExample {json} Success-Response:
    *     HTTP/1.1 200 OK
-   * {
+   * [{
    *    "txid":"01517ff1587fa5ffe6f5eb91c99cf3f2d22330cd7ee847e928ce90ca95bf781b",
    *    "hash":"01517ff1587fa5ffe6f5eb91c99cf3f2d22330cd7ee847e928ce90ca95bf781b",
    *    "version":1,
@@ -406,7 +425,7 @@ class BchRESTControllerLib {
    *    "time":1568338904,
    *    "blocktime":1568338904,
    *    "isValidSLPTx":false
-   * }
+   * }]
    *
    * @apiError UnprocessableEntity Missing required parameters
    *
@@ -417,11 +436,19 @@ class BchRESTControllerLib {
    *       "error": "Unprocessable Entity"
    *     }
    */
-  async transaction (ctx) {
+  async txData (ctx) {
     try {
-      const txid = ctx.request.body.txid
+      console.log(
+        `txData called with this body data: ${JSON.stringify(
+          ctx.request.body,
+          null,
+          2
+        )}`
+      )
 
-      const data = await this.adapters.bch.getTransaction(txid)
+      const txids = ctx.request.body.txids
+
+      const data = await this.adapters.bch.getTransaction(txids)
       // console.log(`utxos: ${JSON.stringify(utxos, null, 2)}`)
 
       ctx.body = data

src/controllers/rest-api/bch/index.js

@@ -56,8 +56,8 @@ class BchRouter {
     this.router.post('/balance', this.postBalance)
     this.router.post('/utxos', this.postUtxos)
     this.router.post('/broadcast', this.postBroadcast)
-    this.router.post('/transactions', this.postTransactions)
-    this.router.post('/transaction', this.postTransaction)
+    this.router.post('/txHistory', this.postTxHistory)
+    this.router.post('/txData', this.postTxData)
     this.router.post('/pubkey', this.postPubKey)
 
     // Attach the Controller routes to the Koa app.
@@ -85,12 +85,12 @@ class BchRouter {
     await _this.bchRESTController.broadcast(ctx, next)
   }
 
-  async postTransactions (ctx, next) {
-    await _this.bchRESTController.transactions(ctx, next)
+  async postTxHistory (ctx, next) {
+    await _this.bchRESTController.txHistory(ctx, next)
   }
 
-  async postTransaction (ctx, next) {
-    await _this.bchRESTController.transaction(ctx, next)
+  async postTxData (ctx, next) {
+    await _this.bchRESTController.txData(ctx, next)
   }
 
   async postPubKey (ctx, next) {

src/controllers/rest-api/index.js

@@ -14,6 +14,7 @@ const LogsRESTController = require('./logs')
 const BchRESTController = require('./bch')
 const IpfsRESTController = require('./ipfs')
 const P2wdbRESTController = require('./p2wdb')
+const PriceRESTController = require('./price')
 
 class RESTControllers {
   constructor (localConfig = {}) {
@@ -67,6 +68,10 @@ class RESTControllers {
     // Attach the REST API Controllers associated with the /p2wdb route
     const p2wdbRESTController = new P2wdbRESTController(dependencies)
     p2wdbRESTController.attach(app)
+
+    // Attach the REST API Controllers associated with the /price route
+    const priceRESTController = new PriceRESTController(dependencies)
+    priceRESTController.attach(app)
   }
 }
 

src/controllers/rest-api/price/controller.js

@@ -0,0 +1,83 @@
+/*
+  REST API Controller library for the /bch route
+*/
+
+const axios = require('axios')
+const { wlogger } = require('../../../adapters/wlogger')
+
+// let _this
+
+class PriceRESTControllerLib {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating /price REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating /price REST Controller.'
+      )
+    }
+
+    // Encapsulate dependencies
+    this.axios = axios
+    // this.UserModel = this.adapters.localdb.Users
+    // this.userUseCases = this.useCases.user
+
+    // _this = this
+  }
+
+  /**
+   * @api {get} /price/usd Get the USD price of BCH
+   * @apiName Get the USD price of BCH
+   * @apiGroup Price
+   * @apiDescription Get the USD price of BCH from Coinbase.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "http://localhost:5005/price/usd" -H "accept: application/json"
+   *
+   */
+  async getUSD (ctx) {
+    try {
+      // Request options
+      const opt = {
+        method: 'get',
+        baseURL: 'https://api.coinbase.com/v2/',
+        url: '/exchange-rates?currency=BCH',
+        timeout: 15000
+      }
+
+      const response = await this.axios.request(opt)
+      // console.log(`response.data: ${JSON.stringify(response.data, null, 2)}`)
+
+      ctx.body = { usd: Number(response.data.data.rates.USD) }
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in GET /price/usd.', err)
+
+      this.handleError(ctx, err)
+    }
+  }
+
+  // DRY error handler
+  handleError (ctx, err) {
+    // If an HTTP status is specified by the buisiness logic, use that.
+    if (err.status) {
+      if (err.message) {
+        ctx.throw(err.status, err.message)
+      } else {
+        ctx.throw(err.status)
+      }
+    } else {
+      // By default use a 422 error if the HTTP status is not specified.
+      ctx.throw(422, err.message)
+    }
+  }
+}
+
+module.exports = PriceRESTControllerLib

src/controllers/rest-api/price/index.js

@@ -0,0 +1,66 @@
+/*
+  REST API library for /bch route.
+*/
+
+// Public npm libraries.
+const Router = require('koa-router')
+
+// Local libraries.
+const PriceRESTControllerLib = require('./controller')
+const Validators = require('../middleware/validators')
+
+let _this
+
+class PriceRouter {
+  constructor (localConfig = {}) {
+    // Dependency Injection.
+    this.adapters = localConfig.adapters
+    if (!this.adapters) {
+      throw new Error(
+        'Instance of Adapters library required when instantiating Price REST Controller.'
+      )
+    }
+    this.useCases = localConfig.useCases
+    if (!this.useCases) {
+      throw new Error(
+        'Instance of Use Cases library required when instantiating Price REST Controller.'
+      )
+    }
+
+    const dependencies = {
+      adapters: this.adapters,
+      useCases: this.useCases
+    }
+
+    // Encapsulate dependencies.
+    this.priceRESTController = new PriceRESTControllerLib(dependencies)
+    this.validators = new Validators()
+
+    // Instantiate the router and set the base route.
+    const baseUrl = '/price'
+    this.router = new Router({ prefix: baseUrl })
+
+    _this = this
+  }
+
+  attach (app) {
+    if (!app) {
+      throw new Error(
+        'Must pass app object when attaching REST API controllers.'
+      )
+    }
+
+    // Define the routes and attach the controller.
+    this.router.get('/usd', this.getPrice)
+
+    // Attach the Controller routes to the Koa app.
+    app.use(this.router.routes())
+    app.use(this.router.allowedMethods())
+  }
+
+  async getPrice (ctx, next) {
+    await _this.priceRESTController.getUSD(ctx, next)
+  }
+}
+
+module.exports = PriceRouter

swarm.key

@@ -0,0 +1,3 @@
+/key/swarm/psk/1.0.0/
+/base16/
+bbd935b70105b03ebd0c6a3c2d2730cd22fc0d18c490ccf689b6c8a22e1bed2a

test/e2e/manual/bch-e2e.js

@@ -7,7 +7,7 @@
   This test will query each REST API endpoint and ensure they are working correctly.
 */
 
-const SERVER = 'http://localhost:5001'
+const SERVER = 'http://localhost:5005'
 
 const axios = require('axios')
 const assert = require('chai').assert
@@ -23,8 +23,8 @@ describe('#BCH E2E Tests', () => {
       const result = await axios.get(url)
       // console.log(`data: ${JSON.stringify(result.data, null, 2)}`)
 
-      assert.isAbove(result.data.status.state.serviceProviders.length, 0)
-      assert.isOk(result.data.status.state.selectedServiceProvider)
+      assert.isAbove(result.data.status.serviceProviders.length, 0)
+      assert.isOk(result.data.status.selectedProvider)
     })
   })
 
@@ -56,9 +56,9 @@ describe('#BCH E2E Tests', () => {
       const result = await axios.post(url, body)
       // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
 
-      assert.equal(result.data.address, body.address)
-      assert.property(result.data, 'bchUtxos')
-      assert.property(result.data, 'slpUtxos')
+      assert.equal(result.data[0].address, body.address)
+      assert.property(result.data[0], 'bchUtxos')
+      assert.property(result.data[0], 'slpUtxos')
     })
   })
 
@@ -74,42 +74,11 @@ describe('#BCH E2E Tests', () => {
 
       assert.equal(result.data.status, 422)
       assert.equal(result.data.success, false)
-      assert.equal(result.data.message, 'TX decode failed')
+      assert.equal(result.data.message, 'Missing inputs')
       assert.equal(result.data.endpoint, 'broadcast')
     })
   })
 
-  describe('#transactions', () => {
-    it('should get transaction history for an address', async () => {
-      const body = {
-        address: 'bitcoincash:qrl2nlsaayk6ekxn80pq0ks32dya8xfclyktem2mqj'
-      }
-
-      const url = `${SERVER}/bch/transactions`
-      const result = await axios.post(url, body)
-      // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
-
-      assert.equal(result.data.status, 200)
-      assert.equal(result.data.success, true)
-      assert.property(result.data, 'transactions')
-    })
-  })
-
-  describe('#transaction', () => {
-    it('should get transaction details for a txid', async () => {
-      const body = {
-        txid: '01517ff1587fa5ffe6f5eb91c99cf3f2d22330cd7ee847e928ce90ca95bf781b'
-      }
-
-      const url = `${SERVER}/bch/transaction`
-      const result = await axios.post(url, body)
-      // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
-
-      assert.property(result.data, 'txid')
-      assert.property(result.data, 'vin')
-    })
-  })
-
   describe('#pubkey', () => {
     it('should return "not found" if pubkey is not on chain', async () => {
       const body = {
@@ -146,4 +115,94 @@ describe('#BCH E2E Tests', () => {
       )
     })
   })
+
+  describe('#txHistory', () => {
+    it('should get transaction history for an address, and sort by default in descending order.', async () => {
+      const address = 'bitcoincash:qpdh9s677ya8tnx7zdhfrn8qfyvy22wj4qa7nwqa5v'
+      const body = {
+        address
+      }
+
+      const url = `${SERVER}/bch/txHistory`
+      const result = await axios.post(url, body)
+      // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
+
+      // Assert expected values and properties.
+      assert.equal(result.data.status, 200)
+      assert.equal(result.data.success, true)
+      assert.equal(result.data.address, address)
+      assert.isArray(result.data.txs)
+
+      // Assert expected sorting
+      assert.isAbove(result.data.txs[0].height, result.data.txs[1].height)
+    })
+
+    it('should sort in ascending order.', async () => {
+      const address = 'bitcoincash:qpdh9s677ya8tnx7zdhfrn8qfyvy22wj4qa7nwqa5v'
+
+      const body = {
+        address,
+        sortOrder: 'ASCENDING'
+      }
+
+      const url = `${SERVER}/bch/txHistory`
+      const result = await axios.post(url, body)
+      // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
+
+      // Assert expected values and properties.
+      assert.equal(result.data.status, 200)
+      assert.equal(result.data.success, true)
+      assert.equal(result.data.address, address)
+      assert.isArray(result.data.txs)
+
+      // Assert expected sorting
+      assert.isAbove(result.data.txs[1].height, result.data.txs[0].height)
+    })
+
+    it('should paginate an address with deep tx history', async () => {
+      const body = {
+        address: 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d'
+      }
+
+      const url = `${SERVER}/bch/txHistory`
+      const result = await axios.post(url, body)
+      // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
+
+      // Assert there is no more than 100 entries
+      assert.isBelow(result.data.txs.length, 101)
+    })
+
+    it('should get the second page of results', async () => {
+      const body = {
+        address: 'bitcoincash:qqlrzp23w08434twmvr4fxw672whkjy0py26r63g3d',
+        page: 1
+      }
+
+      const url = `${SERVER}/bch/txHistory`
+      const result = await axios.post(url, body)
+      // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
+
+      // Assert there is no more than 100 entries
+      assert.isBelow(result.data.txs.length, 101)
+    })
+  })
+
+  describe('#txData', () => {
+    it('should get transaction details for a txid', async () => {
+      const body = {
+        txids: [
+          '01517ff1587fa5ffe6f5eb91c99cf3f2d22330cd7ee847e928ce90ca95bf781b'
+        ]
+      }
+
+      const url = `${SERVER}/bch/txData`
+      const result = await axios.post(url, body)
+      // console.log(`result.data: ${JSON.stringify(result.data, null, 2)}`)
+
+      assert.equal(result.data.status, 200)
+      assert.isArray(result.data.txData)
+      assert.property(result.data.txData[0], 'txid')
+      assert.property(result.data.txData[0], 'vin')
+    })
+  })
 })

test/unit/controllers/rest-api/bch/bch.rest.controller.unit.js

@@ -213,7 +213,7 @@ describe('#BCH-REST-Controller', () => {
     })
   })
 
-  describe('#transactions', () => {
+  describe('#txHistory', () => {
     it('should return 422 status on arbitrary error', async () => {
       try {
         // Force an error
@@ -225,7 +225,7 @@ describe('#BCH-REST-Controller', () => {
           address: 'blah'
         }
 
-        await uut.transactions(ctx)
+        await uut.txHistory(ctx)
 
         assert.fail('Unexpected result')
       } catch (err) {
@@ -242,14 +242,14 @@ describe('#BCH-REST-Controller', () => {
         address: 'blah'
       }
 
-      await uut.transactions(ctx)
+      await uut.txHistory(ctx)
 
       // Assert the expected HTTP response
       assert.equal(ctx.status, 200)
     })
   })
 
-  describe('#transaction', () => {
+  describe('#txData', () => {
     it('should return 422 status on arbitrary error', async () => {
       try {
         // Force an error
@@ -261,7 +261,7 @@ describe('#BCH-REST-Controller', () => {
           txid: 'blah'
         }
 
-        await uut.transaction(ctx)
+        await uut.txData(ctx)
 
         assert.fail('Unexpected result')
       } catch (err) {
@@ -280,7 +280,7 @@ describe('#BCH-REST-Controller', () => {
         txid: 'blah'
       }
 
-      await uut.transaction(ctx)
+      await uut.txData(ctx)
 
       // Assert the expected HTTP response
       assert.equal(ctx.status, 200)