Merge branch 'develop'

Author: Julien Heller

package.json

@@ -1,6 +1,6 @@
 {
   "name": "demux-eos",
-  "version": "3.1.0",
+  "version": "4.0.0",
   "description": "Demux-js Action Reader implementations for EOSIO blockchains",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -20,16 +20,16 @@
     "@types/node-fetch": "^2.1.6",
     "@types/request-promise-native": "^1.0.15",
     "jest": "^22.4.3",
-    "release-it": "^7.5.0",
     "ts-jest": "^23.0.0",
     "tslint": "^5.10.0",
     "tslint-eslint-rules": "^5.3.1",
     "typedoc": "^0.11.1",
     "typescript": "^2.9.2"
   },
   "dependencies": {
+    "@types/express": "^4.16.1",
     "bunyan": "^1.8.12",
-    "demux": "^3.1.4-8cfe8c1.0",
+    "demux": "^4.0.0",
     "eosjs": "^20.0.0-beta3",
     "massive": "^5.7.5",
     "mongodb": "^3.1.3",
@@ -38,13 +38,10 @@
     "request-promise-native": "^1.0.5"
   },
   "peerDependencies": {
-    "demux": "^3.1.3"
+    "demux": "4.0.0"
   },
   "scripts": {
-    "release": "release-it",
-    "compile": "tsc",
-    "build": "tsc",
-    "watch": "tsc -w",
+    "build": "rm -rf dist/* && tsc",
     "lint": "tslint -c tslint.json -p tsconfig.json",
     "test": "jest",
     "build-docs": "./scripts/build-docs.sh",

scripts/build-docs.sh

@@ -1 +1,2 @@
+rm -rf docs/*
 ./node_modules/.bin/typedoc --mode file --theme minimal --target "ES6" --exclude "**/*.test.ts,**/testHelpers/*" --hideGenerator --excludeExternals --excludeNotExported --includeDeclarations --readme none --out docs

src/interfaces.ts

@@ -1,4 +1,18 @@
-import { Action } from 'demux'
+import { Action, ActionReaderOptions } from 'demux'
+
+export interface NodeosActionReaderOptions extends ActionReaderOptions {
+  nodeosEndpoint?: string
+}
+
+export interface MongoActionReaderOptions extends ActionReaderOptions {
+  mongoEndpoint?: string
+  dbName?: string
+}
+
+export interface StateHistoryPostgresActionReaderOptions extends ActionReaderOptions {
+  massiveConfig: any
+  dbSchema?: string
+}
 
 export interface EosAuthorization {
   actor: string

src/mongo/MongoActionReader.test.ts

@@ -9,7 +9,12 @@ describe('MongoActionReader', () => {
   let reader: any
 
   beforeEach(async () => {
-    reader = new MongoActionReader('mongodb://127.0.0.1:27017', 0, false, 'EOS')
+    reader = new MongoActionReader({
+      startAtBlock: 0,
+      onlyIrreversible: false,
+      mongoEndpoint: 'mongodb://127.0.0.1:27017',
+      dbName: 'EOS'
+    })
     await reader.initialize()
   })
 
@@ -29,7 +34,12 @@ describe('MongoActionReader', () => {
   })
 
   it('throws if not correctly initialized', async () => {
-    const failedReader = new MongoActionReader('mongodb://127.0.0.1:27017', 0, false, 'failed')
+    const failedReader = new MongoActionReader({
+      startAtBlock: 0,
+      onlyIrreversible: false,
+      mongoEndpoint: 'mongodb://127.0.0.1:27017',
+      dbName: 'failed',
+    })
     const result = failedReader.getNextBlock()
     expect(result).rejects.toThrow(NotInitializedError)
   })

src/mongo/MongoActionReader.ts

@@ -1,4 +1,3 @@
-import * as Logger from 'bunyan'
 import { AbstractActionReader, NotInitializedError } from 'demux'
 import { Db, MongoClient } from 'mongodb'
 import {
@@ -8,27 +7,24 @@ import {
   RetrieveHeadBlockError,
   RetrieveIrreversibleBlockError,
 } from '../errors'
+import { MongoActionReaderOptions } from '../interfaces'
 import { retry } from '../utils'
 import { MongoBlock } from './MongoBlock'
 
 /**
  * Implementation of an ActionReader that reads blocks from a mongodb instance.
  */
 export class MongoActionReader extends AbstractActionReader {
-  protected log: Logger
-
-  private mongodb: Db | null
+  public dbName: string
+  protected mongoEndpoint: string
   private readonly requiredCollections: Set<string> = new Set(['action_traces', 'block_states'])
+  private mongodb: Db | null
 
-  constructor(
-    protected mongoEndpoint: string = 'mongodb://127.0.0.1:27017',
-    public startAtBlock: number = 1,
-    protected onlyIrreversible: boolean = false,
-    public dbName: string = 'EOS',
-  ) {
-    super({startAtBlock, onlyIrreversible})
+  constructor(options: MongoActionReaderOptions = {}) {
+    super(options)
+    this.mongoEndpoint = options.mongoEndpoint ? options.mongoEndpoint : 'mongodb://127.0.0.1:27017'
+    this.dbName = options.dbName ? options.dbName : 'EOS'
     this.mongodb = null
-    this.log = Logger.createLogger({ name: 'demux' })
   }
 
   public async getHeadBlockNumber(numRetries: number = 120, waitTimeMs: number = 250): Promise<number> {

src/nodeos/NodeosActionReader.test.ts

@@ -17,7 +17,11 @@ describe('NodeosActionReader', () => {
   })
 
   beforeEach(() => {
-    reader = new NodeosActionReader('', 10, false)
+    reader = new NodeosActionReader({
+      nodeosEndpoint: '',
+      startAtBlock: 10,
+      onlyIrreversible: false
+    })
   })
 
   it('returns head block number', async () => {

src/nodeos/NodeosActionReader.ts

@@ -1,7 +1,7 @@
-import * as Logger from 'bunyan'
 import { AbstractActionReader, NotInitializedError } from 'demux'
 import request from 'request-promise-native'
 import { RetrieveBlockError, RetrieveHeadBlockError, RetrieveIrreversibleBlockError } from '../errors'
+import { NodeosActionReaderOptions } from '../interfaces'
 import { retry } from '../utils'
 import { NodeosBlock } from './NodeosBlock'
 
@@ -12,17 +12,11 @@ import { NodeosBlock } from './NodeosBlock'
  */
 export class NodeosActionReader extends AbstractActionReader {
   protected nodeosEndpoint: string
-  protected log: Logger
 
-  constructor(
-    nodeosEndpoint: string = 'http://localhost:8888',
-    public startAtBlock: number = 1,
-    protected onlyIrreversible: boolean = false,
-  ) {
-    super({startAtBlock, onlyIrreversible})
+  constructor(options: NodeosActionReaderOptions = {}) {
+    super(options)
+    const nodeosEndpoint = options.nodeosEndpoint ? options.nodeosEndpoint : 'http://localhost:8888'
     this.nodeosEndpoint = nodeosEndpoint.replace(/\/+$/g, '') // Removes trailing slashes
-
-    this.log = Logger.createLogger({ name: 'demux' })
   }
 
   /**

src/state-history/StateHistoryPostgresActionReader.test.ts

@@ -3,17 +3,16 @@ import { StateHistoryPostgresActionReader } from './StateHistoryPostgresActionRe
 describe('StateHistoryPostgresActionReader', () => {
   let reader: any
   beforeEach(async () => {
-    reader = new StateHistoryPostgresActionReader(
-      {},
-      {
+    reader = new StateHistoryPostgresActionReader({
+      massiveConfig: {
         host: 'localhost',
         port: 5432,
         database: 'statehistory',
         user: 'docker',
         password: 'docker'
       },
-      'chain'
-    )
+      dbSchema: 'chain',
+    })
 
     await reader.setup()
   })

src/state-history/StateHistoryPostgresActionReader.ts

@@ -1,17 +1,18 @@
-import { AbstractActionReader, ActionReaderOptions, NotInitializedError } from 'demux'
+import { AbstractActionReader, NotInitializedError } from 'demux'
 import massive from 'massive'
+import { StateHistoryPostgresActionReaderOptions } from '../interfaces'
 import { StateHistoryPostgresBlock } from './StateHistoryPostgresBlock'
 
 export class StateHistoryPostgresActionReader extends AbstractActionReader {
   private db: any
   private massiveInstance: massive.Database | null = null
+  private massiveConfig: any
+  private dbSchema: string
 
-  constructor(
-    options: ActionReaderOptions,
-    private massiveConfig: any,
-    private dbSchema: string = 'chain',
-  ) {
+  constructor(options: StateHistoryPostgresActionReaderOptions) {
     super(options)
+    this.massiveConfig = options.massiveConfig
+    this.dbSchema = options.dbSchema ? options.dbSchema : 'chain'
   }
 
   public async getHeadBlockNumber(): Promise<number> {