@talismn/scale 0.1.1 → 0.2.0

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');
 
@@ -27,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 = [], 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`
@@ -42,10 +45,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;
@@ -81,10 +81,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 = [];
@@ -124,14 +121,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;
@@ -139,6 +133,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()) => {
@@ -269,43 +273,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 scaleTs.Struct({
-      magicNumber: scaleTs.u32,
-      version: scaleTs.u8
-    }).dec(metadataRpc).version;
-  } catch {
-    return 0;
-  }
-};
-
-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 {
@@ -316,19 +283,7 @@ const decodeScale = (scaleCoder, change, error) => {
   }
 };
 
-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 {
@@ -339,6 +294,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 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.
@@ -388,6 +359,30 @@ const papiStringify = (value, space) => {
   return JSON.stringify(value, replacer, space);
 };
 
+const parseMetadataRpc = metadataRpc => {
+  const metadata = substrateBindings.decAnyMetadata(metadataRpc);
+  const unifiedMetadata = substrateBindings.unifyMetadata(metadata);
+  const lookupFn = metadataBuilders.getLookupFn(unifiedMetadata);
+  const builder = metadataBuilders.getDynamicBuilder(lookupFn);
+  return {
+    metadata,
+    unifiedMetadata,
+    lookupFn,
+    builder
+  };
+};
+
+const getStorageKeyPrefix = (palletName, storageName) => {
+  const palletHash = substrateBindings.Twox128(new TextEncoder().encode(palletName));
+  const storageHash = substrateBindings.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 utils.toHex(combined);
+};
+
 Object.defineProperty(exports, "getDynamicBuilder", {
   enumerable: true,
   get: function () { return metadataBuilders.getDynamicBuilder; }
@@ -396,32 +391,65 @@ Object.defineProperty(exports, "getLookupFn", {
   enumerable: true,
   get: function () { return metadataBuilders.getLookupFn; }
 });
-Object.defineProperty(exports, "fromHex", {
+Object.defineProperty(exports, "Blake2128", {
   enumerable: true,
-  get: function () { return utils.fromHex; }
+  get: function () { return substrateBindings.Blake2128; }
 });
-Object.defineProperty(exports, "toHex", {
+Object.defineProperty(exports, "Blake2128Concat", {
   enumerable: true,
-  get: function () { return utils.toHex; }
+  get: function () { return substrateBindings.Blake2128Concat; }
+});
+Object.defineProperty(exports, "Blake2256", {
+  enumerable: true,
+  get: function () { return substrateBindings.Blake2256; }
+});
+Object.defineProperty(exports, "Blake3256", {
+  enumerable: true,
+  get: function () { return substrateBindings.Blake3256; }
+});
+Object.defineProperty(exports, "Blake3256Concat", {
+  enumerable: true,
+  get: function () { return substrateBindings.Blake3256Concat; }
+});
+Object.defineProperty(exports, "Twox128", {
+  enumerable: true,
+  get: function () { return substrateBindings.Twox128; }
+});
+Object.defineProperty(exports, "Twox256", {
+  enumerable: true,
+  get: function () { return substrateBindings.Twox256; }
+});
+Object.defineProperty(exports, "Twox64Concat", {
+  enumerable: true,
+  get: function () { return substrateBindings.Twox64Concat; }
+});
+Object.defineProperty(exports, "decAnyMetadata", {
+  enumerable: true,
+  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.unifyMetadata; }
+});
+Object.defineProperty(exports, "fromHex", {
   enumerable: true,
-  get: function () { return substrateBindings.v14; }
+  get: function () { return utils.fromHex; }
 });
-Object.defineProperty(exports, "v15", {
+Object.defineProperty(exports, "toHex", {
   enumerable: true,
-  get: function () { return substrateBindings.v15; }
+  get: function () { return utils.toHex; }
 });
 exports.compactMetadata = compactMetadata;
-exports.decodeMetadata = decodeMetadata;
 exports.decodeScale = decodeScale;
 exports.encodeMetadata = encodeMetadata;
 exports.encodeStateKey = encodeStateKey;
 exports.getMetadataVersion = getMetadataVersion;
+exports.getStorageKeyPrefix = getStorageKeyPrefix;
 exports.magicNumber = magicNumber;
 exports.papiParse = papiParse;
 exports.papiStringify = papiStringify;
+exports.parseMetadataRpc = parseMetadataRpc;

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');
 
@@ -27,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 = [], 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`
@@ -42,10 +45,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;
@@ -81,10 +81,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 = [];
@@ -124,14 +121,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;
@@ -139,6 +133,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()) => {
@@ -269,43 +273,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 scaleTs.Struct({
-      magicNumber: scaleTs.u32,
-      version: scaleTs.u8
-    }).dec(metadataRpc).version;
-  } catch {
-    return 0;
-  }
-};
-
-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 {
@@ -316,19 +283,7 @@ const decodeScale = (scaleCoder, change, error) => {
   }
 };
 
