feat(cli): add a RPC batch option to cli (#2322)

Co-authored-by: Kevin Ingersoll <[email protected]>
latticexyz · Mar 5, 2024 · 645736d · 645736d
1 parent 90d0d79
commit 645736d
Show file tree

Hide file tree

Showing 4 changed files with 19 additions and 1 deletion.
diff --git a/.changeset/angry-buses-dress.md b/.changeset/angry-buses-dress.md
@@ -0,0 +1,5 @@
+---
+"@latticexyz/cli": minor
+---
+
+Added an `--rpcBatch` option to `mud deploy` command to batch RPC calls for rate limited RPCs.
diff --git a/docs/pages/cli/deploy.mdx b/docs/pages/cli/deploy.mdx
@@ -43,6 +43,7 @@ These are the command line options you can specify on `mud deploy`:
 | `--saveDeployment       | Save the deployment info to a file               | boolean | `true`                                                     |
 | `--profile`             | The foundry profile to use                       | string  | `local`                                                    |
 | `--rpc`<sup>1</sup>     | The RPC URL to use                               | string  | RPC url from `foundry.toml`                                |
+| `--rpcBatch`            | Enable batch processing of RPC requests          | boolean | `false`                                                    |
 | `--worldAddress`        | Deploy to an existing World at the given address | string  | Empty, deploy new `World`                                  |
 | `--srcDir`              | Source directory                                 | string  | Foundry `src` directory                                    |
 | `--skipBuild`           | Skip rebuilding the contracts before deploying   | boolean | `false`                                                    |

diff --git a/packages/cli/src/commands/dev-contracts.ts b/packages/cli/src/commands/dev-contracts.ts
@@ -83,6 +83,7 @@ const commandModule: CommandModule<typeof devOptions, InferredOptionTypes<typeof
             ...opts,
             configPath,
             rpc,
+            rpcBatch: false,
             skipBuild: false,
             printConfig: false,
             profile: undefined,

diff --git a/packages/cli/src/runDeploy.ts b/packages/cli/src/runDeploy.ts
@@ -22,6 +22,10 @@ export const deployOptions = {
   profile: { type: "string", desc: "The foundry profile to use" },
   saveDeployment: { type: "boolean", desc: "Save the deployment info to a file", default: true },
   rpc: { type: "string", desc: "The RPC URL to use. Defaults to the RPC url from the local foundry.toml" },
+  rpcBatch: {
+    type: "boolean",
+    desc: "Enable batch processing of RPC requests in viem client (defaults to batch size of 100 and wait of 1s)",
+  },
   deployerAddress: {
     type: "string",
     desc: "Deploy using an existing deterministic deployer (https://github.com/Arachnid/deterministic-deployment-proxy)",
@@ -85,7 +89,14 @@ in your contracts directory to use the default anvil private key.`,
   const resolvedConfig = resolveConfig({ config, forgeSourceDir: srcDir, forgeOutDir: outDir });
 
   const client = createWalletClient({
-    transport: http(rpc),
+    transport: http(rpc, {
+      batch: opts.rpcBatch
+        ? {
+            batchSize: 100,
+            wait: 1000,
+          }
+        : undefined,
+    }),
     account: privateKeyToAccount(privateKey),
   });
   console.log("Deploying from", client.account.address);