feat(explorer): fetch deprecated world ABI (#3654)

Co-authored-by: Kevin Ingersoll <kingersoll@gmail.com>

Author: karooolis

.changeset/old-carrots-listen.md

@@ -0,0 +1,9 @@
+---
+"@latticexyz/store-sync": patch
+---
+
+`getWorldAbi()` now returns an ABI that is a combination of:
+
+- base World ABI
+- system ABIs stored onchain with metadata module during deploy
+- world functions

packages/store-sync/src/world/getWorldAbi.test.ts

@@ -1,7 +1,18 @@
 import { createTestClient, http, parseAbi } from "viem";
 import { foundry } from "viem/chains";
 import { describe, expect, it, vi } from "vitest";
-import { mockError, mockMetadata, mockWorldFn } from "./test/mocks";
+import IBaseWorldAbi from "@latticexyz/world/out/IBaseWorld.sol/IBaseWorld.abi.json" assert { type: "json" };
+import { mockError, mockMetadata, mockWorldFn, mockWorldFn2 } from "./test/mocks";
+
+vi.doMock("./getFunctions", () => {
+  const mockGetFunctionsResult = [{ signature: "setNumber(bool)" }, { signature: "batchCall((bytes32,bytes)[])" }];
+  const getFunctions = vi.fn();
+  getFunctions.mockResolvedValue(mockGetFunctionsResult);
+
+  return {
+    getFunctions,
+  };
+});
 
 vi.doMock("../getRecords", () => ({
   getRecords: vi.fn().mockResolvedValue({
@@ -26,6 +37,6 @@ describe("World ABI", () => {
       toBlock: 0n,
     });
 
-    expect(abi).toEqual(parseAbi([mockWorldFn, mockError]));
+    expect(abi).toEqual([...IBaseWorldAbi, ...parseAbi([mockWorldFn, mockError, mockWorldFn2])]);
   });
 });

packages/store-sync/src/world/getWorldAbi.ts

@@ -1,7 +1,26 @@
-import { Client, Abi, Address, hexToString, parseAbi, stringToHex } from "viem";
+import {
+  Client,
+  Abi,
+  Address,
+  AbiItem,
+  AbiFunction,
+  getAddress,
+  toFunctionSelector,
+  hexToString,
+  parseAbi,
+  stringToHex,
+} from "viem";
+import IBaseWorldAbi from "@latticexyz/world/out/IBaseWorld.sol/IBaseWorld.abi.json" assert { type: "json" };
 import metadataConfig from "@latticexyz/world-module-metadata/mud.config";
+import { functionSignatureToAbiItem } from "./functionSignatureToAbiItem";
+import { isDefined } from "@latticexyz/common/utils";
+import { getFunctions } from "./getFunctions";
 import { getRecords } from "../getRecords";
 
+function isAbiFunction(abiItem: AbiItem): abiItem is AbiFunction {
+  return abiItem.type === "function";
+}
+
 export async function getWorldAbi({
   client,
   worldAddress,
@@ -17,19 +36,46 @@ export async function getWorldAbi({
   readonly indexerUrl?: string;
   readonly chainId?: number;
 }): Promise<Abi> {
-  const { records } = await getRecords({
-    table: metadataConfig.tables.metadata__ResourceTag,
-    worldAddress,
-    chainId,
-    indexerUrl,
-    client,
-    fromBlock,
-    toBlock,
-  });
+  const [worldFunctions, { records }] = await Promise.all([
+    getFunctions({
+      client,
+      worldAddress: getAddress(worldAddress),
+      fromBlock,
+      toBlock,
+      indexerUrl,
+      chainId,
+    }),
+    getRecords({
+      table: metadataConfig.tables.metadata__ResourceTag,
+      worldAddress,
+      chainId,
+      indexerUrl,
+      client,
+      fromBlock,
+      toBlock,
+    }),
+  ]);
 
-  const abi = records
+  const metadataAbi = records
     .filter(({ tag }) => tag === stringToHex("worldAbi", { size: 32 }))
     .flatMap(({ value }) => (value === "0x" ? [] : parseAbi(hexToString(value).split("\n"))));
 
-  return abi;
+  const metadataFunctionSelectors = metadataAbi.filter(isAbiFunction).map(toFunctionSelector);
+  const baseFunctionSelectors = (IBaseWorldAbi as Abi).filter(isAbiFunction).map(toFunctionSelector);
+  const worldFunctionsAbi = worldFunctions
+    .map((func) => {
+      try {
+        return functionSignatureToAbiItem(func.signature);
+      } catch (error) {
+        console.error(error);
+      }
+    })
+    .filter(isDefined)
+    .filter(
+      (abiItem) =>
+        !baseFunctionSelectors.includes(toFunctionSelector(abiItem)) &&
+        !metadataFunctionSelectors.includes(toFunctionSelector(abiItem)),
+    );
+
+  return [...(IBaseWorldAbi as Abi), ...metadataAbi, ...worldFunctionsAbi];
 }

packages/store-sync/src/world/test/mocks.ts

@@ -7,6 +7,7 @@ export const mockSystem3Id = stringToHex("system3", { size: 32 });
 export const mockSystem1Fn = "function systemFn(uint256 arg1, bool arg2) pure returns (uint256)";
 export const mockSystem2Fn = "function systemFn2(uint256 arg1, bool arg2) pure returns (uint256)";
 export const mockWorldFn = "function test_WorldFunction(uint256 arg1, bool arg2) pure returns (uint256)";
+export const mockWorldFn2 = "function setNumber(bool)";
 export const mockError = "error Error(string message)";
 
 export const mockMetadata = [