[Exchange Oracle] Handle escrow_created webhook

packages/apps/dashboard/ui/package.json

@@ -73,7 +73,7 @@
     "test": "vitest -u",
     "format:prettier": "prettier --write '**/*.{ts,tsx}'",
     "format:lint": "eslint --fix '**/*.{ts,tsx}'",
-    "format": "npm run format:prettier && npm run format:lint",
+    "format": "yarn format:prettier && yarn format:lint",
     "vercel-build": "yarn workspace @human-protocol/sdk build && yarn build"
   },
   "browserslist": {

packages/apps/fortune/exchange-oracle/server/Dockerfile

@@ -0,0 +1,17 @@
+# Base image
+FROM node:18
+
+# Create app directory
+WORKDIR /usr/src/app
+
+# Bundle app source
+COPY . .
+
+# Install app dependencies
+RUN yarn install
+
+# Creates a "dist" folder with the production build
+RUN yarn workspace @human-protocol/fortune-exchange-oracle-server build
+
+# Start the server using the production build
+CMD [ "node", "packages/apps/fortune/exchange-oracle/server/dist/src/main.js" ]

packages/apps/fortune/exchange-oracle/server/package.json

@@ -10,7 +10,7 @@
     "start": "nest start",
     "start:dev": "NODE_ENV=development nest start --watch",
     "start:debug": "nest start --debug --watch",
-    "start:prod": "node dist/main",
+    "start:prod": "node dist/src/main",
     "lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
     "test": "jest",
     "migration:create": "yarn build && typeorm-ts-node-commonjs migration:create",

packages/apps/fortune/exchange-oracle/server/src/app.controller.ts

@@ -1,14 +1,13 @@
 import { Controller, Get, Redirect } from '@nestjs/common';
 import { Public } from './common/decorators';
-import { ApiExcludeController } from '@nestjs/swagger';
+import { ApiTags, ApiExcludeController } from '@nestjs/swagger';
 
 @Controller('/')
 @ApiExcludeController()
+@ApiTags('Main')
 export class AppController {
   @Public()
   @Get('/')
   @Redirect('/swagger', 301)
-  public health(): string {
-    return 'OK';
-  }
+  public redirect(): void {}
 }

packages/apps/fortune/exchange-oracle/server/src/app.module.ts

@@ -10,6 +10,10 @@ import { WebhookModule } from './modules/webhook/webhook.module';
 import { JwtAuthGuard } from './common/guards/jwt.auth';
 import { JwtHttpStrategy } from './common/guards/strategy';
 import { Web3Module } from './modules/web3/web3.module';
+import { StatsModule } from './modules/stats/stats.module';
+import { AssignmentModule } from './modules/assignment/assignment.module';
+import { CronJobModule } from './modules/cron-job/cron-job.module';
+import { HealthModule } from './modules/health/health.module';
 
 @Module({
   providers: [
@@ -24,9 +28,13 @@ import { Web3Module } from './modules/web3/web3.module';
     JwtHttpStrategy,
   ],
   imports: [
+    HealthModule,
+    AssignmentModule,
     JobModule,
     WebhookModule,
     Web3Module,
+    StatsModule,
+    CronJobModule,
     ConfigModule.forRoot({
       envFilePath: process.env.NODE_ENV
         ? `.env.${process.env.NODE_ENV as string}`

packages/apps/fortune/exchange-oracle/server/src/common/config/env.ts

@@ -5,6 +5,7 @@ export const ConfigNames = {
   HOST: 'HOST',
   PORT: 'PORT',
   WEB3_ENV: 'WEB3_ENV',
+  POSTGRES_URL: 'POSTGRES_URL',
   POSTGRES_HOST: 'POSTGRES_HOST',
   POSTGRES_USER: 'POSTGRES_USER',
   POSTGRES_PASSWORD: 'POSTGRES_PASSWORD',
@@ -13,6 +14,7 @@ export const ConfigNames = {
   POSTGRES_SYNC: 'POSTGRES_SYNC',
   POSTGRES_SSL: 'POSTGRES_SSL',
   POSTGRES_LOGGING: 'POSTGRES_LOGGING',
+  MAX_RETRY_COUNT: 'MAX_RETRY_COUNT',
   WEB3_PRIVATE_KEY: 'WEB3_PRIVATE_KEY',
   S3_ENDPOINT: 'S3_ENDPOINT',
   S3_PORT: 'S3_PORT',
@@ -23,21 +25,24 @@ export const ConfigNames = {
   PGP_ENCRYPT: 'PGP_ENCRYPT',
   PGP_PRIVATE_KEY: 'ENCRYPTION_PRIVATE_KEY',
   PGP_PASSPHRASE: 'PGP_PASSPHRASE',
+  CRON_SECRET: 'CRON_SECRET',
 };
 
 export const envValidator = Joi.object({
   // General
   NODE_ENV: Joi.string().default('development'),
   HOST: Joi.string().default('localhost'),
   PORT: Joi.string().default(3002),
+  MAX_RETRY_COUNT: Joi.number().default(5),
   WEB3_ENV: Joi.string().default('testnet'),
   // Database
   DB_TYPE: Joi.string().default('postgres'),
-  POSTGRES_HOST: Joi.string().default('127.0.0.1'),
-  POSTGRES_USER: Joi.string().default('operator'),
-  POSTGRES_PASSWORD: Joi.string().default('qwerty'),
-  POSTGRES_DATABASE: Joi.string().default('reputation-oracle'),
-  POSTGRES_PORT: Joi.string().default('5432'),
+  POSTGRES_URL: Joi.string().optional(),
+  POSTGRES_HOST: Joi.string().optional(),
+  POSTGRES_USER: Joi.string().optional(),
+  POSTGRES_PASSWORD: Joi.string().optional(),
+  POSTGRES_DATABASE: Joi.string().optional(),
+  POSTGRES_PORT: Joi.string().optional(),
   POSTGRES_SYNC: Joi.string().default('false'),
   POSTGRES_SSL: Joi.string().default('false'),
   POSTGRES_LOGGING: Joi.string(),
@@ -53,4 +58,6 @@ export const envValidator = Joi.object({
   PGP_ENCRYPT: Joi.boolean().default(false),
   PGP_PRIVATE_KEY: Joi.string().optional(),
   PGP_PASSPHRASE: Joi.string().optional(),
+  // Cron Job Secret
+  CRON_SECRET: Joi.string().optional(),
 });

packages/apps/fortune/exchange-oracle/server/src/common/constant/errors.ts

@@ -4,3 +4,21 @@
 export enum ErrorWeb3 {
   InvalidChainId = 'Invalid chain id provided for the configured environment',
 }
+
+/**
+ * Represents error messages associated to webhook.
+ */
+export enum ErrorWebhook {
+  NotSent = 'Webhook was not sent',
+  NotFound = 'Webhook not found',
+  UrlNotFound = 'Webhook URL not found',
+  NotCreated = 'Webhook has not been created',
+}
+
+/**
+ * Represents error messages associated with a cron job.
+ */
+export enum ErrorCronJob {
+  NotCompleted = 'Cron job is not completed',
+  Completed = 'Cron job is completed',
+}

packages/apps/fortune/exchange-oracle/server/src/common/constant/index.ts

@@ -1,8 +1,9 @@
 import { ChainId } from '@human-protocol/sdk';
 
 export const HEADER_SIGNATURE_KEY = 'human-signature';
-export const ESCROW_FAILED_ENDPOINT = '/job/escrow-failed-webhook';
 export const NS = 'hmt';
+export const TOKEN = 'HMT';
+export const DEFAULT_MAX_RETRY_COUNT = 5;
 
 export const LOCALHOST_CHAIN_IDS = [ChainId.LOCALHOST];
 
@@ -16,3 +17,6 @@ export const MAINNET_CHAIN_IDS = [
   ChainId.BSC_MAINNET,
   ChainId.MOONBEAM,
 ];
+
+export const JWT_KVSTORE_KEY = 'jwt_public_key';
+export const KYC_APPROVED = 'APPROVED';

packages/apps/fortune/exchange-oracle/server/src/common/enums/collection.ts

@@ -0,0 +1,4 @@
+export enum SortDirection {
+  ASC = 'ASC',
+  DESC = 'DESC',
+}

packages/apps/fortune/exchange-oracle/server/src/common/enums/cron-job.ts

@@ -0,0 +1,3 @@
+export enum CronJobType {
+  ProcessPendingWebhook = 'process-pending-webhook',
+}

packages/apps/fortune/exchange-oracle/server/src/common/enums/job.ts

@@ -4,6 +4,20 @@ export enum JobStatus {
   CANCELED = 'CANCELED',
 }
 
+export enum JobSortField {
+  CHAIN_ID = 'chain_id',
+  JOB_TYPE = 'job_type',
+  REWARD_AMOUNT = 'reward_amount',
+  CREATED_AT = 'created_at',
+}
+
+export enum JobFieldName {
+  JobDescription = 'job_description',
+  RewardAmount = 'reward_amount',
+  RewardToken = 'reward_token',
+  CreatedAt = 'created_at',
+}
+
 export enum AssignmentStatus {
   ACTIVE = 'ACTIVE',
   VALIDATION = 'VALIDATION',
@@ -12,3 +26,16 @@ export enum AssignmentStatus {
   CANCELED = 'CANCELED',
   REJECTED = 'REJECTED',
 }
+
+export enum AssignmentSortField {
+  CHAIN_ID = 'chain_id',
+  JOB_TYPE = 'job_type',
+  STATUS = 'status',
+  REWARD_AMOUNT = 'reward_amount',
+  CREATED_AT = 'created_at',
+  EXPIRES_AT = 'expires_at',
+}
+
+export enum JobType {
+  FORTUNE = 'FORTUNE',
+}

packages/apps/fortune/exchange-oracle/server/src/common/enums/webhook.ts

@@ -3,6 +3,7 @@ export enum EventType {
   ESCROW_CANCELED = 'escrow_canceled',
   TASK_CREATION_FAILED = 'task_creation_failed',
   SUBMISSION_REJECTED = 'submission_rejected',
+  SUBMISSION_IN_REVIEW = 'submission_in_review',
 }
 
 export enum WebhookStatus {

packages/apps/fortune/exchange-oracle/server/src/common/guards/cron.auth.ts

@@ -0,0 +1,25 @@
+import {
+  CanActivate,
+  ExecutionContext,
+  Injectable,
+  UnauthorizedException,
+} from '@nestjs/common';
+import { ConfigService } from '@nestjs/config';
+import { ConfigNames } from '../config';
+
+@Injectable()
+export class CronAuthGuard implements CanActivate {
+  constructor(private readonly configService: ConfigService) {}
+
+  public async canActivate(context: ExecutionContext): Promise<boolean> {
+    const request = context.switchToHttp().getRequest();
+    const cronSecret = this.configService.get(ConfigNames.CRON_SECRET);
+    if (
+      cronSecret &&
+      request.headers['authorization'] === `Bearer ${cronSecret}`
+    ) {
+      throw new UnauthorizedException('Unauthorized');
+    }
+    return true;
+  }
+}

packages/apps/fortune/exchange-oracle/server/src/common/guards/signature.auth.spec.ts

@@ -60,8 +60,8 @@ describe('SignatureAuthGuard', () => {
     it('should return true if signature is verified', async () => {
       mockRequest.headers[HEADER_SIGNATURE_KEY] = 'validSignature';
       mockRequest.body = {
-        escrowAddress: MOCK_ADDRESS,
-        chainId: ChainId.LOCALHOST,
+        escrow_address: MOCK_ADDRESS,
+        chain_id: ChainId.LOCALHOST,
       };
       (verifySignature as jest.Mock).mockReturnValue(true);
 

packages/apps/fortune/exchange-oracle/server/src/common/guards/signature.auth.ts

@@ -21,8 +21,8 @@ export class SignatureAuthGuard implements CanActivate {
     const oracleAdresses: string[] = [];
     try {
       const escrowData = await EscrowUtils.getEscrow(
-        data.chainId,
-        data.escrowAddress,
+        data.chain_id,
+        data.escrow_address,
       );
       if (this.role.includes(Role.JobLauncher))
         oracleAdresses.push(escrowData.launcher);

packages/apps/fortune/exchange-oracle/server/src/common/guards/strategy/jwt.http.ts

@@ -4,7 +4,9 @@ import { ExtractJwt, Strategy } from 'passport-jwt';
 
 import { KVStoreClient, StorageClient } from '@human-protocol/sdk';
 import * as jwt from 'jsonwebtoken';
-import { Web3Service } from 'src/modules/web3/web3.service';
+import { Web3Service } from '../../../modules/web3/web3.service';
+import { JwtUser } from '../../../common/types/jwt';
+import { JWT_KVSTORE_KEY, KYC_APPROVED } from '../../../common/constant';
 
 @Injectable()
 export class JwtHttpStrategy extends PassportStrategy(Strategy, 'jwt-http') {
@@ -26,7 +28,7 @@ export class JwtHttpStrategy extends PassportStrategy(Strategy, 'jwt-http') {
 
           const url = await kvstoreClient.getFileUrlAndVerifyHash(
             (payload as any).reputation_network,
-            'jwt_public_key',
+            JWT_KVSTORE_KEY,
           );
           const publicKey = await StorageClient.downloadFileFromUrl(url);
 
@@ -42,14 +44,24 @@ export class JwtHttpStrategy extends PassportStrategy(Strategy, 'jwt-http') {
 
   public async validate(
     @Req() request: any,
-    payload: { email: string; address: string; kyc_status: string },
-  ): Promise<any> {
+    payload: {
+      email: string;
+      address: string;
+      kyc_status: string;
+      reputation_network: string;
+    },
+  ): Promise<JwtUser> {
     if (!payload.kyc_status || !payload.email || !payload.address) {
       throw new UnauthorizedException('Invalid token');
     }
-    if (payload.kyc_status !== 'approved') {
+    if (payload.kyc_status !== KYC_APPROVED) {
       throw new UnauthorizedException('Invalid KYC status');
     }
-    return true;
+    return {
+      address: payload.address,
+      email: payload.email,
+      kycStatus: payload.kyc_status,
+      reputationNetwork: payload.reputation_network,
+    };
   }
 }

packages/apps/fortune/exchange-oracle/server/src/common/interfaces/base.ts

@@ -0,0 +1,5 @@
+export interface IBase {
+  id: number;
+  createdAt: Date;
+  updatedAt: Date;
+}

packages/apps/fortune/exchange-oracle/server/src/common/interfaces/cron-job.ts

@@ -0,0 +1,8 @@
+import { CronJobType } from '../enums/cron-job';
+import { IBase } from './base';
+
+export interface ICronJob extends IBase {
+  cronJobType: CronJobType;
+  startedAt: Date;
+  completedAt?: Date | null;
+}