@talismn/balances 0.0.0-pr2075-20250710142256 → 0.0.0-pr2076-20250703120513

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

@@ -0,0 +1,17 @@
+/**
+ * `PluginBalanceTypes` is a collection of plugin-provided balance definitions.
+ *
+ * By hacking declaration merging (typescript magic) we can add variants to this type from within other modules.
+ *
+ * For more details on this process, see:
+ * - https://www.typescriptlang.org/docs/handbook/declaration-merging.html
+ * - https://stackoverflow.com/a/58261244/3926156
+ * - https://stackoverflow.com/a/56099769/3926156
+ * - https://stackoverflow.com/a/56516998/3926156
+ * - https://pqina.nl/blog/typescript-interface-merging-and-extending-modules/
+ *
+ * As a result, consumers of this api will have type information for the `BalanceJson` type
+ * based on the selection of plugins they are using in their app.
+ */
+export interface PluginBalanceTypes {
+}

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

@@ -1 +1,4 @@
 export type Address = string;
+export type AddressesByToken<TTokenType extends {
+    id: string;
+}> = Record<TTokenType["id"], Address[]>;

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

@@ -29,7 +29,7 @@ export type BalanceSearchQuery = Partial<NonFunctionProperties<Balance>> | ((bal
  */
 export declare class Balances {
     #private;
-    constructor(balances: Balances | BalanceJsonList | Balance[] | IBalance[] | BalanceJson[] | Balance, hydrate?: HydrateDb);
+    constructor(balances: Balances | BalanceJsonList | Balance[] | BalanceJson[] | Balance, hydrate?: HydrateDb);
     /**
      * Calling toJSON on a collection of balances will return the underlying BalanceJsonList.
      */
@@ -113,18 +113,18 @@ export declare class Balances {
      */
     get sum(): SumBalancesFormatter;
 }
-export declare const getBalanceId: (balance: Pick<IBalance, "address" | "tokenId">) => string;
+export declare const getBalanceId: (balance: BalanceJson) => string;
 /**
  * An individual balance.
  */
 export declare class Balance {
     #private;
-    constructor(storage: BalanceJson | IBalance, hydrate?: HydrateDb);
+    constructor(storage: BalanceJson, hydrate?: HydrateDb);
     toJSON: () => BalanceJson;
     isSource: (source: BalanceSource) => boolean;
     hydrate: (hydrate?: HydrateDb) => void;
     get id(): string;
-    get source(): string;
+    get source(): "evm-erc20" | "evm-native" | "evm-uniswapv2" | "substrate-assets" | "substrate-foreignassets" | "substrate-native" | "substrate-psp22" | "substrate-tokens";
     get status(): import("./balancetypes").BalanceStatus;
     get address(): string;
     get networkId(): string;
@@ -181,7 +181,6 @@ export declare class Balance {
                 palletId?: string | undefined;
             } | undefined;
             "substrate-foreignassets"?: undefined;
-            "substrate-hydration"?: undefined;
         } | undefined;
     } | {
         id: string;
@@ -234,6 +233,7 @@ export declare class Balance {
         coingeckoId?: string | undefined;
         noDiscovery?: boolean | undefined;
         mirrorOf?: string | undefined;
+        isCustom?: boolean | undefined;
     } | {
         id: string;
         networkId: string;
@@ -278,7 +278,6 @@ export declare class Balance {
         type: "substrate-assets";
         platform: "polkadot";
         assetId: string;
-        isSufficient: boolean;
         existentialDeposit: string;
         isDefault?: boolean | undefined;
         name?: string | undefined;
@@ -295,7 +294,6 @@ export declare class Balance {
         type: "substrate-foreignassets";
         platform: "polkadot";
         onChainId: string;
-        isSufficient: boolean;
         existentialDeposit: string;
         isDefault?: boolean | undefined;
         name?: string | undefined;
@@ -347,23 +345,6 @@ export declare class Balance {
         coingeckoId?: string | undefined;
         noDiscovery?: boolean | undefined;
         mirrorOf?: string | undefined;
-    } | {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
-        type: "substrate-hydration";
-        platform: "polkadot";
-        onChainId: number;
-        assetType: "Token" | "Erc20" | "External";
-        isSufficient: boolean;
-        existentialDeposit: string;
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
     } | null;
     get decimals(): number | null;
     get rates(): TokenRates | null;

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

@@ -1,5 +1,28 @@
+import { PluginBalanceTypes } from "@talismn/balances/plugins";
 import { NetworkId, TokenId } from "@talismn/chaindata-provider";
 import { Address } from "./addresses";
+/**
+ * `BalanceTypes` is an automatically determined sub-selection of `PluginBalanceTypes`.
+ *
+ * It is the same list, but with any invalid `BalanceType` definitions filtered out.
+ */
+export type BalanceTypes = {
+    [BalanceType in keyof PluginBalanceTypes]: PluginBalanceTypes[BalanceType] extends IBalance ? PluginBalanceTypes[BalanceType] : never;
+};
+/**
+ * The `BalanceJson` sum type, which is a union of all of the possible `BalanceTypes`.
+ *
+ * Each variant comes from a plugin in use by the consuming app.
+ *
+ * For example, in an app with the `substrate-native`, `evm-native`, `substrate-tokens` and `evm-erc20` plugins:
+ *
+ *     type BalanceJson = SubNativeBalance | EvmNativeBalance | SubTokensBalance | EvmErc20Balance
+ *
+ * If `BalanceTypes` is empty then `BalanceJson` will fall back to the common `IBalance` interface, which every balance must implement.
+ */
+export type BalanceJson = BalanceTypes[keyof BalanceTypes] extends never ? IBalance : BalanceTypes[keyof BalanceTypes];
+/** A collection of `BalanceJson` objects */
+export type BalanceJsonList = Record<string, BalanceJson>;
 export type BalanceStatus = "live" | "cache" | "stale";
 type IBalanceBase = {
     /** The module that this balance was retrieved by */
@@ -25,9 +48,8 @@ type IBalanceComplexValues = {
 };
 /** `IBalance` is a common interface which all balance types must implement. */
 export type IBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues);
-export type BalanceJson = IBalance;
-/** A collection of `BalanceJson` objects */
-export type BalanceJsonList = Record<string, BalanceJson>;
+export type EvmBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues);
+export type SubstrateBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues);
 /** An unlabelled amount of a balance */
 export type Amount = string;
 export type BalanceStatusTypes = "free" | "reserved" | "locked" | "extra" | "nompool" | "subtensor";

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

@@ -3,5 +3,3 @@ export * from "./balances";
 export * from "./balancetypes";
 export * from "./minimetadatas";
 export * from "./subscriptions";
-export * from "./chainConnectors";
-export * from "./IBalanceModule";

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

@@ -1,6 +1,15 @@
-import { AnyMiniMetadata } from "@talismn/chaindata-provider";
+import { AnyMiniMetadataSchema } from "@talismn/chaindata-provider";
+import z from "zod/v4";
+import { AnyNewBalanceModule, InferChainMeta } from "../modules";
 /** For fast db access, you can calculate the primary key for a miniMetadata using this method */
-export declare const deriveMiniMetadataId: ({ source, chainId, specVersion, }: Pick<AnyMiniMetadata, "source" | "chainId" | "specVersion">) => string;
-export type MiniMetadata<Extra = unknown> = Omit<AnyMiniMetadata, "extra"> & {
-    extra: Extra;
+export declare const deriveMiniMetadataId: ({ source, chainId, specVersion, version, }: Pick<MiniMetadata, "source" | "chainId" | "specVersion" | "version">) => string;
+export type MiniMetadataStatus = 
+/** Metadata is up to date */
+"good"
+/** Metadata exists, but needs to be updated */
+ | "outdated"
+/** Metadata doesn't exist */
+ | "none";
+export type MiniMetadata<M extends AnyNewBalanceModule = AnyNewBalanceModule> = Omit<z.infer<typeof AnyMiniMetadataSchema>, "extra"> & {
+    extra: InferChainMeta<M>["extra"];
 };

package/dist/declarations/src/upgrades/2024-01-25-upgradeRemoveSymbolFromNativeTokenId.d.ts

@@ -0,0 +1,2 @@
+import { Transaction } from "dexie";
+export declare const upgradeRemoveSymbolFromNativeTokenId: (tx: Transaction) => Promise<void>;

package/dist/declarations/src/upgrades/2024-03-19-upgradeBalancesDataBlob.d.ts

@@ -0,0 +1,2 @@
+import { Transaction } from "dexie";
+export declare const upgradeBalancesDataBlob: (tx: Transaction) => Promise<void>;

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

@@ -0,0 +1,2 @@
+export * from "./2024-01-25-upgradeRemoveSymbolFromNativeTokenId";
+export * from "./2024-03-19-upgradeBalancesDataBlob";

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

@@ -1 +1 @@
-export { MINIMETADATA_VERSION } from "@talismn/chaindata-provider";
+export declare const MINIMETADATA_VERSION = 1;