@talismn/scale 0.1.0 → 0.1.2

package/dist/declarations/src/papito.d.ts

@@ -1,6 +1,6 @@
 export { getDynamicBuilder, getLookupFn } from "@polkadot-api/metadata-builders";
-export type { V14, V15, V15Extrinsic, Codec, Binary } from "@polkadot-api/substrate-bindings";
+export type { Codec, UnifiedMetadata } from "@polkadot-api/substrate-bindings";
+export { decAnyMetadata, unifyMetadata, metadata } from "@polkadot-api/substrate-bindings";
 export { toHex, fromHex } from "@polkadot-api/utils";
 /** Constant: https://docs.substrate.io/build/application-development/#metadata-format */
 export declare const magicNumber = 1635018093;
-export { v14, v15, metadata } from "@polkadot-api/substrate-bindings";

package/dist/declarations/src/util/Prettify.d.ts

@@ -0,0 +1,3 @@
+export type Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/declarations/src/util/compactMetadata.d.ts

@@ -1,10 +1,11 @@
-import { V14, V15 } from "../papito";
-export type V14Type = V14["lookup"][0];
-export type V14Pallet = V14["pallets"][0];
-export type V14StorageItem = NonNullable<V14Pallet["storage"]>["items"][0];
-export type V15Type = V15["lookup"][0];
-export type V15Pallet = V15["pallets"][0];
-export type V15StorageItem = NonNullable<V15Pallet["storage"]>["items"][0];
+import { Metadata } from "@polkadot-api/substrate-bindings";
+export type MetadataType = SupportedMetadata["lookup"][number];
+export type MetadataPallet = SupportedMetadata["pallets"][number];
+export type MetadataStorageItem = NonNullable<MetadataPallet["storage"]>["items"][number];
+type SupportedMetadata = Extract<Metadata["metadata"], {
+    tag: SupportedMetadataVersion;
+}>["value"];
+type SupportedMetadataVersion = "v14" | "v15" | "v16";
 /**
  * Converts a `Metadata` into a `MiniMetadata`.
  *
@@ -14,7 +15,12 @@ export type V15StorageItem = NonNullable<V15Pallet["storage"]>["items"][0];
  * E.g. if `palletsAndItems` is `{ pallet: "System", items: ["Account"] }`, then only the
  * types used in the `System.Account` storage query will remain inside of metadata.lookups.
  */
-export declare const compactMetadata: (metadata: V15 | V14, palletsAndItems: Array<{
+export declare const compactMetadata: (anyMetadata: Metadata, palletsAndItems?: Array<{
     pallet: string;
+    constants?: string[];
     items: string[];
+}>, runtimeApisAndMethods?: Array<{
+    runtimeApi: string;
+    methods: string[];
 }>, extraKeepTypes?: number[]) => void;
+export {};

package/dist/declarations/src/util/encodeMetadata.d.ts

@@ -1,8 +1,2 @@
-import { V14, V15 } from "@polkadot-api/substrate-bindings";
-export declare const encodeMetadata: ({ metadata, tag, }: {
-    metadata: V15;
-    tag: "v15";
-} | {
-    metadata: V14;
-    tag: "v14";
-}) => string;
+import { Metadata } from "@polkadot-api/substrate-bindings";
+export declare const encodeMetadata: (metadata: Metadata) => string;

package/dist/declarations/src/util/index.d.ts

@@ -1,5 +1,4 @@
 export * from "./compactMetadata";
-export * from "./decodeMetadata";
 export * from "./decodeScale";
 export * from "./encodeMetadata";
 export * from "./encodeStateKey";

package/dist/declarations/src/util/serdePapi.d.ts

@@ -26,4 +26,5 @@
  * Output: `Enum("Stellar", { code: Binary.fromText("TZS"), issuer: Binary.fromHex("0x34c94b2a4ba9e8b57b22547dcbb30f443c4cb02da3829a89aa1bd4780e4466ba") })`
  */
 export declare const papiParse: <T = unknown>(text: string | T) => T;
-export declare const papiStringify: (value: any, space?: string | number) => string;
+export declare const papiStringify: (value: any, // eslint-disable-line @typescript-eslint/no-explicit-any
+space?: string | number) => string;

package/dist/talismn-scale.cjs.dev.js

@@ -1,8 +1,8 @@
 'use strict';
 
 var metadataBuilders = require('@polkadot-api/metadata-builders');
-var utils = require('@polkadot-api/utils');
 var substrateBindings = require('@polkadot-api/substrate-bindings');
+var utils = require('@polkadot-api/utils');
 var anylogger = require('anylogger');
 var scaleTs = require('scale-ts');
 
@@ -14,55 +14,7 @@ var anylogger__default = /*#__PURE__*/_interopDefault(anylogger);
 const magicNumber = 1635018093;
 
 var packageJson = {
-	name: "@talismn/scale",
-	version: "0.1.0",
-	author: "Talisman",
-	homepage: "https://talisman.xyz",
-	license: "GPL-3.0-or-later",
-	publishConfig: {
-		access: "public"
-	},
-	repository: {
-		directory: "packages/scale",
-		type: "git",
-		url: "https://github.com/talismansociety/talisman.git"
-	},
-	main: "dist/talismn-scale.cjs.js",
-	module: "dist/talismn-scale.esm.js",
-	files: [
-		"/dist"
-	],
-	engines: {
-		node: ">=18"
-	},
-	scripts: {
-		test: "jest",
-		lint: "eslint src --max-warnings 0",
-		clean: "rm -rf dist .turbo node_modules"
-	},
-	dependencies: {
-		"@polkadot-api/metadata-builders": "0.9.1",
-		"@polkadot-api/substrate-bindings": "0.9.3",
-		"@polkadot-api/utils": "0.1.2",
-		anylogger: "^1.0.11",
-		"scale-ts": "^1.6.1"
-	},
-	devDependencies: {
-		"@talismn/eslint-config": "workspace:*",
-		"@talismn/tsconfig": "workspace:*",
-		"@types/jest": "^29.5.14",
-		eslint: "^8.57.1",
-		jest: "^29.7",
-		"ts-jest": "^29.2.5",
-		typescript: "^5.6.3"
-	},
-	eslintConfig: {
-		root: true,
-		"extends": [
-			"@talismn/eslint-config/base"
-		]
-	}
-};
+	name: "@talismn/scale"};
 
 var log = anylogger__default.default(packageJson.name);
 
@@ -75,7 +27,10 @@ var log = anylogger__default.default(packageJson.name);
  * E.g. if `palletsAndItems` is `{ pallet: "System", items: ["Account"] }`, then only the
  * types used in the `System.Account` storage query will remain inside of metadata.lookups.
  */
-const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
+const compactMetadata = (anyMetadata, palletsAndItems = [], runtimeApisAndMethods = [], extraKeepTypes = []) => {
+  if (!isCompactableMetadata(anyMetadata)) throw new Error(`Metadata version ${anyMetadata.metadata.tag} not supported in compactMetadata`);
+  const metadata = anyMetadata.metadata.value;
+
   // remove pallets we don't care about
   metadata.pallets = metadata.pallets.filter(pallet =>
   // keep this pallet if it's listed in `palletsAndItems`
@@ -84,8 +39,9 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
   }) => pallet.name === palletName));
 
   // remove fields we don't care about from each pallet, and extract types for each storage item we care about
