@talismn/scale 0.2.2 → 0.3.1

package/dist/{declarations/src/util/parseMetadataRpc.d.ts → index.d.mts}

@@ -1,4 +1,64 @@
-export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
+import * as _polkadot_api_metadata_builders from '@polkadot-api/metadata-builders';
+import { getDynamicBuilder } from '@polkadot-api/metadata-builders';
+export { MetadataLookup, getDynamicBuilder, getLookupFn } from '@polkadot-api/metadata-builders';
+import * as _polkadot_api_substrate_bindings from '@polkadot-api/substrate-bindings';
+import { Metadata, UnifiedMetadata } from '@polkadot-api/substrate-bindings';
+export { Binary, Blake2128, Blake2128Concat, Blake2256, Blake3256, Blake3256Concat, Codec, FixedSizeBinary, Twox128, Twox256, Twox64Concat, UnifiedMetadata, decAnyMetadata, metadata, unifyMetadata } from '@polkadot-api/substrate-bindings';
+import * as scale_ts from 'scale-ts';
+export { fromHex, mergeUint8, toHex } from '@polkadot-api/utils';
+
+/** Constant: https://docs.substrate.io/build/application-development/#metadata-format */
+declare const magicNumber = 1635018093;
+type MetadataBuilder = ReturnType<typeof getDynamicBuilder>;
+
+type MetadataType = SupportedMetadata["lookup"][number];
+type MetadataPallet = SupportedMetadata["pallets"][number];
+type MetadataStorageItem = NonNullable<MetadataPallet["storage"]>["items"][number];
+type SupportedMetadata = Extract<Metadata["metadata"], {
+    tag: SupportedMetadataVersion;
+}>["value"];
+type SupportedMetadataVersion = "v14" | "v15" | "v16";
+/**
+ * Converts a `Metadata` into a `MiniMetadata`.
+ *
+ * A `MiniMetadata` only contains the types inside of its `lookup` which are relevant for
+ * the storage queries specified in `palletsAndItems`.
+ *
+ * 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.
+ */
+declare const compactMetadata: (anyMetadata: Metadata, palletsAndItems?: Array<{
+    pallet: string;
+    constants?: string[];
+    items: string[];
+}>, runtimeApisAndMethods?: Array<{
+    runtimeApi: string;
+    methods: string[];
+}>, extraKeepTypes?: number[]) => void;
+
+type ScaleStorageCoder$1 = ReturnType<MetadataBuilder["buildStorage"]>;
+declare const decodeScale: <T>(scaleCoder: ScaleStorageCoder$1 | undefined, change: string | null, error?: string) => T | null;
+
+declare const encodeMetadata: (metadata: Metadata) => `0x${string}`;
+
+type ScaleStorageCoder = ReturnType<MetadataBuilder["buildStorage"]>;
+declare const encodeStateKey: (scaleCoder: ScaleStorageCoder | undefined, error?: string, ...args: unknown[]) => `0x${string}` | undefined;
+
+declare const getConstantValueFromMetadata: <T>(metadata: `0x${string}` | {
+    builder: MetadataBuilder;
+    unifiedMetadata: UnifiedMetadata;
+}, pallet: string, constant: string) => T;
+
+/**
+ * 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.
+ */
+declare const getMetadataVersion: (metadataRpc: string | Uint8Array | ArrayBuffer) => number;
+
+declare const getStorageKeyPrefix: (palletName: string, storageName: string) => string;
+
+declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
     metadata: {
         magicNumber: number;
         metadata: {
@@ -186,7 +246,7 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                                 tag: "plain";
                                 value: number;
                             };
-                            fallback: import("@polkadot-api/substrate-bindings").HexString;
+                            fallback: _polkadot_api_substrate_bindings.HexString;
                             docs: string[];
                         }[];
                     } | undefined;
@@ -195,7 +255,7 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                     constants: {
                         name: string;
                         type: number;
-                        value: import("@polkadot-api/substrate-bindings").HexString;
+                        value: _polkadot_api_substrate_bindings.HexString;
                         docs: string[];
                     }[];
                     errors: number | undefined;
@@ -395,7 +455,7 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                                 tag: "plain";
                                 value: number;
                             };
