Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: use keccak chain ID #62

Merged
merged 4 commits into from
Oct 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion apps/agent/src/config/schemas.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Caip2ChainId, Caip2Utils } from "@ebo-agent/blocknumber";
import { Caip2ChainId, Caip2Utils } from "@ebo-agent/shared";
import { isAddress, isHex } from "viem";
import { z } from "zod";

Expand Down
8 changes: 6 additions & 2 deletions apps/agent/src/index.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,11 @@
import { inspect } from "util";
import { isNativeError } from "util/types";
import { EboActorsManager, EboProcessor, ProtocolProvider } from "@ebo-agent/automated-dispute";
import { DiscordNotifier } from "@ebo-agent/automated-dispute/src/services/index.js";
import {
DiscordNotifier,
EboActorsManager,
EboProcessor,
ProtocolProvider,
} from "@ebo-agent/automated-dispute";
import { BlockNumberService } from "@ebo-agent/blocknumber";
import { Logger } from "@ebo-agent/shared";

Expand Down
16 changes: 12 additions & 4 deletions apps/agent/test/e2e/scenarios/01_happy_path/index.spec.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
import { EboActorsManager, EboProcessor, ProtocolProvider } from "@ebo-agent/automated-dispute";
import { BlockNumberService, Caip2ChainId } from "@ebo-agent/blocknumber";
import { Logger } from "@ebo-agent/shared";
import {
EboActorsManager,
EboProcessor,
NotificationService,
ProtocolProvider,
} from "@ebo-agent/automated-dispute";
import { BlockNumberService } from "@ebo-agent/blocknumber";
import { Caip2ChainId, Logger } from "@ebo-agent/shared";
import { CreateServerReturnType } from "prool";
import {
Account,
Expand Down Expand Up @@ -89,7 +94,7 @@ describe.sequential("single agent", () => {
await setUpProphet({
accounts: accounts.map((account) => account.account),
arbitratorAddress: ARBITRATOR_ADDRESS,
chainsToAdd: ["eip155:42161"],
chainsToAdd: [ARBITRUM_ID],
anvilClient: createTestClient({
mode: "anvil",
transport: http(url),
Expand Down Expand Up @@ -163,6 +168,9 @@ describe.sequential("single agent", () => {
blockNumberService,
actorsManager,
logger,
{
notifyError: vi.fn(),
} as unknown as NotificationService,
);

const anvilClient = createTestClient({
Expand Down
2 changes: 1 addition & 1 deletion apps/agent/test/e2e/utils/prophet-e2e-scaffold/eboCore.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import assert from "assert";
import { Caip2ChainId } from "@ebo-agent/blocknumber";
import { Caip2ChainId } from "@ebo-agent/shared";
import { execa } from "execa";
import {
Account,
Expand Down
2 changes: 1 addition & 1 deletion packages/automated-dispute/src/exceptions/errorHandler.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { ILogger } from "@ebo-agent/shared";

import { CustomContractError } from "../exceptions/index.js";
import { NotificationService } from "../services/index.js";
import { NotificationService } from "../interfaces/index.js";

export class ErrorHandler {
private notificationService: NotificationService;
Expand Down
3 changes: 2 additions & 1 deletion packages/automated-dispute/src/external.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export { EboProcessor, EboActorsManager } from "./services/index.js";
export { EboProcessor, EboActorsManager, DiscordNotifier } from "./services/index.js";
export type { NotificationService } from "./interfaces/index.js";
export { ProtocolProvider } from "./providers/index.js";
export type { AccountingModules } from "./types/index.js";
1 change: 1 addition & 0 deletions packages/automated-dispute/src/interfaces/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
export * from "./eboRegistry.js";
export * from "./eboRegistryCommand.js";
export * from "./protocolProvider.js";
export * from "./notificationService.js";
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Caip2ChainId } from "@ebo-agent/blocknumber";
import { Caip2ChainId } from "@ebo-agent/shared";
import { Address, Block } from "viem";

import type {
Expand Down
3 changes: 1 addition & 2 deletions packages/automated-dispute/src/providers/protocolProvider.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { Caip2ChainId } from "@ebo-agent/blocknumber";
import { UnixTimestamp } from "@ebo-agent/shared";
import { Caip2ChainId, UnixTimestamp } from "@ebo-agent/shared";
import {
AbiEvent,
Address,
Expand Down
2 changes: 1 addition & 1 deletion packages/automated-dispute/src/services/discordNotifier.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { ILogger } from "@ebo-agent/shared";
import { Client, IntentsBitField, TextChannel } from "discord.js";
import { stringify } from "viem";

import { NotificationService } from "./notificationService.js";
import { NotificationService } from "../interfaces/index.js";

interface DiscordNotifierConfig {
discordBotToken: string;
Expand Down
16 changes: 11 additions & 5 deletions packages/automated-dispute/src/services/eboActor.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { BlockNumberService, Caip2ChainId } from "@ebo-agent/blocknumber";
import { Address, ILogger, UnixTimestamp } from "@ebo-agent/shared";
import { BlockNumberService } from "@ebo-agent/blocknumber";
import { Address, Caip2ChainId, Caip2Utils, ILogger, UnixTimestamp } from "@ebo-agent/shared";
import { Mutex } from "async-mutex";
import { Heap } from "heap-js";
import { ContractFunctionRevertedError } from "viem";
Expand Down Expand Up @@ -29,14 +29,13 @@ import {
ResponseNotFound,
UnknownEvent,
} from "../exceptions/index.js";
import { EboRegistry, EboRegistryCommand } from "../interfaces/index.js";
import { EboRegistry, EboRegistryCommand, NotificationService } from "../interfaces/index.js";
import { ProtocolProvider } from "../providers/index.js";
import {
AddDispute,
AddRequest,
AddResponse,
FinalizeRequest,
NotificationService,
UpdateDisputeStatus,
} from "../services/index.js";
import { ActorRequest } from "../types/index.js";
Expand Down Expand Up @@ -506,7 +505,14 @@ export class EboActor {
* @param event `RequestCreated` event
*/
private async onRequestCreated(event: EboEvent<"RequestCreated">): Promise<void> {
const { chainId } = event.metadata;
const { chainId: hashedChainId } = event.metadata;
const chainId = Caip2Utils.findByHash(hashedChainId);

if (chainId === undefined) {
this.logger.error(`Unsupported chain hash ${hashedChainId}`);

return;
}

try {
await this.proposeResponse(chainId);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@ import { Address, ILogger } from "@ebo-agent/shared";
import { Mutex } from "async-mutex";

import { RequestAlreadyHandled } from "../exceptions/index.js";
import { NotificationService } from "../interfaces/index.js";
import { ProtocolProvider } from "../providers/protocolProvider.js";
import { ActorRequest, RequestId } from "../types/index.js";
import { EboActor } from "./eboActor.js";
import { EboMemoryRegistry } from "./eboRegistry/eboMemoryRegistry.js";
import { NotificationService } from "./notificationService.js";

export class EboActorsManager {
private readonly requestActorMap: Map<RequestId, EboActor>;
Expand Down
38 changes: 15 additions & 23 deletions packages/automated-dispute/src/services/eboProcessor.ts
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
import { isNativeError } from "util/types";
import { BlockNumberService, Caip2ChainId } from "@ebo-agent/blocknumber";
import { Address, EBO_SUPPORTED_CHAIN_IDS, ILogger, UnixTimestamp } from "@ebo-agent/shared";
import { BlockNumberService } from "@ebo-agent/blocknumber";
import { Address, Caip2ChainId, Caip2Utils, ILogger, UnixTimestamp } from "@ebo-agent/shared";
import { Block } from "viem";

import { PendingModulesApproval, ProcessorAlreadyStarted } from "../exceptions/index.js";
import { isRequestCreatedEvent } from "../guards.js";
import { NotificationService } from "../interfaces/index.js";
import { ProtocolProvider } from "../providers/index.js";
import {
alreadyDeletedActorWarning,
Expand All @@ -20,7 +21,6 @@ import {
RequestId,
} from "../types/index.js";
import { EboActorsManager } from "./eboActorsManager.js";
import { NotificationService } from "./notificationService.js";

const DEFAULT_MS_BETWEEN_CHECKS = 10 * 60 * 1000; // 10 minutes

Expand Down Expand Up @@ -284,12 +284,16 @@ export class EboProcessor {
if (actor) return actor;

if (firstEvent && isRequestCreatedEvent(firstEvent)) {
const chainId = firstEvent.metadata.chainId;
const hashedChainId = firstEvent.metadata.chainId;
const chainId = Caip2Utils.findByHash(hashedChainId);

if (chainId) {
const requestId = Address.normalize(firstEvent.requestId) as RequestId;
const epoch = firstEvent.metadata.epoch;

if (this.isChainSupported(chainId)) {
this.logger.info(`Creating a new EboActor to handle request ${requestId}...`);

return this.createNewActor(firstEvent);
return this.createNewActor(requestId, epoch, chainId);
} else {
this.logger.warn(`Chain ${chainId} not supported by the agent. Skipping...`);

Expand All @@ -306,28 +310,13 @@ export class EboProcessor {
}
}

/**
* Returns true if the CAIP2 compliant chain ID is supported by the EBO agent.
*
* @param chainId CAIP2 chain ID
* @returns true if the chain is supported, otherwise false
*/
private isChainSupported(chainId: Caip2ChainId): boolean {
return EBO_SUPPORTED_CHAIN_IDS.includes(chainId);
}

/**
* Create a new actor based on the data provided by a `RequestCreated` event.
*
* @param event a `RequestCreated` event
* @returns a new `EboActor` instance, `null` if the actor was not created
*/
private createNewActor(event: EboEvent<"RequestCreated">) {
const actorRequest: ActorRequest = {
id: Address.normalize(event.requestId) as RequestId,
epoch: event.metadata.epoch,
chainId: event.metadata.chainId,
};
private createNewActor(id: RequestId, epoch: bigint, chainId: Caip2ChainId) {
const actorRequest: ActorRequest = { id, epoch, chainId };

const actor = this.actorsManager.createActor(
actorRequest,
Expand Down Expand Up @@ -404,6 +393,9 @@ export class EboProcessor {
this.logger.error(
`Could not create a request for epoch ${epoch} and chain ${chain}.`,
);

this.logger.error(err as Error);

await this.notifier.notifyError(err as Error, {
message: `Could not create a request for epoch ${epoch} and chain ${chain}.`,
epoch,
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
import { UnsupportedChain } from "@ebo-agent/blocknumber";
import { Caip2Utils } from "@ebo-agent/shared";

import { CommandAlreadyRun, CommandNotRun } from "../../../exceptions/index.js";
import { EboRegistry, EboRegistryCommand } from "../../../interfaces/index.js";
import { ProtocolProvider } from "../../../providers/index.js";
Expand All @@ -17,9 +20,14 @@ export class AddRequest implements EboRegistryCommand {
): AddRequest {
// @ts-expect-error: must fetch request differently
const eventRequest = event.metadata.request;
const chainId = Caip2Utils.findByHash(event.metadata.chainId);

if (chainId === undefined) throw new UnsupportedChain(event.metadata.chainId);

const request: Request = {
id: event.requestId,
chainId: event.metadata.chainId,
// TODO: move chainId and epoch into decodedData + add request property to it
chainId: chainId,
epoch: event.metadata.epoch,
createdAt: {
timestamp: event.timestamp,
Expand Down
1 change: 0 additions & 1 deletion packages/automated-dispute/src/services/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,4 @@ export * from "./eboActor.js";
export * from "./eboActorsManager.js";
export * from "./eboProcessor.js";
export * from "./eboRegistry/index.js";
export * from "./notificationService.js";
export * from "./discordNotifier.js";
2 changes: 1 addition & 1 deletion packages/automated-dispute/src/types/actorRequest.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Caip2ChainId } from "@ebo-agent/blocknumber";
import { Caip2ChainId } from "@ebo-agent/shared";

import { RequestId } from "./prophet.js";

Expand Down
3 changes: 1 addition & 2 deletions packages/automated-dispute/src/types/events.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
import { Caip2ChainId } from "@ebo-agent/blocknumber";
import { UnixTimestamp } from "@ebo-agent/shared";
import { Address, Hex, Log } from "viem";

Expand All @@ -20,7 +19,7 @@ export interface ResponseProposed {

export interface RequestCreated {
epoch: bigint;
chainId: Caip2ChainId;
chainId: Hex; // keccak256 CAIP-2 chain ID
requestId: RequestId;
}

Expand Down
3 changes: 1 addition & 2 deletions packages/automated-dispute/src/types/prophet.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import { Caip2ChainId } from "@ebo-agent/blocknumber";
import { Branded, NormalizedAddress, UnixTimestamp } from "@ebo-agent/shared";
import { Branded, Caip2ChainId, NormalizedAddress, UnixTimestamp } from "@ebo-agent/shared";
import { Address, Hex } from "viem";

export type RequestId = Branded<NormalizedAddress, "RequestId">;
Expand Down
2 changes: 1 addition & 1 deletion packages/automated-dispute/tests/guards.spec.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Caip2ChainId } from "@ebo-agent/blocknumber";
import { Caip2ChainId } from "@ebo-agent/shared";
import { describe, expect, it } from "vitest";

import { isRequestCreatedEvent } from "../src/guards.js";
Expand Down
6 changes: 3 additions & 3 deletions packages/automated-dispute/tests/services/eboActor.spec.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { UnixTimestamp } from "@ebo-agent/shared";
import { Abi, ContractFunctionRevertedError, encodeErrorResult } from "viem";
import { Abi, ContractFunctionRevertedError, encodeErrorResult, keccak256, toHex } from "viem";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";

import {
Expand All @@ -25,7 +25,7 @@ describe("EboActor", () => {
timestamp: BigInt(Date.UTC(2024, 0, 1, 0, 0, 0) / 1000) as UnixTimestamp,
requestId: request.id,
metadata: {
chainId: request.chainId,
chainId: keccak256(toHex(request.chainId)),
epoch: request.epoch,
requestId: request.id,
request: request.prophetData,
Expand Down Expand Up @@ -452,7 +452,7 @@ describe("EboActor", () => {
timestamp: BigInt(Date.UTC(2024, 0, 1, 0, 0, 0) / 1000) as UnixTimestamp,
requestId: request.id,
metadata: {
chainId: request.chainId,
chainId: keccak256(toHex(request.chainId)),
epoch: request.epoch,
requestId: request.id,
request: request.prophetData,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,12 +24,14 @@ export const DEFAULT_MOCKED_PROTOCOL_CONTRACTS: ProtocolContractsAddresses = {

export const DEFAULT_MOCKED_RESPONSE_DATA: Response = {
id: "0x1234567890123456789012345678901234567890" as ResponseId,
createdAt: 1625097600n,
createdAt: {
timestamp: 1625097600n as UnixTimestamp,
blockNumber: 1n,
logIndex: 0,
},
decodedData: {
response: {
chainId: "eip155:1",
block: 123456n,
epoch: 1n,
},
},
prophetData: {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { Caip2ChainId } from "@ebo-agent/blocknumber";
import { ILogger } from "@ebo-agent/shared";
import { Caip2ChainId, ILogger, UnixTimestamp } from "@ebo-agent/shared";
import { keccak256, toHex } from "viem";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";

import { ResponseAlreadyProposed } from "../../../src/exceptions/index.js";
Expand Down Expand Up @@ -28,7 +28,7 @@ describe("EboActor", () => {
const protocolEpoch: Epoch = {
number: request.epoch,
firstBlockNumber: 1n,
startTimestamp: BigInt(Date.UTC(2024, 1, 1, 0, 0, 0, 0)),
startTimestamp: BigInt(Date.UTC(2024, 1, 1, 0, 0, 0, 0)) as UnixTimestamp,
};

const requestCreatedEvent: EboEvent<"RequestCreated"> = {
Expand All @@ -37,7 +37,7 @@ describe("EboActor", () => {
logIndex: 1,
name: "RequestCreated",
metadata: {
chainId: indexedChainId,
chainId: keccak256(toHex(indexedChainId)),
epoch: protocolEpoch.number,
requestId: requestId,
request: request.prophetData,
Expand Down Expand Up @@ -90,8 +90,6 @@ describe("EboActor", () => {
requestId: requestCreatedEvent.metadata.requestId,
response: ProtocolProvider.encodeResponse({
block: indexedEpochBlockNumber,
chainId: requestCreatedEvent.metadata.chainId,
epoch: protocolEpoch.number,
}),
}),
);
Expand Down
Loading