WIP: copy indexer deposits data to scraper db

docker-compose.yml

@@ -1,5 +1,9 @@
 version: "3.7"
 
+networks:
+  test-network:
+    external: true
+
 services:
   backend:
     container_name: scraper-api-backend
@@ -18,6 +22,8 @@ services:
     depends_on:
       - postgres
       - redis
+    networks:
+      - test-network
   postgres:
     container_name: scraper-api-postgres
     image: postgres:12.2
@@ -27,21 +33,26 @@ services:
       POSTGRES_PASSWORD: ${DB_PASSWORD}
       POSTGRES_DB: ${DB_DATABASE_NAME}
       PG_DATA: /var/lib/postgresql/data
+    command: ["postgres", "-c", "log_statement=all"]
     ports:
-      - 5432:5432
+      - 5433:5432
     volumes:
       - scraper-api-pgdata:/var/lib/postgresql/data
+    networks:
+      - test-network
   redis:
     container_name: scraper-api-redis
     image: redis:6.2-alpine
     restart: always
     ports:
-      - 6379:6379
+      - 6378:6379
     command: ["redis-server", "--appendonly", "yes"]
     environment:
       REDIS_PASSWORD: ${REDIS_PASSWORD}
     volumes:
       - scraper-api-redis-volume:/data
+    networks:
+      - test-network
 volumes:
   backend-node-modules:
   scraper-api-pgdata:

migrations/1735003840563-rewardedDeposit.ts

@@ -0,0 +1,35 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class RewardedDeposit1735003840563 implements MigrationInterface {
+    name = 'RewardedDeposit1735003840563';
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`
+        CREATE TABLE "rewarded_deposit" (
+            "id" SERIAL NOT NULL,
+            "relayHash" character varying NOT NULL,
+            "depositTxHash" character varying NOT NULL,
+            "depositId" integer NOT NULL,
+            "originChainId" integer NOT NULL,
+            "destinationChainId" integer NOT NULL,
+            "depositor" character varying NOT NULL,
+            "recipient" character varying NOT NULL,
+            "inputToken" character varying NOT NULL,
+            "inputAmount" character varying NOT NULL,
+            "outputToken" character varying NOT NULL,
+            "outputAmount" character varying NOT NULL,
+            "exclusiveRelayer" character varying NOT NULL,
+            "depositDate" TIMESTAMP NOT NULL,
+            "fillTxHash" character varying NOT NULL,
+            "relayer" character varying NOT NULL,
+            "totalBridgeFeeUsd" character varying NOT NULL,
+            "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+            CONSTRAINT "UK_rewardedDeposit_depositId_originChainId" UNIQUE ("depositId", "originChainId"),
+            CONSTRAINT "PK_891e96cd023b61f620566c0898a" PRIMARY KEY ("id"))`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`DROP TABLE "rewarded_deposit"`);
+    }
+
+}

migrations/1735659642491-OpRewardV2.ts

