refactor: customRules args as a record

Changed customRules args for `filterByTokensAndAmount`, which required a modification in the function implementation and args processing.

Also, modified the error messages to be more granular and detailed on what was filtered.

Finally, enabled testnets as default config.

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

Author: fernandomg

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

@@ -1,3 +1,5 @@
+import { AddressZero } from "@ethersproject/constants";
+
 import {
   type Hyperlane7683Metadata,
   Hyperlane7683MetadataSchema,
@@ -15,14 +17,14 @@ const metadata: Hyperlane7683Metadata = {
     //   address: "0x9245A985d2055CeA7576B293Da8649bb6C5af9D0",
     //   chainName: "optimism",
     // },
-    {
-      address: "0x9245A985d2055CeA7576B293Da8649bb6C5af9D0",
-      chainName: "arbitrum",
-    },
-    {
-      address: "0x9245A985d2055CeA7576B293Da8649bb6C5af9D0",
-      chainName: "base",
-    },
+    // {
+    //   address: "0x9245A985d2055CeA7576B293Da8649bb6C5af9D0",
+    //   chainName: "arbitrum",
+    // },
+    // {
+    //   address: "0x9245A985d2055CeA7576B293Da8649bb6C5af9D0",
+    //   chainName: "base",
+    // },
     // {
     //   address: "0x9245A985d2055CeA7576B293Da8649bb6C5af9D0",
     //   chainName: "gnosis",
@@ -45,54 +47,54 @@ const metadata: Hyperlane7683Metadata = {
     // },
 
     // testnet
-    // {
-    //   address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
-    //   chainName: "optimismsepolia",
-    // },
-    // {
-    //   address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
-    //   chainName: "arbitrumsepolia",
-    // },
-    // {
-    //   address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
-    //   chainName: "sepolia",
-    // },
-    // {
-    //   address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
-    //   chainName: "basesepolia",
-    // },
-    // {
-    //   address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
-    //   chainName: "basesepolia",
-    //   initialBlock: 21491220,
-    //   pollInterval: 1000,
-    //   confirmationBlocks: 2,
-    // },
+    {
+      address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
+      chainName: "optimismsepolia",
+    },
+    {
+      address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
+      chainName: "arbitrumsepolia",
+    },
+    {
+      address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
+      chainName: "sepolia",
+    },
+    {
+      address: "0x6d2175B89315A9EB6c7eA71fDE54Ac0f294aDC34",
+      chainName: "basesepolia",
+      initialBlock: 21491220,
+      pollInterval: 1000,
+      confirmationBlocks: 2,
+    },
   ],
   customRules: {
     rules: [
       {
         name: "filterByTokenAndAmount",
-        args: [
-          {
-            // "1": ["0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48"],
-            // "10": ["0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85"],
-            "42161": ["0xaf88d065e77c8cC2239327C5EDb3A432268e5831"],
-            "8453": ["0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913"],
-            // "100": ["0x2a22f9c3b484c3629090feed35f17ff8f88f76f0"],
-            // "80094": ["0x549943e04f40284185054145c6E4e9568C1D3241"],
-            // "478": ["0xFBf489bb4783D4B1B2e7D07ba39873Fb8068507D"],
-            // "130": ["0x078D782b760474a361dDA0AF3839290b0EF57AD6"],
-            // "11820": ["0x8d9Bd7E9ec3cd799a659EE650DfF6C799309fA91"],
+        args: {
+          "11155420": {
+            "0x5f94BC7Fb4A2779fef010F96b496cD36A909E818": BigInt(50e18),
+            [AddressZero]: BigInt(5e15),
           },
-          BigInt(50e6)
-        ]
+          "84532": {
+            "0x5f94BC7Fb4A2779fef010F96b496cD36A909E818": BigInt(50e18),
+            [AddressZero]: BigInt(5e15),
+          },
+          "421614": {
+            "0xaf88d065e77c8cC2239327C5EDb3A432268e5831": null,
+            [AddressZero]: BigInt(5e15),
+          },
+          "11155111": {
+            "0x5f94BC7Fb4A2779fef010F96b496cD36A909E818": BigInt(5e18),
+            [AddressZero]: BigInt(5e10),
+          },
+        },
       },
       {
-        name: "intentNotFilled"
-      }
-    ]
-  }
+        name: "intentNotFilled",
+      },
+    ],
+  },
 };
 
 Hyperlane7683MetadataSchema.parse(metadata);

