@polkadot-api/cli 0.19.5-canary.d6be873 → 0.20.0

package/dist/index.d.ts

@@ -87,4 +87,5 @@ declare function getMetadata({ metadata: metadataFile, codeHash, genesis, ...ent
     genesis?: HexString;
 } | null>;
 
-export { type AddOptions, type Commands, type GenerateOptions, type InkAddOptions, add, generate, getCli, getMetadata, ink, readPapiConfig, remove, update };
+export { add, generate, getCli, getMetadata, ink, readPapiConfig, remove, update };
+export type { AddOptions, Commands, GenerateOptions, InkAddOptions };

package/dist/main/package.json.js

@@ -0,0 +1,4 @@
+var version = "0.20.0";
+
+export { version };
+//# sourceMappingURL=package.json.js.map

package/dist/main/package.json.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"package.json.js","sources":[],"sourcesContent":[],"names":[],"mappings":";;;;"}

package/dist/main/src/cli.js

@@ -0,0 +1,49 @@
+import { program, Option } from '@commander-js/extra-typings';
+import * as knownChains from '@polkadot-api/known-chains';
+import { sol } from './commands/sol.js';
+
+function getCli({
+  add,
+  generate,
+  remove,
+  update,
+  ink,
+  version
+}) {
+  program.name("polkadot-api").description("Polkadot API CLI").version(version);
+  const config = new Option("--config <filename>", "Source for the config file");
+  const skipCodegen = new Option(
+    "--skip-codegen",
+    "Skip running codegen after adding"
+  );
+  const whitelist = new Option(
+    "--whitelist <filename>",
+    "Removed. The whitelist path is now .papi/whitelist.ts"
+  ).hideHelp();
+  program.command("generate", {
+    isDefault: true
+  }).description("Generate descriptor files").addOption(config).addOption(whitelist).action(generate);
+  program.command("add").description("Add a new chain spec to the list").argument("<key>", "Key identifier for the chain spec").addOption(config).option("-f, --file <filename>", "Source from metadata encoded file").option("-w, --wsUrl <URL>", "Source from websocket url").option("-c, --chainSpec <filename>", "Source from chain spec file").addOption(
+    new Option("-n, --name <name>", "Source from a well-known chain").choices(
+      Object.keys(knownChains)
+    )
+  ).option("--wasm <filename>", "Source from runtime wasm file").option(
+    "--at <block hash or number>",
+    "Only for -w/--wsUrl. Fetch the metadata for a specific block or hash"
+  ).option("--no-persist", "Do not persist the metadata as a file").addOption(skipCodegen).addOption(whitelist).action(add);
+  program.command("update").description("Update the metadata files and generate descriptor files").argument(
+    "[keys]",
+    "Keys of the metadata files to update, separated by commas. Leave empty for all"
+  ).addOption(config).addOption(skipCodegen).addOption(whitelist).action(update);
+  program.command("remove").description("Remove a chain spec from the list").argument("<key>", "Key identifier for the chain spec").addOption(config).addOption(skipCodegen).addOption(whitelist).action(remove);
+  const inkCommand = program.command("ink").description("Add, update or remove ink contracts");
+  inkCommand.command("add").description("Add or update an ink contract").argument("<file>", ".contract or .json metadata file for the contract").option("-k, --key <key>", "Key identifier for the contract").addOption(config).addOption(skipCodegen).addOption(whitelist).action(ink.add);
+  inkCommand.command("remove").description("Remove an ink contract").argument("<key>", "Key identifier for the contract to remove").addOption(config).addOption(skipCodegen).addOption(whitelist).action(ink.remove);
+  const solCommand = program.command("sol").description("Add, update or remove solidity contracts");
+  solCommand.command("add").description("Add or update a solidity contract").argument("<file>", ".abi file for the contract").argument("<key>", "Key identifier for the contract").addOption(config).addOption(skipCodegen).addOption(whitelist).action(sol.add);
+  solCommand.command("remove").description("Remove a solidity contract").argument("<key>", "Key identifier for the contract to remove").addOption(config).addOption(skipCodegen).addOption(whitelist).action(sol.remove);
+  return program;
+}
+
+export { getCli };
+//# sourceMappingURL=cli.js.map

