@talismn/balances 0.4.0 → 0.5.0

package/CHANGELOG.md

@@ -1,5 +1,45 @@
 # @talismn/balances
 
+## 0.5.0
+
+### Patch Changes
+
+- @talismn/chain-connector@0.6.0
+- @talismn/chain-connector-evm@0.6.0
+- @talismn/chaindata-provider@0.6.0
+- @talismn/token-rates@0.1.18
+
+## 0.4.2
+
+### Patch Changes
+
+- Updated dependencies [1a2fdc73]
+  - @talismn/chaindata-provider@0.5.0
+  - @talismn/chain-connector@0.5.0
+  - @talismn/chain-connector-evm@0.5.0
+  - @talismn/token-rates@0.1.17
+
+## 0.4.1
+
+### Patch Changes
+
+- fb8ee962: feat: proxy dapp websocket requests to talisman wallet backend when available
+- f7aca48b: eslint rules
+- 01bf239b: feat: crowdloan and nom pool balances
+- 48f0222e: fix: removed some explicit `any`s
+- 01bf239b: fix: packages publishing with incorrect interdependency versions
+- Updated dependencies [fb8ee962]
+- Updated dependencies [c898da98]
+- Updated dependencies [f7aca48b]
+- Updated dependencies [01bf239b]
+- Updated dependencies [48f0222e]
+- Updated dependencies [01bf239b]
+  - @talismn/chain-connector@0.4.4
+  - @talismn/chain-connector-evm@0.4.4
+  - @talismn/chaindata-provider@0.4.4
+  - @talismn/token-rates@0.1.16
+  - @talismn/util@0.1.9
+
 ## 0.4.0
 
 ### Patch Changes

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

@@ -1,17 +1,57 @@
 import type { Registry } from "@polkadot/types-codec/types";
-import { ChainId } from "@talismn/chaindata-provider";
-import { BalanceModule, DefaultChainMeta, DefaultModuleConfig, DefaultTransferParams, ExtendableChainMeta, ExtendableModuleConfig, ExtendableTokenType, ExtendableTransferParams } from "./BalanceModule";
-import { AddressesByToken, Balance, Balances, SubscriptionCallback, UnsubscribeFn } from "./types";
+import { ChainConnector } from "@talismn/chain-connector";
+import { Chain, ChainId } from "@talismn/chaindata-provider";
+import { BalanceModule, DefaultChainMeta, DefaultModuleConfig, DefaultTransferParams, ExtendableChainMeta, ExtendableModuleConfig, ExtendableTokenType, ExtendableTransferParams, NewBalanceModule } from "./BalanceModule";
+import { AddressesByToken, Balance, BalanceJson, Balances, SubscriptionCallback, UnsubscribeFn } from "./types";
 /**
  * Wraps a BalanceModule's fetch/subscribe methods with a single `balances` method.
  * This `balances` method will subscribe if a callback parameter is provided, or otherwise fetch.
  */
 export declare function balances<TModuleType extends string, TTokenType extends ExtendableTokenType, TChainMeta extends ExtendableChainMeta = DefaultChainMeta, TModuleConfig extends ExtendableModuleConfig = DefaultModuleConfig, TTransferParams extends ExtendableTransferParams = DefaultTransferParams>(balanceModule: BalanceModule<TModuleType, TTokenType, TChainMeta, TModuleConfig, TTransferParams>, addressesByToken: AddressesByToken<TTokenType>): Promise<Balances>;
 export declare function balances<TModuleType extends string, TTokenType extends ExtendableTokenType, TChainMeta extends ExtendableChainMeta = DefaultChainMeta, TModuleConfig extends ExtendableModuleConfig = DefaultModuleConfig, TTransferParams extends ExtendableTransferParams = DefaultTransferParams>(balanceModule: BalanceModule<TModuleType, TTokenType, TChainMeta, TModuleConfig, TTransferParams>, addressesByToken: AddressesByToken<TTokenType>, callback: SubscriptionCallback<Balances>): Promise<UnsubscribeFn>;
