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

feat(bcash-slp): Created new library for bcash SLP

docker/mainnet/Dockerfile

@@ -1,19 +1,48 @@
-FROM christroutner/ct-base-ubuntu
+FROM ubuntu:20.04
 MAINTAINER Chris Troutner <chris.troutner@gmail.com>
 
-RUN apt-get update -y
+#Update the OS and install any OS packages needed.
+RUN apt-get update
+RUN apt-get install -y sudo git curl nano gnupg wget
+
+#Install Node and NPM
+RUN curl -sL https://deb.nodesource.com/setup_14.x -o nodesource_setup.sh
+RUN bash nodesource_setup.sh
+RUN apt-get install -y nodejs build-essential
+
+#Create the user 'safeuser' and add them to the sudo group.
+RUN useradd -ms /bin/bash safeuser
+RUN adduser safeuser sudo
+
+#Set password to 'abcd8765' change value below if you want a different password
+RUN echo safeuser:abcd8765 | chpasswd
+
+#Set the working directory to be the users home directory
+WORKDIR /home/safeuser
+
+#Setup NPM for non-root global install (like on a mac)
+RUN mkdir /home/safeuser/.npm-global
+RUN chown -R safeuser .npm-global
+RUN echo "export PATH=~/.npm-global/bin:$PATH" >> /home/safeuser/.profile
+RUN runuser -l safeuser -c "npm config set prefix '~/.npm-global'"
+
+# Update to the latest version of npm.
+# Working with npm@7.21.1
+RUN npm install -g npm
+
+#FROM christroutner/ct-base-ubuntu
+#MAINTAINER Chris Troutner <chris.troutner@gmail.com>
+
+#RUN apt-get update -y
 
 #Set the working directory to be the home directory
-WORKDIR /home/safeuser
+#WORKDIR /home/safeuser
 
 # Switch to user account.
 USER safeuser
 # Prep 'sudo' commands.
 #RUN echo 'abcd8765' | sudo -S pwd
 
-# Install Redis. TODO: Make this a separate container.
-
-
 # Clone the repository
 WORKDIR /home/safeuser
 RUN git clone https://github.com/Permissionless-Software-Foundation/bch-api

src/routes/v5/bcash/slp.js

@@ -0,0 +1,140 @@
+/*
+  Electrum API route
+*/
+
+'use strict'
+
+const express = require('express')
+const router = express.Router()
+const axios = require('axios')
+const util = require('util')
+// const bitcore = require('bitcore-lib-cash')
+
+// const ElectrumCash = require('electrum-cash').ElectrumClient
+// const ElectrumCash = require('/home/trout/work/personal/electrum-cash/electrum.js').Client // eslint-disable-line
+
+const wlogger = require('../../../util/winston-logging')
+const config = require('../../../../config')
+
+const RouteUtils = require('../../../util/route-utils')
+const routeUtils = new RouteUtils()
+
+// const BCHJS = require("@psf/bch-js");
+// const bchjs = new BCHJS();
+
+let _this
+
+class BcashSlp {
+  constructor () {
+    this.config = config
+    this.axios = axios
+    this.routeUtils = routeUtils
+    // this.bchjs = bchjs;
+    // _this.bitcore = bitcore
+
+    this.bcashServer = process.env.BCASH_SERVER
+    if (!this.bcashServer) {
+      // console.warn('FULCRUM_API env var not set. Can not connect to Fulcrum indexer.')
+      throw new Error(
+        'BCASH_SERVER env var not set. Can not connect to bcash full node.'
+      )
+    }
+
+    this.router = router
+    this.router.get('/', this.root)
+    this.router.get('/utxos/:address', this.getUtxos)
+  }
+
+  /**
+   * @api {get} /bcash/utxos/{addr} Get utxos for a single address.
+   * @apiName UTXOs for a single address
+   * @apiGroup bcash
+   * @apiDescription Returns an object with UTXOs associated with an address.
+   * This UTXOs will be hydrated with token information.
+   *
+   *
+   * @apiExample Example usage:
+   * curl -X GET "https://api.fullstack.cash/v5/bcash/utxos/bitcoincash:qr69kyzha07dcecrsvjwsj4s6slnlq4r8c30lxnur3" -H "accept: application/json"
+   *
+   */
+  // GET handler for single balance
+  async getUtxos (req, res, next) {
+    try {
+      const address = req.params.address
+
+      // Reject if address is an array.
+      if (Array.isArray(address)) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error: 'address can not be an array. Use POST for bulk upload.'
+        })
+      }
+
+      const cashAddr = _this.bchjs.Address.toCashAddress(address)
+
+      // Prevent a common user error. Ensure they are using the correct network address.
+      const networkIsValid = _this.routeUtils.validateNetwork(cashAddr)
+      if (!networkIsValid) {
+        res.status(400)
+        return res.json({
+          success: false,
+          error:
+            'Invalid network. Trying to use a testnet address on mainnet, or vice versa.'
+        })
+      }
+
+      // TODO: Customize this function below here for bcash, based on this gist:
+      // https://gist.github.com/christroutner/dcb25a895900e557d7b43341ee85fa79
+
+      wlogger.debug(
+        'Executing electrumx/getUtxos with this address: ',
+        cashAddr
+      )
+
+      // Get data from ElectrumX server.
+      const response = await _this.axios.get(
+        `${_this.fulcrumApi}electrumx/utxos/${address}`
+      )
+      // console.log('response', response, _this.fulcrumApi)
+
+      res.status(200)
+      return res.json(response.data)
+    } catch (err) {
+      // Write out error to error log.
+      wlogger.error('Error in elecrumx.js/getUtxos().', err)
+
+      return _this.errorHandler(err, res)
+    }
+  }
+
+  // DRY error handler.
+  errorHandler (err, res) {
+    // Attempt to decode the error message.
+    const { msg, status } = _this.routeUtils.decodeError(err)
+    // console.log('errorHandler msg: ', msg)
+    // console.log('errorHandler status: ', status)
+
+    if (msg) {
+      res.status(status)
+      return res.json({ success: false, error: msg })
+    }
+
+    // Handle error patterns specific to this route.
+    if (err.message) {
+      res.status(400)
+      return res.json({ success: false, error: err.message })
+    }
+
+    // If error can be handled, return the stack trace
+    res.status(500)
+    return res.json({ error: util.inspect(err) })
+  }
+
+  // Root API endpoint. Simply acknowledges that it exists.
+  root (req, res, next) {
+    return res.json({ status: 'bcash-slp' })
+  }
+}
+
+module.exports = BcashSlp