package/dist/main/src/cli.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"cli.js","sources":["../../../src/cli.ts"],"sourcesContent":["import { Option, program } from \"@commander-js/extra-typings\"\nimport type { add, generate, ink, remove, update } from \"./commands\"\nimport * as knownChains from \"@polkadot-api/known-chains\"\nimport { sol } from \"./commands/sol\"\n\nexport type Commands = {\n  add: typeof add\n  generate: typeof generate\n  remove: typeof remove\n  update: typeof update\n  ink: typeof ink\n  version: string\n}\n\nexport function getCli({\n  add,\n  generate,\n  remove,\n  update,\n  ink,\n  version,\n}: Commands) {\n  program.name(\"polkadot-api\").description(\"Polkadot API CLI\").version(version)\n\n  const config = new Option(\"--config <filename>\", \"Source for the config file\")\n  const skipCodegen = new Option(\n    \"--skip-codegen\",\n    \"Skip running codegen after adding\",\n  )\n  const whitelist = new Option(\n    \"--whitelist <filename>\",\n    \"Removed. The whitelist path is now .papi/whitelist.ts\",\n  ).hideHelp()\n\n  program\n    .command(\"generate\", {\n      isDefault: true,\n    })\n    .description(\"Generate descriptor files\")\n    .addOption(config)\n    .addOption(whitelist)\n    .action(generate)\n\n  program\n    .command(\"add\")\n    .description(\"Add a new chain spec to the list\")\n    .argument(\"<key>\", \"Key identifier for the chain spec\")\n    .addOption(config)\n    .option(\"-f, --file <filename>\", \"Source from metadata encoded file\")\n    .option(\"-w, --wsUrl <URL>\", \"Source from websocket url\")\n    .option(\"-c, --chainSpec <filename>\", \"Source from chain spec file\")\n    .addOption(\n      new Option(\"-n, --name <name>\", \"Source from a well-known chain\").choices(\n        Object.keys(knownChains),\n      ),\n    )\n    .option(\"--wasm <filename>\", \"Source from runtime wasm file\")\n    .option(\n      \"--at <block hash or number>\",\n      \"Only for -w/--wsUrl. Fetch the metadata for a specific block or hash\",\n    )\n    .option(\"--no-persist\", \"Do not persist the metadata as a file\")\n    .addOption(skipCodegen)\n    .addOption(whitelist)\n    .action(add)\n\n  program\n    .command(\"update\")\n    .description(\"Update the metadata files and generate descriptor files\")\n    .argument(\n      \"[keys]\",\n      \"Keys of the metadata files to update, separated by commas. Leave empty for all\",\n    )\n    .addOption(config)\n    .addOption(skipCodegen)\n    .addOption(whitelist)\n    .action(update)\n\n  program\n    .command(\"remove\")\n    .description(\"Remove a chain spec from the list\")\n    .argument(\"<key>\", \"Key identifier for the chain spec\")\n    .addOption(config)\n    .addOption(skipCodegen)\n    .addOption(whitelist)\n    .action(remove)\n\n  const inkCommand = program\n    .command(\"ink\")\n    .description(\"Add, update or remove ink contracts\")\n  inkCommand\n    .command(\"add\")\n    .description(\"Add or update an ink contract\")\n    .argument(\"<file>\", \".contract or .json metadata file for the contract\")\n    .option(\"-k, --key <key>\", \"Key identifier for the contract\")\n    .addOption(config)\n    .addOption(skipCodegen)\n    .addOption(whitelist)\n    .action(ink.add)\n  inkCommand\n    .command(\"remove\")\n    .description(\"Remove an ink contract\")\n    .argument(\"<key>\", \"Key identifier for the contract to remove\")\n    .addOption(config)\n    .addOption(skipCodegen)\n    .addOption(whitelist)\n    .action(ink.remove)\n\n  const solCommand = program\n    .command(\"sol\")\n    .description(\"Add, update or remove solidity contracts\")\n  solCommand\n    .command(\"add\")\n    .description(\"Add or update a solidity contract\")\n    .argument(\"<file>\", \".abi file for the contract\")\n    .argument(\"<key>\", \"Key identifier for the contract\")\n    .addOption(config)\n    .addOption(skipCodegen)\n    .addOption(whitelist)\n    .action(sol.add)\n  solCommand\n    .command(\"remove\")\n    .description(\"Remove a solidity contract\")\n    .argument(\"<key>\", \"Key identifier for the contract to remove\")\n    .addOption(config)\n    .addOption(skipCodegen)\n    .addOption(whitelist)\n    .action(sol.remove)\n\n  return program\n}\n"],"names":[],"mappings":";;;;AAcO,SAAS,MAAA,CAAO;AAAA,EACrB,GAAA;AAAA,EACA,QAAA;AAAA,EACA,MAAA;AAAA,EACA,MAAA;AAAA,EACA,GAAA;AAAA,EACA;AACF,CAAA,EAAa;AACX,EAAA,OAAA,CAAQ,KAAK,cAAc,CAAA,CAAE,YAAY,kBAAkB,CAAA,CAAE,QAAQ,OAAO,CAAA;AAE5E,EAAA,MAAM,MAAA,GAAS,IAAI,MAAA,CAAO,qBAAA,EAAuB,4BAA4B,CAAA;AAC7E,EAAA,MAAM,cAAc,IAAI,MAAA;AAAA,IACtB,gBAAA;AAAA,IACA;AAAA,GACF;AACA,EAAA,MAAM,YAAY,IAAI,MAAA;AAAA,IACpB,wBAAA;AAAA,IACA;AAAA,IACA,QAAA,EAAS;AAEX,EAAA,OAAA,CACG,QAAQ,UAAA,EAAY;AAAA,IACnB,SAAA,EAAW;AAAA,GACZ,CAAA,CACA,WAAA,CAAY,2BAA2B,CAAA,CACvC,SAAA,CAAU,MAAM,CAAA,CAChB,SAAA,CAAU,SAAS,CAAA,CACnB,MAAA,CAAO,QAAQ,CAAA;AAElB,EAAA,OAAA,CACG,OAAA,CAAQ,KAAK,CAAA,CACb,WAAA,CAAY,kCAAkC,EAC9C,QAAA,CAAS,OAAA,EAAS,mCAAmC,CAAA,CACrD,SAAA,CAAU,MAAM,EAChB,MAAA,CAAO,uBAAA,EAAyB,mCAAmC,CAAA,CACnE,MAAA,CAAO,mBAAA,EAAqB,2BAA2B,CAAA,CACvD,MAAA,CAAO,4BAAA,EAA8B,6BAA6B,CAAA,CAClE,SAAA;AAAA,IACC,IAAI,MAAA,CAAO,mBAAA,EAAqB,gCAAgC,CAAA,CAAE,OAAA;AAAA,MAChE,MAAA,CAAO,KAAK,WAAW;AAAA;AACzB,GACF,CACC,MAAA,CAAO,mBAAA,EAAqB,+BAA+B,CAAA,CAC3D,MAAA;AAAA,IACC,6BAAA;AAAA,IACA;AAAA,GACF,CACC,MAAA,CAAO,cAAA,EAAgB,uCAAuC,CAAA,CAC9D,SAAA,CAAU,WAAW,CAAA,CACrB,SAAA,CAAU,SAAS,CAAA,CACnB,MAAA,CAAO,GAAG,CAAA;AAEb,EAAA,OAAA,CACG,OAAA,CAAQ,QAAQ,CAAA,CAChB,WAAA,CAAY,yDAAyD,CAAA,CACrE,QAAA;AAAA,IACC,QAAA;AAAA,IACA;AAAA,GACF,CACC,SAAA,CAAU,MAAM,CAAA,CAChB,SAAA,CAAU,WAAW,CAAA,CACrB,SAAA,CAAU,SAAS,CAAA,CACnB,MAAA,CAAO,MAAM,CAAA;AAEhB,EAAA,OAAA,CACG,OAAA,CAAQ,QAAQ,CAAA,CAChB,WAAA,CAAY,mCAAmC,CAAA,CAC/C,QAAA,CAAS,SAAS,mCAAmC,CAAA,CACrD,UAAU,MAAM,CAAA,CAChB,UAAU,WAAW,CAAA,CACrB,UAAU,SAAS,CAAA,CACnB,OAAO,MAAM,CAAA;AAEhB,EAAA,MAAM,aAAa,OAAA,CAChB,OAAA,CAAQ,KAAK,CAAA,CACb,YAAY,qCAAqC,CAAA;AACpD,EAAA,UAAA,CACG,OAAA,CAAQ,KAAK,CAAA,CACb,WAAA,CAAY,+BAA+B,EAC3C,QAAA,CAAS,QAAA,EAAU,mDAAmD,CAAA,CACtE,MAAA,CAAO,iBAAA,EAAmB,iCAAiC,CAAA,CAC3D,SAAA,CAAU,MAAM,CAAA,CAChB,SAAA,CAAU,WAAW,CAAA,CACrB,SAAA,CAAU,SAAS,CAAA,CACnB,MAAA,CAAO,GAAA,CAAI,GAAG,CAAA;AACjB,EAAA,UAAA,CACG,OAAA,CAAQ,QAAQ,CAAA,CAChB,WAAA,CAAY,wBAAwB,CAAA,CACpC,QAAA,CAAS,SAAS,2CAA2C,CAAA,CAC7D,UAAU,MAAM,CAAA,CAChB,UAAU,WAAW,CAAA,CACrB,UAAU,SAAS,CAAA,CACnB,MAAA,CAAO,GAAA,CAAI,MAAM,CAAA;AAEpB,EAAA,MAAM,aAAa,OAAA,CAChB,OAAA,CAAQ,KAAK,CAAA,CACb,YAAY,0CAA0C,CAAA;AACzD,EAAA,UAAA,CACG,OAAA,CAAQ,KAAK,CAAA,CACb,WAAA,CAAY,mCAAmC,EAC/C,QAAA,CAAS,QAAA,EAAU,4BAA4B,CAAA,CAC/C,QAAA,CAAS,OAAA,EAAS,iCAAiC,CAAA,CACnD,SAAA,CAAU,MAAM,CAAA,CAChB,SAAA,CAAU,WAAW,CAAA,CACrB,SAAA,CAAU,SAAS,CAAA,CACnB,MAAA,CAAO,GAAA,CAAI,GAAG,CAAA;AACjB,EAAA,UAAA,CACG,OAAA,CAAQ,QAAQ,CAAA,CAChB,WAAA,CAAY,4BAA4B,CAAA,CACxC,QAAA,CAAS,SAAS,2CAA2C,CAAA,CAC7D,UAAU,MAAM,CAAA,CAChB,UAAU,WAAW,CAAA,CACrB,UAAU,SAAS,CAAA,CACnB,MAAA,CAAO,GAAA,CAAI,MAAM,CAAA;AAEpB,EAAA,OAAO,OAAA;AACT;;;;"}

