@talismn/balances 0.9.11 → 1.0.0

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

@@ -1,4 +1,4 @@
-import { ChainList, SimpleEvmNetworkList, TokenList } from "@talismn/chaindata-provider";
+import { NetworkList, 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,8 +19,7 @@ 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<{
-    chains: ChainList;
-    evmNetworks: SimpleEvmNetworkList;
+    networks: NetworkList;
     tokens: TokenList;
     tokenRates: TokenRatesList;
 }>;
@@ -30,7 +29,7 @@ export type BalanceSearchQuery = Partial<NonFunctionProperties<Balance>> | ((bal
  */
 export declare class Balances {
     #private;
-    constructor(balances: Balances | BalanceJsonList | Balance[] | BalanceJson[] | Balance, hydrate?: HydrateDb);
+    constructor(balances: Balances | BalanceJsonList | Balance[] | IBalance[] | BalanceJson[] | Balance, hydrate?: HydrateDb);
     /**
      * Calling toJSON on a collection of balances will return the underlying BalanceJsonList.
      */
@@ -114,106 +113,258 @@ export declare class Balances {
      */
     get sum(): SumBalancesFormatter;
 }
-export declare const getBalanceId: (balance: BalanceJson) => string;
+export declare const getBalanceId: (balance: Pick<IBalance, "address" | "tokenId">) => string;
 /**
  * An individual balance.
  */
 export declare class Balance {
     #private;
-    constructor(storage: BalanceJson, hydrate?: HydrateDb);
+    constructor(storage: BalanceJson | IBalance, hydrate?: HydrateDb);
     toJSON: () => BalanceJson;
     isSource: (source: BalanceSource) => boolean;
     hydrate: (hydrate?: HydrateDb) => void;
     get id(): string;
-    get source(): "evm-erc20" | "evm-native" | "evm-uniswapv2" | "substrate-assets" | "substrate-equilibrium" | "substrate-foreignassets" | "substrate-native" | "substrate-psp22" | "substrate-tokens";
+    get source(): string;
     get status(): import("./balancetypes").BalanceStatus;
     get address(): string;
-    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 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;
+            "substrate-hydration"?: 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 tokenId(): string;
-    get token(): (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
+    get token(): {
+        id: string;
+        networkId: string;
+        decimals: number;
+        symbol: string;
         type: "evm-erc20";
-    } & {
-        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 & {
+        platform: "ethereum";
+        contractAddress: `0x${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;
         type: "evm-native";
-    } & {
-        evmNetwork: {
-            id: import("@talismn/chaindata-provider").EvmNetworkId;
-        };
-        isCustom?: true;
-    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
+        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;
         type: "evm-uniswapv2";
-    } & {
-        contractAddress: string;
+        platform: "ethereum";
+        contractAddress: `0x${string}`;
         symbol0: string;
         symbol1: string;
         decimals0: number;
         decimals1: number;
-        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 & {
+        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;
         type: "substrate-assets";
-    } & {
-        existentialDeposit: string;
+        platform: "polkadot";
         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";
-    } & {
+        isSufficient: boolean;
         existentialDeposit: string;
-        assetId: string;
-        chain: {
-            id: import("@talismn/chaindata-provider").ChainId;
-        };
-    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
+        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;
         type: "substrate-foreignassets";
-    } & {
-        existentialDeposit: string;
+        platform: "polkadot";
         onChainId: string;
-        isFrozen: boolean;
-        chain: {
-            id: import("@talismn/chaindata-provider").ChainId;
-        };
-    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
+        isSufficient: boolean;
+        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;
         type: "substrate-native";
-    } & {
+        platform: "polkadot";
         existentialDeposit: string;
-        chain: {
-            id: import("@talismn/chaindata-provider").ChainId;
-        };
-    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
+        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;
         type: "substrate-psp22";
-    } & {
-        existentialDeposit: string;
+        platform: "polkadot";
         contractAddress: string;
-        chain: {
-            id: import("@talismn/chaindata-provider").ChainId;
-        };
-    }) | (import("@talismn/chaindata-provider/dist/declarations/src/types/Token/types").TokenBase & {
+        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;
         type: "substrate-tokens";
-    } & {
-        existentialDeposit: string;
+        platform: "polkadot";
         onChainId: string | number;
-        chain: {
-            id: import("@talismn/chaindata-provider").ChainId;
-        };
-    }) | null;
+        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;
+        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;
     /**
@@ -248,7 +399,6 @@ 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,28 +1,5 @@
-import { PluginBalanceTypes } from "@talismn/balances/plugins";
-import { ChainId, EvmChainId, EvmNetworkId, SubChainId, TokenId } from "@talismn/chaindata-provider";
+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 */
@@ -34,17 +11,7 @@ type IBalanceBase = {
     address: Address;
     /** The token this balance is for */
     tokenId: TokenId;
-};
-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;
+    networkId: NetworkId;
 };
 type IBalanceSimpleValues = {
     /** For balance types with a simple value, this is the value of the balance (eg, evm native token balance) */
@@ -57,19 +24,20 @@ type IBalanceComplexValues = {
     value?: undefined;
 };
 /** `IBalance` is a common interface which all balance types must implement. */
-export type IBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues) & (IBalanceBaseEvm | IBalanceBaseSubstrate);
-export type EvmBalance = IBalanceBase & IBalanceBaseEvm & (IBalanceSimpleValues | IBalanceComplexValues);
-export type SubstrateBalance = IBalanceBase & IBalanceBaseSubstrate & (IBalanceSimpleValues | IBalanceComplexValues);
+export type IBalance = IBalanceBase & (IBalanceSimpleValues | IBalanceComplexValues);
+export type BalanceJson = IBalance;
+/** A collection of `BalanceJson` objects */
+export type BalanceJsonList = Record<string, BalanceJson>;
 /** An unlabelled amount of a balance */
 export type Amount = string;
-export type BalanceStatusTypes = "free" | "reserved" | "locked" | "extra" | "crowdloan" | "nompool" | "subtensor";
+export type BalanceStatusTypes = "free" | "reserved" | "locked" | "extra" | "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` or `crowdloans`
+     * e.g. `staking`
      **/
     source?: string;
     label: TLabel;
@@ -101,7 +69,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", TNetworkType extends "ethereum" | "substrate"> = IBalanceBase & (TBalanceValueType extends "simple" ? IBalanceSimpleValues : IBalanceComplexValues) & (TNetworkType extends "ethereum" ? IBalanceBaseEvm : IBalanceBaseSubstrate) & {
+export type NewBalanceType<TModuleType extends string, TBalanceValueType extends "simple" | "complex"> = IBalanceBase & (TBalanceValueType extends "simple" ? IBalanceSimpleValues : IBalanceComplexValues) & {
     source: TModuleType;
 };
 export {};

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

@@ -0,0 +1,6 @@
+import { ChainConnector } from "@talismn/chain-connector";
+import { ChainConnectorEvm } from "@talismn/chain-connector-evm";
+export type ChainConnectors = {
+    substrate?: ChainConnector;
+    evm?: ChainConnectorEvm;
+};

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

@@ -3,3 +3,5 @@ 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,33 +1,6 @@
-import { ChainId } from "@talismn/chaindata-provider";
+import { AnyMiniMetadata } 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, specName, specVersion, balancesConfig, }: Pick<MiniMetadata, "source" | "chainId" | "specName" | "specVersion" | "balancesConfig">) => 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 = {
-    /** 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;
+export declare const deriveMiniMetadataId: ({ source, chainId, specVersion, }: Pick<AnyMiniMetadata, "source" | "chainId" | "specVersion">) => string;
+export type MiniMetadata<Extra = unknown> = Omit<AnyMiniMetadata, "extra"> & {
+    extra: Extra;
 };

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

@@ -0,0 +1,11 @@
+export declare const TokenConfigBaseSchema: import("zod/v4").ZodObject<{
+    symbol: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
+    networkId: import("zod/v4").ZodOptional<import("zod/v4").ZodString>;
+    isDefault: import("zod/v4").ZodOptional<import("zod/v4").ZodOptional<import("zod/v4").ZodBoolean>>;
+    decimals: import("zod/v4").ZodOptional<import("zod/v4").ZodInt>;
+    name: import("zod/v4").ZodOptional<import("zod/v4").ZodOptional<import("zod/v4").ZodString>>;
+    logo: import("zod/v4").ZodOptional<import("zod/v4").ZodOptional<import("zod/v4").ZodString>>;
+    coingeckoId: import("zod/v4").ZodOptional<import("zod/v4").ZodOptional<import("zod/v4").ZodString>>;
+    noDiscovery: import("zod/v4").ZodOptional<import("zod/v4").ZodOptional<import("zod/v4").ZodBoolean>>;
+    mirrorOf: import("zod/v4").ZodOptional<import("zod/v4").ZodOptional<import("zod/v4").ZodString>>;
+}, import("zod/v4/core").$strict>;

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

@@ -0,0 +1 @@
+export { MINIMETADATA_VERSION } from "@talismn/chaindata-provider";