-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 {
@@ -339,6 +294,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 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.
@@ -388,6 +359,30 @@ const papiStringify = (value, space) => {
   return JSON.stringify(value, replacer, space);
 };
 
+const parseMetadataRpc = metadataRpc => {
+  const metadata = substrateBindings.decAnyMetadata(metadataRpc);
+  const unifiedMetadata = substrateBindings.unifyMetadata(metadata);
+  const lookupFn = metadataBuilders.getLookupFn(unifiedMetadata);
+  const builder = metadataBuilders.getDynamicBuilder(lookupFn);
+  return {
+    metadata,
+    unifiedMetadata,
+    lookupFn,
+    builder
+  };
+};
+
+const getStorageKeyPrefix = (palletName, storageName) => {
+  const palletHash = substrateBindings.Twox128(new TextEncoder().encode(palletName));
+  const storageHash = substrateBindings.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 utils.toHex(combined);
+};
+
 Object.defineProperty(exports, "getDynamicBuilder", {
   enumerable: true,
   get: function () { return metadataBuilders.getDynamicBuilder; }
@@ -396,32 +391,65 @@ Object.defineProperty(exports, "getLookupFn", {
   enumerable: true,
   get: function () { return metadataBuilders.getLookupFn; }
 });
-Object.defineProperty(exports, "fromHex", {
+Object.defineProperty(exports, "Blake2128", {
   enumerable: true,
-  get: function () { return utils.fromHex; }
+  get: function () { return substrateBindings.Blake2128; }
 });
-Object.defineProperty(exports, "toHex", {
+Object.defineProperty(exports, "Blake2128Concat", {
   enumerable: true,
-  get: function () { return utils.toHex; }
+  get: function () { return substrateBindings.Blake2128Concat; }
+});
+Object.defineProperty(exports, "Blake2256", {
+  enumerable: true,
+  get: function () { return substrateBindings.Blake2256; }
+});
+Object.defineProperty(exports, "Blake3256", {
+  enumerable: true,
+  get: function () { return substrateBindings.Blake3256; }
+});
+Object.defineProperty(exports, "Blake3256Concat", {
+  enumerable: true,
+  get: function () { return substrateBindings.Blake3256Concat; }
+});
+Object.defineProperty(exports, "Twox128", {
+  enumerable: true,
+  get: function () { return substrateBindings.Twox128; }
+});
+Object.defineProperty(exports, "Twox256", {
+  enumerable: true,
+  get: function () { return substrateBindings.Twox256; }
+});
+Object.defineProperty(exports, "Twox64Concat", {
+  enumerable: true,
+  get: function () { return substrateBindings.Twox64Concat; }
+});
+Object.defineProperty(exports, "decAnyMetadata", {
+  enumerable: true,
+  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.unifyMetadata; }
+});
+Object.defineProperty(exports, "fromHex", {
   enumerable: true,
-  get: function () { return substrateBindings.v14; }
+  get: function () { return utils.fromHex; }
 });
-Object.defineProperty(exports, "v15", {
+Object.defineProperty(exports, "toHex", {
   enumerable: true,
-  get: function () { return substrateBindings.v15; }
+  get: function () { return utils.toHex; }
 });
 exports.compactMetadata = compactMetadata;
-exports.decodeMetadata = decodeMetadata;
 exports.decodeScale = decodeScale;
 exports.encodeMetadata = encodeMetadata;
 exports.encodeStateKey = encodeStateKey;
 exports.getMetadataVersion = getMetadataVersion;
+exports.getStorageKeyPrefix = getStorageKeyPrefix;
 exports.magicNumber = magicNumber;
 exports.papiParse = papiParse;
 exports.papiStringify = papiStringify;
+exports.parseMetadataRpc = parseMetadataRpc;