package/dist/main/src/commands/add.js

@@ -0,0 +1,91 @@
+import { getMetadata, writeMetadataToDisk } from '../metadata.js';
+import { readPapiConfig, defaultConfig, writePapiConfig, papiFolder } from '../papiConfig.js';
+import { compactNumber } from '@polkadot-api/substrate-bindings';
+import { fromHex } from '@polkadot-api/utils';
+import { getMetadataFromRuntime } from '@polkadot-api/wasm-executor/node';
+import * as fs from 'node:fs/promises';
+import ora from 'ora';
+import { generate } from './generate.js';
+import { join } from 'node:path';
+import { existsSync } from 'node:fs';
+
+async function add(key, options) {
+  const config = await readPapiConfig(options.config) ?? defaultConfig;
+  const entries = config.entries;
+  if (key in entries) {
+    console.warn(`Replacing existing ${key} config`);
+  }
+  if (options.file) {
+    entries[key] = {
+      metadata: options.file
+    };
+  } else if (options.wasm) {
+    const spinner = ora(`Loading metadata from runtime`).start();
+    const metadataHex = (await fs.readFile(options.wasm)).toString("hex");
+    const opaqueMeta = fromHex(getMetadataFromRuntime(`0x${metadataHex}`));
+    const metadataLen = compactNumber.dec(opaqueMeta);
+    const compactLen = compactNumber.enc(metadataLen).length;
+    if (opaqueMeta.length - compactLen !== metadataLen)
+      throw new Error("Not able to retrieve runtime metadata");
+    spinner.text = "Writing metadata";
+    const metadataRaw = opaqueMeta.slice(compactLen);
+    const filename = await storeMetadata(metadataRaw, key);
+    spinner.succeed(`Metadata saved as ${filename}`);
+    entries[key] = {
+      metadata: filename
+    };
+  } else {
+    const entry = entryFromOptions(options);
+    entries[key] = entry;
+    if (!options.noPersist) {
+      const spinner = ora(`Loading metadata`).start();
+      const { metadataRaw, genesis, codeHash } = await getMetadata(entry);
+      spinner.text = "Writing metadata";
+      const filename = await storeMetadata(metadataRaw, key);
+      spinner.succeed(`Metadata saved as ${filename}`);
+      entry.metadata = filename;
+      entry.genesis = genesis;
+      entry.codeHash = codeHash;
+    }
+  }
+  await writePapiConfig(options.config, config);
+  console.log(`Saved new spec "${key}"`);
+  if (!options.skipCodegen) {
+    generate({
+      config: options.config
+    });
+  }
+}
+async function storeMetadata(metadata, key) {
+  const defaultFolder = join(papiFolder, "metadata");
+  if (!existsSync(defaultFolder)) {
+    await fs.mkdir(defaultFolder, { recursive: true });
+  }
+  const filename = join(defaultFolder, `${key}.scale`);
+  await writeMetadataToDisk(metadata, filename);
+  return filename;
+}
+const entryFromOptions = (options) => {
+  if (options.wsUrl) {
+    return {
+      wsUrl: options.wsUrl,
+      at: options.at
+    };
+  }
+  if (options.chainSpec) {
+    return {
+      chainSpec: options.chainSpec
+    };
+  }
+  if (options.name) {
+    return {
+      chain: options.name
+    };
+  }
+  throw new Error(
+    "add command needs one source, specified by options -f -w -c or -n"
+  );
+};
+
+export { add };
+//# sourceMappingURL=add.js.map