@@ -0,0 +1,38 @@
+import { MigrationInterface, QueryRunner } from "typeorm";
+
+export class OpRewardV21735659642491 implements MigrationInterface {
+    name = 'OpRewardV21735659642491';
+
+    public async up(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`CREATE TABLE "op_reward_v2" (
+            "id" SERIAL NOT NULL,
+            "depositId" integer NOT NULL,
+            "originChainId" integer NOT NULL,
+            "depositDate" TIMESTAMP NOT NULL,
+            "recipient" character varying NOT NULL,
+            "rate" numeric NOT NULL,
+            "amount" character varying NOT NULL,
+            "amountUsd" character varying NOT NULL,
+            "rewardTokenId" integer NOT NULL,
+            "windowIndex" integer,
+            "isClaimed" boolean NOT NULL DEFAULT false,
+            "createdAt" TIMESTAMP NOT NULL DEFAULT now(),
+            "updatedAt" TIMESTAMP NOT NULL DEFAULT now(),
+            CONSTRAINT "UK_opRewardV2_recipient_depId_chainId" UNIQUE ("recipient", "depositId", "originChainId"),
+            CONSTRAINT "REL_f057b9c78adeb22f4f4fb69ea8" UNIQUE ("depositId", "originChainId"),
+            CONSTRAINT "PK_fc4c022f3de3d4170ae8200c76b" PRIMARY KEY ("id"))
+            `,
+        );
+        await queryRunner.query(`CREATE INDEX "IX_op_reward_v2_recipient" ON "op_reward_v2" ("recipient") `);
+        await queryRunner.query(`ALTER TABLE "op_reward_v2" ADD CONSTRAINT "FK_op_reward_deposit" FOREIGN KEY ("depositId", "originChainId") REFERENCES "rewarded_deposit"("depositId","originChainId") ON DELETE NO ACTION ON UPDATE NO ACTION`);
+        await queryRunner.query(`ALTER TABLE "op_reward_v2" ADD CONSTRAINT "FK_op_reward_token" FOREIGN KEY ("rewardTokenId") REFERENCES "token"("id") ON DELETE NO ACTION ON UPDATE NO ACTION`);
+    }
+
+    public async down(queryRunner: QueryRunner): Promise<void> {
+        await queryRunner.query(`ALTER TABLE "op_reward_v2" DROP CONSTRAINT "FK_op_reward_token"`);
+        await queryRunner.query(`ALTER TABLE "op_reward_v2" DROP CONSTRAINT "FK_op_reward_deposit"`);
+        await queryRunner.query(`DROP INDEX "public"."IX_op_reward_v2_recipient"`);
+        await queryRunner.query(`DROP TABLE "op_reward_v2"`);
+    }
+
+}

src/modules/database/database.providers.ts

@@ -32,6 +32,8 @@ import { ArbReward } from "../rewards/model/arb-reward.entity";
 import { FindMissedFillEventJob } from "../scraper/model/FindMissedFillEventJob.entity";
 import { HubPoolProcessedBlock } from "../scraper/model/HubPoolProcessedBlock.entity";
 import { SetPoolRebalanceRouteEvent } from "../web3/model/SetPoolRebalanceRouteEvent.entity";
+import { RewardedDeposit } from "../rewards/model/RewardedDeposit.entity";
+import { OpRewardV2 } from "../rewards/model/OpRewardV2.entity";
 
 // TODO: Add db entities here
 const entities = [
@@ -66,6 +68,8 @@ const entities = [
   FindMissedFillEventJob,
   HubPoolProcessedBlock,
   SetPoolRebalanceRouteEvent,
+  RewardedDeposit,
+  OpRewardV2,
 ];
 
 @Injectable()

src/modules/rewards/model/OpRewardV2.entity.ts

@@ -0,0 +1,70 @@
+import { Token } from "../../web3/model/token.entity";
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  Index,
+  JoinColumn,
+  ManyToOne,
+  OneToOne,
+  PrimaryGeneratedColumn,
+  Unique,
+  UpdateDateColumn,
+} from "typeorm";
+import { RewardedDeposit } from "./RewardedDeposit.entity";
+
+@Entity()
+@Unique("UK_opRewardV2_recipient_depId_chainId", ["recipient", "depositId", "originChainId"])
+@Index("IX_op_reward_v2_recipient", ["recipient"])
+export class OpRewardV2 {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @Column()
+  depositId: number;
+
+  @Column()
+  originChainId: number;
+
+  @OneToOne(() => RewardedDeposit)
+  @JoinColumn([
+    { name: "depositId", referencedColumnName: "depositId", foreignKeyConstraintName: "FK_op_reward_deposit" },
+    { name: "originChainId", referencedColumnName: "originChainId", foreignKeyConstraintName: "FK_op_reward_deposit" },
+  ])
+  deposit: RewardedDeposit;
+
+  @Column()
+  depositDate: Date;
+
+  @Column()
+  recipient: string;
+
+  @Column({ type: "decimal" })
+  rate: string;
+
+  @Column()
+  amount: string;
+
+  @Column()
+  amountUsd: string;
+
+  @Column()
+  rewardTokenId: number;
+
+  @ManyToOne(() => Token)
+  @JoinColumn([{ name: "rewardTokenId", referencedColumnName: "id", foreignKeyConstraintName: "FK_op_reward_token" }])
+  rewardToken: Token;
+
+  // The window index set in the MerkleDistributor contract
+  @Column({ nullable: true })
+  windowIndex: number;
+
+  @Column({ default: false })
+  isClaimed: boolean;
+
+  @CreateDateColumn()
+  createdAt: Date;
+
+  @UpdateDateColumn()
+  updatedAt: Date;
+}