typescript/solver/solvers/hyperlane7683/rules/filterByTokenAndAmount.ts

@@ -1,51 +1,78 @@
+import { MaxUint256 } from "@ethersproject/constants";
 import { bytes32ToAddress } from "@hyperlane-xyz/utils";
 import z from "zod";
 
 import { Hyperlane7683Rule } from "../filler.js";
 
-const FilterByTokenAndAmountArgs = z.union([
-  z.tuple([
-    z.record(z.string(), z.array(z.string()).nonempty()),
-    z
-      .bigint()
-      .optional()
-      .refine((max) => !max || max > 0n, { message: "Invalid maxAmount" }),
-  ]),
-  z.tuple([z.record(z.string(), z.array(z.string()).nonempty())]),
-]);
+const FilterByTokenAndAmountArgs = z.record(
+  z.string(),
+  z.record(
+    z.string(),
+    z.union([
+      z.null(),
+      z.bigint().refine((max) => max > 0n, { message: "Invalid Max Amount" }),
+    ]),
+  ),
+);
 
 export function filterByTokenAndAmount(
   args: z.infer<typeof FilterByTokenAndAmountArgs>,
 ): Hyperlane7683Rule {
   FilterByTokenAndAmountArgs.parse(args);
 
-  const [allowedTokens, maxAmount] = args;
+  const allowedTokens: Record<string, string[]> = {};
+  
+  for (const [chainId, tokens] of Object.entries(args)) {
+    allowedTokens[chainId] = [];
+
+    for (const token of Object.keys(tokens)) {
+      allowedTokens[chainId].push(token.toLowerCase());
+    }
+  }
 
   return async (parsedArgs) => {
     const tokenIn = bytes32ToAddress(
       parsedArgs.resolvedOrder.minReceived[0].token,
     );
-    const amountIn = parsedArgs.resolvedOrder.minReceived[0].amount;
     const originChainId =
       parsedArgs.resolvedOrder.minReceived[0].chainId.toString();
 
     const tokenOut = bytes32ToAddress(
       parsedArgs.resolvedOrder.maxSpent[0].token,
     );
-    const amountOut = parsedArgs.resolvedOrder.maxSpent[0].amount;
     const destChainId = parsedArgs.resolvedOrder.maxSpent[0].chainId.toString();
 
     if (
       !allowedTokens[originChainId] ||
-      !allowedTokens[originChainId].includes(tokenIn) ||
+      !allowedTokens[originChainId].includes(tokenIn.toLowerCase())
+    ) {
+      return { error: "Input token is not allowed", success: false };
+    }
+
+    if (
       !allowedTokens[destChainId] ||
-      !allowedTokens[destChainId].includes(tokenOut) ||
-      (maxAmount &&
-        (amountIn.lt(amountOut) || amountOut.gt(maxAmount.toString())))
+      !allowedTokens[destChainId].includes(tokenOut.toLowerCase())
     ) {
-      return { error: "Amounts and tokens are not ok", success: false };
+      return { error: "Output token is not allowed", success: false };
+    }
+
+    let maxAmount = args[originChainId][tokenIn];
+
+    if (maxAmount === null) {
+      maxAmount = BigInt(MaxUint256.toString());
+    }
+
+    const amountIn = parsedArgs.resolvedOrder.minReceived[0].amount;
+    const amountOut = parsedArgs.resolvedOrder.maxSpent[0].amount;
+
+    if (amountIn.lte(amountOut)) {
+      return { error: "Intent is not profitable", success: false };
+    }
+    
+    if (amountOut.gt(maxAmount.toString())) {
+      return { error: "Output amount exceeds the maximum allowed", success: false };
     }
 
-    return { data: "Amounts and tokens are ok", success: true };
+    return { data: "Amounts and tokens are Ok", success: true };
   };
 }

typescript/solver/solvers/types.ts

@@ -28,7 +28,7 @@ export const BaseMetadataSchema = z.object({
       rules: z.array(
         z.object({
           name: z.string(),
-          args: z.array(z.any()).optional(),
+          args: z.any().optional(),
         }),
       ),
       keepBaseRules: z.boolean().optional(),