@talismn/sapi 0.0.4 → 0.0.5

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

@@ -0,0 +1,9 @@
+type RpcSendFunc = <T>(method: string, params: unknown[], isCacheable?: boolean) => Promise<T>;
+/**
+ * Fetches the highest supported version of metadata from the chain.
+ *
+ * @param rpcSend
+ * @returns hex-encoded metadata starting with the magic number
+ */
+export declare const fetchBestMetadata: (rpcSend: RpcSendFunc, allowLegacyFallback?: boolean) => Promise<`0x${string}`>;
+export {};

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

@@ -1,2 +1,3 @@
 export * from "./types";
 export * from "./sapi";
+export * from "./fetchBestMetadata";

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

@@ -9,6 +9,7 @@ var utils = require('@polkadot-api/utils');
 var types = require('@polkadot/types');
 var merkleizeMetadata = require('@polkadot-api/merkleize-metadata');
 var substrateBindings = require('@polkadot-api/substrate-bindings');
+var scaleTs = require('scale-ts');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -530,4 +531,51 @@ const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signed
   };
 };
 
+const MAGIC_NUMBER = 1635018093;
+
+// it's important to set a max because some chains also return high invalid version numbers in the metadata_versions list (ex on Polkadot, related to JAM?)
+const MAX_SUPPORTED_METADATA_VERSION = 16;
+/**
+ * Fetches the highest supported version of metadata from the chain.
+ *
+ * @param rpcSend
+ * @returns hex-encoded metadata starting with the magic number
+ */
+const fetchBestMetadata = async (rpcSend, allowLegacyFallback) => {
+  try {
+    // fetch available versions of metadata
+    const metadataVersions = await rpcSend("state_call", ["Metadata_metadata_versions", "0x"], true);
+    const availableVersions = scaleTs.Vector(scaleTs.u32).dec(metadataVersions);
+    const bestVersion = Math.max(...availableVersions.filter(v => v <= MAX_SUPPORTED_METADATA_VERSION));
+    const metadata = await rpcSend("state_call", ["Metadata_metadata_at_version", utils.toHex(scaleTs.u32.enc(bestVersion))], true);
+    return normalizeMetadata(metadata);
+  } catch (cause) {
+    // if the chain doesnt support the Metadata pallet, fallback to legacy rpc provided metadata (V14)
+    const message = cause?.message;
+    if (allowLegacyFallback || message?.includes("is not found") ||
+    // ex: crust standalone
+    message?.includes("Module doesn't have export Metadata_metadata_versions") // ex: 3DPass
+    ) {
+      return await rpcSend("state_getMetadata", [], true);
+    }
+
+    // otherwise throw so it can be handled by the caller
+    throw new Error("Failed to fetch metadata", {
+      cause
+    });
+  }
+};
+
+/**
+ * Removes everything before the magic number in the metadata.
+ * This ensures Opaque metadata is usable by pjs
+ */
+const normalizeMetadata = metadata => {
+  const hexMagicNumber = utils.toHex(scaleTs.u32.enc(MAGIC_NUMBER)).slice(2);
+  const magicNumberIndex = metadata.indexOf(hexMagicNumber);
+  if (magicNumberIndex === -1) throw new Error("Invalid metadata format: magic number not found");
+  return `0x${metadata.slice(magicNumberIndex)}`;
+};
+
+exports.fetchBestMetadata = fetchBestMetadata;
 exports.getScaleApi = getScaleApi;

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

@@ -9,6 +9,7 @@ var utils = require('@polkadot-api/utils');
 var types = require('@polkadot/types');
 var merkleizeMetadata = require('@polkadot-api/merkleize-metadata');
 var substrateBindings = require('@polkadot-api/substrate-bindings');
+var scaleTs = require('scale-ts');
 
 function _interopDefault (e) { return e && e.__esModule ? e : { default: e }; }
 
@@ -530,4 +531,51 @@ const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signed
   };
 };
 
