Cleaned up watch-eth

packages/watch-eth/index.ts

@@ -1,7 +1,8 @@
 export { EventWatcher, EventWatcherOptions } from './src/event-watcher'
+export { EventLog, EventFilter } from './src/models'
 export {
-  BaseEthProvider,
+  EventDB,
+  EthProvider,
   FullEventFilter,
-} from './src/eth-provider/base-eth-provider'
-export { BaseEventDB } from './src/event-db/base-event-db'
-export { EventFilterOptions, EventLog } from './src/models'
+  EventFilterOptions
+} from './src/interfaces'

packages/watch-eth/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@pigi/watch-eth",
-  "version": "0.0.1-beta.7",
-  "description": "Robust library for listening to Ethereum events",
+  "version": "0.0.2-alpha.1",
+  "description": "Robust library for listening to Ethereum events.",
   "main": "build/index.js",
   "files": [
     "build/**/*"

packages/watch-eth/src/eth-provider/default-eth-provider.ts → packages/watch-eth/src/eth-provider.ts

@@ -1,9 +1,15 @@
-import { BaseEthProvider, FullEventFilter } from './base-eth-provider'
+/* External Imports */
 import Web3 from 'web3'
 
+/* Internal Imports */
+import { EthProvider, FullEventFilter } from './interfaces'
 import { EventLog } from '../models'
 
-export class EthWrapper implements BaseEthProvider {
+
+/**
+ * Basic EthProvider implementation.
+ */
+export class DefaultEthProvider implements EthProvider {
   constructor(private web3: Web3) {}
 
   /**

packages/watch-eth/src/event-db/default-event-db.ts → packages/watch-eth/src/event-db.ts

@@ -1,6 +1,11 @@
-import { BaseEventDB } from './base-event-db'
+/* Internal Imports */
+import { EventDB } from './interfaces'
 
-export class EventDBWrapper implements BaseEventDB {
+
+/**
+ * Basic EventDB implementation.
+ */
+export class DefaultEventDB implements EventDB {
   constructor(private db: any) {}
 
   /**

packages/watch-eth/src/event-watcher.ts

@@ -1,21 +1,21 @@
+/* External Imports */
+import { EventEmitter } from 'events'
 import * as W3 from 'web3'
 const Web3 = require('web3') // tslint:disable-line
 
-import { EventEmitter } from 'events'
-
+/* Internal Imports */
 import { sleep } from './utils'
-import { EventFilter, EventFilterOptions, EventLog } from './models'
-import { BaseEventDB } from './event-db/base-event-db'
-import { EventDBWrapper } from './event-db/default-event-db'
-import { EthWrapper } from './eth-provider/default-eth-provider'
-import { BaseEthProvider } from './eth-provider/base-eth-provider'
+import { EventFilter, EventLog } from './models'
+import { EventDB, EthProvider } from './interfaces'
+import { DefaultEventDB } from './event-db'
+import { DefaultEthProvider } from './eth-provider'
+
 
-interface EventSubscription {
+export interface EventSubscription {
   filter: EventFilter
   listeners: Array<(...args: any) => any>
 }
 
-// TODO: Fix this interface.
 export interface EventWatcherOptions {
   address: string
   abi: any
@@ -49,8 +49,8 @@ export class EventWatcher extends EventEmitter {
       ...options,
     }
 
-    this.eth = new EthWrapper(options.eth)
-    this.db = new EventDBWrapper(options.db)
+    this.eth = new DefaultEthProvider(options.eth)
+    this.db = new DefaultEventDB(options.db)
     this.options = options
   }
 

packages/watch-eth/src/eth-provider/base-eth-provider.ts → packages/watch-eth/src/interfaces/eth-provider.interface.ts

@@ -1,5 +1,5 @@
-import { EventLog } from '../models/event-log'
-import { EventFilterOptions } from '../models'
+/* Internal Imports */
+import { EventFilterOptions } from './event-filter'
 
 export interface FullEventFilter extends EventFilterOptions {
   address: string
@@ -8,7 +8,7 @@ export interface FullEventFilter extends EventFilterOptions {
   toBlock: number
 }
 
-export interface BaseEthProvider {
+export interface EthProvider {
   connected(): Promise<boolean>
   getCurrentBlock(): Promise<number>
   getEvents(filter: FullEventFilter): Promise<EventLog[]>

packages/watch-eth/src/event-db/base-event-db.ts → packages/watch-eth/src/interfaces/event-db.interface.ts

@@ -1,4 +1,4 @@
-export interface BaseEventDB {
+export interface EventDB {
   getLastLoggedBlock(event: string): Promise<number>
   setLastLoggedBlock(event: string, block: number): Promise<void>
   getEventSeen(event: string): Promise<boolean>

packages/watch-eth/src/interfaces/event-filter-options.interface.ts

@@ -0,0 +1,4 @@
+export interface EventFilterOptions {
+  event: string
+  indexed?: { [key: string]: any }
+}

packages/watch-eth/src/interfaces/event-log-data.interface.ts

@@ -0,0 +1,4 @@
+export interface EventLogData {
+  transactionHash: string
+  logIndex: number
+}

packages/watch-eth/src/interfaces/index.ts

@@ -0,0 +1,4 @@
+export * from './event-filter-options.interface'
+export * from './eth-provider.interface'
+export * from './event-log-data.interface'
+export * from './event-db.interface'

packages/watch-eth/src/models/event-filter.ts

@@ -1,9 +1,7 @@
+/* Internal Imports */
 import { hash } from '../utils'
+import { EventFilterOptions } from '../interfaces'
 
-export interface EventFilterOptions {
-  event: string
-  indexed?: { [key: string]: any }
-}
 
 /**
  * Represents an event filter.

packages/watch-eth/src/models/event-log.ts

@@ -1,9 +1,7 @@
+/* Internal Imports */
 import { hash } from '../utils'
+import { EventLogData } from '../interfaces'
 
-export interface EventLogData {
-  transactionHash: string
-  logIndex: number
-}
 
 /**
  * Represents a single event log.

packages/watch-eth/src/utils.ts

@@ -1,5 +1,7 @@
+/* External Imports */
 import crypto = require('crypto')
 
+
 /**
  * Creates a simple (not cryptographically secure) hash.
  * @param message Message to be hashed.

packages/watch-eth/test/setup.ts

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