Using postinstallScript instead of setupPapi

Running a single "papi update" command with existing polkadot-api.json
is considerably faster than adding each network, plus more
`postinstallScript` is a more versatile approach.

Author: mutantcornholio

src/scripts/backSync.ts

@@ -20,7 +20,7 @@ program
 program.parse();
 const options: { source: string; template: TemplateNames; rm: boolean } = program.opts();
 
-const alwaysIgnorePatterns = [/^\.papi\/metadata.*/, /^\.gitignore$/];
+const alwaysIgnorePatterns = [/^\.papi\/metadata.*/, /^\.papi\/descriptors.*/, /^\.gitignore$/];
 
 const gitignoreContents = fs.readFileSync(path.join(options.source, ".gitignore"), "utf-8");
 const gitignoreIg = ignore().add(gitignoreContents);

src/templateConfigs/index.ts

@@ -3,9 +3,9 @@ import reactSolidityHardhat from "./react-solidity-hardhat";
 import reactSolidityRemix from "./react-solidity-remix";
 
 export type TemplateConfig = {
-  setupPapi: boolean;
   instructions: string;
   npmRoots: string[];
+  postinstallScript?: string;
 };
 
 export const configs: Record<string, TemplateConfig> = {

src/templateConfigs/react-papi-tailwind.ts

@@ -2,11 +2,11 @@ import { TemplateConfig } from "#src/templateConfigs/index";
 import { colors as c } from "#src/util/log";
 
 const config: TemplateConfig = {
-  setupPapi: true,
   npmRoots: ["/"],
   instructions: `
 ${c.secondary("Start app:")}
 ${c.code("npm run dev")}`,
+  postinstallScript: "npx papi update",
 };
 
 export default config;

src/templateConfigs/react-solidity-hardhat.ts

@@ -2,7 +2,6 @@ import { TemplateConfig } from "#src/templateConfigs/index";
 import { colors as c } from "#src/util/log";
 
 const config: TemplateConfig = {
-  setupPapi: false,
   npmRoots: ["contracts", "frontend"],
   instructions: `
 ${c.primary("Develop smart contracts:")}

src/templateConfigs/react-solidity-remix.ts

@@ -2,7 +2,6 @@ import { TemplateConfig } from "#src/templateConfigs/index";
 import { colors as c } from "#src/util/log";
 
 const config: TemplateConfig = {
-  setupPapi: false,
   npmRoots: ["contracts", "frontend"],
   instructions: `
 ${c.primary("For Remix environment:")}

src/util/childProcess.ts

@@ -1,8 +1,18 @@
 import cp from "child_process";
 
-export function spawnAndWait(cmd: string, args: string[], { cwd }: { cwd?: string }): Promise<void> {
+export function spawnAndWait(
+  cmd: string,
+  args: string[],
+  {
+    cwd,
+    shell = true,
+  }: {
+    cwd?: string;
+    shell?: boolean;
+  },
+): Promise<void> {
   return new Promise((resolve, reject) => {
-    const proc = cp.spawn(cmd, args, { stdio: "inherit", shell: true, cwd: cwd ?? process.cwd() });
+    const proc = cp.spawn(cmd, args, { stdio: "inherit", shell, cwd: cwd ?? process.cwd() });
     proc.on("exit", (code, signal) => {
       if (code === 0) resolve();
       else

src/util/spawnTemplate.ts

@@ -13,8 +13,8 @@ export async function spawnTemplate(dappData: DappData): Promise<void> {
   await copyTemplate(dappData, targetDir, templatesDir);
   await updateFiles(dappData, targetDir);
   await installDeps(targetDir, dappData);
-  if (dappData.config.setupPapi) {
-    await setupPapi(targetDir);
+  if (dappData.config.postinstallScript) {
+    await spawnAndWait("bash", ["-c", dappData.config.postinstallScript], { cwd: targetDir, shell: false });
   }
 
   console.log(
@@ -65,20 +65,3 @@ async function installDeps(targetDir: string, dappData: DappData): Promise<void>
     await spawnAndWait("npm", ["install"], { cwd: path.join(targetDir, root) });
   }
 }
-
-async function setupPapi(targetDir: string): Promise<void> {
-  console.log(c.primary("Setting up polkadot-api..."));
-
-  await spawnAndWait("npx", ["papi", "add", "--skip-codegen", "-n", "paseo", "paseo"], { cwd: targetDir });
-  await spawnAndWait("npx", ["papi", "add", "--skip-codegen", "-n", "paseo_asset_hub", "paseo_asset_hub"], {
-    cwd: targetDir,
-  });
-  await spawnAndWait("npx", ["papi", "add", "--skip-codegen", "-n", "polkadot", "polkadot"], {
-    cwd: targetDir,
-  });
-  await spawnAndWait("npx", ["papi", "add", "--skip-codegen", "-n", "polkadot_asset_hub", "polkadot_asset_hub"], {
-    cwd: targetDir,
-  });
-
-  await spawnAndWait("npx", ["papi"], { cwd: targetDir });
-}

templates/react-papi-tailwind/.papi/polkadot-api.json

@@ -0,0 +1,30 @@
+{
+  "version": 0,
+  "descriptorPath": ".papi/descriptors",
+  "entries": {
+    "paseo": {
+      "chain": "paseo",
+      "metadata": ".papi/metadata/paseo.scale",
+      "genesis": "0x77afd6190f1554ad45fd0d31aee62aacc33c6db0ea801129acb813f913e0764f",
+      "codeHash": "0xcc4b027a0dbb5e0f389dd8418c41012d618290a22f84af8411c8fd20b2738304"
+    },
+    "paseo_asset_hub": {
+      "chain": "paseo_asset_hub",
+      "metadata": ".papi/metadata/paseo_asset_hub.scale",
+      "genesis": "0xd6eec26135305a8ad257a20d003357284c8aa03d0bdb2b357ab0a22371e11ef2",
+      "codeHash": "0xb7f52ff9b4fb5124568a5b8cbfcebba2bc9318bcb5916b69457c10bc6a2d0ac5"
+    },
+    "polkadot": {
+      "chain": "polkadot",
+      "metadata": ".papi/metadata/polkadot.scale",
+      "genesis": "0x91b171bb158e2d3848fa23a9f1c25182fb8e20313b2c1eb49219da7a70ce90c3",
+      "codeHash": "0x716bb701ec19452fa522cdaa83ef101d368ba2bcfd89fde9acb6f793a420a616"
+    },
+    "polkadot_asset_hub": {
+      "chain": "polkadot_asset_hub",
+      "metadata": ".papi/metadata/polkadot_asset_hub.scale",
+      "genesis": "0x68d56f15f85d3136970ec16946040bc1752654e906147f7e43e9d539d7c3de2f",
+      "codeHash": "0x6e20bc52aaaafd1de82ba7d2a3c0fa39193787e240b93608489cf72a4c46a584"
+    }
+  }
+}