@talismn/balances 0.2.3 → 0.3.1

package/CHANGELOG.md

@@ -1,5 +1,36 @@
 # @talismn/balances
 
+## 0.3.1
+
+### Patch Changes
+
+- 8adc7f06: feat: switched build tool to preconstruct
+- Updated dependencies [8adc7f06]
+- Updated dependencies [cfe8d276]
+  - @talismn/chain-connector-evm@0.4.1
+  - @talismn/chaindata-provider@0.4.1
+  - @talismn/chain-connector@0.4.1
+  - @talismn/token-rates@0.1.13
+  - @talismn/util@0.1.6
+
+## 0.3.0
+
+### Minor Changes
+
+- a63dbb3: exclude mirror tokens in sums
+
+### Patch Changes
+
+- 4aa691d: feat: new balance modules
+- Updated dependencies [4aa691d]
+- Updated dependencies [cd6a684]
+- Updated dependencies [a63dbb3]
+  - @talismn/chain-connector-evm@0.4.0
+  - @talismn/chaindata-provider@0.2.1
+  - @talismn/chain-connector@0.2.1
+  - @talismn/token-rates@0.1.12
+  - @talismn/util@0.1.5
+
 ## 0.2.3
 
 ## 0.2.2

package/dist/{BalanceModule.d.ts → declarations/src/BalanceModule.d.ts}

@@ -5,20 +5,20 @@ import { AddressesByToken, Balances, SubscriptionCallback, UnsubscribeFn } from
 export interface BalanceModule<TModuleType extends string, TTokenType extends ExtendableTokenType, TChainMeta extends ExtendableChainMeta = DefaultChainMeta, TModuleConfig extends ExtendableModuleConfig = DefaultModuleConfig> extends BalanceModuleSubstrate<TModuleType, TTokenType, TChainMeta, TModuleConfig>, BalanceModuleEvm<TModuleType, TTokenType, TChainMeta, TModuleConfig> {
 }
 export declare const DefaultBalanceModule: <TModuleType extends string, TTokenType extends IToken, TChainMeta extends ExtendableChainMeta = undefined, TModuleConfig extends ExtendableModuleConfig = undefined>(type: TModuleType) => BalanceModule<TModuleType, TTokenType, TChainMeta, TModuleConfig>;
-export declare type ExtendableTokenType = IToken;
-export declare type ExtendableChainMeta = Record<string, unknown> | undefined;
-export declare type DefaultChainMeta = undefined;
-export declare type ExtendableModuleConfig = Record<string, unknown> | undefined;
-export declare type DefaultModuleConfig = undefined;
+export type ExtendableTokenType = IToken;
+export type ExtendableChainMeta = Record<string, unknown> | undefined;
+export type DefaultChainMeta = undefined;
+export type ExtendableModuleConfig = Record<string, unknown> | undefined;
+export type DefaultModuleConfig = undefined;
 interface BalanceModuleSubstrate<TModuleType extends string, TTokenType extends ExtendableTokenType, TChainMeta extends ExtendableChainMeta = DefaultChainMeta, TModuleConfig extends ExtendableModuleConfig = DefaultModuleConfig> extends BalanceModuleCommon<TModuleType, TTokenType> {
     /** Pre-processes any substrate chain metadata required by this module ahead of time */
-    fetchSubstrateChainMeta(chainConnector: ChainConnector, chaindataProvider: ChaindataProvider, chainId: ChainId): Promise<TChainMeta | null>;
+    fetchSubstrateChainMeta(chainConnector: ChainConnector, chaindataProvider: ChaindataProvider, chainId: ChainId, moduleConfig: TModuleConfig | undefined): Promise<TChainMeta | null>;
     /** Detects which tokens are available on a given substrate chain */
     fetchSubstrateChainTokens(chainConnector: ChainConnector, chaindataProvider: ChaindataProvider, chainId: ChainId, chainMeta: TChainMeta, moduleConfig: TModuleConfig | undefined): Promise<Record<TTokenType["id"], TTokenType>>;
 }
 interface BalanceModuleEvm<TModuleType extends string, TTokenType extends ExtendableTokenType, TChainMeta extends ExtendableChainMeta = DefaultChainMeta, TModuleConfig extends ExtendableModuleConfig = DefaultModuleConfig> extends BalanceModuleCommon<TModuleType, TTokenType> {
     /** Pre-processes any evm chain metadata required by this module ahead of time */
-    fetchEvmChainMeta(chainConnector: ChainConnectorEvm, chaindataProvider: ChaindataProvider, chainId: ChainId): Promise<TChainMeta | null>;
+    fetchEvmChainMeta(chainConnector: ChainConnectorEvm, chaindataProvider: ChaindataProvider, chainId: ChainId, moduleConfig: TModuleConfig | undefined): Promise<TChainMeta | null>;
     /** Detects which tokens are available on a given evm chain */
     fetchEvmChainTokens(chainConnector: ChainConnectorEvm, chaindataProvider: ChaindataProvider, chainId: ChainId, chainMeta: TChainMeta, moduleConfig: TModuleConfig | undefined): Promise<Record<TTokenType["id"], TTokenType>>;
 }