+export type GetOrCreateTypeRegistry = (chainId: ChainId, metadataRpc?: `0x${string}`) => Registry;
 export declare const createTypeRegistryCache: () => {
-    getOrCreateTypeRegistry: (chainId: ChainId, metadataRpc?: `0x${string}`) => Registry;
+    getOrCreateTypeRegistry: GetOrCreateTypeRegistry;
 };
+export type AnyBalanceModule = BalanceModule<any, any, any, any, any>;
+export type AnyNewBalanceModule = NewBalanceModule<any, any, any, any, any>;
+/**
+ * The following `Infer*` collection of generic types can be used when you want to
+ * extract one of the generic type arguments from an existing BalanceModule.
+ *
+ * For example, you might want to write a function which can accept any BalanceModule
+ * as an input, and then return the specific TokenType for that module:
+ * function getTokens<T extends AnyBalanceModule>(module: T): InferTokenType<T>
+ *
+ * Or for another example, you might want a function which can take any BalanceModule `type`
+ * string as input, and then return some data associated with that module with the correct type:
+ * function getChainMeta<T extends AnyBalanceModule>(type: InferModuleType<T>): InferChainMeta<T> | undefined
+ */
+type InferBalanceModuleTypes<T extends AnyNewBalanceModule> = T extends NewBalanceModule<infer TModuleType, infer TTokenType, infer TChainMeta, infer TModuleConfig, infer TTransferParams> ? {
+    TModuleType: TModuleType;
+    TTokenType: TTokenType;
+    TChainMeta: TChainMeta;
+    TModuleConfig: TModuleConfig;
+    TTransferParams: TTransferParams;
+} : never;
+export type InferModuleType<T extends AnyNewBalanceModule> = InferBalanceModuleTypes<T>["TModuleType"];
+export type InferTokenType<T extends AnyNewBalanceModule> = InferBalanceModuleTypes<T>["TTokenType"];
+export type InferChainMeta<T extends AnyNewBalanceModule> = InferBalanceModuleTypes<T>["TChainMeta"];
+export type InferModuleConfig<T extends AnyNewBalanceModule> = InferBalanceModuleTypes<T>["TModuleConfig"];
+export type InferTransferParams<T extends AnyNewBalanceModule> = InferBalanceModuleTypes<T>["TTransferParams"];
+/**
+ * Given a `moduleType` and a `chain` from a chaindataProvider, this function will find the chainMeta
+ * associated with the given balanceModule for the given chain.
+ */
+export declare const findChainMeta: <TBalanceModule extends AnyNewBalanceModule>(moduleType: InferModuleType<TBalanceModule>, chain?: Chain) => InferChainMeta<TBalanceModule> | undefined;
 export declare const filterMirrorTokens: (balance: Balance, i: number, balances: Balance[]) => boolean;
+export declare const getValidSubscriptionIds: () => Set<string>;
+export declare const createSubscriptionId: () => string;
+export declare const deleteSubscriptionId: () => void;
+/**
+ * Sets all balance statuses from `live-${string}` to either `live` or `cached`
+ */
+export declare const deriveStatuses: (validSubscriptionIds: string[], balances: BalanceJson[]) => BalanceJson[];
 /**
  * Used by a variety of balance modules to help encode and decode substrate state calls.
  */
@@ -26,3 +66,21 @@ export declare class StorageHelper {
     tag(tags: any): this;
     decode(input?: string | null): import("@polkadot/types-codec/types").Codec | undefined;
 }
+/**
+ * Pass some these into an `RpcStateQueryHelper` in order to easily batch multiple state queries into the one rpc call.
+ */
+export type RpcStateQuery<T> = {
+    chainId: string;
+    stateKey: string;
+    decodeResult: (change: string | null) => T;
+};
+/**
+ * Used by a variety of balance modules to help batch multiple state queries into the one rpc call.
+ */
+export declare class RpcStateQueryHelper<T> {
+    #private;
+    constructor(chainConnector: ChainConnector, queries: Array<RpcStateQuery<T>>);
+    subscribe(callback: SubscriptionCallback<T[]>, timeout?: number | false, subscribeMethod?: string, responseMethod?: string, unsubscribeMethod?: string): Promise<UnsubscribeFn>;
+    fetch(method?: string): Promise<T[]>;
+}
+export {};

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