test/v5/bcash-slp.js

@@ -0,0 +1,95 @@
+/*
+  TESTS FOR THE bcash/slp.js LIBRARY
+*/
+
+'use strict'
+
+const chai = require('chai')
+const assert = chai.assert
+
+const sinon = require('sinon')
+
+const BcashSlp = require('../../src/routes/v5/bcash/slp')
+
+// Mocking data.
+const { mockReq, mockRes } = require('./mocks/express-mocks')
+// const mockData = require('./mocks/electrumx-mock')
+
+// Used for debugging.
+const util = require('util')
+util.inspect.defaultOptions = { depth: 1 }
+
+if (!process.env.BCASH_SERVER) process.env.BCASH_SERVER = 'http://localhost'
+
+describe('#bcash-slp', () => {
+  let req, res
+  let sandbox
+  const bcashSlp = new BcashSlp()
+  // let electrumxRoute
+
+  before(async () => {
+    if (!process.env.TEST) {
+      process.env.TEST = 'unit'
+    }
+    console.log(`Testing type is: ${process.env.TEST}`)
+
+    if (!process.env.NETWORK) process.env.NETWORK = 'testnet'
+
+    // Connect to electrumx servers if this is an integration test.
+    // if (process.env.TEST === 'integration') {
+    //   await electrumxRoute.connect()
+    //   console.log('Connected to ElectrumX server')
+    // }
+  })
+
+  after(async () => {
+    // console.log(`electrumxRoute.electrumx: `, electrumxRoute.electrumx)
+    // Disconnect from the electrumx server if this is an integration test.
+    // if (process.env.TEST === 'integration') {
+    //   await electrumxRoute.disconnect()
+    //   console.log('Disconnected from ElectrumX server')
+    // }
+  })
+
+  // Setup the mocks before each test.
+  beforeEach(() => {
+    // Mock the req and res objects used by Express routes.
+    req = mockReq
+    res = mockRes
+
+    // Explicitly reset the parmas and body.
+    req.params = {}
+    req.body = {}
+    req.query = {}
+
+    sandbox = sinon.createSandbox()
+
+    // electrumxRoute = new ElecrumxRoute()
+  })
+
+  afterEach(() => {
+    sandbox.restore()
+  })
+
+  after(() => {
+    //
+  })
+
+  describe('#root', () => {
+    // root route handler.
+    const root = bcashSlp.root
+
+    it('should respond to GET for base route', async () => {
+      const result = root(req, res)
+
+      assert.equal(result.status, 'bcash-slp', 'Returns static string')
+    })
+  })
+
+  describe('#getUtxos', () => {
+    it('should return UTXOs for an address, hydrated with SLP info', async () => {
+      // TODO: Add unit tests.
+      assert.isOk(true)
+    })
+  })
+})