package/dist/main/src/commands/add.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add.js","sources":["../../../../src/commands/add.ts"],"sourcesContent":["import { getMetadata, writeMetadataToDisk } from \"@/metadata\"\nimport {\n  defaultConfig,\n  EntryConfig,\n  papiFolder,\n  readPapiConfig,\n  writePapiConfig,\n} from \"@/papiConfig\"\nimport { compactNumber } from \"@polkadot-api/substrate-bindings\"\nimport { fromHex } from \"@polkadot-api/utils\"\nimport { getMetadataFromRuntime } from \"@polkadot-api/wasm-executor/node\"\nimport * as fs from \"node:fs/promises\"\nimport ora from \"ora\"\nimport { CommonOptions } from \"./commonOptions\"\nimport { generate } from \"./generate\"\nimport { join } from \"node:path\"\nimport { existsSync } from \"node:fs\"\n\nexport interface AddOptions extends CommonOptions {\n  file?: string\n  wsUrl?: string\n  chainSpec?: string\n  // well-known chains\n  name?: string\n  wasm?: string\n  noPersist?: boolean\n  // only for wsUrl\n  at?: string\n}\n\nexport async function add(key: string, options: AddOptions) {\n  const config = (await readPapiConfig(options.config)) ?? defaultConfig\n  const entries = config.entries\n\n  if (key in entries) {\n    console.warn(`Replacing existing ${key} config`)\n  }\n\n  if (options.file) {\n    entries[key] = {\n      metadata: options.file,\n    }\n  } else if (options.wasm) {\n    const spinner = ora(`Loading metadata from runtime`).start()\n    const metadataHex = (await fs.readFile(options.wasm)).toString(\"hex\")\n    const opaqueMeta = fromHex(getMetadataFromRuntime(`0x${metadataHex}`))\n\n    // metadata comes with compact length prepended\n    const metadataLen = compactNumber.dec(opaqueMeta)\n    const compactLen = compactNumber.enc(metadataLen).length\n    // verify we got all data\n    if (opaqueMeta.length - compactLen !== metadataLen)\n      throw new Error(\"Not able to retrieve runtime metadata\")\n\n    spinner.text = \"Writing metadata\"\n    const metadataRaw = opaqueMeta.slice(compactLen)\n    const filename = await storeMetadata(metadataRaw, key)\n    spinner.succeed(`Metadata saved as ${filename}`)\n\n    entries[key] = {\n      metadata: filename,\n    }\n  } else {\n    const entry = entryFromOptions(options)\n    entries[key] = entry\n\n    if (!options.noPersist) {\n      const spinner = ora(`Loading metadata`).start()\n      const { metadataRaw, genesis, codeHash } = (await getMetadata(entry))!\n\n      spinner.text = \"Writing metadata\"\n      const filename = await storeMetadata(metadataRaw, key)\n\n      spinner.succeed(`Metadata saved as ${filename}`)\n      entry.metadata = filename\n      entry.genesis = genesis\n      entry.codeHash = codeHash\n    }\n  }\n\n  await writePapiConfig(options.config, config)\n  console.log(`Saved new spec \"${key}\"`)\n\n  if (!options.skipCodegen) {\n    generate({\n      config: options.config,\n    })\n  }\n}\n\nasync function storeMetadata(metadata: Uint8Array, key: string) {\n  const defaultFolder = join(papiFolder, \"metadata\")\n  if (!existsSync(defaultFolder)) {\n    await fs.mkdir(defaultFolder, { recursive: true })\n  }\n  const filename = join(defaultFolder, `${key}.scale`)\n  await writeMetadataToDisk(metadata, filename)\n  return filename\n}\n\nconst entryFromOptions = (options: AddOptions): EntryConfig => {\n  if (options.wsUrl) {\n    return {\n      wsUrl: options.wsUrl,\n      at: options.at,\n    }\n  }\n  if (options.chainSpec) {\n    return {\n      chainSpec: options.chainSpec,\n    }\n  }\n  if (options.name) {\n    return {\n      chain: options.name,\n    }\n  }\n\n  throw new Error(\n    \"add command needs one source, specified by options -f -w -c or -n\",\n  )\n}\n"],"names":[],"mappings":";;;;;;;;;;;AA8BA,eAAsB,GAAA,CAAI,KAAa,OAAA,EAAqB;AAC1D,EAAA,MAAM,MAAA,GAAU,MAAM,cAAA,CAAe,OAAA,CAAQ,MAAM,CAAA,IAAM,aAAA;AACzD,EAAA,MAAM,UAAU,MAAA,CAAO,OAAA;AAEvB,EAAA,IAAI,OAAO,OAAA,EAAS;AAClB,IAAA,OAAA,CAAQ,IAAA,CAAK,CAAA,mBAAA,EAAsB,GAAG,CAAA,OAAA,CAAS,CAAA;AAAA,EACjD;AAEA,EAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,IAAA,OAAA,CAAQ,GAAG,CAAA,GAAI;AAAA,MACb,UAAU,OAAA,CAAQ;AAAA,KACpB;AAAA,EACF,CAAA,MAAA,IAAW,QAAQ,IAAA,EAAM;AACvB,IAAA,MAAM,OAAA,GAAU,GAAA,CAAI,CAAA,6BAAA,CAA+B,CAAA,CAAE,KAAA,EAAM;AAC3D,IAAA,MAAM,WAAA,GAAA,CAAe,MAAM,EAAA,CAAG,QAAA,CAAS,QAAQ,IAAI,CAAA,EAAG,SAAS,KAAK,CAAA;AACpE,IAAA,MAAM,aAAa,OAAA,CAAQ,sBAAA,CAAuB,CAAA,EAAA,EAAK,WAAW,EAAE,CAAC,CAAA;AAGrE,IAAA,MAAM,WAAA,GAAc,aAAA,CAAc,GAAA,CAAI,UAAU,CAAA;AAChD,IAAA,MAAM,UAAA,GAAa,aAAA,CAAc,GAAA,CAAI,WAAW,CAAA,CAAE,MAAA;AAElD,IAAA,IAAI,UAAA,CAAW,SAAS,UAAA,KAAe,WAAA;AACrC,MAAA,MAAM,IAAI,MAAM,uCAAuC,CAAA;AAEzD,IAAA,OAAA,CAAQ,IAAA,GAAO,kBAAA;AACf,IAAA,MAAM,WAAA,GAAc,UAAA,CAAW,KAAA,CAAM,UAAU,CAAA;AAC/C,IAAA,MAAM,QAAA,GAAW,MAAM,aAAA,CAAc,WAAA,EAAa,GAAG,CAAA;AACrD,IAAA,OAAA,CAAQ,OAAA,CAAQ,CAAA,kBAAA,EAAqB,QAAQ,CAAA,CAAE,CAAA;AAE/C,IAAA,OAAA,CAAQ,GAAG,CAAA,GAAI;AAAA,MACb,QAAA,EAAU;AAAA,KACZ;AAAA,EACF,CAAA,MAAO;AACL,IAAA,MAAM,KAAA,GAAQ,iBAAiB,OAAO,CAAA;AACtC,IAAA,OAAA,CAAQ,GAAG,CAAA,GAAI,KAAA;AAEf,IAAA,IAAI,CAAC,QAAQ,SAAA,EAAW;AACtB,MAAA,MAAM,OAAA,GAAU,GAAA,CAAI,CAAA,gBAAA,CAAkB,CAAA,CAAE,KAAA,EAAM;AAC9C,MAAA,MAAM,EAAE,WAAA,EAAa,OAAA,EAAS,UAAS,GAAK,MAAM,YAAY,KAAK,CAAA;AAEnE,MAAA,OAAA,CAAQ,IAAA,GAAO,kBAAA;AACf,MAAA,MAAM,QAAA,GAAW,MAAM,aAAA,CAAc,WAAA,EAAa,GAAG,CAAA;AAErD,MAAA,OAAA,CAAQ,OAAA,CAAQ,CAAA,kBAAA,EAAqB,QAAQ,CAAA,CAAE,CAAA;AAC/C,MAAA,KAAA,CAAM,QAAA,GAAW,QAAA;AACjB,MAAA,KAAA,CAAM,OAAA,GAAU,OAAA;AAChB,MAAA,KAAA,CAAM,QAAA,GAAW,QAAA;AAAA,IACnB;AAAA,EACF;AAEA,EAAA,MAAM,eAAA,CAAgB,OAAA,CAAQ,MAAA,EAAQ,MAAM,CAAA;AAC5C,EAAA,OAAA,CAAQ,GAAA,CAAI,CAAA,gBAAA,EAAmB,GAAG,CAAA,CAAA,CAAG,CAAA;AAErC,EAAA,IAAI,CAAC,QAAQ,WAAA,EAAa;AACxB,IAAA,QAAA,CAAS;AAAA,MACP,QAAQ,OAAA,CAAQ;AAAA,KACjB,CAAA;AAAA,EACH;AACF;AAEA,eAAe,aAAA,CAAc,UAAsB,GAAA,EAAa;AAC9D,EAAA,MAAM,aAAA,GAAgB,IAAA,CAAK,UAAA,EAAY,UAAU,CAAA;AACjD,EAAA,IAAI,CAAC,UAAA,CAAW,aAAa,CAAA,EAAG;AAC9B,IAAA,MAAM,GAAG,KAAA,CAAM,aAAA,EAAe,EAAE,SAAA,EAAW,MAAM,CAAA;AAAA,EACnD;AACA,EAAA,MAAM,QAAA,GAAW,IAAA,CAAK,aAAA,EAAe,CAAA,EAAG,GAAG,CAAA,MAAA,CAAQ,CAAA;AACnD,EAAA,MAAM,mBAAA,CAAoB,UAAU,QAAQ,CAAA;AAC5C,EAAA,OAAO,QAAA;AACT;AAEA,MAAM,gBAAA,GAAmB,CAAC,OAAA,KAAqC;AAC7D,EAAA,IAAI,QAAQ,KAAA,EAAO;AACjB,IAAA,OAAO;AAAA,MACL,OAAO,OAAA,CAAQ,KAAA;AAAA,MACf,IAAI,OAAA,CAAQ;AAAA,KACd;AAAA,EACF;AACA,EAAA,IAAI,QAAQ,SAAA,EAAW;AACrB,IAAA,OAAO;AAAA,MACL,WAAW,OAAA,CAAQ;AAAA,KACrB;AAAA,EACF;AACA,EAAA,IAAI,QAAQ,IAAA,EAAM;AAChB,IAAA,OAAO;AAAA,MACL,OAAO,OAAA,CAAQ;AAAA,KACjB;AAAA,EACF;AAEA,EAAA,MAAM,IAAI,KAAA;AAAA,IACR;AAAA,GACF;AACF,CAAA;;;;"}