-                            fallback: import("@polkadot-api/substrate-bindings").HexString;
+                            fallback: _polkadot_api_substrate_bindings.HexString;
                             docs: string[];
                         }[];
                     } | undefined;
@@ -404,7 +464,7 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                     constants: {
                         name: string;
                         type: number;
-                        value: import("@polkadot-api/substrate-bindings").HexString;
+                        value: _polkadot_api_substrate_bindings.HexString;
                         docs: string[];
                     }[];
                     errors: number | undefined;
@@ -443,7 +503,7 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                 };
                 custom: [string, {
                     type: number;
-                    value: import("@polkadot-api/substrate-bindings").HexString;
+                    value: _polkadot_api_substrate_bindings.HexString;
                 }][];
             };
         } | {
@@ -601,7 +661,7 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                                 tag: "plain";
                                 value: number;
                             };
-                            fallback: import("@polkadot-api/substrate-bindings").HexString;
+                            fallback: _polkadot_api_substrate_bindings.HexString;
                             docs: string[];
                         }[];
                     } | undefined;
@@ -640,7 +700,7 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                     constants: {
                         name: string;
                         type: number;
-                        value: import("@polkadot-api/substrate-bindings").HexString;
+                        value: _polkadot_api_substrate_bindings.HexString;
                         docs: string[];
                         deprecationInfo: {
                             tag: "NotDeprecated";
@@ -698,7 +758,7 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                         }[];
                         output: number;
                         docs: string[];
-                        id: import("@polkadot-api/substrate-bindings").HexString;
+                        id: _polkadot_api_substrate_bindings.HexString;
                     }[];
                     index: number;
                     docs: string[];
@@ -775,61 +835,93 @@ export declare const parseMetadataRpc: (metadataRpc: `0x${string}`) => {
                 };
                 custom: [string, {
                     type: number;
-                    value: import("@polkadot-api/substrate-bindings").HexString;
+                    value: _polkadot_api_substrate_bindings.HexString;
                 }][];
             };
         };
     };
