make install optional

latticexyz · Aug 14, 2024 · dec7d2f · dec7d2f
1 parent f6d872b
commit dec7d2f
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 0 deletions.
diff --git a/packages/cli/src/deploy/common.ts b/packages/cli/src/deploy/common.ts
@@ -100,4 +100,9 @@ export type Module = DeterministicContract & {
   readonly name: string;
   readonly installAsRoot: boolean;
   readonly installData: Hex; // TODO: figure out better naming for this
+  /**
+   * @internal
+   * Optional modules warn instead of throw if they revert while being installed.
+   */
+  readonly optional?: boolean;
 };
diff --git a/packages/cli/src/deploy/configToModules.ts b/packages/cli/src/deploy/configToModules.ts
@@ -28,6 +28,7 @@ export async function configToModules<config extends World>(
 ): Promise<readonly Module[]> {
   const defaultModules: Module[] = [
     {
+      optional: true,
       name: "MetadataModule",
       installAsRoot: false,
       installData: "0x",

diff --git a/packages/cli/src/deploy/ensureModules.ts b/packages/cli/src/deploy/ensureModules.ts
@@ -59,6 +59,12 @@ export async function ensureModules({
                     args: [moduleAddress, mod.installData],
                   });
             } catch (error) {
+              if (mod.optional) {
+                debug(
+                  `optional module ${mod.name} install failed, skipping\n  ${error instanceof BaseError ? error.shortMessage : error}`,
+                );
+                return;
+              }
               if (error instanceof BaseError && error.message.includes("Module_AlreadyInstalled")) {
                 debug(`module ${mod.name} already installed`);
                 return;