Merge pull request #281 from willmeister/feat/278/MergeUtilsIntoCore

Consolidating utils into core package and updating references

packages/core/index.ts

@@ -1 +1,2 @@
 export * from './src/interfaces'
+export * from './src/app'

packages/core/package.json

@@ -32,7 +32,9 @@
     "body-parser": "^1.19.0",
     "debug": "^4.1.1",
     "eth-lib": "^0.2.8",
+    "ethers": "^4.0.30",
     "express": "^4.17.1",
+    "ganache-cli": "^6.4.4",
     "uuid": "^3.3.2",
     "web3": "^1.0.0-beta.55",
     "web3-utils": "^1.0.0-beta.55"

packages/core/src/app/common/index.ts

@@ -1,4 +1,5 @@
 export * from './app'
+export * from './eth'
 export * from './db'
 export * from './net'
 export * from './utils'

packages/utils/src/constants.ts → packages/core/src/app/common/utils/constants.ts

@@ -1,5 +1,5 @@
 /* Internal Imports */
-import { getNullString } from './utils'
+import { getNullString } from './misc'
 
 export const NULL_ADDRESS = getNullString(32)
 export const NULL_HASH = getNullString(64)

packages/core/src/app/common/utils/index.ts

@@ -1,5 +1,8 @@
 export * from './codec'
+export * from './constants'
 export * from './debug-logger'
 export * from './misc'
 export * from './range-store'
+export * from './state-object'
+export * from './sum-tree'
 export * from './type-guards'

packages/core/src/app/common/utils/misc.ts

@@ -94,6 +94,104 @@ export const bnToUint256 = (bn: BigNum): Buffer => {
  * @returns the transacted range's end as a Uint256 Buffer.
  */
 export const getTransactionRangeEnd = (transaction: Transaction): Buffer => {
-  const end = transaction.stateUpdate.id.end
+  const end = transaction.range.end
   return bnToUint256(end)
 }
+
+/**
+ * Sleeps for a number of milliseconds.
+ * @param ms Number of ms to sleep.
+ * @returns a promise that resolves after the number of ms.
+ */
+export const sleep = (ms: number): Promise<void> => {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms)
+  })
+}
+
+/**
+ * Removes "0x" from start of a string if it exists.
+ * @param str String to modify.
+ * @returns the string without "0x".
+ */
+export const remove0x = (str: string): string => {
+  return str.startsWith('0x') ? str.slice(2) : str
+}
+
+/**
+ * Adds "0x" to the start of a string if necessary.
+ * @param str String to modify.
+ * @returns the string with "0x".
+ */
+export const add0x = (str: string): string => {
+  return str.startsWith('0x') ? str : '0x' + str
+}
+
+/**
+ * Checks if something is an Object
+ * @param obj Thing that might be an Object.
+ * @returns `true` if the thing is a Object, `false` otherwise.
+ */
+export const isObject = (obj: any): boolean => {
+  return typeof obj === 'object' && obj !== null
+}
+
+/**
+ * Creates a hex string with a certain number of zeroes.
+ * @param n Number of zeroes.
+ * @returns the hex string.
+ */
+export const getNullString = (n: number): string => {
+  return '0x' + '0'.repeat(n)
+}
+
+/**
+ * Reverses a string in place.
+ * @param str String to reverse.
+ * @returns the reversed string.
+ */
+export const reverse = (str: string): string => {
+  return Array.from(str)
+    .reverse()
+    .join('')
+}
+
+/**
+ * Converts a buffer to a hex string.
+ * @param buf the buffer to be converted.
+ * @returns the buffer as a string.
+ */
+export const bufToHexString = (buf: Buffer): string => {
+  return '0x' + buf.toString('hex')
+}
+
+/**
+ * Converts a big number to a hex string.
+ * @param bn the big number to be converted.
+ * @returns the big number as a string.
+ */
+export const bnToHexString = (bn: BigNum): string => {
+  return '0x' + bn.toString('hex')
+}
+
+/**
+ * Converts either a big number or buffer to hex string
+ * @param value the big number or buffer to be converted
+ * @returns the value as a string.
+ */
+export const hexStringify = (value: BigNum | Buffer): string => {
+  if (value instanceof BigNum) {
+    return bnToHexString(value)
+  } else {
+    return bufToHexString(value)
+  }
+}
+
+/**
+ * Converts a hex string to a buffer
+ * @param hexString the hex string to be converted
+ * @returns the hexString as a buffer.
+ */
+export const hexStrToBuf = (hexString: string): Buffer => {
+  return Buffer.from(hexString.slice(2), 'hex')
+}

packages/core/src/app/common/utils/range-store.ts

@@ -3,15 +3,7 @@ import BigNum = require('bn.js')
 
 /* Internal Imports */
 import { bnMax, bnMin } from './misc'
-
-export interface Range {
-  start: BigNum
-  end: BigNum
-}
-
-export interface BlockRange extends Range {
-  block: BigNum
-}
+import { Range, BlockRange } from '../../../interfaces/common/utils'
 
 /**
  * RangeStore makes it easy to store ranges.

packages/utils/src/data-types/state-object.ts → packages/core/src/app/common/utils/state-object.ts

@@ -1,6 +1,6 @@
 /* Internal Imports */
 import { abi } from '../eth'