package/dist/{helpers.d.ts → declarations/src/helpers.d.ts}

@@ -1,8 +1,9 @@
+import { TypeRegistry } from "@polkadot/types";
 import { ChainConnector } from "@talismn/chain-connector";
 import { ChainConnectorEvm } from "@talismn/chain-connector-evm";
 import { ChaindataProvider } from "@talismn/chaindata-provider";
 import { BalanceModule, DefaultChainMeta, DefaultModuleConfig, ExtendableChainMeta, ExtendableModuleConfig, ExtendableTokenType } from "./BalanceModule";
-import { AddressesByToken, Balances, SubscriptionCallback, UnsubscribeFn } from "./types";
+import { AddressesByToken, Balance, 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.
@@ -15,3 +16,18 @@ export declare function balances<TModuleType extends string, TTokenType extends
     substrate?: ChainConnector;
     evm?: ChainConnectorEvm;
 }, chaindataProvider: ChaindataProvider, addressesByToken: AddressesByToken<TTokenType>, callback: SubscriptionCallback<Balances>): Promise<UnsubscribeFn>;
+export declare const filterMirrorTokens: (balance: Balance, i: number, balances: Balance[]) => boolean;
+/**
+ * Used by a variety of balance modules to help encode and decode substrate state calls.
+ */
+export declare class StorageHelper {
+    #private;
+    tags: any;
+    constructor(registry: TypeRegistry, module: string, method: string, ...parameters: any[]);
+    get stateKey(): `0x${string}` | undefined;
+    get module(): string;
+    get method(): string;
+    get parameters(): any[];
+    tag(tags: any): this;
+    decode(input?: string | null): import("@polkadot/types-codec/types").Codec | undefined;
+}

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

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

package/dist/{types → declarations/src/types}/balances.d.ts

@@ -7,18 +7,18 @@ import { BalanceJson, BalanceJsonList, IBalance } from "./balancetypes";
  * internal global typescript context, which is then picked up on by this module.
  */
 /** A utility type used to extract the underlying `BalanceType` of a specific source from a generalised `BalanceJson` */
