feat: add bond escalation module

defi-wonderland · Sep 17, 2024 · f4a2378 · f4a2378
1 parent 3d049da
commit f4a2378
Show file tree

Hide file tree

Showing 6 changed files with 1,764 additions and 11 deletions.
diff --git a/apps/agent/src/index.ts b/apps/agent/src/index.ts
@@ -12,6 +12,7 @@ const config = {
             oracle: "0x00",
             epochManager: "0x00",
             eboRequestCreator: "0x00",
+            bondEscalationModule: "0x00",
         } as const,
         privateKey: "0xsecret" as const,
     },

diff --git a/packages/automated-dispute/src/abis/bondEscalationModule.ts b/packages/automated-dispute/src/abis/bondEscalationModule.ts
diff --git a/packages/automated-dispute/src/abis/index.ts b/packages/automated-dispute/src/abis/index.ts
@@ -1,3 +1,4 @@
 export * from "./oracle.js";
 export * from "./epochManager.js";
 export * from "./eboRequestCreator.js";
+export * from "./bondEscalationModule.js";
diff --git a/packages/automated-dispute/src/constants.ts b/packages/automated-dispute/src/constants.ts
@@ -1 +1,6 @@
-export const ProtocolContractsNames = ["oracle", "epochManager", "eboRequestCreator"] as const;
+export const ProtocolContractsNames = [
+    "oracle",
+    "epochManager",
+    "eboRequestCreator",
+    "bondEscalationModule",
+] as const;
diff --git a/packages/automated-dispute/src/providers/protocolProvider.ts b/packages/automated-dispute/src/providers/protocolProvider.ts
@@ -19,7 +19,12 @@ import { privateKeyToAccount } from "viem/accounts";
 import { arbitrum } from "viem/chains";
 
 import type { Dispute, EboEvent, EboEventName, Epoch, Request, Response } from "../types/index.js";
-import { eboRequestCreatorAbi, epochManagerAbi, oracleAbi } from "../abis/index.js";
+import {
+    bondEscalationModuleAbi,
+    eboRequestCreatorAbi,
+    epochManagerAbi,
+    oracleAbi,
+} from "../abis/index.js";
 import {
     InvalidAccountOnClient,
     RpcUrlsEmpty,
@@ -56,6 +61,11 @@ export class ProtocolProvider implements IProtocolProvider {
         typeof this.writeClient,
         Address
     >;
+    private bondEscalationContract: GetContractReturnType<
+        typeof bondEscalationModuleAbi,
+        typeof this.writeClient,
+        Address
+    >;
 
     /**
      * Creates a new ProtocolProvider instance
@@ -114,6 +124,14 @@ export class ProtocolProvider implements IProtocolProvider {
                 wallet: this.writeClient,
             },
         });
+        this.bondEscalationContract = getContract({
+            address: contracts.bondEscalationModule,
+            abi: bondEscalationModuleAbi,
+            client: {
+                public: this.readClient,
+                wallet: this.writeClient,
+            },
+        });
     }
 
     public write: IWriteProvider = {
@@ -418,8 +436,8 @@ export class ProtocolProvider implements IProtocolProvider {
     ): Promise<void> {
         try {
             const { request: simulatedRequest } = await this.readClient.simulateContract({
-                address: this.oracleContract.address,
-                abi: oracleAbi,
+                address: this.bondEscalationContract.address,
+                abi: bondEscalationModuleAbi,
                 functionName: "pledgeForDispute",
                 args: [request, dispute],
                 account: this.writeClient.account,
@@ -464,8 +482,8 @@ export class ProtocolProvider implements IProtocolProvider {
     ): Promise<void> {
         try {
             const { request: simulatedRequest } = await this.readClient.simulateContract({
-                address: this.oracleContract.address,
-                abi: oracleAbi,
+                address: this.bondEscalationContract.address,
+                abi: bondEscalationModuleAbi,
                 functionName: "pledgeAgainstDispute",
                 args: [request, dispute],
                 account: this.writeClient.account,
@@ -512,8 +530,8 @@ export class ProtocolProvider implements IProtocolProvider {
     ): Promise<void> {
         try {
             const { request: simulatedRequest } = await this.readClient.simulateContract({
-                address: this.oracleContract.address,
-                abi: oracleAbi,
+                address: this.bondEscalationContract.address,
+                abi: bondEscalationModuleAbi,
                 functionName: "settleBondEscalation",
                 args: [request, response, dispute],
                 account: this.writeClient.account,

diff --git a/packages/automated-dispute/tests/services/protocolProvider.spec.ts b/packages/automated-dispute/tests/services/protocolProvider.spec.ts
@@ -11,9 +11,12 @@ import { privateKeyToAccount } from "viem/accounts";
 import { arbitrum } from "viem/chains";
 import { afterEach, beforeEach, describe, expect, it, Mock, vi } from "vitest";
 
-import { eboRequestCreatorAbi } from "../../src/abis/eboRequestCreator.js";
-import { epochManagerAbi } from "../../src/abis/epochManager.js";
-import { oracleAbi } from "../../src/abis/oracle.js";
+import {
+    bondEscalationModuleAbi,
+    eboRequestCreatorAbi,
+    epochManagerAbi,
+    oracleAbi,
+} from "../../src/abis/index.js";
 import {
     InvalidAccountOnClient,
     RpcUrlsEmpty,
@@ -46,6 +49,7 @@ describe("ProtocolProvider", () => {
         oracle: "0x1234567890123456789012345678901234567890",
         epochManager: "0x1234567890123456789012345678901234567890",
         eboRequestCreator: "0x1234567890123456789012345678901234567890",
+        bondEscalationModule: "0x1234567890123456789012345678901234567890",
     };
 
     beforeEach(() => {
@@ -71,6 +75,18 @@ describe("ProtocolProvider", () => {
                     },
                 };
             }
+            if (
+                abi === bondEscalationModuleAbi &&
+                address === mockContractAddress.bondEscalationModule
+            ) {
+                return {
+                    write: {
+                        pledgeForDispute: vi.fn(),
+                        pledgeAgainstDispute: vi.fn(),
+                        settleDispute: vi.fn(),
+                    },
+                };
+            }
             throw new Error("Invalid contract address or ABI");
         });
 
@@ -487,6 +503,7 @@ describe("ProtocolProvider", () => {
             oracle: "0x1234567890123456789012345678901234567890",
             epochManager: "0x1234567890123456789012345678901234567890",
             eboRequestCreator: "0x1234567890123456789012345678901234567890",
+            bondEscalationModule: "0x1234567890123456789012345678901234567890",
         };
 
         it("creates a request successfully", async () => {
@@ -529,6 +546,7 @@ describe("ProtocolProvider", () => {
                     oracle: "0x1234567890123456789012345678901234567890",
                     epochManager: "0x1234567890123456789012345678901234567890",
                     eboRequestCreator: "0x1234567890123456789012345678901234567890",
+                    bondEscalationModule: "0x1234567890123456789012345678901234567890",
                 },
                 mockedPrivateKey,
             );