@talismn/balances 3.0.4 → 3.0.5

package/dist/index.d.ts

@@ -82,25 +82,7 @@ export type ExtraAmount<TLabel extends string> = BaseAmountWithLabel<TLabel> & {
   includeInTotal?: boolean;
 };
 //#endregion
-//#region src/types/balances.d.ts
-type FormattedAmount<GenericAmount extends AmountWithLabel<TLabel>, TLabel extends string> = Omit<GenericAmount, "amount"> & {
-  amount: BalanceFormatter;
-};
-export declare function excludeFromTransferableAmount(locks: Amount | FormattedAmount<LockedAmount<string>, string> | Array<FormattedAmount<LockedAmount<string>, string>>): bigint;
-export declare function excludeFromFeePayableLocks(locks: Amount | LockedAmount<string> | Array<LockedAmount<string>>): Array<LockedAmount<string>>;
-export declare function includeInTotalExtraAmount(extra?: FormattedAmount<ExtraAmount<string>, string> | Array<FormattedAmount<ExtraAmount<string>, string>>): bigint;
-/** A utility type used to extract the underlying `BalanceType` of a specific source from a generalised `BalanceJson` */
-export type NarrowBalanceType<S extends IBalance, P> = S extends {
-  source: P;
-} ? S : never;
-export type BalanceSource = BalanceJson["source"];
-/** TODO: Remove this in favour of a frontend-friendly `ChaindataProvider` */
-export type HydrateDb = Partial<{
-  networks: NetworkList;
-  tokens: TokenList;
-  tokenRates: TokenRatesList;
-}>;
-export type BalanceSearchQuery = Partial<NonFunctionProperties<Balance>> | ((balance: Balance) => boolean);
+//#region src/classes/Balances.d.ts
 /**
  * A collection of balances.
  */
@@ -182,7 +164,6 @@ export declare class Balances {
   get count(): number;
   /**
    * Get the summed value of balances in this collection.
-   * TODO: Sum up token amounts AND fiat amounts
    *
    * @example
    * // Get the sum of all transferable balances in usd.
@@ -190,10 +171,116 @@ export declare class Balances {
    */
   get sum(): SumBalancesFormatter;
 }