-export declare type NarrowBalanceType<S extends IBalance, P> = S extends {
+export type NarrowBalanceType<S extends IBalance, P> = S extends {
     source: P;
 } ? S : never;
-export declare type BalanceSource = BalanceJson["source"];
+export type BalanceSource = BalanceJson["source"];
 /** TODO: Remove this in favour of a frontend-friendly `ChaindataProvider` */
-export declare type HydrateDb = Partial<{
+export type HydrateDb = Partial<{
     chains: ChainList;
     evmNetworks: EvmNetworkList;
     tokens: TokenList;
     tokenRates: TokenRatesList;
 }>;
-export declare type BalanceSearchQuery = Partial<NonFunctionProperties<Balance>> | ((balance: Balance) => boolean);
+export type BalanceSearchQuery = Partial<NonFunctionProperties<Balance>> | ((balance: Balance) => boolean);
 /**
  * A collection of balances.
  */

package/dist/{types → declarations/src/types}/balancetypes.d.ts

@@ -1,12 +1,12 @@
+import { PluginBalanceTypes } from "@talismn/balances/plugins";
 import { ChainId, EvmNetworkId, MultiChainId, TokenId } from "@talismn/chaindata-provider";
-import { PluginBalanceTypes } from "../plugins";
 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 declare type BalanceTypes = {
+export type BalanceTypes = {
     [BalanceType in keyof PluginBalanceTypes]: PluginBalanceTypes[BalanceType] extends IBalance ? PluginBalanceTypes[BalanceType] : never;
 };
 /**
@@ -20,12 +20,12 @@ export declare type BalanceTypes = {
  *
  * If `BalanceTypes` is empty then `BalanceJson` will fall back to the common `IBalance` interface, which every balance must implement.
  */
-export declare type BalanceJson = BalanceTypes[keyof BalanceTypes] extends never ? IBalance : BalanceTypes[keyof BalanceTypes];
+export type BalanceJson = BalanceTypes[keyof BalanceTypes] extends never ? IBalance : BalanceTypes[keyof BalanceTypes];
 /** A collection of `BalanceJson` objects */
-export declare type BalanceJsonList = Record<string, BalanceJson>;
-export declare type BalanceStatus = "live" | "cache";
+export type BalanceJsonList = Record<string, BalanceJson>;
+export type BalanceStatus = "live" | "cache";
 /** `IBalance` is a common interface which all balance types must implement. */
-export declare type IBalance = {
+export type IBalance = {
     /** The module that this balance was retrieved by */
     source: string;
     /** Has this balance never been fetched, or is it from a cache, or is it up to date? */
@@ -41,7 +41,7 @@ export declare type IBalance = {
     /** The evm chain this balance is on */
     evmNetworkId?: EvmNetworkId;
 } & IBalanceAmounts;
-export declare type IBalanceAmounts = {
+export type IBalanceAmounts = {
     /** The portion of a balance that is not reserved. The free balance is the only balance that matters for most operations. */
     free?: Amount | AmountWithLabel<string> | Array<AmountWithLabel<string>>;
     /** The portion of a balance that is owned by the account but is reserved/suspended/unavailable. Reserved balance can still be slashed, but only after all the free balance has been slashed. */
@@ -52,14 +52,14 @@ export declare type IBalanceAmounts = {
     extra?: ExtraAmount<string> | Array<ExtraAmount<string>>;
 };
 /** An unlabelled amount of a balance */
-export declare type Amount = string;
+export type Amount = string;
 /** A labelled amount of a balance */
-export declare type AmountWithLabel<TLabel extends string> = {
+export type AmountWithLabel<TLabel extends string> = {
     label: TLabel;
     amount: Amount;
 };
 /** A labelled locked amount of a balance */
-export declare type LockedAmount<TLabel extends string> = AmountWithLabel<TLabel> & {
+export type LockedAmount<TLabel extends string> = AmountWithLabel<TLabel> & {
     /**
      * By default, the largest locked amount is subtrated from the transferable amount of this balance.
      * If this property is set to true, this particular lock will be skipped when making this calculation.
@@ -77,12 +77,12 @@ export declare type LockedAmount<TLabel extends string> = AmountWithLabel<TLabel
 export declare function excludeFromTransferableAmount(locks: Amount | LockedAmount<string> | Array<LockedAmount<string>>): bigint;
 export declare function excludeFromFeePayableLocks(locks: Amount | LockedAmount<string> | Array<LockedAmount<string>>): Array<LockedAmount<string>>;
 /** A labelled extra amount of a balance */
-export declare type ExtraAmount<TLabel extends string> = AmountWithLabel<TLabel> & {
+export type ExtraAmount<TLabel extends string> = AmountWithLabel<TLabel> & {
     /** If set to true, this extra amount will be included in the calculation of the total amount of this balance. */
     includeInTotal?: boolean;
 };
 export declare function includeInTotalExtraAmount(extra?: ExtraAmount<string> | Array<ExtraAmount<string>>): bigint;
 /** Used by plugins to help define their custom `BalanceType` */
-export declare type NewBalanceType<TModuleType extends string, T extends IBalanceAmounts> = IBalance & {
+export type NewBalanceType<TModuleType extends string, T extends IBalanceAmounts> = IBalance & {
     source: TModuleType;
 } & T;

package/dist/{types → declarations/src/types}/subscriptions.d.ts

@@ -8,4 +8,4 @@ export interface SubscriptionCallback<Result> {
 /**
  * A function which cancels a subscription when called.
  */
-export declare type UnsubscribeFn = () => void;
+export type UnsubscribeFn = () => void;

package/dist/talismn-balances.cjs.d.ts

@@ -0,0 +1 @@
+export * from "./declarations/src/index";