-    unifiedMetadata: import("@polkadot-api/substrate-bindings").UnifiedMetadata<14 | 15 | 16>;
-    lookupFn: import("@polkadot-api/metadata-builders").MetadataLookup;
+    unifiedMetadata: _polkadot_api_substrate_bindings.UnifiedMetadata<14 | 15 | 16>;
+    lookupFn: _polkadot_api_metadata_builders.MetadataLookup;
     builder: {
-        buildDefinition: (id: number) => import("@polkadot-api/substrate-bindings").Codec<any>;
+        buildDefinition: (id: number) => scale_ts.Codec<any>;
         buildStorage: (pallet: string, entry: string) => {
-            args: [import("@polkadot-api/substrate-bindings").Encoder<any[]>, import("@polkadot-api/substrate-bindings").Decoder<any[]>] & {
-                enc: import("@polkadot-api/substrate-bindings").Encoder<any[]>;
-                dec: import("@polkadot-api/substrate-bindings").Decoder<any[]>;
+            args: [scale_ts.Encoder<any[]>, scale_ts.Decoder<any[]>] & {
+                enc: scale_ts.Encoder<any[]>;
+                dec: scale_ts.Decoder<any[]>;
             } & {
-                inner: import("@polkadot-api/substrate-bindings").Codec<any>[];
+                inner: scale_ts.Codec<any>[];
             };
             keys: {
                 enc: (...args: any[]) => string;
                 dec: (value: string) => any[];
             };
-            value: import("@polkadot-api/substrate-bindings").Codec<any>;
+            value: scale_ts.Codec<any>;
             len: number;
             fallback: any;
         };
         buildEvent: (pallet: string, name: string) => {
-            codec: import("@polkadot-api/substrate-bindings").Codec<any>;
+            codec: scale_ts.Codec<any>;
             location: [number, number];
         };
         buildError: (pallet: string, name: string) => {
-            codec: import("@polkadot-api/substrate-bindings").Codec<any>;
+            codec: scale_ts.Codec<any>;
             location: [number, number];
         };
         buildViewFn: (pallet: string, entry: string) => {
-            args: [import("@polkadot-api/substrate-bindings").Encoder<any[]>, import("@polkadot-api/substrate-bindings").Decoder<any[]>] & {
-                enc: import("@polkadot-api/substrate-bindings").Encoder<any[]>;
-                dec: import("@polkadot-api/substrate-bindings").Decoder<any[]>;
+            args: [scale_ts.Encoder<any[]>, scale_ts.Decoder<any[]>] & {
+                enc: scale_ts.Encoder<any[]>;
+                dec: scale_ts.Decoder<any[]>;
             } & {
-                inner: import("@polkadot-api/substrate-bindings").Codec<any>[];
+                inner: scale_ts.Codec<any>[];
             };
-            value: import("@polkadot-api/substrate-bindings").Codec<any>;
+            value: scale_ts.Codec<any>;
         };
         buildRuntimeCall: (api: string, method: string) => {
-            args: [import("@polkadot-api/substrate-bindings").Encoder<any[]>, import("@polkadot-api/substrate-bindings").Decoder<any[]>] & {
-                enc: import("@polkadot-api/substrate-bindings").Encoder<any[]>;
-                dec: import("@polkadot-api/substrate-bindings").Decoder<any[]>;
+            args: [scale_ts.Encoder<any[]>, scale_ts.Decoder<any[]>] & {
+                enc: scale_ts.Encoder<any[]>;
+                dec: scale_ts.Decoder<any[]>;
             } & {
-                inner: import("@polkadot-api/substrate-bindings").Codec<any>[];
+                inner: scale_ts.Codec<any>[];
             };
-            value: import("@polkadot-api/substrate-bindings").Codec<any>;
+            value: scale_ts.Codec<any>;
         };
         buildCall: (pallet: string, name: string) => {
-            codec: import("@polkadot-api/substrate-bindings").Codec<any>;
+            codec: scale_ts.Codec<any>;
             location: [number, number];
         };
-        buildConstant: (pallet: string, constantName: string) => import("@polkadot-api/substrate-bindings").Codec<any>;
+        buildConstant: (pallet: string, constantName: string) => scale_ts.Codec<any>;
         ss58Prefix: number | undefined;
     };
 };
+
+/**
+ * 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.
+ * E.g. api.query.Tokens.Account(accountAddress, papiParse(onChainId))
+ *
+ * The `onChainId` field on chaindata must be a JSON-parseable string, but for some SCALE types (especially the Binary type) we must
+ * use specific `polkadot-api` classes to handle SCALE-encoding the statekey.
+ *
+ * Some examples:
+ * Input: `5`
+ * Output: `5`
+ *
+ * Input: `{ type: "DexShare", value: [ { type: "Token", value: { type: "ACA" } }, { type: "Token", value: { type: "AUSD" } } ] }`
+ * Output: `Enum("DexShare", [Enum("Token", Enum("ACA")), Enum("Token", Enum("AUSD"))])`
+ *
+ * Input: `{ type: "LiquidCrowdloan", value: 13 }`
+ * Output: `Enum("LiquidCrowdloan", 13)`
+ *
+ * Input: `{ type: "NativeToken", value: "bigint:2" }`
+ * Output: `Enum("NativeToken", 2n)`
+ *
+ * Input: `{ type: "Erc20", value: "hex:0x07df96d1341a7d16ba1ad431e2c847d978bc2bce" }`
+ * Output: `Enum("Erc20", Binary.fromHex("0x07df96d1341a7d16ba1ad431e2c847d978bc2bce"))`
+ *
+ * Input: `{ type: "Stellar", value: { code: "bin:TZS", issuer: "hex:0x34c94b2a4ba9e8b57b22547dcbb30f443c4cb02da3829a89aa1bd4780e4466ba" } }`
+ * Output: `Enum("Stellar", { code: Binary.fromText("TZS"), issuer: Binary.fromHex("0x34c94b2a4ba9e8b57b22547dcbb30f443c4cb02da3829a89aa1bd4780e4466ba") })`
+ */
+declare const papiParse: <T = unknown>(text: string | T) => T;
+declare const papiStringify: (value: unknown, space?: string | number) => string;
+
+export { type MetadataBuilder, type MetadataPallet, type MetadataStorageItem, type MetadataType, type ScaleStorageCoder, compactMetadata, decodeScale, encodeMetadata, encodeStateKey, getConstantValueFromMetadata, getMetadataVersion, getStorageKeyPrefix, magicNumber, papiParse, papiStringify, parseMetadataRpc };