@talismn/scale 0.0.2 → 0.1.1

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

@@ -1,3 +1,2 @@
-export * from "./capi";
-export * from "./metadata";
-export * from "./storage";
+export * from "./papito";
+export * from "./util";

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

@@ -0,0 +1,6 @@
+export { getDynamicBuilder, getLookupFn } from "@polkadot-api/metadata-builders";
+export type { V14, V15, V15Extrinsic, Codec, Binary } from "@polkadot-api/substrate-bindings";
+export { toHex, fromHex } from "@polkadot-api/utils";
+/** Constant: https://docs.substrate.io/build/application-development/#metadata-format */
+export declare const magicNumber = 1635018093;
+export { v14, v15, metadata } from "@polkadot-api/substrate-bindings";

package/dist/declarations/src/util/compactMetadata.d.ts

@@ -0,0 +1,24 @@
+import { V14, V15 } from "../papito";
+export type V14Type = V14["lookup"][0];
+export type V14Pallet = V14["pallets"][0];
+export type V14StorageItem = NonNullable<V14Pallet["storage"]>["items"][0];
+export type V15Type = V15["lookup"][0];
+export type V15Pallet = V15["pallets"][0];
+export type V15StorageItem = NonNullable<V15Pallet["storage"]>["items"][0];
+/**
+ * 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.
+ */
+export declare const compactMetadata: (metadata: V15 | V14, palletsAndItems?: Array<{
+    pallet: string;
+    constants?: string[];
+    items: string[];
+}>, runtimeApisAndMethods?: Array<{
+    runtimeApi: string;
+    methods: string[];
+}>, extraKeepTypes?: number[]) => void;

package/dist/declarations/src/util/decodeMetadata.d.ts

@@ -0,0 +1,13 @@
+import { V14, V15 } from "@polkadot-api/substrate-bindings";
+export declare const decodeMetadata: (metadataRpc: string) => {
+    metadataVersion: number;
+} & ({
+    metadata: V15;
+    tag: "v15";
+} | {
+    metadata: V14;
+    tag: "v14";
+} | {
+    metadata?: undefined;
+    tag?: undefined;
+});

package/dist/declarations/src/util/decodeScale.d.ts

@@ -0,0 +1,4 @@
+import { getDynamicBuilder } from "@polkadot-api/metadata-builders";
+type ScaleStorageCoder = ReturnType<ReturnType<typeof getDynamicBuilder>["buildStorage"]>;
+export declare const decodeScale: <T>(scaleCoder: ScaleStorageCoder | undefined, change: string | null, error?: string) => T | null;
+export {};

package/dist/declarations/src/util/encodeMetadata.d.ts

@@ -0,0 +1,8 @@
+import { V14, V15 } from "@polkadot-api/substrate-bindings";
+export declare const encodeMetadata: ({ metadata, tag, }: {
+    metadata: V15;
+    tag: "v15";
+} | {
+    metadata: V14;
+    tag: "v14";
+}) => string;

package/dist/declarations/src/util/encodeStateKey.d.ts

@@ -0,0 +1,4 @@
+import { getDynamicBuilder } from "@polkadot-api/metadata-builders";
+type ScaleStorageCoder = ReturnType<ReturnType<typeof getDynamicBuilder>["buildStorage"]>;
+export declare const encodeStateKey: (scaleCoder: ScaleStorageCoder | undefined, error?: string, ...args: any[]) => string | undefined;
+export {};

package/dist/declarations/src/util/getMetadataVersion.d.ts

@@ -0,0 +1,6 @@
+/**
+ * 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.
+ */
+export declare const getMetadataVersion: (metadataRpc: string | Uint8Array | ArrayBuffer) => number;

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

@@ -0,0 +1,7 @@
+export * from "./compactMetadata";
+export * from "./decodeMetadata";
+export * from "./decodeScale";
+export * from "./encodeMetadata";
+export * from "./encodeStateKey";
+export * from "./getMetadataVersion";
+export * from "./serdePapi";

package/dist/declarations/src/util/serdePapi.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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") })`
+ */
+export declare const papiParse: <T = unknown>(text: string | T) => T;
+export declare const papiStringify: (value: any, // eslint-disable-line @typescript-eslint/no-explicit-any
+space?: string | number) => string;