feat(cli): fetch world deploy block number if available (#3417)

Co-authored-by: alvrs <alvarius@lattice.xyz>

Author: JackieXu

.changeset/curly-apples-bake.md

@@ -0,0 +1,5 @@
+---
+"@latticexyz/cli": patch
+---
+
+When upgrading an existing world, the deployer now attempts to read the deploy block number from the `worlds.json` file. If it is found, the `HelloWorld` and `HelloStore` event are fetched from this block instead of searching for the events starting from the genesis block.

packages/cli/src/deploy/deploy.ts

@@ -38,6 +38,11 @@ type DeployOptions = {
   artifacts: readonly ContractArtifact[];
   salt?: Hex;
   worldAddress?: Address;
+  /**
+   * Block number of an existing world deployment.
+   * Only used if `worldAddress` is provided.
+   */
+  worldDeployBlock?: bigint;
   /**
    * Address of determinstic deployment proxy: https://github.com/Arachnid/deterministic-deployment-proxy
    * By default, we look for a deployment at 0x4e59b44847b379578588920ca78fbf26c0b4956c and, if not, deploy one.
@@ -64,14 +69,15 @@ export async function deploy({
   artifacts,
   salt,
   worldAddress: existingWorldAddress,
+  worldDeployBlock,
   deployerAddress: initialDeployerAddress,
   indexerUrl,
   chainId,
 }: DeployOptions): Promise<WorldDeploy> {
   const deployerAddress = initialDeployerAddress ?? (await ensureDeployer(client));
 
   const worldDeploy = existingWorldAddress
-    ? await getWorldDeploy(client, existingWorldAddress)
+    ? await getWorldDeploy(client, existingWorldAddress, worldDeployBlock)
     : config.deploy.customWorld
       ? await deployCustomWorld({
           client,

packages/cli/src/deploy/getWorldDeploy.ts

@@ -7,7 +7,11 @@ import { logsToWorldDeploy } from "./logsToWorldDeploy";
 
 const deploys = new Map<Address, WorldDeploy>();
 
-export async function getWorldDeploy(client: Client, worldAddress: Address): Promise<WorldDeploy> {
+export async function getWorldDeploy(
+  client: Client,
+  worldAddress: Address,
+  deployBlock?: bigint,
+): Promise<WorldDeploy> {
   const address = getAddress(worldAddress);
 
   let deploy = deploys.get(address);
@@ -20,10 +24,9 @@ export async function getWorldDeploy(client: Client, worldAddress: Address): Pro
 
   debug("looking up world deploy for", address);
 
-  const [fromBlock, toBlock] = await Promise.all([
-    getBlock(client, { blockTag: "earliest" }),
-    getBlock(client, { blockTag: "latest" }),
-  ]);
+  const [fromBlock, toBlock] = deployBlock
+    ? [{ number: deployBlock }, { number: deployBlock }]
+    : await Promise.all([getBlock(client, { blockTag: "earliest" }), getBlock(client, { blockTag: "latest" })]);
 
   const blockLogs = await fetchBlockLogs({
     publicClient: client,
@@ -34,6 +37,10 @@ export async function getWorldDeploy(client: Client, worldAddress: Address): Pro
     maxBlockRange: 100_000n,
   });
 
+  if (blockLogs.length === 0) {
+    throw new Error("could not find `HelloWorld` or `HelloStore` event");
+  }
+
   deploy = {
     ...logsToWorldDeploy(blockLogs.flatMap((block) => block.logs)),
     stateBlock: toBlock.number,

packages/cli/src/runDeploy.ts

@@ -144,6 +144,13 @@ export async function runDeploy(opts: DeployOptions): Promise<WorldDeploy> {
 
   const chainId = await getChainId(client);
   const indexerUrl = opts.indexerUrl ?? defaultChains.find((chain) => chain.id === chainId)?.indexerUrl;
+  const worldDeployBlock = opts.worldAddress
+    ? getWorldDeployBlock({
+        worldAddress: opts.worldAddress,
+        worldsFile: config.deploy.worldsFile,
+        chainId,
+      })
+    : undefined;
 
   console.log("Deploying from", client.account.address);
 
@@ -156,6 +163,7 @@ export async function runDeploy(opts: DeployOptions): Promise<WorldDeploy> {
     deployerAddress: opts.deployerAddress as Hex | undefined,
     salt,
     worldAddress: opts.worldAddress as Hex | undefined,
+    worldDeployBlock,
     client,
     tables,
     systems,
@@ -215,3 +223,17 @@ export async function runDeploy(opts: DeployOptions): Promise<WorldDeploy> {
 
   return worldDeploy;
 }
+
+function getWorldDeployBlock({
+  chainId,
+  worldAddress,
+  worldsFile,
+}: {
+  chainId: number;
+  worldAddress: string;
+  worldsFile: string;
+}): bigint | undefined {
+  const deploys = existsSync(worldsFile) ? JSON.parse(readFileSync(worldsFile, "utf-8")) : {};
+  const worldDeployBlock = deploys[chainId]?.address === worldAddress ? deploys[chainId].blockNumber : undefined;
+  return worldDeployBlock ? BigInt(worldDeployBlock) : undefined;
+}