eco-solver 0.0.1-security → 1.5.1

package/src/watch/intent/watch-fulfillment.service.ts

@@ -0,0 +1,115 @@
+import { Injectable, Logger } from '@nestjs/common'
+import { EcoConfigService } from '@/eco-configs/eco-config.service'
+import { Queue } from 'bullmq'
+import { QUEUES } from '@/common/redis/constants'
+import { InjectQueue } from '@nestjs/bullmq'
+import { getIntentJobId } from '@/common/utils/strings'
+import { Solver } from '@/eco-configs/eco-config.types'
+import { EcoLogMessage } from '@/common/logging/eco-log-message'
+import { MultichainPublicClientService } from '@/transaction/multichain-public-client.service'
+import { PublicClient, zeroHash } from 'viem'
+import { convertBigIntsToStrings } from '@/common/viem/utils'
+import { entries } from 'lodash'
+import { InboxAbi } from '@eco-foundation/routes-ts'
+import { WatchEventService } from '@/watch/intent/watch-event.service'
+import { FulfillmentLog } from '@/contracts/inbox'
+
+/**
+ * This service subscribes to Inbox contracts for Fulfillment events. It subscribes on all
+ * supported chains and prover addresses. When an event is emitted, adds the event
+ * to the queue to update the intent in the database.
+ */
+@Injectable()
+export class WatchFulfillmentService extends WatchEventService<Solver> {
+  protected logger = new Logger(WatchFulfillmentService.name)
+
+  constructor(
+    @InjectQueue(QUEUES.INBOX.queue) protected readonly inboxQueue: Queue,
+    protected readonly publicClientService: MultichainPublicClientService,
+    protected readonly ecoConfigService: EcoConfigService,
+  ) {
+    super(inboxQueue, publicClientService, ecoConfigService)
+  }
+
+  /**
+   * Subscribes to all Inbox constacts for Fulfillment events. It loads a mapping of the unsubscribe events to
+   * call {@link onModuleDestroy} to close the clients.
+   */
+  async subscribe(): Promise<void> {
+    const subscribeTasks = entries(this.ecoConfigService.getSolvers()).map(async ([, solver]) => {
+      const client = await this.publicClientService.getClient(solver.chainID)
+      await this.subscribeTo(client, solver)
+    })
+    await Promise.all(subscribeTasks)
+  }
+
+  async unsubscribe() {
+    super.unsubscribe()
+    this.logger.debug(
+      EcoLogMessage.fromDefault({
+        message: `watch fulfillment: unsubscribe`,
+      }),
+    )
+  }
+
+  /**
+   * Checks to see what networks we have intent sources for
+   * @returns the supported chains for the event
+   */
+  getSupportedChains(): bigint[] {
+    return this.ecoConfigService.getIntentSources().map((source) => BigInt(source.chainID))
+  }
+
+  async subscribeTo(client: PublicClient, solver: Solver) {
+    this.logger.debug(
+      EcoLogMessage.fromDefault({
+        message: `watch fulfillment event: subscribeToFulfillment`,
+        properties: {
+          solver,
+        },
+      }),
+    )
+    const souceChains = this.getSupportedChains()
+    this.unwatch[solver.chainID] = client.watchContractEvent({
+      onError: async (error) => {
+        await this.onError(error, client, solver)
+      },
+      address: solver.inboxAddress,
+      abi: InboxAbi,
+      eventName: 'Fulfillment',
+      args: {
+        // restrict by acceptable chains, chain ids must be bigints
+        _sourceChainID: souceChains,
+      },
+      onLogs: this.addJob(),
+    })
+  }
+
+  addJob() {
+    return async (logs: FulfillmentLog[]) => {
+      for (const log of logs) {
+        // bigint as it can't serialize to JSON
+        const fulfillment = convertBigIntsToStrings(log)
+        const jobId = getIntentJobId(
+          'watch-fulfillement',
+          fulfillment.args._hash ?? zeroHash,
+          fulfillment.logIndex ?? 0,
+        )
+        this.logger.debug(
+          EcoLogMessage.fromDefault({
+            message: `watch fulfillment`,
+            properties: {
+              fulfillment,
+              jobId,
+            },
+          }),
+        )
+        // add to processing queue
+        await this.inboxQueue.add(QUEUES.INBOX.jobs.fulfillment, fulfillment, {
+          jobId,
+          ...this.intentJobConfig,
+        })
+      }
+    }
+  }
+}

package/src/watch/watch.module.ts

@@ -0,0 +1,13 @@
+import { Module } from '@nestjs/common'
+import { initBullMQ } from '@/bullmq/bullmq.helper'
+import { QUEUES } from '@/common/redis/constants'
+import { WatchCreateIntentService } from '@/watch/intent/watch-create-intent.service'
+import { TransactionModule } from '@/transaction/transaction.module'
+import { WatchFulfillmentService } from '@/watch/intent/watch-fulfillment.service'
+
+@Module({
+  imports: [initBullMQ(QUEUES.SOURCE_INTENT), initBullMQ(QUEUES.INBOX), TransactionModule],
+  providers: [WatchCreateIntentService, WatchFulfillmentService],
+  exports: [WatchCreateIntentService, WatchFulfillmentService],
+})
+export class WatchModule {}

package/test/app.e2e-spec.ts

@@ -0,0 +1,21 @@
+import { Test, TestingModule } from '@nestjs/testing'
+import { INestApplication } from '@nestjs/common'
+import * as request from 'supertest'
+import { AppModule } from './../src/app.module'
+
+describe('AppController (e2e)', () => {
+  let app: INestApplication
+
+  beforeEach(async () => {
+    const moduleFixture: TestingModule = await Test.createTestingModule({
+      imports: [AppModule],
+    }).compile()
+
+    app = moduleFixture.createNestApplication()
+    await app.init()
+  })
+
+  it('/ (GET)', () => {
+    return request(app.getHttpServer()).get('/').expect(200).expect('Hello World!')
+  })
+})

package/test/jest-e2e.json

@@ -0,0 +1,9 @@
+{
+  "moduleFileExtensions": ["js", "json", "ts"],
+  "rootDir": ".",
+  "testEnvironment": "node",
+  "testRegex": ".e2e-spec.ts$",
+  "transform": {
+    "^.+\\.(t|j)s$": "ts-jest"
+  }
+}

package/tsconfig.build.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": ["node_modules", "test", "dist", "**/*spec.ts"]
+}

package/tsconfig.json

@@ -0,0 +1,29 @@
+{
+  "compilerOptions": {
+    "module": "commonjs",
+    "declaration": true,
+    "removeComments": true,
+    "emitDecoratorMetadata": true,
+    "experimentalDecorators": true,
+    "allowSyntheticDefaultImports": true,
+    "target": "ES2021",
+    "sourceMap": true,
+    "outDir": "./dist",
+    "baseUrl": "./",
+    "incremental": true,
+    "skipLibCheck": true,
+    "strictNullChecks": true,
+    "noImplicitAny": false,
+    "strictBindCallApply": false,
+    "forceConsistentCasingInFileNames": false,
+    "noFallthroughCasesInSwitch": false,
+    "inlineSources": true,
+    "resolveJsonModule": true,
+    "paths": {
+      "@/*": ["./src/*"]
+    }
+  },
+  "ts-node": {
+    "require": ["tsconfig-paths/register"]
+  }
+}