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

Adding /price/usd REST endpoint

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",

src/adapters/bch/index.js

@@ -297,6 +297,7 @@ class BchAdapter {
     }
   }
 
+  // Get details on an array of TXIDs.
   async getTransaction (txids) {
     try {
       console.log(

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