@talismn/sapi 0.0.0-pr2277-20251211070508 → 0.0.0-pr2295-20260110031023

package/dist/index.d.mts

@@ -0,0 +1,111 @@
+import { SignerPayloadJSON } from '@polkadot/types/types';
+import * as _polkadot_types from '@polkadot/types';
+import { ExtDef } from '@polkadot/types/extrinsic/signedExtensions/types';
+import { UnifiedMetadata, MetadataLookup, MetadataBuilder } from '@talismn/scale';
+
+type DecodedCall<Args = any> = {
+    pallet: string;
+    method: string;
+    args: Args;
+};
+type PayloadSignerConfig = {
+    address: string;
+    tip?: bigint;
+};
+type JsonRpcRequestSend = (method: string, params: unknown[], isCacheable?: boolean) => Promise<unknown>;
+type SapiConnectorProps = {
+    chainId: string;
+    send: JsonRpcRequestSend;
+    submit?: (payload: SignerPayloadJSON, signature?: `0x${string}`, txInfo?: any) => Promise<{
+        hash: `0x${string}`;
+    }>;
+    submitWithBittensorMevShield?: (payload: SignerPayloadJSON, txInfo?: any) => Promise<{
+        hash: `0x${string}`;
+    }>;
+};
+
+type SapiConnector = Required<SapiConnectorProps>;
+
+type Chain = {
+    connector: SapiConnector;
+    hexMetadata: `0x${string}`;
+    token: {
+        symbol: string;
+        decimals: number;
+    };
+    hasCheckMetadataHash?: boolean;
+    signedExtensions?: ExtDef;
+    registryTypes?: unknown;
+    metadata: UnifiedMetadata;
+    lookup: MetadataLookup;
+    builder: MetadataBuilder;
+    metadataRpc: `0x${string}`;
+};
+
+type ScaleApiSubmitMode = "default" | "bittensor-mev-shield";
+
+type ScaleApi = NonNullable<ReturnType<typeof getScaleApi>>;
+declare const getScaleApi: (connector: SapiConnectorProps, hexMetadata: `0x${string}`, token: {
+    symbol: string;
+    decimals: number;
+}, hasCheckMetadataHash?: boolean, signedExtensions?: ExtDef, registryTypes?: unknown) => {
+    id: string;
+    chainId: string;
+    specName: string;
+    specVersion: number;
+    hasCheckMetadataHash: boolean | undefined;
+    base58Prefix: number;
+    token: {
+        symbol: string;
+        decimals: number;
+    };
+    chain: Chain;
+    getConstant: <T>(pallet: string, constant: string) => T;
+    getStorage: <T>(pallet: string, entry: string, keys: unknown[], at?: string) => Promise<T>;
+    getDecodedCall: (pallet: string, method: string, args: unknown) => {
+        type: string;
+        value: {
+            type: string;
+            value: unknown;
+        };
+    };
+    getDecodedCallFromPayload: <Res extends DecodedCall>(payload: {
+        method: SignerPayloadJSON["method"];
+    }) => Res;
+    getExtrinsicPayload: (pallet: string, method: string, args: unknown, config: PayloadSignerConfig) => Promise<{
+        payload: SignerPayloadJSON;
+        txMetadata: Uint8Array | undefined;
+        shortMetadata: `0x${string}` | undefined;
+    }>;
+    getFeeEstimate: (payload: SignerPayloadJSON) => Promise<bigint>;
+    getRuntimeCallValue: <T>(apiName: string, method: string, args: unknown[]) => Promise<T>;
+    getTypeRegistry: (payload: SignerPayloadJSON) => _polkadot_types.TypeRegistry;
+    submit: (payload: SignerPayloadJSON, signature?: `0x${string}`, txInfo?: unknown, mode?: ScaleApiSubmitMode) => Promise<{
+        hash: `0x${string}`;
+    }>;
+    getCallDocs: (pallet: string, method: string) => string | null;
+    getDryRunCall: <T>(from: string, decodedCall: DecodedCall<unknown>) => Promise<{
+        available: boolean;
+        data: null;
+        ok?: undefined;
+        errorMessage?: undefined;
+    } | {
+        available: boolean;
+        data: T;
+        ok: boolean;
+        errorMessage: string | null;
+    }>;
+    isApiAvailable: (name: string, method: string) => boolean;
+};
+
+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.
+ *
+ * @param rpcSend
+ * @returns hex-encoded metadata starting with the magic number
+ */
+declare const fetchBestMetadata: (rpcSend: RpcSendFunc, allowLegacyFallback?: boolean) => Promise<`0x${string}`>;
+
+export { type DecodedCall, type JsonRpcRequestSend, MAX_SUPPORTED_METADATA_VERSION, type PayloadSignerConfig, type SapiConnectorProps, type ScaleApi, fetchBestMetadata, getScaleApi };

