@talismn/balances 0.0.0-pr2043-20250703063531 → 0.0.0-pr2059-20250626001054

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

@@ -1,4 +1,4 @@
-import { NetworkList, TokenList } from "@talismn/chaindata-provider";
+import { ChainList, SimpleEvmNetworkList, TokenList } from "@talismn/chaindata-provider";
 import { TokenRateCurrency, TokenRates, TokenRatesList } from "@talismn/token-rates";
 import { NonFunctionProperties } from "@talismn/util";
 import { Amount, AmountWithLabel, BalanceJson, BalanceJsonList, BalanceStatusTypes, ExtraAmount, IBalance, LockedAmount } from "./balancetypes";
@@ -19,7 +19,8 @@ export type NarrowBalanceType<S extends IBalance, P> = S extends {
 export type BalanceSource = BalanceJson["source"];
 /** TODO: Remove this in favour of a frontend-friendly `ChaindataProvider` */
 export type HydrateDb = Partial<{
-    networks: NetworkList;
+    chains: ChainList;
+    evmNetworks: SimpleEvmNetworkList;
     tokens: TokenList;
     tokenRates: TokenRatesList;
 }>;
@@ -124,228 +125,95 @@ export declare class Balance {
     isSource: (source: BalanceSource) => boolean;
     hydrate: (hydrate?: HydrateDb) => void;
     get id(): string;
-    get source(): "evm-erc20" | "evm-native" | "evm-uniswapv2" | "substrate-assets" | "substrate-foreignassets" | "substrate-native" | "substrate-psp22" | "substrate-tokens";
+    get source(): "evm-erc20" | "evm-native" | "evm-uniswapv2" | "substrate-assets" | "substrate-equilibrium" | "substrate-foreignassets" | "substrate-native" | "substrate-psp22" | "substrate-tokens";
     get status(): import("./balancetypes").BalanceStatus;
     get address(): string;
-    get networkId(): string;
-    get network(): {
-        id: string;
-        name: string;
-        nativeTokenId: string;
-        nativeCurrency: {
-            decimals: number;
-            symbol: string;
-            name: string;
-            coingeckoId?: string | undefined;
-            mirrorOf?: string | undefined;
-            logo?: string | undefined;
-        };
-        blockExplorerUrls: string[];
-        genesisHash: `0x${string}`;
-        platform: "polkadot";
-        chainName: string;
-        specName: string;
-        specVersion: number;
-        account: "secp256k1" | "*25519";
-        prefix: number;
-        rpcs: string[];
-        topology: {
-            type: "standalone";
-        } | {
-            type: "relay";
-        } | {
-            type: "parachain";
-            relayId: string;
-            paraId: number;
-        };
-        isTestnet?: boolean | undefined;
-        isDefault?: boolean | undefined;
-        forceScan?: boolean | undefined;
-        logo?: string | undefined;
-        themeColor?: string | undefined;
-        chainspecQrUrl?: string | undefined;
-        latestMetadataQrUrl?: string | undefined;
-        oldPrefix?: number | undefined;
-        registryTypes?: any;
-        signedExtensions?: any;
-        hasCheckMetadataHash?: boolean | undefined;
-        hasExtrinsicSignatureTypePrefix?: boolean | undefined;
-        isUnknownFeeToken?: boolean | undefined;
-        balancesConfig?: {
-            "substrate-native"?: {
-                disable?: boolean | undefined;
-            } | undefined;
-            "substrate-assets"?: undefined;
-            "substrate-psp22"?: undefined;
-            "substrate-tokens"?: {
-                palletId?: string | undefined;
-            } | undefined;
-            "substrate-foreignassets"?: undefined;
-        } | undefined;
-    } | {
-        id: string;
-        name: string;
-        nativeTokenId: string;
-        nativeCurrency: {
-            decimals: number;
-            symbol: string;
-            name: string;
-            coingeckoId?: string | undefined;
-            mirrorOf?: string | undefined;
-            logo?: string | undefined;
-        };
-        blockExplorerUrls: string[];
-        platform: "ethereum";
-        rpcs: string[];
-        isTestnet?: boolean | undefined;
-        isDefault?: boolean | undefined;
-        forceScan?: boolean | undefined;
-        logo?: string | undefined;
-        themeColor?: string | undefined;
-        substrateChainId?: string | undefined;
-        preserveGasEstimate?: boolean | undefined;
-        feeType?: "legacy" | "eip-1559" | undefined;
-        l2FeeType?: {
-            type: "op-stack";
-        } | {
-            type: "scroll";
-            l1GasPriceOracle: `0x${string}`;
-        } | undefined;
-        contracts?: Partial<Record<"Erc20Aggregator" | "Multicall3", `0x${string}`>> | undefined;
-        balancesConfig?: {
-            "evm-native"?: undefined;
-            "evm-erc20"?: undefined;
-            "evm-uniswapv2"?: undefined;
-        } | undefined;
-    } | null;
+    get chainId(): string | undefined;
+    get chain(): import("@talismn/chaindata-provider").Chain | null;
+    get evmNetworkId(): string | undefined;
+    get evmNetwork(): import("@talismn/chaindata-provider").SimpleEvmNetwork | null;
     get tokenId(): string;
-    get token(): {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
+    get token(): (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
         type: "evm-erc20";
-        platform: "ethereum";
-        contractAddress: `0x${string}`;
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
-        isCustom?: boolean | undefined;
-    } | {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
+    } & {
+        contractAddress: string;
+        evmNetwork: {
+            id: import("@talismn/chaindata-provider").EvmNetworkId;
+        } | null;
+        isCustom?: true;
+        image?: string;
+    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
         type: "evm-native";
-        platform: "ethereum";
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
-    } | {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
+    } & {
+        evmNetwork: {
+            id: import("@talismn/chaindata-provider").EvmNetworkId;
+        };
+        isCustom?: true;
+    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
         type: "evm-uniswapv2";
-        platform: "ethereum";
-        contractAddress: `0x${string}`;
+    } & {
+        contractAddress: string;
         symbol0: string;
         symbol1: string;
         decimals0: number;
         decimals1: number;
-        tokenAddress0: `0x${string}`;
-        tokenAddress1: `0x${string}`;
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
-        isCustom?: boolean | undefined;
-        coingeckoId0?: string | undefined;
-        coingeckoId1?: string | undefined;
-    } | {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
+        tokenAddress0: string;
+        tokenAddress1: string;
+        coingeckoId0?: string;
+        coingeckoId1?: string;
+        evmNetwork: {
+            id: import("@talismn/chaindata-provider").EvmNetworkId;
+        } | null;
+    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
         type: "substrate-assets";
-        platform: "polkadot";
+    } & {
+        existentialDeposit: string;
         assetId: string;
+        isFrozen: boolean;
+        chain: {
+            id: import("@talismn/chaindata-provider").ChainId;
+        };
+    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
+        type: "substrate-equilibrium";
+    } & {
         existentialDeposit: string;
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
-        isFrozen?: boolean | undefined;
-    } | {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
+        assetId: string;
+        chain: {
+            id: import("@talismn/chaindata-provider").ChainId;
+        };
+    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
         type: "substrate-foreignassets";
-        platform: "polkadot";
-        onChainId: string;
+    } & {
         existentialDeposit: string;
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
-        isFrozen?: boolean | undefined;
-    } | {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
+        onChainId: string;
+        isFrozen: boolean;
+        chain: {
+            id: import("@talismn/chaindata-provider").ChainId;
+        };
+    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
         type: "substrate-native";
-        platform: "polkadot";
+    } & {
         existentialDeposit: string;
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
-    } | {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
+        chain: {
+            id: import("@talismn/chaindata-provider").ChainId;
+        };
+    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
         type: "substrate-psp22";
-        platform: "polkadot";
+    } & {
+        existentialDeposit: string;
         contractAddress: string;
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
-    } | {
-        id: string;
-        networkId: string;
-        decimals: number;
-        symbol: string;
+        chain: {
+            id: import("@talismn/chaindata-provider").ChainId;
+        };
+    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
         type: "substrate-tokens";
-        platform: "polkadot";
-        onChainId: string | number;
+    } & {
         existentialDeposit: string;
-        isDefault?: boolean | undefined;
-        name?: string | undefined;
-        logo?: string | undefined;
-        coingeckoId?: string | undefined;
-        noDiscovery?: boolean | undefined;
-        mirrorOf?: string | undefined;
-    } | null;
+        onChainId: string | number;
+        chain: {
+            id: import("@talismn/chaindata-provider").ChainId;
+        };
+    }) | null;
     get decimals(): number | null;
     get rates(): TokenRates | null;
     /**
@@ -380,6 +248,7 @@ export declare class Balance {
     /** The frozen balance of this token. Is included in the free amount. */
     get locked(): BalanceFormatter;
     get locks(): FormattedAmount<AmountWithLabel<string>, string>[];
+    get crowdloans(): FormattedAmount<AmountWithLabel<string>, string>[];
     get nompools(): FormattedAmount<AmountWithLabel<string>, string>[];
     get subtensor(): FormattedAmount<AmountWithLabel<string>, string>[];
     /** The extra balance of this token */

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

@@ -1,5 +1,5 @@
 import { PluginBalanceTypes } from "@talismn/balances/plugins";
-import { NetworkId, TokenId } from "@talismn/chaindata-provider";
+import { ChainId, EvmChainId, EvmNetworkId, SubChainId, TokenId } from "@talismn/chaindata-provider";
 import { Address } from "./addresses";
 /**
  * `BalanceTypes` is an automatically determined sub-selection of `PluginBalanceTypes`.
@@ -34,7 +34,17 @@ type IBalanceBase = {
     address: Address;
     /** The token this balance is for */
     tokenId: TokenId;
-    networkId: NetworkId;
+};
+type IBalanceBaseEvm = {
+    /** WIP, use `chainId` or `evmNetworkId` for now */
+    multiChainId: EvmChainId;
+    /** The evm chain this balance is on */
+    evmNetworkId: EvmNetworkId;
+};
+type IBalanceBaseSubstrate = {
+    multiChainId: SubChainId;
+    /** The substrate chain this balance is on */
+    chainId: ChainId;
 };
 type IBalanceSimpleValues = {
     /** For balance types with a simple value, this is the value of the balance (eg, evm native token balance) */
@@ -47,19 +57,19 @@ type IBalanceComplexValues = {
     value?: undefined;
 };
 /** `IBalance` is a common interface which all balance types must implement. */
-export type IBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues);
-export type EvmBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues);
-export type SubstrateBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues);
+export type IBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues) & (IBalanceBaseEvm | IBalanceBaseSubstrate);
+export type EvmBalance = IBalanceBase & IBalanceBaseEvm & (IBalanceSimpleValues | IBalanceComplexValues);
+export type SubstrateBalance = IBalanceBase & IBalanceBaseSubstrate & (IBalanceSimpleValues | IBalanceComplexValues);
 /** An unlabelled amount of a balance */
 export type Amount = string;