-  const items = palletsAndItems.flatMap(({
+  const palletsKeepTypes = palletsAndItems.flatMap(({
     pallet: palletName,
+    constants: constantNames,
     items: itemNames
   }) => {
     const pallet = metadata.pallets.find(pallet => pallet.name === palletName);
@@ -96,7 +52,7 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
 
     // remove pallet fields we don't care about
     pallet.calls = undefined;
-    pallet.constants = [];
+    pallet.constants = constantNames ? pallet.constants.filter(constant => constantNames.includes(constant.name)) : [];
     // v15 (NOT v14) has docs
     if ("docs" in pallet) pallet.docs = [];
     pallet.errors = undefined;
@@ -105,19 +61,54 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
 
     // filter and extract storage items we care about
     pallet.storage.items = pallet.storage.items.filter(item => itemNames.some(itemName => item.name === itemName));
-    return pallet.storage.items;
+    return [...pallet.storage.items.flatMap(item => [
+    // each type can be either "Plain" or "Map"
+    // if it's "Plain" we only need to get the value type
+    // if it's a "Map" we want to keep both the key AND the value types
+    item.type.tag === "plain" && item.type.value, item.type.tag === "map" && item.type.value.key, item.type.tag === "map" && item.type.value.value]).filter(type => typeof type === "number"), ...pallet.constants.flatMap(constant => constant.type)];
   });
 
+  // remove runtime apis we don't care about
+  let runtimeApisKeepTypes = [];
+  if ("apis" in metadata) {
+    // metadata is v15 (NOT v14)
+
+    // keep this api if it's listed in `runtimeApisAndMethods`
+    metadata.apis = metadata.apis.filter(runtimeApi => runtimeApisAndMethods.some(({
+      runtimeApi: runtimeApiName
+    }) => runtimeApi.name === runtimeApiName));
+
+    // remove methods we don't care about from each runtime api, and extract types for each call's params and result
+    runtimeApisKeepTypes = runtimeApisAndMethods.flatMap(({
+      runtimeApi: runtimeApiName,
+      methods: methodNames
+    }) => {
+      const runtimeApi = metadata.apis.find(runtimeApi => runtimeApi.name === runtimeApiName);
+      if (!runtimeApi) {
+        log.debug("Failed to find runtimeApi", runtimeApiName);
+        return [];
+      }
+
+      // remove runtime fields we don't care about
+      runtimeApi.docs = [];
+      if (!runtimeApi.methods) return [];
+
+      // filter and extract methods we care about
+      runtimeApi.methods = runtimeApi.methods.filter(method => methodNames.some(methodName => method.name === methodName));
+      return runtimeApi.methods.flatMap(method => [
+      // each method has an array of input types (for the params)
+      ...method.inputs.map(input => input.type),
+      // and one output type (for the result)
+      method.output]);
+    });
+  }
+
   // this is a set of type ids which we plan to keep in our compacted metadata
   // anything not in this set will be deleted
   // we start off with just the types of the state calls we plan to make,
   // then we run those types through a function (addDependentTypes) which will also include
   // all of the types which those types depend on - recursively
-  const keepTypes = new Set(items.flatMap(item => [
-  // each type can be either "Plain" or "Map"
-  // if it's "Plain" we only need to get the value type
-  // if it's a "Map" we want to keep both the key AND the value types
-  item.type.tag === "plain" && item.type.value, item.type.tag === "map" && item.type.value.key, item.type.tag === "map" && item.type.value.value]).filter(type => typeof type === "number"));
+  const keepTypes = new Set([...palletsKeepTypes, ...runtimeApisKeepTypes]);
   extraKeepTypes?.forEach(type => keepTypes.add(type));
 
   // recursively find all the types which our keepTypes depend on and add them to the keepTypes set
@@ -136,20 +127,11 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
     return newTypeId ?? 0;
   };
   remapTypeIds(metadata, getNewTypeId);
-
-  // ditch the remaining data we don't need to keep in a miniMetata
-  if ("apis" in metadata) {
-    // metadata is v15 (NOT v14)
-    metadata.apis = [];
-  }
-  if ("address" in metadata.extrinsic) {
-    // metadata is v15 (NOT v14)
-    metadata.extrinsic.address = 0;
-    metadata.extrinsic.call = 0;
-    metadata.extrinsic.extra = 0;
-    metadata.extrinsic.signature = 0;
-  }
-  metadata.extrinsic.signedExtensions = [];
+  if ("address" in metadata.extrinsic) metadata.extrinsic.address = 0;
+  if ("call" in metadata.extrinsic) metadata.extrinsic.call = 0;
+  if ("signature" in metadata.extrinsic) metadata.extrinsic.signature = 0;
+  if ("extra" in metadata.extrinsic) metadata.extrinsic.extra = 0;
+  if ("signedExtensions" in metadata.extrinsic) metadata.extrinsic.signedExtensions = [];
   if ("outerEnums" in metadata) {
     // metadata is v15 (NOT v14)
     metadata.outerEnums.call = 0;
@@ -157,6 +139,16 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
     metadata.outerEnums.event = 0;
   }
 };
+const isCompactableMetadata = metadata => {
+  switch (metadata.metadata.tag) {
+    case "v14":
+    case "v15":
+    case "v16":
+      return true;
+    default:
+      return false;
+  }
+};
 const addDependentTypes = (metadataTysMap, keepTypes, types,
 // Prevent stack overflow when a type references itself
 addedTypes = new Set()) => {
@@ -208,6 +200,7 @@ addedTypes = new Set()) => {
 const remapTypeIds = (metadata, getNewTypeId) => {
   remapLookupTypeIds(metadata, getNewTypeId);
   remapStorageTypeIds(metadata, getNewTypeId);
+  remapRuntimeApisTypeIds(metadata, getNewTypeId);
 };
 const remapLookupTypeIds = (metadata, getNewTypeId) => {
   for (const type of metadata.lookup) {
@@ -270,79 +263,59 @@ const remapStorageTypeIds = (metadata, getNewTypeId) => {
         item.type.value.value = getNewTypeId(item.type.value.value);
       }
     }
+    for (const constant of pallet.constants ?? []) {
+      constant.type = getNewTypeId(constant.type);
+    }
   }
 };
-
-/**
- * Extracts the `version` u8 from a SCALE-encoded metadata blob and returns it as a `number`.
- *
- * Only reads the first 40 bytes of the blob.
- */
-const getMetadataVersion = metadataRpc => {
-  try {
-    return scaleTs.Struct({
-      magicNumber: scaleTs.u32,
-      version: scaleTs.u8
-    }).dec(metadataRpc).version;
-  } catch {
-    return 0;
+const remapRuntimeApisTypeIds = (metadata, getNewTypeId) => {
+  for (const runtimeApi of metadata.apis) {
+    for (const method of runtimeApi.methods ?? []) {
+      for (const input of method.inputs) {
+        input.type = getNewTypeId(input.type);
+      }
+      method.output = getNewTypeId(method.output);
+    }
   }
 };
 
-const decodeMetadata = metadataRpc => {
-  const metadataVersion = getMetadataVersion(metadataRpc);
-  if (metadataVersion !== 15 && metadataVersion !== 14) return {
-    metadataVersion
-  };
-  const decoded = substrateBindings.metadata.dec(metadataRpc);
-  if (decoded.metadata.tag === "v15") return {
-    metadataVersion,
-    metadata: decoded.metadata.value,
-    tag: decoded.metadata.tag
-  };
-  if (decoded.metadata.tag === "v14") return {
-    metadataVersion,
-    metadata: decoded.metadata.value,
-    tag: decoded.metadata.tag
-  };
-  return {
-    metadataVersion
-  };
-};
-
 const decodeScale = (scaleCoder, change, error) => {
   if (change === null) return null;
   try {
-    return scaleCoder?.dec(change) ?? null;
+    return scaleCoder?.value?.dec(change) ?? null;
   } catch (cause) {
     log.warn(error ?? `Failed to decode ${change}`, cause);
     return null;
   }
 };
 
-const encodeMetadata = ({
-  metadata,
-  tag
-}) => utils.toHex(substrateBindings.metadata.enc({
-  magicNumber,
-  metadata: tag === "v15" ? {
-    tag,
-    value: metadata
-  } : {
-    tag,
-    value: metadata
-  }
-}));
+const encodeMetadata = metadata => utils.toHex(substrateBindings.metadata.enc(metadata));
 
 const encodeStateKey = (scaleCoder, error, ...args) => {
   try {
-    return scaleCoder?.enc(...args);
+    return scaleCoder?.keys?.enc(...args);
   } catch (cause) {
     log.warn(error ?? `Failed to encode stateKey ${JSON.stringify(args)}`, cause);
     return;
   }
 };
 
+/**
+ * Extracts the `version` u8 from a SCALE-encoded metadata blob and returns it as a `number`.
+ *
+ * Only reads the first 40 bytes of the blob.
+ */
+const getMetadataVersion = metadataRpc => {
+  try {
+    return scaleTs.Struct({
+      magicNumber: scaleTs.u32,
+      version: scaleTs.u8
+    }).dec(metadataRpc).version;
+  } catch {
+    return 0;
+  }
+};
+
 /**
  * For the substrate-tokens (and other) modules, we configure the `onChainId` field in chaindata to tell the module how to query each token.
  * These queries are made to the tokens pallet.
@@ -400,28 +373,27 @@ Object.defineProperty(exports, "getLookupFn", {
   enumerable: true,
   get: function () { return metadataBuilders.getLookupFn; }
 });
-Object.defineProperty(exports, "fromHex", {
-  enumerable: true,
-  get: function () { return utils.fromHex; }
-});
-Object.defineProperty(exports, "toHex", {
+Object.defineProperty(exports, "decAnyMetadata", {
   enumerable: true,
-  get: function () { return utils.toHex; }
+  get: function () { return substrateBindings.decAnyMetadata; }
 });
 Object.defineProperty(exports, "metadata", {
   enumerable: true,
   get: function () { return substrateBindings.metadata; }
 });
-Object.defineProperty(exports, "v14", {
+Object.defineProperty(exports, "unifyMetadata", {
   enumerable: true,
-  get: function () { return substrateBindings.v14; }
+  get: function () { return substrateBindings.unifyMetadata; }
 });
-Object.defineProperty(exports, "v15", {
+Object.defineProperty(exports, "fromHex", {
   enumerable: true,
-  get: function () { return substrateBindings.v15; }
+  get: function () { return utils.fromHex; }
+});
+Object.defineProperty(exports, "toHex", {
+  enumerable: true,
+  get: function () { return utils.toHex; }
 });
 exports.compactMetadata = compactMetadata;
-exports.decodeMetadata = decodeMetadata;
 exports.decodeScale = decodeScale;
 exports.encodeMetadata = encodeMetadata;
 exports.encodeStateKey = encodeStateKey;

package/dist/talismn-scale.cjs.prod.js

@@ -1,8 +1,8 @@
 'use strict';
 
 var metadataBuilders = require('@polkadot-api/metadata-builders');
-var utils = require('@polkadot-api/utils');
 var substrateBindings = require('@polkadot-api/substrate-bindings');
+var utils = require('@polkadot-api/utils');
 var anylogger = require('anylogger');
 var scaleTs = require('scale-ts');
 
@@ -14,55 +14,7 @@ var anylogger__default = /*#__PURE__*/_interopDefault(anylogger);
 const magicNumber = 1635018093;
 
 var packageJson = {
-	name: "@talismn/scale",
-	version: "0.1.0",
-	author: "Talisman",
-	homepage: "https://talisman.xyz",
-	license: "GPL-3.0-or-later",
-	publishConfig: {
-		access: "public"
-	},
-	repository: {
-		directory: "packages/scale",
-		type: "git",
-		url: "https://github.com/talismansociety/talisman.git"
-	},
-	main: "dist/talismn-scale.cjs.js",
-	module: "dist/talismn-scale.esm.js",
-	files: [
-		"/dist"
-	],
-	engines: {
-		node: ">=18"
-	},
-	scripts: {
-		test: "jest",
-		lint: "eslint src --max-warnings 0",
-		clean: "rm -rf dist .turbo node_modules"
-	},
-	dependencies: {
-		"@polkadot-api/metadata-builders": "0.9.1",
-		"@polkadot-api/substrate-bindings": "0.9.3",
-		"@polkadot-api/utils": "0.1.2",
-		anylogger: "^1.0.11",
-		"scale-ts": "^1.6.1"
-	},
-	devDependencies: {
-		"@talismn/eslint-config": "workspace:*",
-		"@talismn/tsconfig": "workspace:*",
-		"@types/jest": "^29.5.14",
-		eslint: "^8.57.1",
-		jest: "^29.7",
-		"ts-jest": "^29.2.5",
-		typescript: "^5.6.3"
-	},
-	eslintConfig: {
-		root: true,
-		"extends": [
-			"@talismn/eslint-config/base"
-		]
-	}
-};
+	name: "@talismn/scale"};
 
 var log = anylogger__default.default(packageJson.name);
 
@@ -75,7 +27,10 @@ var log = anylogger__default.default(packageJson.name);
  * E.g. if `palletsAndItems` is `{ pallet: "System", items: ["Account"] }`, then only the
  * types used in the `System.Account` storage query will remain inside of metadata.lookups.
  */
-const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
+const compactMetadata = (anyMetadata, palletsAndItems = [], runtimeApisAndMethods = [], extraKeepTypes = []) => {
+  if (!isCompactableMetadata(anyMetadata)) throw new Error(`Metadata version ${anyMetadata.metadata.tag} not supported in compactMetadata`);
+  const metadata = anyMetadata.metadata.value;
+
   // remove pallets we don't care about
   metadata.pallets = metadata.pallets.filter(pallet =>
   // keep this pallet if it's listed in `palletsAndItems`
@@ -84,8 +39,9 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
   }) => pallet.name === palletName));
 
   // remove fields we don't care about from each pallet, and extract types for each storage item we care about
