@talismn/sapi 0.0.11 → 0.1.0

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

@@ -1,3 +1,4 @@
+export declare const MAX_SUPPORTED_METADATA_VERSION = 15;
 type RpcSendFunc = <T>(method: string, params: unknown[], isCacheable?: boolean) => Promise<T>;
 /**
  * Fetches the highest supported version of metadata from the chain.

package/dist/declarations/src/helpers/getSapiConnector.d.ts

@@ -1,3 +1,3 @@
 import { SapiConnectorProps } from "../types";
 export type SapiConnector = Required<SapiConnectorProps>;
-export declare const getSapiConnector: ({ chainId, send, submit }: SapiConnectorProps) => SapiConnector;
+export declare const getSapiConnector: ({ chainId, send, submit, submitWithBittensorMevShield, }: SapiConnectorProps) => SapiConnector;

package/dist/declarations/src/helpers/submit.d.ts

@@ -0,0 +1,6 @@
+import { SignerPayloadJSON } from "@polkadot/types/types";
+import { Chain } from "./types";
+export type ScaleApiSubmitMode = "default" | "bittensor-mev-shield";
+export declare const submit: (chain: Chain, payload: SignerPayloadJSON, signature?: `0x${string}`, txInfo?: unknown, mode?: ScaleApiSubmitMode) => Promise<{
+    hash: `0x${string}`;
+}>;

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

@@ -1,5 +1,6 @@
 import { ExtDef } from "@polkadot/types/extrinsic/signedExtensions/types";
 import { SignerPayloadJSON } from "@polkadot/types/types";
+import { ScaleApiSubmitMode } from "./helpers/submit";
 import { Chain } from "./helpers/types";
 import { DecodedCall, PayloadSignerConfig, SapiConnectorProps } from "./types";
 export type ScaleApi = NonNullable<ReturnType<typeof getScaleApi>>;
@@ -38,7 +39,7 @@ export declare const getScaleApi: (connector: SapiConnectorProps, hexMetadata: `
     getFeeEstimate: (payload: SignerPayloadJSON) => Promise<bigint>;
     getRuntimeCallValue: <T>(apiName: string, method: string, args: unknown[]) => Promise<T>;
     getTypeRegistry: (payload: SignerPayloadJSON) => import("@polkadot/types").TypeRegistry;
-    submit: (payload: SignerPayloadJSON, signature?: `0x${string}`, txInfo?: unknown) => Promise<{
+    submit: (payload: SignerPayloadJSON, signature?: `0x${string}`, txInfo?: unknown, mode?: ScaleApiSubmitMode) => Promise<{
         hash: `0x${string}`;
     }>;
     getCallDocs: (pallet: string, method: string) => string | null;

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

@@ -15,4 +15,7 @@ export type SapiConnectorProps = {
     submit?: (payload: SignerPayloadJSON, signature?: `0x${string}`, txInfo?: any) => Promise<{
         hash: `0x${string}`;
     }>;
+    submitWithBittensorMevShield?: (payload: SignerPayloadJSON, txInfo?: any) => Promise<{
+        hash: `0x${string}`;
+    }>;
 };

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

@@ -315,13 +315,18 @@ const getFeeEstimate = async (chain, payload, chainInfo) => {
 const getSapiConnector = ({
   chainId,
   send,
-  submit
+  submit,
+  submitWithBittensorMevShield
 }) => ({
   chainId,
   send,
   submit: (...args) => {
     if (submit) return submit(...args);
     throw new Error("submit handler not provided");
+  },
+  submitWithBittensorMevShield: (...args) => {
+    if (submitWithBittensorMevShield) return submitWithBittensorMevShield(...args);
+    throw new Error("submitWithBittensorMevShield handler not provided");
   }
 });
 
@@ -340,16 +345,18 @@ const getPayloadWithMetadataHash = (chain, chainInfo, payload) => {
       specName,
       specVersion
     } = chainInfo;
-
-    // since ultimately this needs a V15 object, would be nice if this accepted one directly as input
-    const merkleizedMetadata = merkleizeMetadata.merkleizeMetadata(chain.hexMetadata, {
+    const metadataHashInputs = {
       tokenSymbol,
       decimals,
       base58Prefix,
       specName,
       specVersion
-    });
+    };
+
+    // since ultimately this needs a V15 object, would be nice if this accepted one directly as input
+    const merkleizedMetadata = merkleizeMetadata.merkleizeMetadata(chain.hexMetadata, metadataHashInputs);
     const metadataHash = utils.toHex(merkleizedMetadata.digest());
+    log.log("metadataHash", metadataHash, metadataHashInputs);
     const payloadWithMetadataHash = {
       ...payload,
       mode: 1,
@@ -480,6 +487,16 @@ const getSignerPayloadJSON = async (chain, palletName, methodName, args, signerC
   };
 };
 
+const submit = async (chain, payload, signature, txInfo, mode) => {
+  switch (mode) {
+    case "bittensor-mev-shield":
+      if (signature) throw new Error("Signature should not be provided when using bittensor-mev-shield mode");
+      return chain.connector.submitWithBittensorMevShield(payload, txInfo);
+    default:
+      return chain.connector.submit(payload, signature, txInfo);
+  }
+};
+
 const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signedExtensions, registryTypes) => {
   const {
     unifiedMetadata: metadata,
@@ -521,7 +538,7 @@ const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signed
     getFeeEstimate: payload => getFeeEstimate(chain, payload, chainInfo),
     getRuntimeCallValue: (apiName, method, args) => getRuntimeCallResult(chain, apiName, method, args),
     getTypeRegistry: payload => getTypeRegistry(chain, payload),
-    submit: (payload, signature, txInfo) => chain.connector.submit(payload, signature, txInfo),
+    submit: (payload, signature, txInfo, mode) => submit(chain, payload, signature, txInfo, mode),
     getCallDocs: (pallet, method) => getCallDocs(chain, pallet, method),
     getDryRunCall: (from, decodedCall) => getDryRunCall(chain, from, decodedCall),
     isApiAvailable: (name, method) => isApiAvailable(chain, name, method)
@@ -531,7 +548,8 @@ 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;
+const MAX_SUPPORTED_METADATA_VERSION = 15; // v16 sometimes outputs different metadata hashes, ignore v16 until that is fixed in PAPI
+
 /**
  * Fetches the highest supported version of metadata from the chain.
  *
@@ -578,5 +596,6 @@ const normalizeMetadata = metadata => {
   return `0x${metadata.slice(magicNumberIndex)}`;
 };
 
+exports.MAX_SUPPORTED_METADATA_VERSION = MAX_SUPPORTED_METADATA_VERSION;
 exports.fetchBestMetadata = fetchBestMetadata;
 exports.getScaleApi = getScaleApi;

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

@@ -315,13 +315,18 @@ const getFeeEstimate = async (chain, payload, chainInfo) => {
 const getSapiConnector = ({
   chainId,
   send,
-  submit
+  submit,
+  submitWithBittensorMevShield
 }) => ({
   chainId,
   send,
   submit: (...args) => {
     if (submit) return submit(...args);
     throw new Error("submit handler not provided");
+  },
+  submitWithBittensorMevShield: (...args) => {
+    if (submitWithBittensorMevShield) return submitWithBittensorMevShield(...args);
+    throw new Error("submitWithBittensorMevShield handler not provided");
   }
 });
 
@@ -340,16 +345,18 @@ const getPayloadWithMetadataHash = (chain, chainInfo, payload) => {
       specName,
       specVersion
     } = chainInfo;
-
-    // since ultimately this needs a V15 object, would be nice if this accepted one directly as input
-    const merkleizedMetadata = merkleizeMetadata.merkleizeMetadata(chain.hexMetadata, {
+    const metadataHashInputs = {
       tokenSymbol,
       decimals,
       base58Prefix,
       specName,
       specVersion
-    });
+    };
+
+    // since ultimately this needs a V15 object, would be nice if this accepted one directly as input
+    const merkleizedMetadata = merkleizeMetadata.merkleizeMetadata(chain.hexMetadata, metadataHashInputs);
     const metadataHash = utils.toHex(merkleizedMetadata.digest());
+    log.log("metadataHash", metadataHash, metadataHashInputs);
     const payloadWithMetadataHash = {
       ...payload,
       mode: 1,
@@ -480,6 +487,16 @@ const getSignerPayloadJSON = async (chain, palletName, methodName, args, signerC
   };
 };
 
+const submit = async (chain, payload, signature, txInfo, mode) => {
+  switch (mode) {
+    case "bittensor-mev-shield":
+      if (signature) throw new Error("Signature should not be provided when using bittensor-mev-shield mode");
+      return chain.connector.submitWithBittensorMevShield(payload, txInfo);
+    default:
+      return chain.connector.submit(payload, signature, txInfo);
+  }
+};
+
 const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signedExtensions, registryTypes) => {
   const {
     unifiedMetadata: metadata,
@@ -521,7 +538,7 @@ const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signed
     getFeeEstimate: payload => getFeeEstimate(chain, payload, chainInfo),
     getRuntimeCallValue: (apiName, method, args) => getRuntimeCallResult(chain, apiName, method, args),
     getTypeRegistry: payload => getTypeRegistry(chain, payload),
-    submit: (payload, signature, txInfo) => chain.connector.submit(payload, signature, txInfo),
+    submit: (payload, signature, txInfo, mode) => submit(chain, payload, signature, txInfo, mode),
     getCallDocs: (pallet, method) => getCallDocs(chain, pallet, method),
     getDryRunCall: (from, decodedCall) => getDryRunCall(chain, from, decodedCall),
     isApiAvailable: (name, method) => isApiAvailable(chain, name, method)
@@ -531,7 +548,8 @@ 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;
+const MAX_SUPPORTED_METADATA_VERSION = 15; // v16 sometimes outputs different metadata hashes, ignore v16 until that is fixed in PAPI
+
 /**
  * Fetches the highest supported version of metadata from the chain.
  *
@@ -578,5 +596,6 @@ const normalizeMetadata = metadata => {
   return `0x${metadata.slice(magicNumberIndex)}`;
 };
 
+exports.MAX_SUPPORTED_METADATA_VERSION = MAX_SUPPORTED_METADATA_VERSION;
 exports.fetchBestMetadata = fetchBestMetadata;
 exports.getScaleApi = getScaleApi;

package/dist/talismn-sapi.esm.js

@@ -309,13 +309,18 @@ const getFeeEstimate = async (chain, payload, chainInfo) => {
 const getSapiConnector = ({
   chainId,
   send,
-  submit
+  submit,
+  submitWithBittensorMevShield
 }) => ({
   chainId,
   send,
   submit: (...args) => {
     if (submit) return submit(...args);
     throw new Error("submit handler not provided");
+  },
+  submitWithBittensorMevShield: (...args) => {
+    if (submitWithBittensorMevShield) return submitWithBittensorMevShield(...args);
+    throw new Error("submitWithBittensorMevShield handler not provided");
   }
 });
 
@@ -334,16 +339,18 @@ const getPayloadWithMetadataHash = (chain, chainInfo, payload) => {
       specName,
       specVersion
     } = chainInfo;
-
-    // since ultimately this needs a V15 object, would be nice if this accepted one directly as input
-    const merkleizedMetadata = merkleizeMetadata(chain.hexMetadata, {
+    const metadataHashInputs = {
       tokenSymbol,
       decimals,
       base58Prefix,
       specName,
       specVersion
-    });
+    };
+
+    // since ultimately this needs a V15 object, would be nice if this accepted one directly as input
+    const merkleizedMetadata = merkleizeMetadata(chain.hexMetadata, metadataHashInputs);
     const metadataHash = toHex(merkleizedMetadata.digest());
+    log.log("metadataHash", metadataHash, metadataHashInputs);
     const payloadWithMetadataHash = {
       ...payload,
       mode: 1,
@@ -474,6 +481,16 @@ const getSignerPayloadJSON = async (chain, palletName, methodName, args, signerC
   };
 };
 
+const submit = async (chain, payload, signature, txInfo, mode) => {
+  switch (mode) {
+    case "bittensor-mev-shield":
+      if (signature) throw new Error("Signature should not be provided when using bittensor-mev-shield mode");
+      return chain.connector.submitWithBittensorMevShield(payload, txInfo);
+    default:
+      return chain.connector.submit(payload, signature, txInfo);
+  }
+};
+
 const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signedExtensions, registryTypes) => {
   const {
     unifiedMetadata: metadata,
@@ -515,7 +532,7 @@ const getScaleApi = (connector, hexMetadata, token, hasCheckMetadataHash, signed
     getFeeEstimate: payload => getFeeEstimate(chain, payload, chainInfo),
     getRuntimeCallValue: (apiName, method, args) => getRuntimeCallResult(chain, apiName, method, args),
     getTypeRegistry: payload => getTypeRegistry(chain, payload),
-    submit: (payload, signature, txInfo) => chain.connector.submit(payload, signature, txInfo),
+    submit: (payload, signature, txInfo, mode) => submit(chain, payload, signature, txInfo, mode),
     getCallDocs: (pallet, method) => getCallDocs(chain, pallet, method),
     getDryRunCall: (from, decodedCall) => getDryRunCall(chain, from, decodedCall),
     isApiAvailable: (name, method) => isApiAvailable(chain, name, method)
@@ -525,7 +542,8 @@ 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;
+const MAX_SUPPORTED_METADATA_VERSION = 15; // v16 sometimes outputs different metadata hashes, ignore v16 until that is fixed in PAPI
+
 /**
  * Fetches the highest supported version of metadata from the chain.
  *
@@ -572,4 +590,4 @@ const normalizeMetadata = metadata => {
   return `0x${metadata.slice(magicNumberIndex)}`;
 };
 
-export { fetchBestMetadata, getScaleApi };
+export { MAX_SUPPORTED_METADATA_VERSION, fetchBestMetadata, getScaleApi };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/sapi",
-  "version": "0.0.11",
+  "version": "0.1.0",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -31,7 +31,7 @@
     "anylogger": "^1.0.11",
     "polkadot-api": "1.13.1",
     "scale-ts": "^1.6.1",
-    "@talismn/scale": "0.2.1"
+    "@talismn/scale": "0.3.0"
   },
   "devDependencies": {
     "@types/jest": "^29.5.14",
@@ -39,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.3",
+    "@talismn/eslint-config": "0.0.3"
   },
   "eslintConfig": {
     "root": true,