-export type BalanceStatusTypes = "free" | "reserved" | "locked" | "extra" | "nompool" | "subtensor";
+export type BalanceStatusTypes = "free" | "reserved" | "locked" | "extra" | "crowdloan" | "nompool" | "subtensor";
 /** A labelled amount of a balance */
 type BaseAmountWithLabel<TLabel extends string> = {
     type: BalanceStatusTypes;
     /**
      * For modules which fetch balances via module sources, the source is equivalent to previous 'subSource' field
      * on the parent balance object
-     * e.g. `staking`
+     * e.g. `staking` or `crowdloans`
      **/
     source?: string;
     label: TLabel;
@@ -91,7 +101,7 @@ export type ExtraAmount<TLabel extends string> = BaseAmountWithLabel<TLabel> & {
     includeInTotal?: boolean;
 };
 /** Used by plugins to help define their custom `BalanceType` */
-export type NewBalanceType<TModuleType extends string, TBalanceValueType extends "simple" | "complex"> = IBalanceBase & (TBalanceValueType extends "simple" ? IBalanceSimpleValues : IBalanceComplexValues) & {
+export type NewBalanceType<TModuleType extends string, TBalanceValueType extends "simple" | "complex", TNetworkType extends "ethereum" | "substrate"> = IBalanceBase & (TBalanceValueType extends "simple" ? IBalanceSimpleValues : IBalanceComplexValues) & (TNetworkType extends "ethereum" ? IBalanceBaseEvm : IBalanceBaseSubstrate) & {
     source: TModuleType;
 };
 export {};

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

@@ -1,8 +1,6 @@
-import { AnyMiniMetadataSchema } from "@talismn/chaindata-provider";
-import z from "zod/v4";
-import { AnyNewBalanceModule, InferChainMeta } from "../modules";
+import { ChainId } from "@talismn/chaindata-provider";
 /** For fast db access, you can calculate the primary key for a miniMetadata using this method */
-export declare const deriveMiniMetadataId: ({ source, chainId, specVersion, libVersion, }: Pick<MiniMetadata, "source" | "chainId" | "specVersion" | "libVersion">) => string;
+export declare const deriveMiniMetadataId: ({ source, chainId, specName, specVersion, balancesConfig, }: Pick<MiniMetadata, "source" | "chainId" | "specName" | "specVersion" | "balancesConfig">) => string;
 export type MiniMetadataStatus = 
 /** Metadata is up to date */
 "good"
@@ -10,6 +8,26 @@ export type MiniMetadataStatus =
  | "outdated"
 /** Metadata doesn't exist */
  | "none";
-export type MiniMetadata<M extends AnyNewBalanceModule = AnyNewBalanceModule> = Omit<z.infer<typeof AnyMiniMetadataSchema>, "extra"> & {
-    extra: InferChainMeta<M>["extra"];
+export type MiniMetadata = {
+    /** The DB id for this metadata */
+    id: string;
+    /** The balance module which created this miniMetadata */
+    source: string;
+    /** The chain this miniMetadata came from */
+    chainId: ChainId;
+    /** The chain specName which this miniMetadata is valid for */
+    specName: string;
+    /** The chain specVersion which this miniMetadata is valid for */
+    specVersion: string;
+    /** The JSON-encoded chain balancesConfig which this miniMetadata is valid for */
+    balancesConfig: string;
+    /** The version of the metadata format e.g. 13, 14, 15, etc */
+    version: number;
+    /** The miniMetadata encoded as a hex string */
+    data: `0x${string}` | null;
+    /**
+     * Some balance modules need a little bit of extra data in addition to the miniMetadata.
+     * They can store that data as a JSON-encoded string here.
+     */
+    extra: string;
 };

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

@@ -0,0 +1,8 @@
+import { EvmTokenFetcher, MiniMetadataUpdater } from "@talismn/balances";
+import { ChaindataProvider } from "@talismn/chaindata-provider";
+/** Pulls the latest chaindata from https://github.com/TalismanSociety/chaindata */
+export declare const hydrateChaindataAndMiniMetadata: (chaindataProvider: ChaindataProvider, miniMetadataUpdater: MiniMetadataUpdater) => Promise<void>;
+/** Builds any missing miniMetadatas (e.g. for the user's custom substrate chains) */
+export declare const updateCustomMiniMetadata: (chaindataProvider: ChaindataProvider, miniMetadataUpdater: MiniMetadataUpdater) => Promise<void>;
+/** Fetches any missing Evm Tokens */
+export declare const updateEvmTokens: (chaindataProvider: ChaindataProvider, evmTokenFetcher: EvmTokenFetcher) => Promise<void>;

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

@@ -0,0 +1 @@
+export * from "./hydrateChaindata";