package/dist/main/src/commands/generate.js

@@ -0,0 +1,459 @@
+import { getMetadata } from '../metadata.js';
+import { readPapiConfig } from '../papiConfig.js';
+import { cliVersion } from '../version.js';
+import { generateMultipleDescriptors, generateInkTypes, generateSolTypes, capitalize } from '@polkadot-api/codegen';
+import { getInkLookup } from '@polkadot-api/ink-contracts';
+import { EntryPointCodec, TypedefCodec } from '@polkadot-api/metadata-compatibility';
+import { Blake2128, Binary, h64, Vector, Tuple } from '@polkadot-api/substrate-bindings';
+import { toHex } from '@polkadot-api/utils';
+import { spawn } from 'child_process';
+import { existsSync } from 'fs';
+import fsExists from 'fs.promises.exists';
+import fs, { mkdtemp, rm } from 'fs/promises';
+import { tmpdir } from 'os';
+import path, { join } from 'path';
+import process from 'process';
+import { readPackage } from 'read-pkg';
+import { rollup } from 'rollup';
+import esbuild from 'rollup-plugin-esbuild';
+import tsc from 'tsc-prog';
+import { updatePackage } from 'write-package';
+import { detectPackageManager } from '../packageManager.js';
+
+async function generate(opts) {
+  if (process.env.PAPI_SKIP_GENERATE) {
+    return;
+  }
+  if (opts.whitelist) {
+    console.error(
+      "The --whitelist option has been removed. The whitelist should be placed at `.papi/whitelist.ts`"
+    );
+    process.exit(1);
+  }
+  const config = await readPapiConfig(opts.config);
+  if (!config) {
+    throw new Error("Can't find the Polkadot-API configuration");
+  }
+  const sources = config.entries;
+  if (Object.keys(sources).length == 0) {
+    console.log("No chains defined in config file");
+  }
+  console.log(`Reading metadata`);
+  const chains = await Promise.all(
+    Object.entries(sources).map(async ([key, source]) => ({
+      key,
+      ...await getMetadata(source),
+      knownTypes: {}
+    }))
+  );
+  const contracts = Object.fromEntries(
+    await Promise.all(
+      ["ink", "sol"].map(async (kind) => [
+        kind,
+        Object.fromEntries(
+          await Promise.all(
+            Object.entries(config[kind] ?? {}).map(async ([key, v]) => [
+              key,
+              toHex(Blake2128(Binary.fromText(await fs.readFile(v, "utf-8"))))
+            ])
+          )
+        )
+      ])
+    )
+  );
+  if (chains.length === 0) {
+    console.log("No entries in polkadot-api.json. Nothing to generate.");
+    return;
+  }
+  const whitelist = await readWhitelist(".papi/whitelist.ts");
+  const descriptorsDir = join(process.cwd(), config.descriptorPath);
+  if (await alreadyGenerated(descriptorsDir, chains, contracts, whitelist)) {
+    console.log("Detected previous descriptors with no changes needed.");
+    return;
+  }
+  console.log(`Generating descriptors`);
+  await cleanDescriptorsPackage(config.descriptorPath);
+  if (!config.options?.noDescriptorsPackage) {
+    await addDescriptorsToPackageJson(config.descriptorPath);
+  }
+  const clientPath = opts.clientLibrary ?? "polkadot-api";
+  const descriptorSrcDir = join(descriptorsDir, "src");
+  const hash = await outputCodegen(
+    chains,
+    descriptorSrcDir,
+    clientPath,
+    whitelist
+  );
+  if (config.ink || config.sol) {
+    outputContractCodegen(config, descriptorSrcDir);
+  }
+  await replacePackageJson(descriptorsDir, hash);
+  const cleanCodegen = await compileCodegen(descriptorsDir);
+  if (cleanCodegen) {
+    await tagGenerated(descriptorsDir, chains, contracts, whitelist);
+    await fs.rm(descriptorSrcDir, { recursive: true });
+  }
+  if (!config.options?.noDescriptorsPackage) {
+    await runInstall();
+    await flushBundlerCache();
+  }
+}
+async function tagGenerated(descriptorsDir, chains, contracts, whitelist) {
+  const filePath = join(descriptorsDir, "generated.json");
+  await fs.writeFile(
+    filePath,
+    JSON.stringify({
+      cliVersion,
+      whitelist,
+      chains: Object.fromEntries(
+        chains.map(({ key, metadataRaw }) => [
+          key,
+          toHex(Blake2128(metadataRaw))
+        ])
+      ),
+      contracts
+    })
+  );
+}
+async function alreadyGenerated(descriptorsDir, chains, contracts, whitelist) {
+  const generatedJs\u00F4n = join(descriptorsDir, "generated.json");
+  if (!existsSync(generatedJs\u00F4n)) return false;
+  try {
+    const generated = JSON.parse(
+      await fs.readFile(generatedJs\u00F4n, {
+        encoding: "utf-8"
+      })
+    );
+    if ((generated.whitelist ?? ["*"]).join(",") != (whitelist ?? ["*"]).join(",") || generated.cliVersion !== cliVersion)
+      return false;
+    return chains.length === Object.entries(generated.chains).length && chains.every(({ key, metadataRaw }) => {
+      const hash = toHex(Blake2128(metadataRaw));
+      return hash === generated.chains[key];
+    }) && ["ink", "sol"].every(
+      (kind) => Object.entries(contracts[kind]).length === Object.entries(generated.contracts[kind]).length && Object.entries(contracts[kind]).every(
+        ([k, hash]) => hash === generated.contracts[kind][k]
+      )
+    );
+  } catch {
+    return false;
+  }
+}
+async function cleanDescriptorsPackage(path2) {
+  const descriptorsDir = join(process.cwd(), path2);
+  if (!existsSync(descriptorsDir)) {
+    await fs.mkdir(descriptorsDir, { recursive: true });
+    await fs.writeFile(
+      join(descriptorsDir, ".gitignore"),
+      "*\n!.gitignore\n!package.json\n"
+    );
+  }
+  const distDir = join(descriptorsDir, "dist");
+  if (existsSync(distDir)) {
+    await fs.rm(distDir, { recursive: true });
+  }
+}
+async function addDescriptorsToPackageJson(path2) {
+  const [packageJson, protocol] = await Promise.all([
+    readPackage(),
+    getPackageProtocol()
+  ]);
+  const packageSource = `${protocol}:${path2}`;
+  const currentSource = packageJson.dependencies?.["@polkadot-api/descriptors"];
+  if (currentSource !== packageSource) {
+    await updatePackage({
+      dependencies: {
+        "@polkadot-api/descriptors": packageSource
+      }
+    });
+  }
+}
+async function getPackageProtocol() {
+  const { packageManager, version } = await detectPackageManager();
+  switch (packageManager) {
+    case "yarn":
+      const yarnMajorVersion = Number(version.split(".").at(0));
+      return yarnMajorVersion >= 2 ? "portal" : "file";
+    default:
+      return "file";
+  }
+}
+async function runInstall() {
+  const { executable } = await detectPackageManager();
+  console.log(`${executable} install`);
+  const child = spawn(executable, ["install"], {
+    stdio: "inherit",
+    shell: true,
+    env: {
+      ...process.env,
+      PAPI_SKIP_GENERATE: "true"
+    }
+  });
+  await new Promise((resolve) => child.on("close", resolve));
+}
+const generateMetadataExportFile = (input) => `const binMeta: string = "${Buffer.from(input).toString("base64")}"; export default binMeta;`;
+async function outputCodegen(chains, outputFolder, clientPath, whitelist) {
+  const {
+    commonFileContent,
+    descriptorsFileContent,
+    descriptorTypesFiles,
+    metadataTypes,
+    typesFileContent,
+    publicTypes
+  } = generateMultipleDescriptors(
+    chains,
+    {
+      client: clientPath,
+      metadataTypes: "./metadataTypes",
+      types: "./common-types",
+      descriptorValues: "./descriptors",
+      common: "./common"
+    },
+    {
+      whitelist: whitelist ?? void 0
+    }
+  );
+  const hash = h64(
+    Binary.fromText(Array.from(metadataTypes.checksumToIdx.keys()).join(""))
+  );
+  const EntryPointsCodec = Vector(EntryPointCodec);
+  const TypedefsCodec = Vector(TypedefCodec);
+  const TypesCodec = Tuple(EntryPointsCodec, TypedefsCodec);
+  await fs.mkdir(outputFolder, { recursive: true });
+  await fs.writeFile(path.join(outputFolder, "common.ts"), commonFileContent);
+  const metadataTypesBase64 = Buffer.from(
+    TypesCodec.enc([metadataTypes.entryPoints, metadataTypes.typedefs])
+  ).toString("base64");
+  await fs.writeFile(
+    path.join(outputFolder, "metadataTypes.ts"),
+    `
+const content = "${metadataTypesBase64}"
+export default content
+    `
+  );
+  await fs.writeFile(
+    path.join(outputFolder, "descriptors.ts"),
+    descriptorsFileContent
+  );
+  await fs.writeFile(
+    path.join(outputFolder, "common-types.ts"),
+    typesFileContent
+  );
+  await Promise.all(
+    chains.map((chain, i) => [
+      fs.writeFile(
+        join(outputFolder, `${chain.key}.ts`),
+        descriptorTypesFiles[i].content
+      ),
+      fs.writeFile(
+        join(outputFolder, `${chain.key}_metadata.ts`),
+        generateMetadataExportFile(chain.metadataRaw)
+      )
+    ]).flat()
+  );
+  await generateIndex(
+    outputFolder,
+    chains.map((chain) => chain.key),
+    publicTypes,
+    Object.fromEntries(
+      chains.filter((x) => x.codeHash).map((x) => [x.codeHash, x.key])
+    )
+  );
+  return hash;
+}
+async function outputContractCodegen(contracts, outputFolder) {
+  console.log("Generating smart contract types");
+  const contractsFolder = join(outputFolder, "contracts");
+  if (!existsSync(contractsFolder))
+    await fs.mkdir(contractsFolder, { recursive: true });
+  const imports = [];
+  for (const [key, metadata] of Object.entries(contracts.ink ?? {})) {
+    try {
+      const types = generateInkTypes(
+        getInkLookup(JSON.parse(await fs.readFile(metadata, "utf-8")))
+      );
+      await fs.writeFile(join(contractsFolder, `${key}.ts`), types);
+      imports.push(`export { descriptor as ${key} } from './${key}'`);
+    } catch (ex) {
+      console.error("Exception when generating descriptors for contract " + key);
+      console.error(ex);
+    }
+  }
+  for (const [key, metadata] of Object.entries(contracts.sol ?? {})) {
+    try {
+      const types = generateSolTypes(
+        JSON.parse(await fs.readFile(metadata, "utf-8"))
+      );
+      await fs.writeFile(join(contractsFolder, `${key}.ts`), types);
+      imports.push(`export { descriptor as ${key} } from './${key}'`);
+    } catch (ex) {
+      console.error("Exception when generating descriptors for contract " + key);
+      console.error(ex);
+    }
+  }
+  await fs.writeFile(
+    join(contractsFolder, `index.ts`),
+    imports.join("\n") + "\n"
+  );
+  fs.appendFile(
+    join(outputFolder, "index.ts"),
+    `
+    export * as contracts from './contracts';
+    `
+  );
+}
+async function compileCodegen(packageDir) {
+  const srcDir = join(packageDir, "src");
+  const outDir = join(packageDir, "dist");
+  if (await fsExists(outDir)) {
+    await fs.rm(outDir, { recursive: true });
+  }
+  const bundleSuccess = await bundleEsm(path.join(srcDir, "index.ts"), {
+    dir: outDir
+  });
+  const program = tsc.createProgramFromConfig({
+    basePath: srcDir,
+    compilerOptions: {
+      skipLibCheck: true,
+      declaration: true,
+      emitDeclarationOnly: true,
+      target: "esnext",
+      module: "esnext",
+      resolveJsonModule: true,
+      allowSyntheticDefaultImports: true,
+      outDir
+    }
+  });
+  tsc.emit(program);
+  const errors = [
+    program.getGlobalDiagnostics(),
+    program.getOptionsDiagnostics(),
+    program.getSemanticDiagnostics(),
+    program.getSyntacticDiagnostics(),
+    program.getDeclarationDiagnostics(),
+    program.getConfigFileParsingDiagnostics()
+  ].flat();
+  return bundleSuccess && errors.length === 0;
+}
+const cacheMetadataStr = `
+export const getMetadata: (codeHash: string) => Promise<Uint8Array | null> = async (
+  codeHash: string
+)=> {
+  try {
+    return await metadatas[codeHash].getMetadata()
+  } catch {}
+  return null
+}`;
+const generateIndex = async (path2, keys, publicTypes, metadatas) => {
+  const indexTs = [
+    ...keys.flatMap((key) => [
+      `import { default as ${key}, type ${capitalize(key)}WhitelistEntry } from "./${key}";`,
+      `export { ${key} }`,
+      `export type * from "./${key}";`
+    ]),
+    `export {`,
+    publicTypes.join(", "),
+    `} from './common-types';`,
+    `const metadatas: Record<string, { getMetadata: () => Promise<Uint8Array> }> = {${Object.entries(
+      metadatas
+    ).map(([codeHash, key]) => `["${codeHash}"]: ${key}`).join(",\n")}}`,
+    cacheMetadataStr,
+    `export type WhitelistEntry = ${keys.map((key) => `${capitalize(key)}WhitelistEntry`).join(" | ")};`,
+    `export type WhitelistEntriesByChain = Partial<{"*": WhitelistEntry[], ${keys.map((key) => `${key}: WhitelistEntry[]`).join(",\n")}}>`
+  ].join("\n");
+  await fs.writeFile(join(path2, "index.ts"), indexTs);
+};
+async function replacePackageJson(descriptorsDir, version) {
+  await fs.writeFile(
+    join(descriptorsDir, "package.json"),
+    `{
+  "version": "0.1.0-autogenerated.${version}",
+  "name": "@polkadot-api/descriptors",
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "module": "./dist/index.js",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "browser": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "sideEffects": false,
+  "peerDependencies": {
+    "polkadot-api": ">=2.0.0-rc.1"
+  }
+}
+`
+  );
+}
+async function readWhitelist(filename) {
+  if (!await fsExists(filename)) {
+    return null;
+  }
+  const tmpDir = await mkdtemp(join(tmpdir(), "papi-"));
+  try {
+    await bundleEsm(filename, { file: join(tmpDir, "index.js") });
+    const { whitelist } = await import(join(tmpDir, "index.js"));
+    return whitelist;
+  } finally {
+    await rm(tmpDir, { recursive: true }).catch(console.error);
+  }
+}
+async function flushBundlerCache() {
+  try {
+    const viteMetadata = join(
+      process.cwd(),
+      "node_modules",
+      ".vite",
+      "deps",
+      "_metadata.json"
+    );
+    if (await fsExists(viteMetadata)) {
+      await rm(viteMetadata);
+    }
+  } catch (ex) {
+    console.error(ex);
+  }
+}
+const isExternal = (id) => !id.startsWith(".") && !path.isAbsolute(id);
+const scaleBinaryPlugin = () => ({
+  name: "scale-binary",
+  async load(id) {
+    if (!id.endsWith(".scale")) return null;
+    const data = await fs.readFile(id);
+    const base64 = Buffer.from(data).toString("base64");
+    return `const base64 = "${base64}";
+export default base64;`;
+  }
+});
+async function bundleEsm(entry, output) {
+  let bundle;
+  try {
+    bundle = await rollup({
+      input: entry,
+      external: isExternal,
+      plugins: [scaleBinaryPlugin(), esbuild({ target: "es2022" })],
+      logLevel: "silent"
+    });
+    await bundle.write({
+      ...output,
+      format: "es"
+    });
+    return true;
+  } catch (ex) {
+    console.error(ex);
+    return false;
+  } finally {
+    await bundle?.close();
+  }
+}
+
+export { generate };
+//# sourceMappingURL=generate.js.map