Adding first batch of helpers.

Author: mirek

Diff for: .eslintrc

@@ -0,0 +1,37 @@
+extends: "eslint:recommended"
+env:
+  es6: true
+  node: true
+  browser: true
+parserOptions:
+  ecmaVersion: 2017
+  sourceType: module
+rules:
+  no-console: off
+  comma-dangle: [1, never]
+  max-len: off
+  no-mixed-spaces-and-tabs: error
+  no-tabs: error
+  no-use-before-define: [error, {functions: false, classes: true}]
+  no-undefined: off
+  object-curly-spacing: [0, never]
+  semi: [error, never]
+  space-before-function-paren: 0
+  quotes: [error, single]
+globals:
+  after: true
+  afterEach: true
+  artifacts: true
+  before: true
+  beforeEach: true
+  console: true
+  contract: true
+  describe: true
+  document: true
+  expect: true
+  fetch: true
+  it: true
+  navigator: true
+  process: true
+  URL: true
+  window: true

Diff for: .gitignore

@@ -0,0 +1,2 @@
+node_modules
+package-lock.json

Diff for: derive.js

@@ -0,0 +1,22 @@
+
+const secp256k1 = require('secp256k1')
+const toChecksumAddress = require('./to-checksum-address')
+const keccak256 = require('./keccak256')
+
+function derive(privateKey) {
+
+  if (!secp256k1.privateKeyVerify(privateKey)) {
+    throw new TypeError('Invalid private key.')
+  }
+
+  const publicKey = secp256k1.publicKeyCreate(privateKey, false).slice(1)
+
+  const address = toChecksumAddress(keccak256(publicKey).slice(-20))
+
+  return {
+    publicKey: '0x' + publicKey.toString('hex'),
+    address
+  }
+}
+
+module.exports = derive

Diff for: is-promise.js

@@ -0,0 +1,15 @@
+
+const { isFunction } = require('lodash')
+const { get } = require('lodash')
+
+/**
+ * Check if `value` is Promise/A+.
+ *
+ * @param {any} value
+ * @return {boolean}
+ */
+function isPromise(value) {
+  return isFunction(get(value, 'then'))
+}
+
+module.exports = isPromise

Diff for: keccak256.js

@@ -0,0 +1,8 @@
+
+const createKeccakHash = require('keccak')
+
+function keccak256(value) {
+  return createKeccakHash('keccak256').update(value).digest()
+}
+
+module.exports = keccak256

Diff for: make-ganeche-account.js

@@ -0,0 +1,11 @@
+
+const derive = require('./derive')
+
+const DEFAULT_BALANCE = '00000000000000000000000000000000ffffffffffffffffffffffffffffffff'
+
+function makeGenacheAccount(secretKey) {
+  const { publicKey, address } = derive(secretKey)
+  return { balance: DEFAULT_BALANCE, secretKey: '0x' + secretKey.toString('hex'), publicKey, address }
+}
+
+module.exports = makeGenacheAccount

Diff for: make-solc.js

@@ -0,0 +1,36 @@
+
+const sh = require('./sh-sync')
+
+const DEFAULT_SOLC = '/usr/local/bin/solc'
+
+/**
+ * Make solidity compiler for `root` base path with contracts.
+ *
+ * Usage:
+ *
+ *    const solc = makeCompiler(`${__dirname}/../contracts`)
+ *    const { abi, bin } = solc('Foo.sol')
+ *
+ * @param {string} root Contracts' root directory.
+ * @param {string} 1.solc = '/usr/local/bin/solc' Solidity compiler executable path.
+ * @return {function} Compiler function.
+ */
+function makeSolc(root, { solc = DEFAULT_SOLC } = {}) {
+
+  function compile(name) {
+    const { stdout, stderr } = sh(`${solc} --combined-json abi,bin ${root}/${name}`)
+    if (stderr) {
+      throw new Error('stderr', { stdout, stderr })
+    }
+    const parsed = JSON.parse(stdout)
+    const r = {}
+    for (const [key, { bin, abi }] of Object.entries(parsed.contracts)) {
+      r[key.split(':')[1]] = { abi: JSON.parse(abi), bin: '0x' + bin }
+    }
+    return r
+  }
+
+  return compile
+}
+
+module.exports = makeSolc

Diff for: package.json

@@ -2,7 +2,7 @@
   "private": true,
   "name": "bmono",
   "version": "0.0.1",
-  "description": "",
+  "description": "Blockchain monorepo/npm - all the little things to prototype blockchain based systems fast.",
   "main": "index.js",
   "scripts": {
     "test": "mocha"
@@ -16,5 +16,18 @@
   "bugs": {
     "url": "https://github.com/appliedblockchain/bmono/issues"
   },
-  "homepage": "https://github.com/appliedblockchain/bmono#readme"
+  "homepage": "https://github.com/appliedblockchain/bmono#readme",
+  "devDependencies": {
+    "chai": "^4.1.2",
+    "eslint": "^4.15.0",
+    "mocha": "^5.0.0"
+  },
+  "dependencies": {
+    "keccak": "^1.4.0",
+    "lodash": "^4.17.4",
+    "progress": "^2.0.0",
+    "secp256k1": "^3.4.0",
+    "sprintf": "^0.1.5",
+    "web3": "^0.20.4"
+  }
 }

