feat: unify metadata information

Renamed `originSettler` in Hyperlane7683 to `intentSources` and moved
the type definition to the `BaseMetadataSchema`.

Co-authored-by: Lisandro Corbalan <lisandro@bootnode.dev>

Author: fernandomg

typescript/solver/solvers/eco/types.ts

@@ -5,36 +5,12 @@ import type { IntentCreatedEventObject } from "../../typechain/eco/contracts/Int
 import { BaseMetadataSchema } from "../types.js";
 
 export const EcoMetadataSchema = BaseMetadataSchema.extend({
-  protocolName: z.string(),
-  intentSources: z.array(
-    z.object({
-      address: addressSchema,
-      chainName: z.string().refine((name) => chainNames.includes(name), {
-        message: "Invalid chainName",
-      }),
-      pollInterval: z.number().optional(),
-      confirmationBlocks: z.number().optional(),
-      initialBlock: z.number().optional(),
-      processedIds: z.array(z.string()).optional(),
-    }),
-  ),
   adapters: z.record(
     z.string().refine((name) => chainNames.includes(name), {
       message: "Invalid chainName",
     }),
     addressSchema,
   ),
-  customRules: z
-    .object({
-      rules: z.array(
-        z.object({
-          name: z.string(),
-          args: z.array(z.any()).optional(),
-        }),
-      ),
-      keepBaseRules: z.boolean().optional(),
-    })
-    .optional(),
 });
 
 export type EcoMetadata = z.infer<typeof EcoMetadataSchema>;

typescript/solver/solvers/hyperlane7683/config/metadata.ts

@@ -5,7 +5,7 @@ import {
 
 const metadata: Hyperlane7683Metadata = {
   protocolName: "Hyperlane7683",
-  originSettlers: [
+  intentSources: [
     // mainnet
     // {
     //   address: "0x5F69f9aeEB44e713fBFBeb136d712b22ce49eb88",

typescript/solver/solvers/hyperlane7683/listener.ts

@@ -17,8 +17,8 @@ export class Hyperlane7683Listener extends BaseListener<
   OpenEventArgs
 > {
   constructor(metadata: Hyperlane7683Metadata) {
-    const { originSettlers, protocolName } = metadata;
-    const hyperlane7683Metadata = { contracts: originSettlers, protocolName };
+    const { intentSources, protocolName } = metadata;
+    const hyperlane7683Metadata = { contracts: intentSources, protocolName };
 
     super(Hyperlane7683__factory, "Open", hyperlane7683Metadata, log);
   }
@@ -40,24 +40,24 @@ export class Hyperlane7683Listener extends BaseListener<
 }
 
 export const create = async () => {
-  const { originSettlers } = metadata;
+  const { intentSources } = metadata;
   const blocksByChain = await getLastIndexedBlocks();
 
-  metadata.originSettlers = originSettlers.map((originSettler) => {
+  metadata.intentSources = intentSources.map((intentSource) => {
     const chainBlockNumber =
-      blocksByChain[originSettler.chainName]?.blockNumber;
+      blocksByChain[intentSource.chainName]?.blockNumber;
 
     if (
       chainBlockNumber &&
-      chainBlockNumber >= (originSettler.initialBlock ?? 0)
+      chainBlockNumber >= (intentSource.initialBlock ?? 0)
     ) {
       return {
-        ...originSettler,
-        initialBlock: blocksByChain[originSettler.chainName].blockNumber,
-        processedIds: blocksByChain[originSettler.chainName].processedIds,
+        ...intentSource,
+        initialBlock: blocksByChain[intentSource.chainName].blockNumber,
+        processedIds: blocksByChain[intentSource.chainName].processedIds,
       };
     }
-    return originSettler;
+    return intentSource;
   });
 
   return new Hyperlane7683Listener(metadata).create();

typescript/solver/solvers/hyperlane7683/types.ts

@@ -1,7 +1,6 @@
 import type { BigNumber } from "ethers";
 import z from "zod";
-import { chainNames } from "../../config/index.js";
-import { addressSchema } from "../../config/types.js";
+
 import type { OpenEventObject } from "../../typechain/hyperlane7683/contracts/Hyperlane7683.js";
 import { BaseMetadataSchema } from "../types.js";
 
@@ -42,19 +41,6 @@ export type IntentData = {
   maxSpent: ResolvedCrossChainOrder["maxSpent"];
 };
 
-export const Hyperlane7683MetadataSchema = BaseMetadataSchema.extend({
-  originSettlers: z.array(
-    z.object({
-      address: addressSchema,
-      chainName: z.string().refine((name) => chainNames.includes(name), {
-        message: "Invalid chainName",
-      }),
-      pollInterval: z.number().optional(),
-      confirmationBlocks: z.number().optional(),
-      initialBlock: z.number().optional(),
-      processedIds: z.array(z.string()).optional(),
-    }),
-  ),
-});
+export const Hyperlane7683MetadataSchema = BaseMetadataSchema.extend({});
 
 export type Hyperlane7683Metadata = z.infer<typeof Hyperlane7683MetadataSchema>;

typescript/solver/solvers/types.ts

@@ -1,6 +1,8 @@
 import { isValidAddress } from "@hyperlane-xyz/utils";
 import z from "zod";
 
+import { chainNames } from "../config/index.js";
+
 export const addressSchema = z
   .string()
   .refine((address) => isValidAddress(address), {
@@ -9,6 +11,18 @@ export const addressSchema = z
 
 export const BaseMetadataSchema = z.object({
   protocolName: z.string(),
+  intentSources: z.array(
+    z.object({
+      address: addressSchema,
+      chainName: z.string().refine((name) => chainNames.includes(name), {
+        message: "Invalid chainName",
+      }),
+      pollInterval: z.number().optional(),
+      confirmationBlocks: z.number().optional(),
+      initialBlock: z.number().optional(),
+      processedIds: z.array(z.string()).optional(),
+    }),
+  ),
   customRules: z
     .object({
       rules: z.array(