@talismn/balances 0.0.0-pr974-20230915020916 → 0.0.0-pr974-20231123032136

package/CHANGELOG.md

@@ -1,20 +1,31 @@
 # @talismn/balances
 
-## 0.0.0-pr974-20230915020916
+## 0.0.0-pr974-20231123032136
 
 ### Patch Changes
 
 - d2ccdafb: fix: balance subscriptions never update registry cache with new metadata
+- c4d59671: bump typescript version
 - a916db00: docs: added @talismn/balances readme
 - a3a1bd7c: feat: psp22 balances module
+- c681c8bb: Use Balances::transfer_allow_death as default method for substrate balance transfers
+- Updated dependencies [123647e3]
 - Updated dependencies [03939d5f]
+- Updated dependencies [123647e3]
+- Updated dependencies [e0eb84ad]
+- Updated dependencies [372f9951]
+- Updated dependencies [c4d59671]
+- Updated dependencies [e0eb84ad]
 - Updated dependencies [850381a5]
+- Updated dependencies [5aadf998]
 - Updated dependencies [4cace80d]
+- Updated dependencies [372f9951]
 - Updated dependencies [9ebcd938]
-  - @talismn/chaindata-provider@0.0.0-pr974-20230915020916
-  - @talismn/chain-connector-evm@0.0.0-pr974-20230915020916
-  - @talismn/chain-connector@0.0.0-pr974-20230915020916
-  - @talismn/token-rates@0.0.0-pr974-20230915020916
+  - @talismn/token-rates@0.0.0-pr974-20231123032136
+  - @talismn/chaindata-provider@0.0.0-pr974-20231123032136
+  - @talismn/chain-connector@0.0.0-pr974-20231123032136
+  - @talismn/chain-connector-evm@0.0.0-pr974-20231123032136
+  - @talismn/util@0.0.0-pr974-20231123032136
 
 ## 0.6.0
 

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

@@ -2,7 +2,6 @@ import { UnsignedTransaction } from "@substrate/txwrapper-core";
 import { ChainConnector } from "@talismn/chain-connector";
 import { ChainConnectorEvm } from "@talismn/chain-connector-evm";
 import { ChainId, ChaindataProvider, IToken } from "@talismn/chaindata-provider";
-import { ethers } from "ethers";
 import { AddressesByToken, Balances, SubscriptionCallback, UnsubscribeFn } from "./types";
 export type ExtendableTokenType = IToken;
 export type ExtendableChainMeta = Record<string, unknown> | undefined;
@@ -21,9 +20,6 @@ export type NewTransferParamsType<T extends Record<string, unknown>> = BaseTrans
 export type TransferTokenTx = {
     type: "substrate";
     tx: UnsignedTransaction;
-} | {
-    type: "evm";
-    tx: ethers.providers.TransactionRequest;
 };
 export type ChainConnectors = {
     substrate?: ChainConnector;

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

@@ -83,4 +83,15 @@ 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[]>;
 }
+/**
+ *
+ * Detect Balances::transfer -> Balances::transfer_allow_death migration
+ * https://github.com/paritytech/substrate/pull/12951
+ *
+ * `transfer_allow_death` is the preferred method,
+ * so if something goes wrong during detection, we should assume the chain has migrated
+ * @param metadataRpc string containing the hashed RPC metadata for the chain
+ * @returns
+ */
+export declare const detectTransferMethod: (metadataRpc: `0x${string}`) => "transfer" | "transferAllowDeath";
 export {};

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