Diff for: progress.js

@@ -0,0 +1,21 @@
+
+const sprintf = require('sprintf')
+const Progress = require('progress')
+
+/**
+ * Usage:
+ *
+ *   const progress = makeProgress('foo', 100)
+ *   progress.tick()
+ *
+ * @param {string} name
+ * @param {number} total
+ * @return {Progress}
+ */
+function makeProgress(name, total) {
+  return new Progress(sprintf('%20s [:bar] :percent :current/:total :rate/s :etas', name), {
+    total, width: 20, incomplete: ' ', renderThrottle: 1000 / 12, clear: true
+  })
+}
+
+module.exports = makeProgress

Diff for: puts.js

@@ -0,0 +1,8 @@
+
+const sprintf = require('sprintf')
+
+function puts(...args) {
+  console.log(sprintf(...args))
+}
+
+module.exports = puts

Diff for: sh-async.js

@@ -0,0 +1,22 @@
+
+const { exec } = require('child_process')
+
+/**
+ * Execute simple shell command (async wrapper).
+ *
+ * @param {string} cmd
+ * @return {{ stdout: string, stderr: string }}
+ */
+async function shAsync(cmd) {
+  return new Promise(function (resolve, reject) {
+    exec(cmd, (err, stdout, stderr) => {
+      if (err) {
+        reject(err)
+      } else {
+        resolve({ stdout, stderr })
+      }
+    })
+  })
+}
+
+module.exports = shAsync

Diff for: sh-sync.js

@@ -0,0 +1,20 @@
+
+const { execSync } = require('child_process')
+const { Writable } = require('stream')
+
+/**
+ * Execute simple shell command (sync).
+ *
+ * @param {string} cmd
+ * @return {object} { stdout: string, stderr: string }
+ */
+function shSync(cmd) {
+  let stderr = ''
+  const stdout = execSync(cmd, {
+    stderr: (new Writable()).on('data', _1 => stderr += _1),
+    encoding: 'utf8'
+  })
+  return { stdout, stderr }
+}
+
+module.exports = shSync

Diff for: to-checksum-address.js

@@ -0,0 +1,31 @@
+
+const createKeccakHash = require('keccak')
+const { isBuffer } = require('lodash')
+const { isString } = require('lodash')
+
+function toChecksumAddress(value) {
+
+  if (isBuffer(value)) {
+    if (value.length !== 20) {
+      throw new TypeError(`Expected buffer size 20, got ${value.length}.`)
+    }
+    return toChecksumAddress('0x' + value.toString('hex'))
+  }
+
+  if (!isString(value)) {
+    throw new TypeError(`Expected string, got ${typeof value}.`)
+  }
+
+  if (value.length !== 2 + 20 * 2) {
+    throw new TypeError(`Invalid input size ${value.length}, expected 2 + 20 * 2.`)
+  }
+
+  const hex = value.slice(2).toLowerCase()
+  const hash = createKeccakHash('keccak256').update(hex).digest('hex')
+  return '0x' + hex
+    .split('')
+    .map((c, i) => parseInt(hash[i], 16) >= 8 ? c.toUpperCase() : c)
+    .join('')
+}
+
+module.exports = toChecksumAddress

Diff for: web3-compile-deploy.js

@@ -0,0 +1,44 @@
+
+const assert = require('assert')
+const Web3 = require('web3')
+const { each, set } = require('lodash')
+
+const nullAddress = '0x0000000000000000000000000000000000000000'
+
+/**
+ * Usage:
+ *
+ *   const solc = require('bmono/make-solc')(`${__dirname}/../contracts`)
+ *   require('bmono/web3-compile-deploy')(solc)
+ *
+ *   const Web3 = require('web3')
+ *   const web3 = new Web3(...)
+ *   web3.compile('Foo.sol')
+ *   const foo = await web3.deploy('Foo', [], { from, gas })
+ *
+ * @param {solc} solc
+ */
+function web3CompileDeploy(solc) {
+
+  Web3.prototype.require = function (filename, { from } = {}) {
+    each(solc(filename), ({ abi, bin: data }, key) => {
+      set(this, ['ctr', key], new this.eth.Contract(abi, { from, data }))
+    })
+    return this.ctr
+  }
+
+  Web3.prototype.deploy = async function (name, args, { from, gas } = {}) {
+    const result = await this.ctr[name]
+      .deploy({ arguments: args })
+      .send({
+        from,
+        gas
+      })
+    assert(result.options.address !== nullAddress, 'Expected deployed contract to have an address.')
+    result.setProvider(this.currentProvider)
+    return result
+  }
+
+}
+
+module.exports = web3CompileDeploy