@@ -61,6 +61,19 @@ export declare class Balances {
      * @returns All balances which match the query.
      */
     find: (query: BalanceSearchQuery | BalanceSearchQuery[]) => Balances;
+    /**
+     * Filters this collection to exclude token balances where the token has a `mirrorOf` field
+     * and another balance exists in this collection for the token specified by the `mirrorOf` field.
+     */
+    filterMirrorTokens: () => Balances;
+    /**
+     * Filters this collection to only include balances which are not zero.
+     */
+    filterNonZero: (type: "total" | "free" | "reserved" | "locked" | "frozen" | "transferable" | "feePayable") => Balances;
+    /**
+     * Filters this collection to only include balances which are not zero AND have a fiat conversion rate.
+     */
+    filterNonZeroFiat: (type: "total" | "free" | "reserved" | "locked" | "frozen" | "transferable" | "feePayable", currency: TokenRateCurrency) => Balances;
     /**
      * Add some balances to this collection.
      * Added balances take priority over existing balances.
@@ -134,9 +147,21 @@ export declare class Balance {
     get free(): BalanceFormatter;
     /** The reserved balance of this token. Is included in the total. */
     get reserved(): BalanceFormatter;
+    get reserves(): {
+        amount: BalanceFormatter;
+        label: string;
+        meta?: unknown;
+    }[];
     /** The frozen balance of this token. Is included in the free amount. */
     get locked(): BalanceFormatter;
-    /** @depreacted - use balance.locked */
+    get locks(): {
+        amount: BalanceFormatter;
+        label: string;
+        meta?: unknown;
+        includeInTransferable?: boolean | undefined;
+        excludeFromFeePayable?: boolean | undefined;
+    }[];
+    /** @deprecated Use balance.locked */
     get frozen(): BalanceFormatter;
     /** The transferable balance of this token. Is generally the free amount - the miscFrozen amount. */
     get transferable(): BalanceFormatter;
@@ -151,6 +176,26 @@ export declare class BalanceFormatter {
     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 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);
@@ -164,7 +209,7 @@ export declare class FiatSumBalancesFormatter {
     get reserved(): number;
     /** The frozen balance of these tokens. Is included in the free amount. */
     get locked(): number;
-    /** @deprecated - use balances.locked */
+    /** @deprecated Use balances.locked */
     get frozen(): number;
     /** The transferable balance of these tokens. Is generally the free amount - the miscFrozen amount. */
     get transferable(): number;
@@ -174,5 +219,6 @@ export declare class FiatSumBalancesFormatter {
 export declare class SumBalancesFormatter {
     #private;
     constructor(balances: Balances);
+    get planck(): PlanckSumBalancesFormatter;
     fiat(currency: TokenRateCurrency): FiatSumBalancesFormatter;
 }

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

@@ -23,11 +23,18 @@ export type BalanceTypes = {
 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";
+export type BalanceStatusLive = `live-${string}`;
+export declare const BalanceStatusLive: (subscriptionId: string) => BalanceStatusLive;
+export type BalanceStatus = BalanceStatusLive | "live" | "cache" | "stale";
 /** `IBalance` is a common interface which all balance types must implement. */
 export type IBalance = {
     /** The module that this balance was retrieved by */
     source: string;
+    /**
+     * For modules which fetch balances via module sources, this is the sub-source
+     * e.g. `staking` or `crowdloans`
+     **/
+    subSource?: string;
     /** Has this balance never been fetched, or is it from a cache, or is it up to date? */
     status: BalanceStatus;
     /** The address of the account which owns this balance */
@@ -57,6 +64,7 @@ export type Amount = string;
 export type AmountWithLabel<TLabel extends string> = {
     label: TLabel;
     amount: Amount;
+    meta?: unknown;
 };
 /** A labelled locked amount of a balance */
 export type LockedAmount<TLabel extends string> = AmountWithLabel<TLabel> & {