-import { StateObject, AbiEncodable } from '../interfaces/data-types'
+import { StateObject, AbiEncodable } from '../../../interfaces'
 
 /**
  * Creates a StateObject from an encoded StateObject.
@@ -18,15 +18,15 @@ const fromEncoded = (encoded: string): AbiStateObject => {
 export class AbiStateObject implements StateObject, AbiEncodable {
   public static abiTypes = ['address', 'bytes']
 
-  constructor(readonly predicateAddress: string, readonly data: string) {}
+  constructor(readonly predicate: string, readonly parameters: string) {}
 
   /**
    * @returns the abi encoded StateObject.
    */
   get encoded(): string {
     return abi.encode(AbiStateObject.abiTypes, [
-      this.predicateAddress,
-      this.data,
+      this.predicate,
+      this.parameters,
     ])
   }
 

packages/utils/src/sum-tree.ts → packages/core/src/app/common/utils/sum-tree.ts

@@ -2,8 +2,8 @@
 import BigNum = require('bn.js')
 
 /* Internal Imports */
-import { keccak256 } from './eth'
-import { reverse } from './utils'
+import { keccak256 } from '../eth'
+import { reverse } from './misc'
 import { NULL_HASH } from './constants'
 
 export interface ImplicitBounds {

packages/core/src/interfaces/common/utils/crypto.interface.ts

@@ -0,0 +1,5 @@
+export interface EcdsaSignature {
+  v: string
+  r: string
+  s: string
+}

packages/core/src/interfaces/common/utils/index.ts

@@ -1,3 +1,4 @@
+export * from './crypto.interface'
 export * from './logger.interface'
 export * from './state.interface'
 export * from './type.interface'

packages/core/src/interfaces/common/utils/state.interface.ts

@@ -14,8 +14,17 @@ export interface StateUpdate {
   newState: StateObject
 }
 
+export interface Range {
+  start: BigNum
+  end: BigNum
+}
+
+export interface BlockRange extends Range {
+  block: BigNum
+}
+
 export interface Transaction {
-  stateUpdate: StateUpdate
+  range: Range
   witness: any
   block: number
 }

packages/core/src/interfaces/common/utils/type.interface.ts

@@ -1 +1,5 @@
 export type Type<T> = new (...args: any[]) => T
+
+export interface AbiEncodable {
+  encoded: string
+}

packages/utils/test/eth/utils.spec.ts → packages/core/test/app/common/eth/utils.spec.ts

@@ -1,7 +1,7 @@
-import '../setup'
+import '../../../setup'
 
 /* Internal Imports */
-import { keccak256 } from '../../src/eth/utils'
+import { keccak256 } from '../../../../src/app/common/eth/utils'
 
 describe('Ethereum Utils', () => {
   describe('keccak256', () => {

packages/utils/test/utils.spec.ts → packages/core/test/app/common/utils/misc.spec.ts

@@ -1,7 +1,13 @@
-import './setup'
+import '../../../setup'
 
 /* Internal Imports */
-import { sleep, remove0x, add0x, getNullString, isObject } from '../src/utils'
+import {
+  sleep,
+  remove0x,
+  add0x,
+  getNullString,
+  isObject,
+} from '../../../../src/app/common/utils'
 
 describe('Miscellanous Utils', () => {
   describe('sleep', () => {

packages/utils/test/sum-tree.spec.ts → packages/core/test/app/common/utils/sum-tree.spec.ts

@@ -1,10 +1,10 @@
-import { should } from './setup'
+import { should } from '../../../setup'
 
 /* External Imports */
 import BigNum = require('bn.js')
 
 /* Internal Imports */
-import { MerkleSumTree, MerkleTreeNode } from '../src/sum-tree'
+import { MerkleSumTree, MerkleTreeNode } from '../../../../src/app/common/utils'
 
 describe('MerkleSumTree', () => {
   describe('construction', () => {

packages/core/test/setup.ts

@@ -1,7 +1,3 @@
 import chai = require('chai')
-import chaiAsPromised = require('chai-as-promised')
 
-const should = chai.should()
-chai.use(chaiAsPromised)
-
-export { should }
+export const should = chai.should()

packages/predicates/package.json

@@ -31,7 +31,7 @@
   },
   "devDependencies": {
     "@pigi/prettier-config": "^0.0.2-alpha.2",
-    "@pigi/utils": "^0.0.1-alpha.2",
+    "@pigi/core": "^0.0.1-alpha.1",
     "@types/chai": "^4.1.7",
     "@types/debug": "^4.1.2",
     "@types/mocha": "^5.2.6",

packages/predicates/src/ownership/transaction.ts

@@ -9,7 +9,8 @@ import {
   abi,
   keccak256,
   hexStringify,
-} from '@pigi/utils'
+  StateUpdate,
+} from '@pigi/core'
 
 /**
  * Creates a Transaction from an encoded Transaction.

packages/predicates/test/ownership/transaction.spec.ts

@@ -4,7 +4,7 @@ import '../setup'
 import debug from 'debug'
 const log = debug('test:info:ownership-predicate')
 import BigNum = require('bn.js')
-import { AbiStateObject } from '@pigi/utils'
+import { AbiStateObject } from '@pigi/core'
 
 /* Internal Imports */
 import { OwnershipTransaction } from '../..//src/ownership/transaction'