src/modules/rewards/model/RewardedDeposit.entity.ts

@@ -0,0 +1,68 @@
+import {
+  Column,
+  CreateDateColumn,
+  Entity,
+  PrimaryGeneratedColumn,
+  Unique,
+} from "typeorm";
+
+@Entity()
+@Unique("UK_rewardedDeposit_depositId_originChainId", [
+  "depositId",
+  "originChainId",
+])
+export class RewardedDeposit {
+  @PrimaryGeneratedColumn()
+  id: number;
+
+  @Column()
+  relayHash: string;
+
+  @Column()
+  depositTxHash: string;
+
+  @Column()
+  depositId: number;
+
+  @Column()
+  originChainId: number;
+
+  @Column()
+  destinationChainId: number;
+
+  @Column()
+  depositor: string;
+
+  @Column()
+  recipient: string;
+
+  @Column()
+  inputToken: string;
+
+  @Column()
+  inputAmount: string;
+
+  @Column()
+  outputToken: string;
+
+  @Column()
+  outputAmount: string;
+
+  @Column()
+  exclusiveRelayer: string;
+
+  @Column()
+  depositDate: Date;
+
+  @Column()
+  fillTxHash: string;
+
+  @Column()
+  relayer: string;
+
+  @Column()
+  totalBridgeFeeUsd: string;
+
+  @CreateDateColumn()
+  createdAt: Date;
+}

src/modules/rewards/module.ts

@@ -22,19 +22,26 @@ import { RewardsWindowJobFixture } from "./adapter/db/rewards-window-job-fixture
 import { ArbRebateService } from "./services/arb-rebate-service";
 import { ArbReward } from "./model/arb-reward.entity";
 import { ArbRewardFixture } from "./adapter/db/arb-reward-fixture";
+import { RewardedDeposit } from "./model/RewardedDeposit.entity";
+import { OpRewardV2 } from "./model/OpRewardV2.entity";
+import { OpRebateServiceV2 } from "./services/opRebateServiceV2";
 
 @Module({})
 export class RewardModule {
   static forRoot(moduleOptions: ModuleOptions): DynamicModule {
     const module: DynamicModule = {
       module: RewardModule,
       controllers: [RewardController],
-      providers: [RewardService, OpRebateService, ReferralService, ReferralRewardsService, ArbRebateService],
+      providers: [
+        ArbRebateService, OpRebateService, OpRebateServiceV2, ReferralService, ReferralRewardsService, RewardService,
+      ],
       imports: [
         TypeOrmModule.forFeature([
           Deposit,
           OpReward,
+          OpRewardV2,
           DepositsMv,
+          RewardedDeposit,
           RewardsWindowJob,
           ReferralRewardsWindowJobResult,
           ArbReward,
@@ -44,7 +51,7 @@ export class RewardModule {
         ReferralModule.forRoot(moduleOptions),
         MarketPriceModule.forRoot(),
       ],
-      exports: [RewardService, OpRebateService, ReferralService, ArbRebateService],
+      exports: [ArbRebateService, OpRebateService, OpRebateServiceV2, ReferralService, RewardService],
     };
 
     if (moduleOptions.runModes.includes(RunMode.Test)) {

src/modules/rewards/services/op-rebate-service.ts

@@ -19,7 +19,7 @@ import { ReferralRewardsWindowJobResult } from "../model/RewardsWindowJobResult.
 
 const OP_REBATE_RATE = 0.95;
 const REWARDS_PERCENTAGE_LIMIT = 0.0025; // 25 bps
-const ELIGIBLE_OP_REWARDS_CHAIN_IDS = [
+export const ELIGIBLE_OP_REWARDS_CHAIN_IDS = [
   ChainIds.base,
   ChainIds.lisk,
   ChainIds.mode,