@talismn/scale 0.1.1 → 0.2.0

package/dist/talismn-scale.esm.js

@@ -1,8 +1,9 @@
+import { getLookupFn, getDynamicBuilder } from '@polkadot-api/metadata-builders';
 export { getDynamicBuilder, getLookupFn } from '@polkadot-api/metadata-builders';
+import { metadata, Binary, decAnyMetadata, unifyMetadata, Twox128 } from '@polkadot-api/substrate-bindings';
+export { Blake2128, Blake2128Concat, Blake2256, Blake3256, Blake3256Concat, Twox128, Twox256, Twox64Concat, 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, u8, u32 } from 'scale-ts';
 
@@ -23,7 +24,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 = [], runtimeApisAndMethods = [], 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`
@@ -38,10 +42,7 @@ const compactMetadata = (metadata, palletsAndItems = [], runtimeApisAndMethods =
     items: itemNames
   }) => {
     const pallet = metadata.pallets.find(pallet => pallet.name === palletName);
-    if (!pallet) {
-      log.debug("Failed to find pallet", palletName);
-      return [];
-    }
+    if (!pallet) return [];
 
     // remove pallet fields we don't care about
     pallet.calls = undefined;
@@ -77,10 +78,7 @@ const compactMetadata = (metadata, palletsAndItems = [], runtimeApisAndMethods =
       methods: methodNames
     }) => {
       const runtimeApi = metadata.apis.find(runtimeApi => runtimeApi.name === runtimeApiName);
-      if (!runtimeApi) {
-        log.debug("Failed to find runtimeApi", runtimeApiName);
-        return [];
-      }
+      if (!runtimeApi) return [];
 
       // remove runtime fields we don't care about
       runtimeApi.docs = [];
@@ -120,14 +118,11 @@ const compactMetadata = (metadata, palletsAndItems = [], runtimeApisAndMethods =
     return newTypeId ?? 0;
   };
   remapTypeIds(metadata, getNewTypeId);
-  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;
@@ -135,6 +130,16 @@ const compactMetadata = (metadata, palletsAndItems = [], runtimeApisAndMethods =
     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()) => {
@@ -265,43 +270,6 @@ const remapRuntimeApisTypeIds = (metadata, getNewTypeId) => {
   }
 };
 
-/**
- * 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 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 {
@@ -312,19 +280,7 @@ const decodeScale = (scaleCoder, change, error) => {
   }
 };
 
-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 {
@@ -335,6 +291,22 @@ const encodeStateKey = (scaleCoder, error, ...args) => {
   }
 };
 
+/**
+ * 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.
@@ -384,4 +356,28 @@ const papiStringify = (value, space) => {
   return JSON.stringify(value, replacer, space);
 };
 
-export { compactMetadata, decodeMetadata, decodeScale, encodeMetadata, encodeStateKey, getMetadataVersion, magicNumber, papiParse, papiStringify };
+const parseMetadataRpc = metadataRpc => {
+  const metadata = decAnyMetadata(metadataRpc);
+  const unifiedMetadata = unifyMetadata(metadata);
+  const lookupFn = getLookupFn(unifiedMetadata);
+  const builder = getDynamicBuilder(lookupFn);
+  return {
+    metadata,
+    unifiedMetadata,
+    lookupFn,
+    builder
+  };
+};
+
+const getStorageKeyPrefix = (palletName, storageName) => {
+  const palletHash = Twox128(new TextEncoder().encode(palletName));
+  const storageHash = Twox128(new TextEncoder().encode(storageName));
+
+  // Concatenate and convert to hex
+  const combined = new Uint8Array(palletHash.length + storageHash.length);
+  combined.set(palletHash, 0);
+  combined.set(storageHash, palletHash.length);
+  return toHex(combined);
+};
+
+export { compactMetadata, decodeScale, encodeMetadata, encodeStateKey, getMetadataVersion, getStorageKeyPrefix, magicNumber, papiParse, papiStringify, parseMetadataRpc };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/scale",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -21,9 +21,9 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@polkadot-api/metadata-builders": "0.10.2",
-    "@polkadot-api/substrate-bindings": "0.11.1",
-    "@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"
   },
@@ -33,8 +33,8 @@
     "jest": "^29.7",
     "ts-jest": "^29.2.5",
     "typescript": "^5.6.3",
-    "@talismn/eslint-config": "0.0.3",
-    "@talismn/tsconfig": "0.0.2"
+    "@talismn/tsconfig": "0.0.2",
+    "@talismn/eslint-config": "0.0.3"
   },
   "eslintConfig": {
     "root": true,

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;
-});