@talismn/balances 0.0.0-pr752-20230512080211 → 0.0.0-pr756-20230516054136

package/CHANGELOG.md

@@ -1,23 +1,25 @@
 # @talismn/balances
 
-## 0.0.0-pr752-20230512080211
+## 0.0.0-pr756-20230516054136
 
 ### 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.0.0-pr752-20230512080211
-  - @talismn/chain-connector-evm@0.0.0-pr752-20230512080211
-  - @talismn/chaindata-provider@0.0.0-pr752-20230512080211
-  - @talismn/token-rates@0.0.0-pr752-20230512080211
-  - @talismn/util@0.0.0-pr752-20230512080211
+  - @talismn/chain-connector@0.0.0-pr756-20230516054136
+  - @talismn/chain-connector-evm@0.0.0-pr756-20230516054136
+  - @talismn/chaindata-provider@0.0.0-pr756-20230516054136
+  - @talismn/token-rates@0.0.0-pr756-20230516054136
+  - @talismn/util@0.0.0-pr756-20230516054136
 
 ## 0.4.0
 

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

@@ -1,7 +1,7 @@
 import type { Registry } from "@polkadot/types-codec/types";
 import { ChainConnector } from "@talismn/chain-connector";
-import { ChainId } from "@talismn/chaindata-provider";
-import { BalanceModule, DefaultChainMeta, DefaultModuleConfig, DefaultTransferParams, ExtendableChainMeta, ExtendableModuleConfig, ExtendableTokenType, ExtendableTransferParams } from "./BalanceModule";
+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.
@@ -13,6 +13,37 @@ export type GetOrCreateTypeRegistry = (chainId: ChainId, metadataRpc?: `0x${stri
 export declare const createTypeRegistryCache: () => {
     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;
@@ -52,3 +83,4 @@ export declare class RpcStateQueryHelper<T> {
     subscribe(callback: SubscriptionCallback<T[]>, timeout?: number | false, subscribeMethod?: string, responseMethod?: string, unsubscribeMethod?: string): Promise<UnsubscribeFn>;
     fetch(method?: string): Promise<T[]>;
 }
+export {};

package/dist/talismn-balances.cjs.dev.js

@@ -69,7 +69,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr752-20230512080211",
+	version: "0.0.0-pr756-20230516054136",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -135,6 +135,11 @@ var packageJson = {
 
 var log = anylogger__default["default"](packageJson.name);
 
+/**
+ * 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.
+ */
+
 async function balances(balanceModule, addressesByToken, callback) {
   // subscription request
   if (callback !== undefined) return await balanceModule.subscribeBalances(addressesByToken, callback);
@@ -166,6 +171,31 @@ const createTypeRegistryCache = () => {
     getOrCreateTypeRegistry
   };
 };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-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
+ */
+
+/**
+ * Given a `moduleType` and a `chain` from a chaindataProvider, this function will find the chainMeta
+ * associated with the given balanceModule for the given chain.
+ */
+const findChainMeta = (moduleType, chain) => {
+  return (chain.balanceMetadata ?? []).find(meta => meta.moduleType === moduleType)?.metadata;
+};
 const filterMirrorTokens = (balance, i, balances) => {
   // TODO: implement a mirrorOf property, which should be set from chaindata
   const mirrorOf = balance.token?.mirrorOf;
@@ -368,7 +398,36 @@ class RpcStateQueryHelper {
   }
 }
 
+/**
+ * `BalanceTypes` is an automatically determined sub-selection of `PluginBalanceTypes`.
+ *
+ * It is the same list, but with any invalid `BalanceType` definitions filtered out.
+ */
+
+/**
+ * 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-orml` and `evm-erc20` plugins:
+ *
+ *     type BalanceJson = SubNativeBalance | EvmNativeBalance | SubOrmlBalance | EvmErc20Balance
+ *
+ * If `BalanceTypes` is empty then `BalanceJson` will fall back to the common `IBalance` interface, which every balance must implement.
+ */
+
+/** A collection of `BalanceJson` objects */
+
 const BalanceStatusLive = subscriptionId => `live-${subscriptionId}`;
+
+/** `IBalance` is a common interface which all balance types must implement. */
+
+/** An unlabelled amount of a balance */
+
+/** A labelled amount of a balance */
+
+/** A labelled locked amount of a balance */
+
 function excludeFromTransferableAmount(locks) {
   if (typeof locks === "string") return BigInt(locks);
   if (!Array.isArray(locks)) locks = [locks];
@@ -396,7 +455,7 @@ function includeInTotalExtraAmount(extra) {
  */
 
 /** A utility type used to extract the underlying `BalanceType` of a specific source from a generalised `BalanceJson` */
-
+/** TODO: Remove this in favour of a frontend-friendly `ChaindataProvider` */
 /**
  * A collection of balances.
  */
@@ -908,5 +967,6 @@ exports.deriveStatuses = deriveStatuses;
 exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
 exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
 exports.filterMirrorTokens = filterMirrorTokens;
+exports.findChainMeta = findChainMeta;
 exports.getValidSubscriptionIds = getValidSubscriptionIds;
 exports.includeInTotalExtraAmount = includeInTotalExtraAmount;

package/dist/talismn-balances.cjs.prod.js

@@ -69,7 +69,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr752-20230512080211",
+	version: "0.0.0-pr756-20230516054136",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -135,6 +135,11 @@ var packageJson = {
 
 var log = anylogger__default["default"](packageJson.name);
 
+/**
+ * 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.
+ */
+
 async function balances(balanceModule, addressesByToken, callback) {
   // subscription request
   if (callback !== undefined) return await balanceModule.subscribeBalances(addressesByToken, callback);
@@ -166,6 +171,31 @@ const createTypeRegistryCache = () => {
     getOrCreateTypeRegistry
   };
 };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-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
+ */
+
+/**
+ * Given a `moduleType` and a `chain` from a chaindataProvider, this function will find the chainMeta
+ * associated with the given balanceModule for the given chain.
+ */
+const findChainMeta = (moduleType, chain) => {
+  return (chain.balanceMetadata ?? []).find(meta => meta.moduleType === moduleType)?.metadata;
+};
 const filterMirrorTokens = (balance, i, balances) => {
   // TODO: implement a mirrorOf property, which should be set from chaindata
   const mirrorOf = balance.token?.mirrorOf;
@@ -368,7 +398,36 @@ class RpcStateQueryHelper {
   }
 }
 
+/**
+ * `BalanceTypes` is an automatically determined sub-selection of `PluginBalanceTypes`.
+ *
+ * It is the same list, but with any invalid `BalanceType` definitions filtered out.
+ */
+
+/**
+ * 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-orml` and `evm-erc20` plugins:
+ *
+ *     type BalanceJson = SubNativeBalance | EvmNativeBalance | SubOrmlBalance | EvmErc20Balance
+ *
+ * If `BalanceTypes` is empty then `BalanceJson` will fall back to the common `IBalance` interface, which every balance must implement.
+ */
+
+/** A collection of `BalanceJson` objects */
+
 const BalanceStatusLive = subscriptionId => `live-${subscriptionId}`;
+
+/** `IBalance` is a common interface which all balance types must implement. */
+
+/** An unlabelled amount of a balance */
+
+/** A labelled amount of a balance */
+
+/** A labelled locked amount of a balance */
+
 function excludeFromTransferableAmount(locks) {
   if (typeof locks === "string") return BigInt(locks);
   if (!Array.isArray(locks)) locks = [locks];
@@ -396,7 +455,7 @@ function includeInTotalExtraAmount(extra) {
  */
 
 /** A utility type used to extract the underlying `BalanceType` of a specific source from a generalised `BalanceJson` */
-
+/** TODO: Remove this in favour of a frontend-friendly `ChaindataProvider` */
 /**
  * A collection of balances.
  */
@@ -908,5 +967,6 @@ exports.deriveStatuses = deriveStatuses;
 exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
 exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
 exports.filterMirrorTokens = filterMirrorTokens;
+exports.findChainMeta = findChainMeta;
 exports.getValidSubscriptionIds = getValidSubscriptionIds;
 exports.includeInTotalExtraAmount = includeInTotalExtraAmount;

package/dist/talismn-balances.esm.js

@@ -60,7 +60,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr752-20230512080211",
+	version: "0.0.0-pr756-20230516054136",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -126,6 +126,11 @@ var packageJson = {
 
 var log = anylogger(packageJson.name);
 
+/**
+ * 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.
+ */
+
 async function balances(balanceModule, addressesByToken, callback) {
   // subscription request
   if (callback !== undefined) return await balanceModule.subscribeBalances(addressesByToken, callback);
@@ -157,6 +162,31 @@ const createTypeRegistryCache = () => {
     getOrCreateTypeRegistry
   };
 };
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+
+// eslint-disable-next-line @typescript-eslint/no-explicit-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
+ */
+
+/**
+ * Given a `moduleType` and a `chain` from a chaindataProvider, this function will find the chainMeta
+ * associated with the given balanceModule for the given chain.
+ */
+const findChainMeta = (moduleType, chain) => {
+  return (chain.balanceMetadata ?? []).find(meta => meta.moduleType === moduleType)?.metadata;
+};
 const filterMirrorTokens = (balance, i, balances) => {
   // TODO: implement a mirrorOf property, which should be set from chaindata
   const mirrorOf = balance.token?.mirrorOf;
@@ -359,7 +389,36 @@ class RpcStateQueryHelper {
   }
 }
 
+/**
+ * `BalanceTypes` is an automatically determined sub-selection of `PluginBalanceTypes`.
+ *
+ * It is the same list, but with any invalid `BalanceType` definitions filtered out.
+ */
+
+/**
+ * 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-orml` and `evm-erc20` plugins:
+ *
+ *     type BalanceJson = SubNativeBalance | EvmNativeBalance | SubOrmlBalance | EvmErc20Balance
+ *
+ * If `BalanceTypes` is empty then `BalanceJson` will fall back to the common `IBalance` interface, which every balance must implement.
+ */
+
+/** A collection of `BalanceJson` objects */
+
 const BalanceStatusLive = subscriptionId => `live-${subscriptionId}`;
+
+/** `IBalance` is a common interface which all balance types must implement. */
+
+/** An unlabelled amount of a balance */
+
+/** A labelled amount of a balance */
+
+/** A labelled locked amount of a balance */
+
 function excludeFromTransferableAmount(locks) {
   if (typeof locks === "string") return BigInt(locks);
   if (!Array.isArray(locks)) locks = [locks];
@@ -387,7 +446,7 @@ function includeInTotalExtraAmount(extra) {
  */
 
 /** A utility type used to extract the underlying `BalanceType` of a specific source from a generalised `BalanceJson` */
-
+/** TODO: Remove this in favour of a frontend-friendly `ChaindataProvider` */
 /**
  * A collection of balances.
  */
@@ -879,4 +938,4 @@ class SumBalancesFormatter {
   }
 }
 
-export { Balance, BalanceFormatter, BalanceStatusLive, Balances, DefaultBalanceModule, FiatSumBalancesFormatter, PlanckSumBalancesFormatter, RpcStateQueryHelper, StorageHelper, SumBalancesFormatter, TalismanBalancesDatabase, balances, createSubscriptionId, createTypeRegistryCache, db, deleteSubscriptionId, deriveStatuses, excludeFromFeePayableLocks, excludeFromTransferableAmount, filterMirrorTokens, getValidSubscriptionIds, includeInTotalExtraAmount };
+export { Balance, BalanceFormatter, BalanceStatusLive, Balances, DefaultBalanceModule, FiatSumBalancesFormatter, PlanckSumBalancesFormatter, RpcStateQueryHelper, StorageHelper, SumBalancesFormatter, TalismanBalancesDatabase, balances, createSubscriptionId, createTypeRegistryCache, db, deleteSubscriptionId, deriveStatuses, excludeFromFeePayableLocks, excludeFromTransferableAmount, filterMirrorTokens, findChainMeta, getValidSubscriptionIds, includeInTotalExtraAmount };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances",
-  "version": "0.0.0-pr752-20230512080211",
+  "version": "0.0.0-pr756-20230516054136",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -27,18 +27,18 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/chain-connector": "0.0.0-pr752-20230512080211",
-    "@talismn/chain-connector-evm": "0.0.0-pr752-20230512080211",
-    "@talismn/chaindata-provider": "0.0.0-pr752-20230512080211",
-    "@talismn/token-rates": "0.0.0-pr752-20230512080211",
-    "@talismn/util": "0.0.0-pr752-20230512080211",
+    "@talismn/chain-connector": "0.0.0-pr756-20230516054136",
+    "@talismn/chain-connector-evm": "0.0.0-pr756-20230516054136",
+    "@talismn/chaindata-provider": "0.0.0-pr756-20230516054136",
+    "@talismn/token-rates": "0.0.0-pr756-20230516054136",
+    "@talismn/util": "0.0.0-pr756-20230516054136",
     "anylogger": "^1.0.11",
     "dexie": "^3.2.3",
     "lodash": "4.17.21"
   },
   "devDependencies": {
     "@polkadot/types": "^10.1.4",
-    "@talismn/eslint-config": "0.0.0-pr752-20230512080211",
+    "@talismn/eslint-config": "0.0.0-pr756-20230516054136",
     "@talismn/tsconfig": "0.0.2",
     "@types/jest": "^27.5.1",
     "@types/lodash": "^4.14.180",