Merge branch 'main' into decouple-order-3-leyers

Author: lmcorbalan

Dockerfile

@@ -0,0 +1,14 @@
+FROM node:20-alpine
+
+# Bundle APP files
+WORKDIR /workspace
+COPY .  ./
+RUN corepack enable
+RUN yarn install
+RUN yarn build:solver
+RUN npm install pm2 -g
+
+# Show current folder structure in logs
+RUN ls -al -R
+
+CMD [ "pm2-runtime", "start", "ecosystem.config.js", "--env", "production" ]

README.md

@@ -31,6 +31,33 @@ cd intents-framework
 yarn
 ```
 
+### Running the Solver
+
+Run the following commands from the root directory (you need `docker` installed)
+
+```bash
+docker build -t solver .
+```
+
+Once it finish building the image
+
+```bash
+docker run -it -e [PRIVATE_KEY=SOME_PK_YOU_OWN | MNEMONIC=SOME_MNEMONIC_YOU_OWN] solver
+```
+
+The solver is run using `pm2` inside the docker container so `pm2` commands can still be used inside a container with the docker exec command:
+
+```bash
+# Monitoring CPU/Usage of each process
+docker exec -it <container-id> pm2 monit
+# Listing managed processes
+docker exec -it <container-id> pm2 list
+# Get more information about a process
+docker exec -it <container-id> pm2 show
+# 0sec downtime reload all applications
+docker exec -it <container-id> pm2 reload all
+```
+
 ### Versioning
 
 For the versions available, see the tags on this repository.

ecosystem.config.js

@@ -0,0 +1,14 @@
+module.exports = {
+  apps : [{
+    name: "solver",
+    script: "./typescript/solver/dist/index.js",
+    env: {
+      NODE_ENV: "development",
+    },
+    env_production: {
+      NODE_ENV: "production",
+      LOG_LEVEL: "info",
+      LOG_FORMAT: "json",
+    }
+  }]
+}

package.json

@@ -2,7 +2,7 @@
   "name": "intents-framework",
   "version": "0.1.0",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build:solver": "yarn workspace solver build"
   },
   "repository": {
     "type": "git",

typescript/solver/NonceKeeperWallet.ts

@@ -1,10 +1,12 @@
+import { defaultPath, HDNode } from "@ethersproject/hdnode";
 import type { Deferrable } from "@ethersproject/properties";
 import type {
   Provider,
   TransactionRequest,
   TransactionResponse,
 } from "@ethersproject/providers";
 import { Wallet } from "@ethersproject/wallet";
+import type { Wordlist } from "@ethersproject/wordlists";
 
 import { log } from "./logger.js";
 
@@ -31,8 +33,22 @@ export class NonceKeeperWallet extends Wallet {
       transaction.nonce = this.getNextNonce();
     }
 
-    log.debug("transaction", transaction);
+    log.debug({ msg: "transaction", transaction });
 
     return super.sendTransaction(transaction);
   }
+
+  static override fromMnemonic(
+    mnemonic: string,
+    path?: string,
+    wordlist?: Wordlist,
+  ) {
+    if (!path) {
+      path = defaultPath;
+    }
+
+    return new NonceKeeperWallet(
+      HDNode.fromMnemonic(mnemonic, undefined, wordlist).derivePath(path),
+    );
+  }
 }

typescript/solver/README.md

@@ -142,7 +142,9 @@ The clock-list supersedes the allow-list, i.e. if a message matches both the all
 
 ### Logging
 
-The application utilizes a custom Logger class for logging. You can adjust the log level and format by modifying the Logger instantiation in index.ts.
+The application utilizes a custom Logger class for logging. You can adjust the log level and format by modifying the Logger instantiation in index.ts. By default it will log to `stdout` in a human-readable format using the `INFO` level.
+
+You can customize the logging destination by using a pino transport of your choosing. There's an example for logging to a Syslog server running on `localhost` commented in [logger.ts](logger.ts). Check out the [pino transports docs](https://github.com/pinojs/pino/blob/main/docs/transports.md) for other available transports.
 
 ## Adding a New Solver
 

typescript/solver/config/chainMetadata.ts

@@ -0,0 +1,30 @@
+import { z } from "zod";
+
+import { chainMetadata as defaultChainMetadata } from "@hyperlane-xyz/registry";
+
+import { ChainMetadataSchema } from "@hyperlane-xyz/sdk";
+import type { ChainMap, ChainMetadata } from "@hyperlane-xyz/sdk";
+
+import { objMerge } from "@hyperlane-xyz/utils";
+
+const customChainMetadata = {
+  // Example custom configuration
+  // "base": {
+  //   "rpcUrls": [
+  //     {
+  //       "http": "https://base.llamarpc.com"
+  //     }
+  //   ]
+  // }
+};
+
+const chainMetadata = objMerge<ChainMap<ChainMetadata>>(
+  defaultChainMetadata,
+  customChainMetadata,
+  10,
+  false,
+);
+
+z.record(z.string(), ChainMetadataSchema).parse(chainMetadata);
+
+export { chainMetadata };

typescript/solver/config/index.ts

@@ -1,8 +1,8 @@
-import z from "zod";
 import dotenvFlow from "dotenv-flow";
+import z from "zod";
 import allowBlockListsGlobal from "./allowBlockLists.js";
+import { chainMetadata } from "./chainMetadata.js";
 import { ConfigSchema } from "./types.js";
-import { chainMetadata } from "@hyperlane-xyz/registry";
 
 dotenvFlow.config();
 
@@ -15,7 +15,7 @@ export { LOG_FORMAT, LOG_LEVEL, MNEMONIC, PRIVATE_KEY };
 
 type GenericAllowBlockListItem = z.infer<typeof ConfigSchema>;
 
-type GenericAllowBlockLists = {
+export type GenericAllowBlockLists = {
   allowList: GenericAllowBlockListItem[];
   blockList: GenericAllowBlockListItem[];
 };
@@ -69,16 +69,16 @@ const { chainIds, chainNames, chainIdsToName } = Object.entries(
   chainMetadata,
 ).reduce<{
   chainNames: Array<string>;
-  chainIds: { [key: string]: number | string };
+  chainIds: { [key: string]: number };
   chainIdsToName: { [key: string]: string };
 }>(
   (acc, [key, value]) => {
     acc.chainNames.push(key);
-    acc.chainIds[key] = value.chainId;
+    acc.chainIds[key] = Number(value.chainId);
     acc.chainIdsToName[value.chainId.toString()] = key;
     return acc;
   },
   { chainNames: [], chainIds: {}, chainIdsToName: {} },
 );
 
-export { chainIds, chainNames, chainIdsToName };
+export { chainIds, chainIdsToName, chainNames };

typescript/solver/index.ts

@@ -5,10 +5,10 @@ import "./patch-bigint-buffer-warn.js";
 import { log } from "./logger.js";
 import * as solvers from "./solvers/index.js";
 import { getMultiProvider } from "./solvers/utils.js";
-
+import { chainMetadata } from "./config/chainMetadata.js";
 
 const main = async () => {
-  const multiProvider = await getMultiProvider().catch(
+  const multiProvider = await getMultiProvider(chainMetadata).catch(
     (error) => (log.error(error.reason ?? error.message), process.exit(1)),
   );
 

typescript/solver/logger.ts

@@ -26,7 +26,17 @@ function createLogger(name?: string, logFormat?: LogFormat, logLevel?: Level) {
   const baseConfig = { level: logLevel, name };
 
   if (logFormat === LogFormat.JSON) {
-    return pino(baseConfig);
+    return pino({
+      ...baseConfig,
+      // transport: {
+      //   target: "pino-socket",
+      //   options: {
+      //     address: "127.0.0.1",
+      //     port: 514,
+      //     mode: "udp",
+      //   },
+      // },
+    });
   }
 
   return pino(baseConfig, pretty(prettyConfig));