@talismn/balances 0.2.2 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @talismn/balances
 
+## 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
 
 ### Patch Changes

package/dist/BalanceModule.d.ts

@@ -12,13 +12,13 @@ export declare type ExtendableModuleConfig = Record<string, unknown> | undefined
 export declare 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

@@ -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/helpers.js

@@ -1,6 +1,11 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.balances = void 0;
+exports.StorageHelper = exports.filterMirrorTokens = exports.balances = void 0;
+const types_1 = require("@polkadot/types");
+const log_1 = __importDefault(require("./log"));
 async function balances(balanceModule, chainConnectors, chaindataProvider, addressesByToken, callback) {
     // subscription request
     if (callback !== undefined)
@@ -9,3 +14,86 @@ async function balances(balanceModule, chainConnectors, chaindataProvider, addre
     return await balanceModule.fetchBalances(chainConnectors, chaindataProvider, addressesByToken);
 }
 exports.balances = balances;
+const filterMirrorTokens = (balance, i, balances) => {
+    // TODO implement a mirrorOf property, which should be set from chaindata
+    const mirrorOf = balance.token?.mirrorOf;
+    return !mirrorOf || !balances.find((b) => b.tokenId === mirrorOf);
+};
+exports.filterMirrorTokens = filterMirrorTokens;
+/**
+ * Used by a variety of balance modules to help encode and decode substrate state calls.
+ */
+class StorageHelper {
+    #registry;
+    #storageKey;
+    #module;
+    #method;
+    #parameters;
+    tags = null;
+    constructor(registry, module, method, ...parameters) {
+        this.#registry = registry;
+        this.#module = module;
+        this.#method = method;
+        this.#parameters = parameters;
+        const _metadataVersion = 0; // is not used inside the decorateStorage function
+        let query;
+        try {
+            query = (0, types_1.decorateStorage)(registry, registry.metadata, _metadataVersion);
+        }
+        catch (error) {
+            log_1.default.debug(`Failed to decorate storage: ${error.message}`);
+            this.#storageKey = null;
+        }
+        try {
+            if (!query)
+                throw new Error(`decoratedStorage unavailable`);
+            this.#storageKey = new types_1.StorageKey(registry, parameters ? [query[module][method], parameters] : query[module][method]);
+        }
+        catch (error) {
+            log_1.default.debug(`Failed to create storageKey ${module || "unknown"}.${method || "unknown"}: ${error.message}`);
+            this.#storageKey = null;
+        }
+    }
+    get stateKey() {
+        return this.#storageKey?.toHex();
+    }
+    get module() {
+        return this.#module;
+    }
+    get method() {
+        return this.#method;
+    }
+    get parameters() {
+        return this.#parameters;
+    }
+    tag(tags) {
+        this.tags = tags;
+        return this;
+    }
+    decode(input) {
+        if (!this.#storageKey)
+            return;
+        return this.#decodeStorageScaleResponse(this.#registry, this.#storageKey, input);
+    }
+    #decodeStorageScaleResponse(typeRegistry, storageKey, input) {
+        if (input === undefined || input === null)
+            return;
+        const type = storageKey.outputType || "Raw";
+        const meta = storageKey.meta || {
+            fallback: undefined,
+            modifier: { isOptional: true },
+            type: { asMap: { linked: { isTrue: false } }, isMap: false },
+        };
+        try {
+            return typeRegistry.createTypeUnsafe(type, [
+                meta.modifier.isOptional
+                    ? typeRegistry.createTypeUnsafe(type, [input], { isPedantic: true })
+                    : input,
+            ], { isOptional: meta.modifier.isOptional, isPedantic: !meta.modifier.isOptional });
+        }
+        catch (error) {
+            throw new Error(`Unable to decode storage ${storageKey.section || "unknown"}.${storageKey.method || "unknown"}: ${error.message}`);
+        }
+    }
+}
+exports.StorageHelper = StorageHelper;

package/dist/types/balances.js

@@ -13,6 +13,7 @@ exports.SumBalancesFormatter = exports.FiatSumBalancesFormatter = exports.Balanc
 const util_1 = require("@talismn/util");
 const memoize_1 = __importDefault(require("lodash/memoize"));
 const typescript_memoize_1 = require("typescript-memoize");
+const helpers_1 = require("../helpers");
 const log_1 = __importDefault(require("../log"));
 const balancetypes_1 = require("./balancetypes");
 /**
@@ -396,7 +397,7 @@ class FiatSumBalancesFormatter {
         const fiat = (balance) => balance[balanceField].fiat(this.#currency) || 0;
         // a function to add two amounts
         const sum = (a, b) => a + b;
-        return [...this.#balances].reduce((total, balance) => sum(
+        return [...this.#balances].filter(helpers_1.filterMirrorTokens).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.2.2",
+  "version": "0.3.0",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "UNLICENSED",
@@ -31,11 +31,11 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/chain-connector": "^0.2.0",
-    "@talismn/chain-connector-evm": "^0.3.0",
-    "@talismn/chaindata-provider": "^0.2.0",
-    "@talismn/token-rates": "^0.1.11",
-    "@talismn/util": "^0.1.4",
+    "@talismn/chain-connector": "^0.2.1",
+    "@talismn/chain-connector-evm": "^0.4.0",
+    "@talismn/chaindata-provider": "^0.2.1",
+    "@talismn/token-rates": "^0.1.12",
+    "@talismn/util": "^0.1.5",
     "lodash": "^4.17.21",
     "typescript-memoize": "^1.1.0"
   },