-  const items = palletsAndItems.flatMap(({
+  const palletsKeepTypes = palletsAndItems.flatMap(({
     pallet: palletName,
+    constants: constantNames,
     items: itemNames
   }) => {
     const pallet = metadata.pallets.find(pallet => pallet.name === palletName);
@@ -96,7 +52,7 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
 
     // remove pallet fields we don't care about
     pallet.calls = undefined;
-    pallet.constants = [];
+    pallet.constants = constantNames ? pallet.constants.filter(constant => constantNames.includes(constant.name)) : [];
     // v15 (NOT v14) has docs
     if ("docs" in pallet) pallet.docs = [];
     pallet.errors = undefined;
@@ -105,19 +61,54 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
 
     // filter and extract storage items we care about
     pallet.storage.items = pallet.storage.items.filter(item => itemNames.some(itemName => item.name === itemName));
-    return pallet.storage.items;
+    return [...pallet.storage.items.flatMap(item => [
+    // each type can be either "Plain" or "Map"
+    // if it's "Plain" we only need to get the value type
+    // if it's a "Map" we want to keep both the key AND the value types
+    item.type.tag === "plain" && item.type.value, item.type.tag === "map" && item.type.value.key, item.type.tag === "map" && item.type.value.value]).filter(type => typeof type === "number"), ...pallet.constants.flatMap(constant => constant.type)];
   });
 
+  // remove runtime apis we don't care about
+  let runtimeApisKeepTypes = [];
+  if ("apis" in metadata) {
+    // metadata is v15 (NOT v14)
+
+    // keep this api if it's listed in `runtimeApisAndMethods`
+    metadata.apis = metadata.apis.filter(runtimeApi => runtimeApisAndMethods.some(({
+      runtimeApi: runtimeApiName
+    }) => runtimeApi.name === runtimeApiName));
+
+    // remove methods we don't care about from each runtime api, and extract types for each call's params and result
+    runtimeApisKeepTypes = runtimeApisAndMethods.flatMap(({
+      runtimeApi: runtimeApiName,
+      methods: methodNames
+    }) => {
+      const runtimeApi = metadata.apis.find(runtimeApi => runtimeApi.name === runtimeApiName);
+      if (!runtimeApi) {
+        log.debug("Failed to find runtimeApi", runtimeApiName);
+        return [];
+      }
+
+      // remove runtime fields we don't care about
+      runtimeApi.docs = [];
+      if (!runtimeApi.methods) return [];
+
+      // filter and extract methods we care about
+      runtimeApi.methods = runtimeApi.methods.filter(method => methodNames.some(methodName => method.name === methodName));
+      return runtimeApi.methods.flatMap(method => [
+      // each method has an array of input types (for the params)
+      ...method.inputs.map(input => input.type),
+      // and one output type (for the result)
+      method.output]);
+    });
+  }
+
   // this is a set of type ids which we plan to keep in our compacted metadata
   // anything not in this set will be deleted
   // we start off with just the types of the state calls we plan to make,
   // then we run those types through a function (addDependentTypes) which will also include
   // all of the types which those types depend on - recursively
-  const keepTypes = new Set(items.flatMap(item => [
-  // each type can be either "Plain" or "Map"
-  // if it's "Plain" we only need to get the value type
-  // if it's a "Map" we want to keep both the key AND the value types
-  item.type.tag === "plain" && item.type.value, item.type.tag === "map" && item.type.value.key, item.type.tag === "map" && item.type.value.value]).filter(type => typeof type === "number"));
+  const keepTypes = new Set([...palletsKeepTypes, ...runtimeApisKeepTypes]);
   extraKeepTypes?.forEach(type => keepTypes.add(type));
 
   // recursively find all the types which our keepTypes depend on and add them to the keepTypes set
@@ -136,20 +127,11 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
     return newTypeId ?? 0;
   };
   remapTypeIds(metadata, getNewTypeId);
-
-  // ditch the remaining data we don't need to keep in a miniMetata
-  if ("apis" in metadata) {
-    // metadata is v15 (NOT v14)
-    metadata.apis = [];
-  }
-  if ("address" in metadata.extrinsic) {
-    // metadata is v15 (NOT v14)
-    metadata.extrinsic.address = 0;
-    metadata.extrinsic.call = 0;
-    metadata.extrinsic.extra = 0;
-    metadata.extrinsic.signature = 0;
-  }
-  metadata.extrinsic.signedExtensions = [];
+  if ("address" in metadata.extrinsic) metadata.extrinsic.address = 0;
+  if ("call" in metadata.extrinsic) metadata.extrinsic.call = 0;
+  if ("signature" in metadata.extrinsic) metadata.extrinsic.signature = 0;
+  if ("extra" in metadata.extrinsic) metadata.extrinsic.extra = 0;
+  if ("signedExtensions" in metadata.extrinsic) metadata.extrinsic.signedExtensions = [];
   if ("outerEnums" in metadata) {
     // metadata is v15 (NOT v14)
     metadata.outerEnums.call = 0;
@@ -157,6 +139,16 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
     metadata.outerEnums.event = 0;
   }
 };
+const isCompactableMetadata = metadata => {
+  switch (metadata.metadata.tag) {
+    case "v14":
+    case "v15":
+    case "v16":
+      return true;
+    default:
+      return false;
+  }
+};
 const addDependentTypes = (metadataTysMap, keepTypes, types,
 // Prevent stack overflow when a type references itself
 addedTypes = new Set()) => {
@@ -208,6 +200,7 @@ addedTypes = new Set()) => {
 const remapTypeIds = (metadata, getNewTypeId) => {
   remapLookupTypeIds(metadata, getNewTypeId);
   remapStorageTypeIds(metadata, getNewTypeId);
+  remapRuntimeApisTypeIds(metadata, getNewTypeId);
 };
 const remapLookupTypeIds = (metadata, getNewTypeId) => {
   for (const type of metadata.lookup) {
@@ -270,79 +263,59 @@ const remapStorageTypeIds = (metadata, getNewTypeId) => {
         item.type.value.value = getNewTypeId(item.type.value.value);
       }
     }
+    for (const constant of pallet.constants ?? []) {
+      constant.type = getNewTypeId(constant.type);
+    }
   }
 };
-
-/**
- * Extracts the `version` u8 from a SCALE-encoded metadata blob and returns it as a `number`.
- *
- * Only reads the first 40 bytes of the blob.
- */
-const getMetadataVersion = metadataRpc => {
-  try {
-    return scaleTs.Struct({
-      magicNumber: scaleTs.u32,
-      version: scaleTs.u8
-    }).dec(metadataRpc).version;
-  } catch {
-    return 0;
+const remapRuntimeApisTypeIds = (metadata, getNewTypeId) => {
+  for (const runtimeApi of metadata.apis) {
+    for (const method of runtimeApi.methods ?? []) {
+      for (const input of method.inputs) {
+        input.type = getNewTypeId(input.type);
+      }
+      method.output = getNewTypeId(method.output);
+    }
   }
 };
 
-const decodeMetadata = metadataRpc => {
-  const metadataVersion = getMetadataVersion(metadataRpc);
-  if (metadataVersion !== 15 && metadataVersion !== 14) return {
-    metadataVersion
-  };
-  const decoded = substrateBindings.metadata.dec(metadataRpc);
-  if (decoded.metadata.tag === "v15") return {
-    metadataVersion,
-    metadata: decoded.metadata.value,
-    tag: decoded.metadata.tag
-  };
-  if (decoded.metadata.tag === "v14") return {
-    metadataVersion,
-    metadata: decoded.metadata.value,
-    tag: decoded.metadata.tag
-  };
-  return {
-    metadataVersion
-  };
-};
-
 const decodeScale = (scaleCoder, change, error) => {
   if (change === null) return null;
   try {
-    return scaleCoder?.dec(change) ?? null;
+    return scaleCoder?.value?.dec(change) ?? null;
   } catch (cause) {
     log.warn(error ?? `Failed to decode ${change}`, cause);
     return null;
   }
 };
 
-const encodeMetadata = ({
-  metadata,
-  tag
-}) => utils.toHex(substrateBindings.metadata.enc({
-  magicNumber,
-  metadata: tag === "v15" ? {
-    tag,
-    value: metadata
-  } : {
-    tag,
-    value: metadata
-  }
-}));
+const encodeMetadata = metadata => utils.toHex(substrateBindings.metadata.enc(metadata));
 
 const encodeStateKey = (scaleCoder, error, ...args) => {
   try {
-    return scaleCoder?.enc(...args);
+    return scaleCoder?.keys?.enc(...args);
   } catch (cause) {
     log.warn(error ?? `Failed to encode stateKey ${JSON.stringify(args)}`, cause);
     return;
   }
 };
 
+/**
+ * Extracts the `version` u8 from a SCALE-encoded metadata blob and returns it as a `number`.
+ *
+ * Only reads the first 40 bytes of the blob.
+ */
+const getMetadataVersion = metadataRpc => {
+  try {
+    return scaleTs.Struct({
+      magicNumber: scaleTs.u32,
+      version: scaleTs.u8
+    }).dec(metadataRpc).version;
+  } catch {
+    return 0;
+  }
+};
+
 /**
  * For the substrate-tokens (and other) modules, we configure the `onChainId` field in chaindata to tell the module how to query each token.
  * These queries are made to the tokens pallet.
@@ -400,28 +373,27 @@ Object.defineProperty(exports, "getLookupFn", {
   enumerable: true,
   get: function () { return metadataBuilders.getLookupFn; }
 });
-Object.defineProperty(exports, "fromHex", {
-  enumerable: true,
-  get: function () { return utils.fromHex; }
-});
-Object.defineProperty(exports, "toHex", {
+Object.defineProperty(exports, "decAnyMetadata", {
   enumerable: true,
-  get: function () { return utils.toHex; }
+  get: function () { return substrateBindings.decAnyMetadata; }
 });
 Object.defineProperty(exports, "metadata", {
   enumerable: true,
   get: function () { return substrateBindings.metadata; }
 });
-Object.defineProperty(exports, "v14", {
+Object.defineProperty(exports, "unifyMetadata", {
   enumerable: true,
-  get: function () { return substrateBindings.v14; }
+  get: function () { return substrateBindings.unifyMetadata; }
 });
-Object.defineProperty(exports, "v15", {
+Object.defineProperty(exports, "fromHex", {
   enumerable: true,
-  get: function () { return substrateBindings.v15; }
+  get: function () { return utils.fromHex; }
+});
+Object.defineProperty(exports, "toHex", {
+  enumerable: true,
+  get: function () { return utils.toHex; }
 });
 exports.compactMetadata = compactMetadata;
-exports.decodeMetadata = decodeMetadata;
 exports.decodeScale = decodeScale;
 exports.encodeMetadata = encodeMetadata;
 exports.encodeStateKey = encodeStateKey;

package/dist/talismn-scale.esm.js

@@ -1,64 +1,16 @@
 export { getDynamicBuilder, getLookupFn } from '@polkadot-api/metadata-builders';
+import { metadata, Binary } from '@polkadot-api/substrate-bindings';
+export { decAnyMetadata, metadata, unifyMetadata } from '@polkadot-api/substrate-bindings';
 import { toHex } from '@polkadot-api/utils';
 export { fromHex, toHex } from '@polkadot-api/utils';
-import { metadata, Binary } from '@polkadot-api/substrate-bindings';
-export { metadata, v14, v15 } from '@polkadot-api/substrate-bindings';
 import anylogger from 'anylogger';
-import { Struct, u32, u8 } from 'scale-ts';
+import { Struct, u8, u32 } from 'scale-ts';
 
 /** Constant: https://docs.substrate.io/build/application-development/#metadata-format */
 const magicNumber = 1635018093;
 
 var packageJson = {
-	name: "@talismn/scale",
-	version: "0.1.0",
-	author: "Talisman",
-	homepage: "https://talisman.xyz",
-	license: "GPL-3.0-or-later",
-	publishConfig: {
-		access: "public"
-	},
-	repository: {
-		directory: "packages/scale",
-		type: "git",
-		url: "https://github.com/talismansociety/talisman.git"
-	},
-	main: "dist/talismn-scale.cjs.js",
-	module: "dist/talismn-scale.esm.js",
-	files: [
-		"/dist"
-	],
-	engines: {
-		node: ">=18"
-	},
-	scripts: {
-		test: "jest",
-		lint: "eslint src --max-warnings 0",
-		clean: "rm -rf dist .turbo node_modules"
-	},
-	dependencies: {
-		"@polkadot-api/metadata-builders": "0.9.1",
-		"@polkadot-api/substrate-bindings": "0.9.3",
-		"@polkadot-api/utils": "0.1.2",
-		anylogger: "^1.0.11",
-		"scale-ts": "^1.6.1"
-	},
-	devDependencies: {
-		"@talismn/eslint-config": "workspace:*",
-		"@talismn/tsconfig": "workspace:*",
-		"@types/jest": "^29.5.14",
-		eslint: "^8.57.1",
-		jest: "^29.7",
-		"ts-jest": "^29.2.5",
-		typescript: "^5.6.3"
-	},
-	eslintConfig: {
-		root: true,
-		"extends": [
-			"@talismn/eslint-config/base"
-		]
-	}
-};
+	name: "@talismn/scale"};
 
 var log = anylogger(packageJson.name);
 
@@ -71,7 +23,10 @@ var log = anylogger(packageJson.name);
  * E.g. if `palletsAndItems` is `{ pallet: "System", items: ["Account"] }`, then only the
  * types used in the `System.Account` storage query will remain inside of metadata.lookups.
  */
-const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
+const compactMetadata = (anyMetadata, palletsAndItems = [], runtimeApisAndMethods = [], extraKeepTypes = []) => {
+  if (!isCompactableMetadata(anyMetadata)) throw new Error(`Metadata version ${anyMetadata.metadata.tag} not supported in compactMetadata`);
+  const metadata = anyMetadata.metadata.value;
+
   // remove pallets we don't care about
   metadata.pallets = metadata.pallets.filter(pallet =>
   // keep this pallet if it's listed in `palletsAndItems`
@@ -80,8 +35,9 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
   }) => pallet.name === palletName));
 
   // remove fields we don't care about from each pallet, and extract types for each storage item we care about