+const MAGIC_NUMBER = 1635018093;
+
+// it's important to set a max because some chains also return high invalid version numbers in the metadata_versions list (ex on Polkadot, related to JAM?)
+const MAX_SUPPORTED_METADATA_VERSION = 16;
+/**
+ * Fetches the highest supported version of metadata from the chain.
+ *
+ * @param rpcSend
+ * @returns hex-encoded metadata starting with the magic number
+ */
+const fetchBestMetadata = async (rpcSend, allowLegacyFallback) => {
+  try {
+    // fetch available versions of metadata
+    const metadataVersions = await rpcSend("state_call", ["Metadata_metadata_versions", "0x"], true);
+    const availableVersions = scaleTs.Vector(scaleTs.u32).dec(metadataVersions);
+    const bestVersion = Math.max(...availableVersions.filter(v => v <= MAX_SUPPORTED_METADATA_VERSION));
+    const metadata = await rpcSend("state_call", ["Metadata_metadata_at_version", utils.toHex(scaleTs.u32.enc(bestVersion))], true);
+    return normalizeMetadata(metadata);
+  } catch (cause) {
+    // if the chain doesnt support the Metadata pallet, fallback to legacy rpc provided metadata (V14)
+    const message = cause?.message;
+    if (allowLegacyFallback || message?.includes("is not found") ||
+    // ex: crust standalone
+    message?.includes("Module doesn't have export Metadata_metadata_versions") // ex: 3DPass
+    ) {
+      return await rpcSend("state_getMetadata", [], true);
+    }
+
+    // otherwise throw so it can be handled by the caller
+    throw new Error("Failed to fetch metadata", {
+      cause
+    });
+  }
+};
+
+/**
+ * Removes everything before the magic number in the metadata.
+ * This ensures Opaque metadata is usable by pjs
+ */
+const normalizeMetadata = metadata => {
+  const hexMagicNumber = utils.toHex(scaleTs.u32.enc(MAGIC_NUMBER)).slice(2);
+  const magicNumberIndex = metadata.indexOf(hexMagicNumber);
+  if (magicNumberIndex === -1) throw new Error("Invalid metadata format: magic number not found");
+  return `0x${metadata.slice(magicNumberIndex)}`;
+};
+
+exports.fetchBestMetadata = fetchBestMetadata;
 exports.getScaleApi = getScaleApi;

package/dist/talismn-sapi.esm.js

@@ -7,6 +7,7 @@ import { toHex, mergeUint8 } from '@polkadot-api/utils';
 import { TypeRegistry, Metadata } from '@polkadot/types';
 import { merkleizeMetadata } from '@polkadot-api/merkleize-metadata';
 import { enhanceEncoder, Bytes, u16 } from '@polkadot-api/substrate-bindings';
+import { Vector, u32 } from 'scale-ts';
 
 var packageJson = {
 	name: "@talismn/sapi"};
@@ -524,4 +525,50 @@ const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signed
   };
 };
 
-export { getScaleApi };
+const MAGIC_NUMBER = 1635018093;
+
+// it's important to set a max because some chains also return high invalid version numbers in the metadata_versions list (ex on Polkadot, related to JAM?)
+const MAX_SUPPORTED_METADATA_VERSION = 16;
+/**
+ * Fetches the highest supported version of metadata from the chain.
+ *
+ * @param rpcSend
+ * @returns hex-encoded metadata starting with the magic number
+ */
+const fetchBestMetadata = async (rpcSend, allowLegacyFallback) => {
+  try {
+    // fetch available versions of metadata
+    const metadataVersions = await rpcSend("state_call", ["Metadata_metadata_versions", "0x"], true);
+    const availableVersions = Vector(u32).dec(metadataVersions);
+    const bestVersion = Math.max(...availableVersions.filter(v => v <= MAX_SUPPORTED_METADATA_VERSION));
+    const metadata = await rpcSend("state_call", ["Metadata_metadata_at_version", toHex(u32.enc(bestVersion))], true);
+    return normalizeMetadata(metadata);
+  } catch (cause) {
+    // if the chain doesnt support the Metadata pallet, fallback to legacy rpc provided metadata (V14)
+    const message = cause?.message;
+    if (allowLegacyFallback || message?.includes("is not found") ||
+    // ex: crust standalone
+    message?.includes("Module doesn't have export Metadata_metadata_versions") // ex: 3DPass
+    ) {
+      return await rpcSend("state_getMetadata", [], true);
+    }
+
+    // otherwise throw so it can be handled by the caller
+    throw new Error("Failed to fetch metadata", {
+      cause
+    });
+  }
+};
+
+/**
+ * Removes everything before the magic number in the metadata.
+ * This ensures Opaque metadata is usable by pjs
+ */
+const normalizeMetadata = metadata => {
+  const hexMagicNumber = toHex(u32.enc(MAGIC_NUMBER)).slice(2);
+  const magicNumberIndex = metadata.indexOf(hexMagicNumber);
+  if (magicNumberIndex === -1) throw new Error("Invalid metadata format: magic number not found");
+  return `0x${metadata.slice(magicNumberIndex)}`;
+};
+
+export { fetchBestMetadata, getScaleApi };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/sapi",
-  "version": "0.0.4",
+  "version": "0.0.5",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -30,6 +30,7 @@
     "@polkadot/util": "13.5.1",
     "anylogger": "^1.0.11",
     "polkadot-api": "1.13.1",
+    "scale-ts": "^1.6.1",
     "@talismn/scale": "0.1.2"
   },
   "devDependencies": {
@@ -38,8 +39,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,