@talismn/balances 0.0.0-pr677-20230418034508 → 0.0.0-pr677-20230418051607

package/CHANGELOG.md

@@ -1,21 +1,21 @@
 # @talismn/balances
 
-## 0.0.0-pr677-20230418034508
+## 0.0.0-pr677-20230418051607
 
 ### Patch Changes
 
 - fb8ee962: feat: proxy dapp websocket requests to talisman wallet backend when available
-- 6b9a99a1: feat: crowdloan and nom pool balances
-- 9d24530b: fix: packages publishing with incorrect interdependency versions
+- 31ba6a31: feat: crowdloan and nom pool balances
+- b08460f2: fix: packages publishing with incorrect interdependency versions
 - Updated dependencies [fb8ee962]
 - Updated dependencies [c898da98]
-- Updated dependencies [6b9a99a1]
-- Updated dependencies [9d24530b]
-  - @talismn/chain-connector@0.0.0-pr677-20230418034508
-  - @talismn/chain-connector-evm@0.0.0-pr677-20230418034508
-  - @talismn/util@0.0.0-pr677-20230418034508
-  - @talismn/chaindata-provider@0.0.0-pr677-20230418034508
-  - @talismn/token-rates@0.0.0-pr677-20230418034508
+- Updated dependencies [31ba6a31]
+- Updated dependencies [b08460f2]
+  - @talismn/chain-connector@0.0.0-pr677-20230418051607
+  - @talismn/chain-connector-evm@0.0.0-pr677-20230418051607
+  - @talismn/util@0.0.0-pr677-20230418051607
+  - @talismn/chaindata-provider@0.0.0-pr677-20230418051607
+  - @talismn/token-rates@0.0.0-pr677-20230418051607
 
 ## 0.4.0
 

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.
@@ -148,7 +161,7 @@ export declare class Balance {
         includeInTransferable?: boolean | undefined;
         excludeFromFeePayable?: boolean | undefined;
     }[];
-    /** @depreacted - use balance.locked */
+    /** @deprecated Use balance.locked */
     get frozen(): BalanceFormatter;
     /** The transferable balance of this token. Is generally the free amount - the miscFrozen amount. */
     get transferable(): BalanceFormatter;

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

@@ -69,7 +69,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr677-20230418034508",
+	version: "0.0.0-pr677-20230418051607",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -490,6 +490,27 @@ class Balances {
     return new Balances([...this].filter(filter));
   };
 
+  /**
+   * 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 = () => new Balances([...this].filter(filterMirrorTokens));
+
+  /**
+   * Filters this collection to only include balances which are not zero.
+   */
+  filterNonZero = type => {
+    const filter = balance => balance[type].planck > 0n;
+    return this.find(filter);
+  };
+  /**
+   * Filters this collection to only include balances which are not zero AND have a fiat conversion rate.
+   */
+  filterNonZeroFiat = (type, currency) => {
+    const filter = balance => (balance[type].fiat(currency) ?? 0) > 0;
+    return this.find(filter);
+  };
+
   /**
    * Add some balances to this collection.
    * Added balances take priority over existing balances.
@@ -704,7 +725,7 @@ class Balance {
       };
     });
   }
-  /** @depreacted - use balance.locked */
+  /** @deprecated Use balance.locked */
   get frozen() {
     return this.locked;
   }
@@ -763,11 +784,11 @@ class FiatSumBalancesFormatter {
   }
   #sum = balanceField => {
     // a function to get a fiat amount from a balance
