Merge pull request #102 from plasma-group/dev-k1

Rename Ethereum-related event services to `EthEventX`

packages/core/src/app.module.ts

@@ -10,13 +10,12 @@ import {
   OperatorService,
   ChainService,
   EthModule,
-  EventModule,
   DBModule,
   ProofModule,
 } from './services'
 
 @Module({
-  imports: [EthModule, EventModule, DBModule, ProofModule],
+  imports: [EthModule, DBModule, ProofModule],
   services: [
     SyncService,
     GuardService,

packages/core/src/services/eth/eth.module.ts

@@ -5,8 +5,16 @@ import { Module } from '@nestd/core'
 import { EthDataService } from './eth-data.service'
 import { ContractService } from './contract.service'
 import { WalletService } from './wallet.service'
+import { EthEventWatcherService } from './events/eth-event-watcher.service'
+import { EthEventHandlerService } from './events/eth-event-handler.service'
 
 @Module({
-  services: [EthDataService, ContractService, WalletService],
+  services: [
+    EthDataService,
+    ContractService,
+    WalletService,
+    EthEventWatcherService,
+    EthEventHandlerService,
+  ],
 })
 export class EthModule {}

packages/core/src/services/events/event-handler.service.ts → packages/core/src/services/eth/events/eth-event-handler.service.ts

@@ -2,28 +2,28 @@
 import { Service, OnStart } from '@nestd/core'
 
 /* Services */
-import { EventWatcherService } from './event-watcher.service'
-import { EventService } from '../event.service'
-import { LoggerService, SyncLogger } from '../logging'
+import { EthEventWatcherService } from './eth-event-watcher.service'
+import { EventService } from '../../event.service'
+import { LoggerService, SyncLogger } from '../../logging'
 
 /* Internal Imports */
-import { EthereumEvent } from '../../models/eth'
-import { PlasmaBlock, Deposit, Exit } from '../../models/chain'
+import { EthereumEvent } from '../../../models/eth'
+import { PlasmaBlock, Deposit, Exit } from '../../../models/chain'
 
 /**
  * Service that handles events coming from
  * EventWatcherService and parses them into
  * useable objects.
  */
 @Service()
-export class EventHandlerService implements OnStart {
+export class EthEventHandlerService implements OnStart {
   private readonly name = 'eventHandler'
   private readonly logger = new SyncLogger(this.name, this.logs)
 
   constructor(
     private readonly logs: LoggerService,
     private readonly events: EventService,
-    private readonly eventWatcher: EventWatcherService
+    private readonly eventWatcher: EthEventWatcherService
   ) {}
 
   public async onStart(): Promise<void> {

packages/core/src/services/events/event-watcher.service.ts → packages/core/src/services/eth/events/eth-event-watcher.service.ts

@@ -3,14 +3,14 @@ import { Service, OnStart, OnStop } from '@nestd/core'
 import { EventWatcher } from 'watch-eth'
 
 /* Services */
-import { SyncDB } from '../db/interfaces/sync-db'
-import { EthDataService } from '../eth/eth-data.service'
-import { ContractService } from '../eth/contract.service'
-import { ConfigService } from '../config.service'
-import { EventService } from '../event.service'
+import { SyncDB } from '../../db/interfaces/sync-db'
+import { EthDataService } from '../eth-data.service'
+import { ContractService } from '../contract.service'
+import { ConfigService } from '../../config.service'
+import { EventService } from '../../event.service'
 
 /* Internal Imports */
-import { CONFIG } from '../../constants'
+import { CONFIG } from '../../../constants'
 
 interface EventWatcherOptions {
   finalityDepth: number
@@ -21,7 +21,7 @@ interface EventWatcherOptions {
  * Service that watches for events from Ethereum.
  */
 @Service()
-export class EventWatcherService implements OnStart, OnStop {
+export class EthEventWatcherService implements OnStart, OnStop {
   public watcher: EventWatcher
   private readonly name = 'eventWatcher'
 

packages/core/src/services/index.ts

@@ -9,15 +9,14 @@ export { JsonRpcService } from './jsonrpc/jsonrpc.service'
 export { DBService } from './db/db.service'
 export { ChainService } from './chain.service'
 export { ProofVerificationService } from './proof/proof-verification.service'
-export { EventWatcherService } from './events/event-watcher.service'
-export { EventHandlerService } from './events/event-handler.service'
 export { OperatorService } from './operator.service'
 export { SyncService } from './sync.service'
 export { WalletService } from './eth/wallet.service'
 export { EthDataService } from './eth/eth-data.service'
+export { EthEventWatcherService } from './eth/events/eth-event-watcher.service'
+export { EthEventHandlerService } from './eth/events/eth-event-handler.service'
 
 /* Modules */
 export { DBModule } from './db/db.module'
 export { EthModule } from './eth/eth.module'
-export { EventModule } from './events/event.module'
 export { ProofModule } from './proof/proof.module'

packages/core/src/utils/misc.ts

@@ -55,3 +55,23 @@ export const bnMin = (a: BigNum, b: BigNum): BigNum => {
 export const bnMax = (a: BigNum, b: BigNum): BigNum => {
   return a.gt(b) ? a : b
 }
+
+interface PrettyPrintable {
+  [key: string]: string | number | BigNum | boolean | any
+}
+
+/**
+ * Converts an object to a pretty JSON string.
+ * @param obj Object to convert.
+ * @returns the object as a pretty JSON string.
+ */
+export const prettify = (obj: PrettyPrintable): string => {
+  const parsed: PrettyPrintable = {}
+  for (const key of Object.keys(obj)) {
+    const value = obj[key]
+    parsed[key] = BigNum.isBN(value)
+      ? `${value.toString(16)} (${value.toString(10)})`
+      : value
+  }
+  return JSON.stringify(parsed, null, 2)
+}