refactor: move event listener to blocks/eventManager

apps/main-chain/package.json

@@ -12,6 +12,7 @@
     "dependencies": {
       "@joincolony/graphql": "workspace:*",
       "@joincolony/clients": "workspace:*",
+      "@joincolony/blocks": "workspace:*",
       "@joincolony/utils": "workspace:*"
     }
   }

apps/main-chain/src/blockProcessor.ts

@@ -1,6 +1,6 @@
 import { Log } from '@ethersproject/abstract-provider';
 import { blocksMap, getLatestSeenBlockNumber } from '~blockListener';
-import { getMatchingListeners } from '~eventListeners';
+import eventManager from '~eventManager';
 import { getInterfaceByListener } from '~interfaces';
 import rpcProvider from '~provider';
 
@@ -182,7 +182,10 @@ export const processNextBlock = async (): Promise<void> => {
 
     for (const log of logs) {
       // Find listeners that match the log
-      const listeners = getMatchingListeners(log.topics, log.address);
+      const listeners = eventManager.getMatchingListeners(
+        log.topics,
+        log.address,
+      );
       if (!listeners.length) {
         continue;
       }

apps/main-chain/src/eventListeners/colony.ts

@@ -9,7 +9,6 @@ import {
 import { ContractEventsSignatures, EventHandler } from '~types';
 import { notNull } from '~utils';
 import {
-  addEventListener,
   addNetworkEventListener,
   addTokenEventListener,
 } from '~eventListeners';
@@ -51,13 +50,14 @@ import { handleProxyColonyRequested } from '~handlers/proxyColonies';
 import setTokenAuthority from '~handlers/tokens/setTokenAuthority';
 import { addProxyColoniesEventListener } from './proxyColonies';
 import { output } from '@joincolony/utils';
+import eventManager from '~eventManager';
 
 const addColonyEventListener = (
   eventSignature: ContractEventsSignatures,
   address: string,
   handler: EventHandler,
 ): void => {
-  addEventListener({
+  eventManager.addEventListener({
     type: EventListenerType.Colony,
     address,
     eventSignature,

apps/main-chain/src/eventListeners/extension/index.ts

@@ -4,12 +4,10 @@ import { Extension, getExtensionHash } from '@colony/colony-js';
 import { ContractEventsSignatures, EventHandler } from '~types';
 import {
   EventListenerType,
-  addEventListener,
-  getEventListeners,
-  setEventListeners,
   setupListenerForOneTxPaymentExtensions,
   setupListenersForStagedExpenditureExtensions,
 } from '~eventListeners';
+import eventManager from '~eventManager';
 import {
   ExtensionFragment,
   ListExtensionsDocument,
@@ -44,7 +42,7 @@ export const addExtensionEventListener = (
   colonyAddress: string,
   handler: EventHandler,
 ): void => {
-  addEventListener({
+  eventManager.addEventListener({
     type: EventListenerType.Extension,
     eventSignature,
     address: extensionAddress,
@@ -58,8 +56,8 @@ export const addExtensionEventListener = (
 export const removeExtensionEventListeners = (
   extensionAddress: string,
 ): void => {
-  const existingListeners = getEventListeners();
-  setEventListeners(
+  const existingListeners = eventManager.getEventListeners();
+  eventManager.setEventListeners(
     existingListeners.filter((listener) => {
       if (listener.type !== EventListenerType.Extension) {
         return true;

apps/main-chain/src/eventListeners/index.ts

@@ -1,4 +1,3 @@
-export * from './eventListeners';
 export * from './types';
 export * from './colony';
 export * from './network';

apps/main-chain/src/eventListeners/network.ts

@@ -1,13 +1,14 @@
+import { EventListenerType } from '@joincolony/blocks';
 import { utils } from 'ethers';
 
-import { EventListenerType, addEventListener } from '~eventListeners';
+import eventManager from '~eventManager';
 import { ContractEventsSignatures, EventHandler } from '~types';
 
 export const addNetworkEventListener = (
   eventSignature: ContractEventsSignatures,
   handler: EventHandler,
 ): void =>
-  addEventListener({
+  eventManager.addEventListener({
     type: EventListenerType.Network,
     eventSignature,
     topics: [utils.id(eventSignature)],

apps/main-chain/src/eventListeners/proxyColonies.ts

@@ -1,13 +1,14 @@
 import { utils } from 'ethers';
 
-import { EventListenerType, addEventListener } from '~eventListeners';
 import { ContractEventsSignatures, EventHandler } from '~types';
+import eventManager from '~eventManager';
+import { EventListenerType } from '@joincolony/blocks';
 
 export const addProxyColoniesEventListener = (
   eventSignature: ContractEventsSignatures,
   handler: EventHandler,
 ): void =>
-  addEventListener({
+  eventManager.addEventListener({
     type: EventListenerType.ProxyColonies,
     eventSignature,
     topics: [utils.id(eventSignature)],

apps/main-chain/src/eventListeners/token.ts

@@ -1,6 +1,6 @@
 import { ContractEventsSignatures, EventHandler } from '~types';
-import { addEventListener, getEventListeners } from '~eventListeners';
-import { EventListenerType, EventListener } from './types';
+import eventManager from '~eventManager';
+import { EventListenerType, EventListener } from '@joincolony/blocks';
 import { utils } from 'ethers';
 import isEqual from 'lodash/isEqual';
 
@@ -32,12 +32,12 @@ export const addTokenEventListener = (
    * As a general rule, this will only *NOT* apply to the token Transfer event
    * as that's the only one treated differently.
    */
-  const listenerExists = getEventListeners().some((existingListener) =>
-    isEqual(existingListener, tokenListener),
-  );
+  const listenerExists = eventManager
+    .getEventListeners()
+    .some((existingListener) => isEqual(existingListener, tokenListener));
   if (listenerExists) {
     return;
   }
 
-  return addEventListener(tokenListener);
+  return eventManager.addEventListener(tokenListener);
 };

apps/main-chain/src/eventManager.ts

@@ -0,0 +1,5 @@
+import { EventManager } from '@joincolony/blocks';
+
+const eventManager = new EventManager();
+
+export default eventManager;

apps/main-chain/src/index.ts

@@ -3,6 +3,7 @@ import { utils } from 'ethers';
 
 import { startBlockListener } from '~blockListener';
 import '~amplifyClient';
+import '~eventManager';
 import { startStatsServer } from '~stats';
 import {
   setupListenersForColonies,

apps/main-chain/src/stats.ts

@@ -1,7 +1,7 @@
 import express from 'express';
 
 import { getLastBlockNumber, getStats, initStats } from '~utils';
-import { getListenersStats } from '~eventListeners';
+import eventManager from '~eventManager';
 import rpcProvider from '~provider';
 import { output } from '@joincolony/utils';
 
@@ -33,7 +33,7 @@ app.get('/stats', async (_, res) => {
  * Use to check currently active listeners
  */
 app.get('/listeners', async (_, res) => {
-  res.type('json').send(getListenersStats());
+  res.type('json').send(eventManager.getListenersStats());
 });
 
 export const startStatsServer = async (): Promise<void> => {

packages/blocks/package.json

@@ -0,0 +1,8 @@
+{
+  "name": "@joincolony/blocks",
+  "main": "src/index.ts",
+  "version": "1.0.0",
+  "dependencies": {
+    "@joincolony/utils": "workspace:*"
+  }
+}

packages/blocks/src/eventManager.ts

@@ -0,0 +1,48 @@
+import { verbose } from '@joincolony/utils';
+import { EventListener } from './types';
+
+export class EventManager {
+  private listeners: EventListener[] = [];
+
+  public getEventListeners(): EventListener[] {
+    return this.listeners;
+  }
+
+  public setEventListeners(newListeners: EventListener[]): void {
+    this.listeners = newListeners;
+  }
+
+  public addEventListener(listener: EventListener): void {
+    verbose(
+      `Added listener for event ${listener.eventSignature}`,
+      listener.address ? `filtering address ${listener.address}` : '',
+    );
+    this.listeners.push(listener);
+  }
+
+  public getMatchingListeners(
+    logTopics: string[],
+    logAddress: string,
+  ): EventListener[] {
+    return this.listeners.filter((listener) => {
+      if (listener.address && logAddress !== listener.address) {
+        return false;
+      }
+
+      if (listener.topics.length > logTopics.length) {
+        return false;
+      }
+
+      return listener.topics.every((topic, index) => {
+        return (
+          topic === null ||
+          topic.toLowerCase() === logTopics[index].toLowerCase()
+        );
+      });
+    });
+  }
+
+  public getListenersStats(): string {
+    return JSON.stringify(this.listeners);
+  }
+}

packages/blocks/src/index.ts

@@ -0,0 +1,2 @@
+export * from './eventManager';
+export * from './types';