-  const items = palletsAndItems.flatMap(({
+  const palletsKeepTypes = palletsAndItems.flatMap(({
     pallet: palletName,
+    constants: constantNames,
     items: itemNames
   }) => {
     const pallet = metadata.pallets.find(pallet => pallet.name === palletName);
@@ -92,7 +48,7 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
 
     // remove pallet fields we don't care about
     pallet.calls = undefined;
-    pallet.constants = [];
+    pallet.constants = constantNames ? pallet.constants.filter(constant => constantNames.includes(constant.name)) : [];
     // v15 (NOT v14) has docs
     if ("docs" in pallet) pallet.docs = [];
     pallet.errors = undefined;
@@ -101,19 +57,54 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
 
     // filter and extract storage items we care about
     pallet.storage.items = pallet.storage.items.filter(item => itemNames.some(itemName => item.name === itemName));
-    return pallet.storage.items;
+    return [...pallet.storage.items.flatMap(item => [
+    // each type can be either "Plain" or "Map"
+    // if it's "Plain" we only need to get the value type
+    // if it's a "Map" we want to keep both the key AND the value types
+    item.type.tag === "plain" && item.type.value, item.type.tag === "map" && item.type.value.key, item.type.tag === "map" && item.type.value.value]).filter(type => typeof type === "number"), ...pallet.constants.flatMap(constant => constant.type)];
   });
 
+  // remove runtime apis we don't care about
+  let runtimeApisKeepTypes = [];
+  if ("apis" in metadata) {
+    // metadata is v15 (NOT v14)
+
+    // keep this api if it's listed in `runtimeApisAndMethods`
+    metadata.apis = metadata.apis.filter(runtimeApi => runtimeApisAndMethods.some(({
+      runtimeApi: runtimeApiName
+    }) => runtimeApi.name === runtimeApiName));
+
+    // remove methods we don't care about from each runtime api, and extract types for each call's params and result
+    runtimeApisKeepTypes = runtimeApisAndMethods.flatMap(({
+      runtimeApi: runtimeApiName,
+      methods: methodNames
+    }) => {
+      const runtimeApi = metadata.apis.find(runtimeApi => runtimeApi.name === runtimeApiName);
+      if (!runtimeApi) {
+        log.debug("Failed to find runtimeApi", runtimeApiName);
+        return [];
+      }
+
+      // remove runtime fields we don't care about
+      runtimeApi.docs = [];
+      if (!runtimeApi.methods) return [];
+
+      // filter and extract methods we care about
+      runtimeApi.methods = runtimeApi.methods.filter(method => methodNames.some(methodName => method.name === methodName));
+      return runtimeApi.methods.flatMap(method => [
+      // each method has an array of input types (for the params)
+      ...method.inputs.map(input => input.type),
+      // and one output type (for the result)
+      method.output]);
+    });
+  }
+
   // this is a set of type ids which we plan to keep in our compacted metadata
   // anything not in this set will be deleted
   // we start off with just the types of the state calls we plan to make,
   // then we run those types through a function (addDependentTypes) which will also include
   // all of the types which those types depend on - recursively
-  const keepTypes = new Set(items.flatMap(item => [
-  // each type can be either "Plain" or "Map"
-  // if it's "Plain" we only need to get the value type
-  // if it's a "Map" we want to keep both the key AND the value types
-  item.type.tag === "plain" && item.type.value, item.type.tag === "map" && item.type.value.key, item.type.tag === "map" && item.type.value.value]).filter(type => typeof type === "number"));
+  const keepTypes = new Set([...palletsKeepTypes, ...runtimeApisKeepTypes]);
   extraKeepTypes?.forEach(type => keepTypes.add(type));
 
   // recursively find all the types which our keepTypes depend on and add them to the keepTypes set
@@ -132,20 +123,11 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
     return newTypeId ?? 0;
   };
   remapTypeIds(metadata, getNewTypeId);
-
-  // ditch the remaining data we don't need to keep in a miniMetata
-  if ("apis" in metadata) {
-    // metadata is v15 (NOT v14)
-    metadata.apis = [];
-  }
-  if ("address" in metadata.extrinsic) {
-    // metadata is v15 (NOT v14)
-    metadata.extrinsic.address = 0;
-    metadata.extrinsic.call = 0;
-    metadata.extrinsic.extra = 0;
-    metadata.extrinsic.signature = 0;
-  }
-  metadata.extrinsic.signedExtensions = [];
+  if ("address" in metadata.extrinsic) metadata.extrinsic.address = 0;
+  if ("call" in metadata.extrinsic) metadata.extrinsic.call = 0;
+  if ("signature" in metadata.extrinsic) metadata.extrinsic.signature = 0;
+  if ("extra" in metadata.extrinsic) metadata.extrinsic.extra = 0;
+  if ("signedExtensions" in metadata.extrinsic) metadata.extrinsic.signedExtensions = [];
   if ("outerEnums" in metadata) {
     // metadata is v15 (NOT v14)
     metadata.outerEnums.call = 0;
@@ -153,6 +135,16 @@ const compactMetadata = (metadata, palletsAndItems, extraKeepTypes) => {
     metadata.outerEnums.event = 0;
   }
 };
+const isCompactableMetadata = metadata => {
+  switch (metadata.metadata.tag) {
+    case "v14":
+    case "v15":
+    case "v16":
+      return true;
+    default:
+      return false;
+  }
+};
 const addDependentTypes = (metadataTysMap, keepTypes, types,
 // Prevent stack overflow when a type references itself
 addedTypes = new Set()) => {
@@ -204,6 +196,7 @@ addedTypes = new Set()) => {
 const remapTypeIds = (metadata, getNewTypeId) => {
   remapLookupTypeIds(metadata, getNewTypeId);
   remapStorageTypeIds(metadata, getNewTypeId);
+  remapRuntimeApisTypeIds(metadata, getNewTypeId);
 };
 const remapLookupTypeIds = (metadata, getNewTypeId) => {
   for (const type of metadata.lookup) {
@@ -266,79 +259,59 @@ const remapStorageTypeIds = (metadata, getNewTypeId) => {
         item.type.value.value = getNewTypeId(item.type.value.value);
       }
     }
+    for (const constant of pallet.constants ?? []) {
+      constant.type = getNewTypeId(constant.type);
+    }
   }
 };
-
-/**
- * Extracts the `version` u8 from a SCALE-encoded metadata blob and returns it as a `number`.
- *
- * Only reads the first 40 bytes of the blob.
- */
-const getMetadataVersion = metadataRpc => {
-  try {
-    return Struct({
-      magicNumber: u32,
-      version: u8
-    }).dec(metadataRpc).version;
-  } catch {
-    return 0;
+const remapRuntimeApisTypeIds = (metadata, getNewTypeId) => {
+  for (const runtimeApi of metadata.apis) {
+    for (const method of runtimeApi.methods ?? []) {
+      for (const input of method.inputs) {
+        input.type = getNewTypeId(input.type);
+      }
+      method.output = getNewTypeId(method.output);
+    }
   }
 };
 
-const decodeMetadata = metadataRpc => {
-  const metadataVersion = getMetadataVersion(metadataRpc);
-  if (metadataVersion !== 15 && metadataVersion !== 14) return {
-    metadataVersion
-  };
-  const decoded = metadata.dec(metadataRpc);
-  if (decoded.metadata.tag === "v15") return {
-    metadataVersion,
-    metadata: decoded.metadata.value,
-    tag: decoded.metadata.tag
-  };
-  if (decoded.metadata.tag === "v14") return {
-    metadataVersion,
-    metadata: decoded.metadata.value,
-    tag: decoded.metadata.tag
-  };
-  return {
-    metadataVersion
-  };
-};
-
 const decodeScale = (scaleCoder, change, error) => {
   if (change === null) return null;
   try {
-    return scaleCoder?.dec(change) ?? null;
+    return scaleCoder?.value?.dec(change) ?? null;
   } catch (cause) {
     log.warn(error ?? `Failed to decode ${change}`, cause);
     return null;
   }
 };
 
-const encodeMetadata = ({
-  metadata: metadata$1,
-  tag
-}) => toHex(metadata.enc({
-  magicNumber,
-  metadata: tag === "v15" ? {
-    tag,
-    value: metadata$1
-  } : {
-    tag,
-    value: metadata$1
-  }
-}));
+const encodeMetadata = metadata$1 => toHex(metadata.enc(metadata$1));
 
 const encodeStateKey = (scaleCoder, error, ...args) => {
   try {
-    return scaleCoder?.enc(...args);
+    return scaleCoder?.keys?.enc(...args);
   } catch (cause) {
     log.warn(error ?? `Failed to encode stateKey ${JSON.stringify(args)}`, cause);
     return;
   }
 };
 
+/**
+ * Extracts the `version` u8 from a SCALE-encoded metadata blob and returns it as a `number`.
+ *
+ * Only reads the first 40 bytes of the blob.
+ */
+const getMetadataVersion = metadataRpc => {
+  try {
+    return Struct({
+      magicNumber: u32,
+      version: u8
+    }).dec(metadataRpc).version;
+  } catch {
+    return 0;
+  }
+};
+
 /**
  * For the substrate-tokens (and other) modules, we configure the `onChainId` field in chaindata to tell the module how to query each token.
  * These queries are made to the tokens pallet.
@@ -388,4 +361,4 @@ const papiStringify = (value, space) => {
   return JSON.stringify(value, replacer, space);
 };
 
-export { compactMetadata, decodeMetadata, decodeScale, encodeMetadata, encodeStateKey, getMetadataVersion, magicNumber, papiParse, papiStringify };
+export { compactMetadata, decodeScale, encodeMetadata, encodeStateKey, getMetadataVersion, magicNumber, papiParse, papiStringify };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/scale",
-  "version": "0.1.0",
+  "version": "0.1.2",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -21,9 +21,9 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@polkadot-api/metadata-builders": "0.9.1",
-    "@polkadot-api/substrate-bindings": "0.9.3",
-    "@polkadot-api/utils": "0.1.2",
+    "@polkadot-api/metadata-builders": "0.12.2",
+    "@polkadot-api/substrate-bindings": "0.14.0",
+    "@polkadot-api/utils": "0.2.0",
     "anylogger": "^1.0.11",
     "scale-ts": "^1.6.1"
   },

package/dist/declarations/src/util/decodeMetadata.d.ts

@@ -1,13 +0,0 @@
-import { V14, V15 } from "@polkadot-api/substrate-bindings";
-export declare const decodeMetadata: (metadataRpc: string) => {
-    metadataVersion: number;
-} & ({
-    metadata: V15;
-    tag: "v15";
-} | {
-    metadata: V14;
-    tag: "v14";
-} | {
-    metadata?: undefined;
-    tag?: undefined;
-});