-    const fiat = balance => balance[balanceField].fiat(this.#currency) || 0;
+    const fiat = balance => balance[balanceField].fiat(this.#currency) ?? 0;
 
     // a function to add two amounts
     const sum = (a, b) => a + b;
-    return [...this.#balances].filter(filterMirrorTokens).reduce((total, balance) => sum(
+    return this.#balances.filterMirrorTokens().each.reduce((total, balance) => sum(
     // add the total amount...
     total,
     // ...to the fiat amount of each balance

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

@@ -69,7 +69,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr677-20230418034508",
+	version: "0.0.0-pr677-20230418051607",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -490,6 +490,27 @@ class Balances {
     return new Balances([...this].filter(filter));
   };
 
+  /**
+   * 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 = () => new Balances([...this].filter(filterMirrorTokens));
+
+  /**
+   * Filters this collection to only include balances which are not zero.
+   */
+  filterNonZero = type => {
+    const filter = balance => balance[type].planck > 0n;
+    return this.find(filter);
+  };
+  /**
+   * Filters this collection to only include balances which are not zero AND have a fiat conversion rate.
+   */
+  filterNonZeroFiat = (type, currency) => {
+    const filter = balance => (balance[type].fiat(currency) ?? 0) > 0;
+    return this.find(filter);
+  };
+
   /**
    * Add some balances to this collection.
    * Added balances take priority over existing balances.
@@ -704,7 +725,7 @@ class Balance {
       };
     });
   }
-  /** @depreacted - use balance.locked */
+  /** @deprecated Use balance.locked */
   get frozen() {
     return this.locked;
   }
@@ -763,11 +784,11 @@ class FiatSumBalancesFormatter {
   }
   #sum = balanceField => {
     // a function to get a fiat amount from a balance
-    const fiat = balance => balance[balanceField].fiat(this.#currency) || 0;
+    const fiat = balance => balance[balanceField].fiat(this.#currency) ?? 0;
 
     // a function to add two amounts
     const sum = (a, b) => a + b;
-    return [...this.#balances].filter(filterMirrorTokens).reduce((total, balance) => sum(
+    return this.#balances.filterMirrorTokens().each.reduce((total, balance) => sum(
     // add the total amount...
     total,
     // ...to the fiat amount of each balance

package/dist/talismn-balances.esm.js

@@ -60,7 +60,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr677-20230418034508",
+	version: "0.0.0-pr677-20230418051607",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "UNLICENSED",
@@ -481,6 +481,27 @@ class Balances {
     return new Balances([...this].filter(filter));
   };
 
+  /**
+   * 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 = () => new Balances([...this].filter(filterMirrorTokens));
+
+  /**
+   * Filters this collection to only include balances which are not zero.
+   */
+  filterNonZero = type => {
+    const filter = balance => balance[type].planck > 0n;
+    return this.find(filter);
+  };
+  /**
+   * Filters this collection to only include balances which are not zero AND have a fiat conversion rate.
+   */
+  filterNonZeroFiat = (type, currency) => {
+    const filter = balance => (balance[type].fiat(currency) ?? 0) > 0;
+    return this.find(filter);
+  };
+
   /**
    * Add some balances to this collection.
    * Added balances take priority over existing balances.
@@ -695,7 +716,7 @@ class Balance {
       };
     });
   }
-  /** @depreacted - use balance.locked */
+  /** @deprecated Use balance.locked */
   get frozen() {
     return this.locked;
   }
@@ -754,11 +775,11 @@ class FiatSumBalancesFormatter {
   }
   #sum = balanceField => {
     // a function to get a fiat amount from a balance
-    const fiat = balance => balance[balanceField].fiat(this.#currency) || 0;
+    const fiat = balance => balance[balanceField].fiat(this.#currency) ?? 0;
 
     // a function to add two amounts
     const sum = (a, b) => a + b;
-    return [...this.#balances].filter(filterMirrorTokens).reduce((total, balance) => sum(
+    return this.#balances.filterMirrorTokens().each.reduce((total, balance) => sum(
     // add the total amount...
     total,
     // ...to the fiat amount of each balance

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances",
-  "version": "0.0.0-pr677-20230418034508",
+  "version": "0.0.0-pr677-20230418051607",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -27,11 +27,11 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/chain-connector": "0.0.0-pr677-20230418034508",
-    "@talismn/chain-connector-evm": "0.0.0-pr677-20230418034508",
-    "@talismn/chaindata-provider": "0.0.0-pr677-20230418034508",
-    "@talismn/token-rates": "0.0.0-pr677-20230418034508",
-    "@talismn/util": "0.0.0-pr677-20230418034508",
+    "@talismn/chain-connector": "0.0.0-pr677-20230418051607",
+    "@talismn/chain-connector-evm": "0.0.0-pr677-20230418051607",
+    "@talismn/chaindata-provider": "0.0.0-pr677-20230418051607",
+    "@talismn/token-rates": "0.0.0-pr677-20230418051607",
+    "@talismn/util": "0.0.0-pr677-20230418051607",
     "anylogger": "^1.0.11",
     "dexie": "^3.2.3",
     "lodash": "4.17.21"