@@ -149,6 +149,9 @@ export declare class Balance {
     get reserved(): BalanceFormatter;
     get reserves(): {
         amount: BalanceFormatter;
+        /**
+         * Filters this collection to only include balances which are not zero.
+         */
         label: string;
         meta?: unknown;
     }[];
@@ -156,6 +159,9 @@ export declare class Balance {
     get locked(): BalanceFormatter;
     get locks(): {
         amount: BalanceFormatter;
+        /**
+         * Filters this collection to only include balances which are not zero.
+         */
         label: string;
         meta?: unknown;
         includeInTransferable?: boolean | undefined;

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

@@ -69,7 +69,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr974-20230915020916",
+	version: "0.0.0-pr974-20231123032136",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "GPL-3.0-or-later",
@@ -111,10 +111,10 @@ var packageJson = {
 		"@talismn/tsconfig": "workspace:*",
 		"@types/jest": "^27.5.1",
 		"@types/lodash": "^4.14.180",
-		eslint: "^8.4.0",
+		eslint: "^8.52.0",
 		jest: "^28.1.0",
 		"ts-jest": "^28.0.2",
-		typescript: "^4.6.4"
+		typescript: "^5.2.2"
 	},
 	peerDependencies: {
 		"@polkadot/types": "10.x"
@@ -399,6 +399,26 @@ class RpcStateQueryHelper {
   }
 }
 
+/**
+ *
+ * Detect Balances::transfer -> Balances::transfer_allow_death migration
+ * https://github.com/paritytech/substrate/pull/12951
+ *
+ * `transfer_allow_death` is the preferred method,
+ * so if something goes wrong during detection, we should assume the chain has migrated
+ * @param metadataRpc string containing the hashed RPC metadata for the chain
+ * @returns
+ */
+const detectTransferMethod = metadataRpc => {
+  const pjsMetadata = new types.Metadata(new types.TypeRegistry(), metadataRpc);
+  pjsMetadata.registry.setMetadata(pjsMetadata);
+  const balancesPallet = pjsMetadata.asLatest.pallets.find(pallet => pallet.name.eq("Balances"));
+  const balancesCallsTypeIndex = balancesPallet?.calls.value.type.toNumber();
+  const balancesCallsType = balancesCallsTypeIndex !== undefined ? pjsMetadata.asLatest.lookup.types[balancesCallsTypeIndex] : undefined;
+  const hasDeprecatedTransferCall = balancesCallsType?.type.def.asVariant?.variants.find(variant => variant.name.eq("transfer")) !== undefined;
+  return hasDeprecatedTransferCall ? "transfer" : "transferAllowDeath";
+};
+
 /**
  * `BalanceTypes` is an automatically determined sub-selection of `PluginBalanceTypes`.
  *
@@ -690,7 +710,7 @@ class Balance {
   hydrate = hydrate => {
     if (hydrate !== undefined) this.#db = hydrate;
   };
-  #format = balance => new BalanceFormatter(typeof balance === "bigint" ? balance.toString() : balance, this.decimals || undefined, this.#db?.tokenRates && this.#db.tokenRates[this.tokenId]);
+  #format = balance => new BalanceFormatter(util.isBigInt(balance) ? balance.toString() : balance, this.decimals || undefined, this.#db?.tokenRates && this.#db.tokenRates[this.tokenId]);
 
   //
   // Accessors
@@ -823,7 +843,7 @@ class BalanceFormatter {
   #decimals;
   #fiatRatios;
   constructor(planck, decimals, fiatRatios) {
-    this.#planck = typeof planck === "bigint" ? planck.toString() : planck ?? "0";
+    this.#planck = util.isBigInt(planck) ? planck.toString() : planck ?? "0";
     this.#decimals = decimals || 0;
     this.#fiatRatios = fiatRatios || null;
   }
@@ -965,6 +985,7 @@ exports.createTypeRegistryCache = createTypeRegistryCache;
 exports.db = db;
 exports.deleteSubscriptionId = deleteSubscriptionId;
 exports.deriveStatuses = deriveStatuses;
+exports.detectTransferMethod = detectTransferMethod;
 exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
 exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
 exports.filterMirrorTokens = filterMirrorTokens;

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

@@ -69,7 +69,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr974-20230915020916",
+	version: "0.0.0-pr974-20231123032136",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "GPL-3.0-or-later",
@@ -111,10 +111,10 @@ var packageJson = {
 		"@talismn/tsconfig": "workspace:*",
 		"@types/jest": "^27.5.1",
 		"@types/lodash": "^4.14.180",
-		eslint: "^8.4.0",
+		eslint: "^8.52.0",
 		jest: "^28.1.0",
 		"ts-jest": "^28.0.2",
-		typescript: "^4.6.4"
+		typescript: "^5.2.2"
 	},
 	peerDependencies: {
 		"@polkadot/types": "10.x"
@@ -399,6 +399,26 @@ class RpcStateQueryHelper {
   }
 }
 
+/**
+ *
+ * Detect Balances::transfer -> Balances::transfer_allow_death migration
+ * https://github.com/paritytech/substrate/pull/12951
+ *
+ * `transfer_allow_death` is the preferred method,
+ * so if something goes wrong during detection, we should assume the chain has migrated
+ * @param metadataRpc string containing the hashed RPC metadata for the chain
+ * @returns
+ */
+const detectTransferMethod = metadataRpc => {
+  const pjsMetadata = new types.Metadata(new types.TypeRegistry(), metadataRpc);
+  pjsMetadata.registry.setMetadata(pjsMetadata);
+  const balancesPallet = pjsMetadata.asLatest.pallets.find(pallet => pallet.name.eq("Balances"));
+  const balancesCallsTypeIndex = balancesPallet?.calls.value.type.toNumber();
+  const balancesCallsType = balancesCallsTypeIndex !== undefined ? pjsMetadata.asLatest.lookup.types[balancesCallsTypeIndex] : undefined;
+  const hasDeprecatedTransferCall = balancesCallsType?.type.def.asVariant?.variants.find(variant => variant.name.eq("transfer")) !== undefined;
+  return hasDeprecatedTransferCall ? "transfer" : "transferAllowDeath";
+};
+
 /**
  * `BalanceTypes` is an automatically determined sub-selection of `PluginBalanceTypes`.
  *
@@ -690,7 +710,7 @@ class Balance {
   hydrate = hydrate => {
     if (hydrate !== undefined) this.#db = hydrate;
   };
-  #format = balance => new BalanceFormatter(typeof balance === "bigint" ? balance.toString() : balance, this.decimals || undefined, this.#db?.tokenRates && this.#db.tokenRates[this.tokenId]);
+  #format = balance => new BalanceFormatter(util.isBigInt(balance) ? balance.toString() : balance, this.decimals || undefined, this.#db?.tokenRates && this.#db.tokenRates[this.tokenId]);
 
   //
   // Accessors
@@ -823,7 +843,7 @@ class BalanceFormatter {
   #decimals;
   #fiatRatios;
   constructor(planck, decimals, fiatRatios) {
-    this.#planck = typeof planck === "bigint" ? planck.toString() : planck ?? "0";
+    this.#planck = util.isBigInt(planck) ? planck.toString() : planck ?? "0";
     this.#decimals = decimals || 0;
     this.#fiatRatios = fiatRatios || null;
   }
@@ -965,6 +985,7 @@ exports.createTypeRegistryCache = createTypeRegistryCache;
 exports.db = db;
 exports.deleteSubscriptionId = deleteSubscriptionId;
 exports.deriveStatuses = deriveStatuses;
+exports.detectTransferMethod = detectTransferMethod;
 exports.excludeFromFeePayableLocks = excludeFromFeePayableLocks;
 exports.excludeFromTransferableAmount = excludeFromTransferableAmount;
 exports.filterMirrorTokens = filterMirrorTokens;

package/dist/talismn-balances.esm.js

@@ -1,6 +1,6 @@
 import { Dexie } from 'dexie';
-import { decorateStorage, StorageKey, TypeRegistry, Metadata } from '@polkadot/types';
-import { hasOwnProperty, BigMath, isArrayOf, planckToTokens } from '@talismn/util';
+import { decorateStorage, StorageKey, Metadata, TypeRegistry } from '@polkadot/types';
+import { hasOwnProperty, BigMath, isArrayOf, isBigInt, planckToTokens } from '@talismn/util';
 import groupBy from 'lodash/groupBy';
 import anylogger from 'anylogger';
 
@@ -60,7 +60,7 @@ const db = new TalismanBalancesDatabase();
 
 var packageJson = {
 	name: "@talismn/balances",
-	version: "0.0.0-pr974-20230915020916",
+	version: "0.0.0-pr974-20231123032136",
 	author: "Talisman",
 	homepage: "https://talisman.xyz",
 	license: "GPL-3.0-or-later",
@@ -102,10 +102,10 @@ var packageJson = {
 		"@talismn/tsconfig": "workspace:*",
 		"@types/jest": "^27.5.1",
 		"@types/lodash": "^4.14.180",
-		eslint: "^8.4.0",
+		eslint: "^8.52.0",
 		jest: "^28.1.0",
 		"ts-jest": "^28.0.2",
-		typescript: "^4.6.4"
+		typescript: "^5.2.2"
 	},
 	peerDependencies: {
 		"@polkadot/types": "10.x"
@@ -390,6 +390,26 @@ class RpcStateQueryHelper {
   }
 }
 
+/**
+ *
+ * Detect Balances::transfer -> Balances::transfer_allow_death migration
+ * https://github.com/paritytech/substrate/pull/12951
+ *
+ * `transfer_allow_death` is the preferred method,
+ * so if something goes wrong during detection, we should assume the chain has migrated
+ * @param metadataRpc string containing the hashed RPC metadata for the chain
+ * @returns
+ */
+const detectTransferMethod = metadataRpc => {
+  const pjsMetadata = new Metadata(new TypeRegistry(), metadataRpc);
+  pjsMetadata.registry.setMetadata(pjsMetadata);
+  const balancesPallet = pjsMetadata.asLatest.pallets.find(pallet => pallet.name.eq("Balances"));
+  const balancesCallsTypeIndex = balancesPallet?.calls.value.type.toNumber();
+  const balancesCallsType = balancesCallsTypeIndex !== undefined ? pjsMetadata.asLatest.lookup.types[balancesCallsTypeIndex] : undefined;
+  const hasDeprecatedTransferCall = balancesCallsType?.type.def.asVariant?.variants.find(variant => variant.name.eq("transfer")) !== undefined;
+  return hasDeprecatedTransferCall ? "transfer" : "transferAllowDeath";
+};
+
 /**
  * `BalanceTypes` is an automatically determined sub-selection of `PluginBalanceTypes`.
  *
@@ -681,7 +701,7 @@ class Balance {
   hydrate = hydrate => {
     if (hydrate !== undefined) this.#db = hydrate;
   };
-  #format = balance => new BalanceFormatter(typeof balance === "bigint" ? balance.toString() : balance, this.decimals || undefined, this.#db?.tokenRates && this.#db.tokenRates[this.tokenId]);
+  #format = balance => new BalanceFormatter(isBigInt(balance) ? balance.toString() : balance, this.decimals || undefined, this.#db?.tokenRates && this.#db.tokenRates[this.tokenId]);
 
   //
   // Accessors
@@ -814,7 +834,7 @@ class BalanceFormatter {
   #decimals;
   #fiatRatios;
   constructor(planck, decimals, fiatRatios) {
-    this.#planck = typeof planck === "bigint" ? planck.toString() : planck ?? "0";
+    this.#planck = isBigInt(planck) ? planck.toString() : planck ?? "0";
     this.#decimals = decimals || 0;
     this.#fiatRatios = fiatRatios || null;
   }
@@ -939,4 +959,4 @@ class SumBalancesFormatter {
   }
 }
 
-export { Balance, BalanceFormatter, BalanceStatusLive, Balances, DefaultBalanceModule, FiatSumBalancesFormatter, PlanckSumBalancesFormatter, RpcStateQueryHelper, StorageHelper, SumBalancesFormatter, TalismanBalancesDatabase, balances, createSubscriptionId, createTypeRegistryCache, db, deleteSubscriptionId, deriveStatuses, excludeFromFeePayableLocks, excludeFromTransferableAmount, filterMirrorTokens, findChainMeta, getValidSubscriptionIds, includeInTotalExtraAmount };
+export { Balance, BalanceFormatter, BalanceStatusLive, Balances, DefaultBalanceModule, FiatSumBalancesFormatter, PlanckSumBalancesFormatter, RpcStateQueryHelper, StorageHelper, SumBalancesFormatter, TalismanBalancesDatabase, balances, createSubscriptionId, createTypeRegistryCache, db, deleteSubscriptionId, deriveStatuses, detectTransferMethod, excludeFromFeePayableLocks, excludeFromTransferableAmount, filterMirrorTokens, findChainMeta, getValidSubscriptionIds, includeInTotalExtraAmount };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@talismn/balances",
-  "version": "0.0.0-pr974-20230915020916",
+  "version": "0.0.0-pr974-20231123032136",
   "author": "Talisman",
   "homepage": "https://talisman.xyz",
   "license": "GPL-3.0-or-later",
@@ -27,25 +27,25 @@
     "clean": "rm -rf dist && rm -rf .turbo rm -rf node_modules"
   },
   "dependencies": {
-    "@talismn/chain-connector": "0.0.0-pr974-20230915020916",
-    "@talismn/chain-connector-evm": "0.0.0-pr974-20230915020916",
-    "@talismn/chaindata-provider": "0.0.0-pr974-20230915020916",
-    "@talismn/token-rates": "0.0.0-pr974-20230915020916",
-    "@talismn/util": "0.2.0",
+    "@talismn/chain-connector": "0.0.0-pr974-20231123032136",
+    "@talismn/chain-connector-evm": "0.0.0-pr974-20231123032136",
+    "@talismn/chaindata-provider": "0.0.0-pr974-20231123032136",
+    "@talismn/token-rates": "0.0.0-pr974-20231123032136",
+    "@talismn/util": "0.0.0-pr974-20231123032136",
     "anylogger": "^1.0.11",
     "dexie": "^3.2.4",
     "lodash": "4.17.21"
   },
   "devDependencies": {
     "@polkadot/types": "^10.1.4",
-    "@talismn/eslint-config": "0.0.2",
+    "@talismn/eslint-config": "0.0.0-pr974-20231123032136",
     "@talismn/tsconfig": "0.0.2",
     "@types/jest": "^27.5.1",
     "@types/lodash": "^4.14.180",
-    "eslint": "^8.4.0",
+    "eslint": "^8.52.0",
     "jest": "^28.1.0",
     "ts-jest": "^28.0.2",
-    "typescript": "^4.6.4"
+    "typescript": "^5.2.2"
   },
   "peerDependencies": {
     "@polkadot/types": "10.x"