-export declare const getBalanceId: (balance: Pick<IBalance, "address" | "tokenId">) => string;
-/**
- * An individual balance.
- */
+//#endregion
+//#region src/classes/formatters.d.ts
+export declare class BalanceValueGetter {
+  #private;
+  constructor(storage: BalanceJson);
+  get(valueType: BalanceStatusTypes): AmountWithLabel<string>[];
+  add(valueType: BalanceStatusTypes, amount: Omit<AmountWithLabel<string>, "type">): void;
+}
+export declare class BalanceFormatter {
+  #private;
+  constructor(planck: string | bigint | undefined, decimals?: number | undefined, fiatRatios?: TokenRates | null);
+  toJSON: () => string;
+  get planck(): bigint;
+  get tokens(): string;
+  fiat(currency: TokenRateCurrency): number | null;
+}
+export declare class PlanckSumBalancesFormatter {
+  #private;
+  constructor(balances: Balances);
+  /**
+   * The total balance of these tokens. Includes the free and the reserved amount.
+   */
+  get total(): bigint;
+  /** The non-reserved balance of these tokens. Includes the frozen amount. Is included in the total. */
+  get free(): bigint;
+  /** The reserved balance of these tokens. Is included in the total. */
+  get reserved(): bigint;
+  /** The frozen balance of these tokens. Is included in the free amount. */
+  get locked(): bigint;
+  /** @deprecated Use balances.locked */
+  get frozen(): bigint;
+  /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
+  get transferable(): bigint;
+  /** The unavailable balance of these tokens. */
+  get unavailable(): bigint;
+  /** The feePayable balance of these tokens. Is generally the free amount - the feeFrozen amount. */
+  get feePayable(): bigint;
+}
+export declare class FiatSumBalancesFormatter {
+  #private;
+  constructor(balances: Balances, currency: TokenRateCurrency);
+  /**
+   * The total balance of these tokens. Includes the free and the reserved amount.
+   */
+  get total(): number;
+  /** The non-reserved balance of these tokens. Includes the frozen amount. Is included in the total. */
+  get free(): number;
+  /** The reserved balance of these tokens. Is included in the total. */
+  get reserved(): number;
+  /** The frozen balance of these tokens. Is included in the free amount. */
+  get locked(): number;
+  /** @deprecated Use balances.locked */
+  get frozen(): number;
+  /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
+  get transferable(): number;
+  /** The unavailable balance of these tokens. */
+  get unavailable(): number;
+  /** The feePayable balance of these tokens. Is generally the free amount - the feeFrozen amount. */
+  get feePayable(): number;
+}
+export declare class SumBalancesFormatter {
+  #private;
+  constructor(balances: Balances);
+  get planck(): PlanckSumBalancesFormatter;
+  fiat(currency: TokenRateCurrency): FiatSumBalancesFormatter;
+  change24h(currency: TokenRateCurrency): Change24hCurrencyFormatter;
+}
+export declare class Change24hCurrencyFormatter {
+  #private;
+  constructor(balances: Balances, currency: TokenRateCurrency);
+  get total(): {
+    diff: number;
+    ratio: number;
+  } | null;
+  get free(): {
+    diff: number;
+    ratio: number;
+  } | null;
+  get reserved(): {
+    diff: number;
+    ratio: number;
+  } | null;
+  get locked(): {
+    diff: number;
+    ratio: number;
+  } | null;
+  get frozen(): {
+    diff: number;
+    ratio: number;
+  } | null;
+  get transferable(): {
+    diff: number;
+    ratio: number;
+  } | null;
+  get unavailable(): {
+    diff: number;
+    ratio: number;
+  } | null;
+  get feePayable(): {
+    diff: number;
+    ratio: number;
+  } | null;
+}
+//#endregion
+//#region src/classes/FormattedAmount.d.ts
+type FormattedAmount<GenericAmount extends AmountWithLabel<TLabel>, TLabel extends string> = Omit<GenericAmount, "amount"> & {
+  amount: BalanceFormatter;
+};
+//#endregion
+//#region src/classes/Balance.d.ts
 export declare class Balance {
   #private;
   constructor(storage: BalanceJson | IBalance, hydrate?: HydrateDb);
@@ -328,20 +415,6 @@ export declare class Balance {
   } | null;
   get tokenId(): string;
   get token(): {
-    id: string;
-    networkId: string;
-    isDefault?: boolean | undefined;
-    decimals: number;
-    symbol: string;
-    name?: string | undefined;
-    logo?: string | undefined;
-    coingeckoId?: string | undefined;
-    noDiscovery?: boolean | undefined;
-    mirrorOf?: string | undefined;
-    type: "sol-spl";
-    platform: "solana";
-    mintAddress: string;
-  } | {
     id: string;
     networkId: string;
     isDefault?: boolean | undefined;
@@ -366,8 +439,12 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "evm-native";
-    platform: "ethereum";
+    type: "substrate-hydration";
+    platform: "polkadot";
+    onChainId: number;
+    assetType: "Erc20" | "External" | "Token";
+    isSufficient: boolean;
+    existentialDeposit: string;
   } | {
     id: string;
     networkId: string;
@@ -396,10 +473,18 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "sol-token2022";
-    platform: "solana";
-    mintAddress: string;
-    isTransferable?: boolean | undefined;
+    type: "evm-uniswapv2";
+    platform: "ethereum";
+    contractAddress: `0x${string}`;
+    isCustom?: boolean | undefined;
+    symbol0: string;
+    symbol1: string;
+    decimals0: number;
+    decimals1: number;
+    tokenAddress0: `0x${string}`;
+    tokenAddress1: `0x${string}`;
+    coingeckoId0?: string | undefined;
+    coingeckoId1?: string | undefined;
   } | {
     id: string;
     networkId: string;
@@ -411,9 +496,8 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "substrate-psp22";
-    platform: "polkadot";
-    contractAddress: string;
+    type: "evm-native";
+    platform: "ethereum";
   } | {
     id: string;
     networkId: string;
@@ -442,10 +526,12 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "substrate-tokens";
+    type: "substrate-dtao";
     platform: "polkadot";
-    onChainId: string | number;
-    existentialDeposit: string;
+    netuid: number;
+    subnetName?: string | undefined;
+    hotkey?: string | undefined;
+    isTransferable: boolean;
   } | {
     id: string;
     networkId: string;
@@ -457,11 +543,8 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "substrate-hydration";
+    type: "substrate-native";
     platform: "polkadot";
-    onChainId: number;
-    assetType: "Erc20" | "External" | "Token";
-    isSufficient: boolean;
     existentialDeposit: string;
   } | {
     id: string;
@@ -474,18 +557,9 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "evm-uniswapv2";
-    platform: "ethereum";
-    contractAddress: `0x${string}`;
-    isCustom?: boolean | undefined;
-    symbol0: string;
-    symbol1: string;
-    decimals0: number;
-    decimals1: number;
-    tokenAddress0: `0x${string}`;
-    tokenAddress1: `0x${string}`;
-    coingeckoId0?: string | undefined;
-    coingeckoId1?: string | undefined;
+    type: "substrate-psp22";
+    platform: "polkadot";
+    contractAddress: string;
   } | {
     id: string;
     networkId: string;
@@ -497,12 +571,10 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "substrate-dtao";
+    type: "substrate-tokens";
     platform: "polkadot";
-    netuid: number;
-    subnetName?: string | undefined;
-    hotkey?: string | undefined;
-    isTransferable: boolean;
+    onChainId: string | number;
+    existentialDeposit: string;
   } | {
     id: string;
     networkId: string;
@@ -514,9 +586,8 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "substrate-native";
-    platform: "polkadot";
-    existentialDeposit: string;
+    type: "sol-native";
+    platform: "solana";
   } | {
     id: string;
     networkId: string;
@@ -528,8 +599,24 @@ export declare class Balance {
     coingeckoId?: string | undefined;
     noDiscovery?: boolean | undefined;
     mirrorOf?: string | undefined;
-    type: "sol-native";
+    type: "sol-spl";
     platform: "solana";
+    mintAddress: string;
+  } | {
+    id: string;
+    networkId: string;
+    isDefault?: boolean | undefined;
+    decimals: number;
+    symbol: string;
+    name?: string | undefined;
+    logo?: string | undefined;
+    coingeckoId?: string | undefined;
+    noDiscovery?: boolean | undefined;
+    mirrorOf?: string | undefined;
+    type: "sol-token2022";
+    platform: "solana";
+    mintAddress: string;
+    isTransferable?: boolean | undefined;
   } | null;
   get decimals(): number | null;
   get rates(): TokenRates | null;
@@ -581,117 +668,20 @@ export declare class Balance {
   /** The feePayable balance of this token. Is generally the free amount - the feeFrozen amount. */
   get feePayable(): BalanceFormatter;
 }
-/** raw "locked" values, straight from the IBalance JSON (see getRawTotalPlanck) */
-export declare const getRawLocks: (balance: IBalance) => AmountWithLabel<string>[];
-/**
- * Computes `new Balance(b).total.planck` without constructing a Balance (which allocates
- * several BalanceFormatters per access) — used for high-frequency zero-balance filtering.
- * MUST mirror Balance.total exactly, including the DelegatedStaking-hold/nompool rule
- * (guarded by a parity test in balance-raw-helpers.test.ts).
- */
-export declare const getRawTotalPlanck: (balance: IBalance) => bigint;
-export declare class BalanceValueGetter {
-  #private;
-  constructor(storage: BalanceJson);
-  get(valueType: BalanceStatusTypes): AmountWithLabel<string>[];
-  add(valueType: BalanceStatusTypes, amount: Omit<AmountWithLabel<string>, "type">): void;
-}
-export declare class BalanceFormatter {
-  #private;
-  constructor(planck: string | bigint | undefined, decimals?: number | undefined, fiatRatios?: TokenRates | null);
-  toJSON: () => string;
-  get planck(): bigint;
-  get tokens(): string;
-  fiat(currency: TokenRateCurrency): number | null;
-}
-export declare class PlanckSumBalancesFormatter {
-  #private;
-  constructor(balances: Balances);
-  /**
-   * The total balance of these tokens. Includes the free and the reserved amount.
-   */
-  get total(): bigint;
-  /** The non-reserved balance of these tokens. Includes the frozen amount. Is included in the total. */
-  get free(): bigint;
-  /** The reserved balance of these tokens. Is included in the total. */
-  get reserved(): bigint;
-  /** The frozen balance of these tokens. Is included in the free amount. */
-  get locked(): bigint;
-  /** @deprecated Use balances.locked */
-  get frozen(): bigint;
-  /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
-  get transferable(): bigint;
-  /** The unavailable balance of these tokens. */
-  get unavailable(): bigint;
-  /** The feePayable balance of these tokens. Is generally the free amount - the feeFrozen amount. */
-  get feePayable(): bigint;
-}
-export declare class FiatSumBalancesFormatter {
-  #private;
-  constructor(balances: Balances, currency: TokenRateCurrency);
-  /**
-   * The total balance of these tokens. Includes the free and the reserved amount.
-   */
-  get total(): number;
-  /** The non-reserved balance of these tokens. Includes the frozen amount. Is included in the total. */
-  get free(): number;
-  /** The reserved balance of these tokens. Is included in the total. */
-  get reserved(): number;
-  /** The frozen balance of these tokens. Is included in the free amount. */
-  get locked(): number;
-  /** @deprecated Use balances.locked */
-  get frozen(): number;
-  /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
-  get transferable(): number;
-  /** The unavailable balance of these tokens. */
-  get unavailable(): number;
-  /** The feePayable balance of these tokens. Is generally the free amount - the feeFrozen amount. */
-  get feePayable(): number;
-}
-export declare class SumBalancesFormatter {
-  #private;
-  constructor(balances: Balances);
-  get planck(): PlanckSumBalancesFormatter;
-  fiat(currency: TokenRateCurrency): FiatSumBalancesFormatter;
-  change24h(currency: TokenRateCurrency): Change24hCurrencyFormatter;
-}
-export declare class Change24hCurrencyFormatter {
-  #private;
-  constructor(balances: Balances, currency: TokenRateCurrency);
-  get total(): {
-    diff: number;
-    ratio: number;
-  } | null;
-  get free(): {
-    diff: number;
-    ratio: number;
-  } | null;
-  get reserved(): {
-    diff: number;
-    ratio: number;
-  } | null;
-  get locked(): {
-    diff: number;
-    ratio: number;
-  } | null;
-  get frozen(): {
-    diff: number;
-    ratio: number;
-  } | null;
-  get transferable(): {
-    diff: number;
-    ratio: number;
-  } | null;
-  get unavailable(): {
-    diff: number;
-    ratio: number;
-  } | null;
-  get feePayable(): {
-    diff: number;
-    ratio: number;
-  } | null;
-}
-export declare const filterMirrorTokens: (balance: Balance, _i: number, balances: Balance[]) => boolean;
+/** raw values of a given type, straight from the IBalance JSON (no Balance/formatter allocation) */
+//#endregion
+//#region src/types/balances.d.ts
+export type NarrowBalanceType<S extends IBalance, P> = S extends {
+  source: P;
+} ? S : never;
+export type BalanceSource = BalanceJson["source"];
+/** TODO: Remove this in favour of a frontend-friendly `ChaindataProvider` */
+export type HydrateDb = Partial<{
+  networks: NetworkList;
+  tokens: TokenList;
+  tokenRates: TokenRatesList;
+}>;
+export type BalanceSearchQuery = Partial<NonFunctionProperties<Balance>> | ((balance: Balance) => boolean);
 //#endregion
 //#region src/types/chainConnectors.d.ts
 export type ChainConnectors = {
@@ -877,6 +867,28 @@ export declare class BalancesProvider {
 }
 export declare const getSweepStaleVariant: (balance: IBalance) => IBalance;
 //#endregion
+//#region src/classes/helpers.d.ts
+export declare function excludeFromTransferableAmount(locks: Amount | FormattedAmount<LockedAmount<string>, string> | Array<FormattedAmount<LockedAmount<string>, string>>): bigint;
+export declare function excludeFromFeePayableLocks(locks: Amount | LockedAmount<string> | Array<LockedAmount<string>>): Array<LockedAmount<string>>;
+export declare function includeInTotalExtraAmount(extra?: FormattedAmount<ExtraAmount<string>, string> | Array<FormattedAmount<ExtraAmount<string>, string>>): bigint;
+/** A utility type used to extract the underlying `BalanceType` of a specific source from a generalised `BalanceJson` */
+export declare const getBalanceId: (balance: Pick<IBalance, "address" | "tokenId">) => string;
+/**
+ * An individual balance.
+ */
+export declare const filterMirrorTokens: (balance: Balance, _i: number, balances: Balance[]) => boolean;
+//#endregion
+//#region src/classes/rawBalance.d.ts
+/** raw "locked" values, straight from the IBalance JSON (see getRawTotalPlanck) */
+export declare const getRawLocks: (balance: IBalance) => AmountWithLabel<string>[];
+/**
+ * Computes `new Balance(b).total.planck` without constructing a Balance (which allocates
+ * several BalanceFormatters per access) — used for high-frequency zero-balance filtering.
+ * MUST mirror Balance.total exactly, including the DelegatedStaking-hold/nompool rule
+ * (guarded by a parity test in balance-raw-helpers.test.ts).
+ */
+export declare const getRawTotalPlanck: (balance: IBalance) => bigint;
+//#endregion
 //#region src/modules/abis/erc20BalancesAggregator.d.ts
 export declare const erc20BalancesAggregatorAbi: readonly [{
   readonly name: "balances";
@@ -23605,6 +23617,7 @@ export declare const BALANCE_MODULES: (IBalanceModule<"evm-erc20", {
 }, {
   palletId: string;
 }>)[];
+/** @deprecated unused */
 export type AnyBalanceModule = (typeof BALANCE_MODULES)[number];
 //#endregion
 export { type DTaoClaimTarget, type DTaoConvictionLockInfo, MINIMETADATA_VERSION };