package/dist/index.d.ts

@@ -0,0 +1,111 @@
+import { SignerPayloadJSON } from '@polkadot/types/types';
+import * as _polkadot_types from '@polkadot/types';
+import { ExtDef } from '@polkadot/types/extrinsic/signedExtensions/types';
+import { UnifiedMetadata, MetadataLookup, MetadataBuilder } from '@talismn/scale';
+
+type DecodedCall<Args = any> = {
+    pallet: string;
+    method: string;
+    args: Args;
+};
+type PayloadSignerConfig = {
+    address: string;
+    tip?: bigint;
+};
+type JsonRpcRequestSend = (method: string, params: unknown[], isCacheable?: boolean) => Promise<unknown>;
+type SapiConnectorProps = {
+    chainId: string;
+    send: JsonRpcRequestSend;
+    submit?: (payload: SignerPayloadJSON, signature?: `0x${string}`, txInfo?: any) => Promise<{
+        hash: `0x${string}`;
+    }>;
+    submitWithBittensorMevShield?: (payload: SignerPayloadJSON, txInfo?: any) => Promise<{
+        hash: `0x${string}`;
+    }>;
+};
+
+type SapiConnector = Required<SapiConnectorProps>;
+
+type Chain = {
+    connector: SapiConnector;
+    hexMetadata: `0x${string}`;
+    token: {
+        symbol: string;
+        decimals: number;
+    };
+    hasCheckMetadataHash?: boolean;
+    signedExtensions?: ExtDef;
+    registryTypes?: unknown;
+    metadata: UnifiedMetadata;
+    lookup: MetadataLookup;
+    builder: MetadataBuilder;
+    metadataRpc: `0x${string}`;
+};
+
+type ScaleApiSubmitMode = "default" | "bittensor-mev-shield";
+
+type ScaleApi = NonNullable<ReturnType<typeof getScaleApi>>;
+declare const getScaleApi: (connector: SapiConnectorProps, hexMetadata: `0x${string}`, token: {
+    symbol: string;
+    decimals: number;
+}, hasCheckMetadataHash?: boolean, signedExtensions?: ExtDef, registryTypes?: unknown) => {
+    id: string;
+    chainId: string;
+    specName: string;
+    specVersion: number;
+    hasCheckMetadataHash: boolean | undefined;
+    base58Prefix: number;
+    token: {
+        symbol: string;
+        decimals: number;
+    };
+    chain: Chain;
+    getConstant: <T>(pallet: string, constant: string) => T;
+    getStorage: <T>(pallet: string, entry: string, keys: unknown[], at?: string) => Promise<T>;
+    getDecodedCall: (pallet: string, method: string, args: unknown) => {
+        type: string;
+        value: {
+            type: string;
+            value: unknown;
+        };
+    };
+    getDecodedCallFromPayload: <Res extends DecodedCall>(payload: {
+        method: SignerPayloadJSON["method"];
+    }) => Res;
+    getExtrinsicPayload: (pallet: string, method: string, args: unknown, config: PayloadSignerConfig) => Promise<{
+        payload: SignerPayloadJSON;
+        txMetadata: Uint8Array | undefined;
+        shortMetadata: `0x${string}` | undefined;
+    }>;
+    getFeeEstimate: (payload: SignerPayloadJSON) => Promise<bigint>;
+    getRuntimeCallValue: <T>(apiName: string, method: string, args: unknown[]) => Promise<T>;
+    getTypeRegistry: (payload: SignerPayloadJSON) => _polkadot_types.TypeRegistry;
+    submit: (payload: SignerPayloadJSON, signature?: `0x${string}`, txInfo?: unknown, mode?: ScaleApiSubmitMode) => Promise<{
+        hash: `0x${string}`;
+    }>;
+    getCallDocs: (pallet: string, method: string) => string | null;
+    getDryRunCall: <T>(from: string, decodedCall: DecodedCall<unknown>) => Promise<{
+        available: boolean;
+        data: null;
+        ok?: undefined;
+        errorMessage?: undefined;
+    } | {
+        available: boolean;
+        data: T;
+        ok: boolean;
+        errorMessage: string | null;
+    }>;
+    isApiAvailable: (name: string, method: string) => boolean;
+};
+
+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.
+ *
+ * @param rpcSend
+ * @returns hex-encoded metadata starting with the magic number
+ */
+declare const fetchBestMetadata: (rpcSend: RpcSendFunc, allowLegacyFallback?: boolean) => Promise<`0x${string}`>;
+
+export { type DecodedCall, type JsonRpcRequestSend, MAX_SUPPORTED_METADATA_VERSION, type PayloadSignerConfig, type SapiConnectorProps, type ScaleApi, fetchBestMetadata, getScaleApi };