@swapkit/helpers 1.0.4 → 1.1.0

package/package.json

@@ -4,6 +4,7 @@
   "dependencies": {
     "@swapkit/tokens": "1.0.1",
     "ky": "1.4.0",
+    "picocolors": "1.0.1",
     "zod": "3.23.8"
   },
   "files": [
@@ -29,5 +30,5 @@
   },
   "type": "module",
   "types": "./src/index.ts",
-  "version": "1.0.4"
+  "version": "1.1.0"
 }

package/src/helpers/__tests__/asset.test.ts

@@ -174,7 +174,7 @@ describe("getDecimal", () => {
   });
 
   describe("Radix", () => {
-    test(
+    test.todo(
       "returns proper decimal for radix and it's assets",
       async () => {
         const radixDecimal = await getDecimal({ chain: Chain.Radix, symbol: "XRD" });
@@ -218,7 +218,7 @@ describe("assetFromString", () => {
     });
   });
 
-  test("should return the correct object for Radix resource", () => {
+  test.todo("should return the correct object for Radix resource", () => {
     const assetString =
       "XRD.xwBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75";
     const result = assetFromString(assetString);

package/src/helpers/others.ts

@@ -45,7 +45,7 @@ export function wrapWithThrow<T>(fn: () => T, errorKey?: ErrorKeys) {
   }
 }
 
-export const getChainIdentifier = (chain: Chain) => {
+export function getChainIdentifier<T extends Chain>(chain: T) {
   switch (chain) {
     case Chain.THORChain:
       return `${chain}.RUNE`;
@@ -59,4 +59,17 @@ export const getChainIdentifier = (chain: Chain) => {
     default:
       return `${chain}.${chain}`;
   }
-};
+}
+
+const skipWarnings = ["production", "test"].includes(process.env.NODE_ENV || "");
+const warnings = new Set();
+export function warnOnce(condition: boolean, warning: string) {
+  if (!skipWarnings && condition) {
+    if (warnings.has(warning)) {
+      return;
+    }
+
+    warnings.add(warning);
+    console.warn(warning);
+  }
+}

package/src/modules/__tests__/assetValue.test.ts

@@ -42,16 +42,17 @@ describe("AssetValue", () => {
 
       expect(atomDerived.toString()).toBe("THOR.ATOM");
 
-      const radixXWBTC = new AssetValue({
-        identifier:
-          "RADIX.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
-        decimal: 8,
-        value: 11112222,
-      });
-
-      expect(radixXWBTC.toString()).toBe(
-        "RADIX.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
-      );
+      // TODO:
+      // const radixXWBTC = new AssetValue({
+      //   identifier:
+      //     "RADIX.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
+      //   decimal: 8,
+      //   value: 11112222,
+      // });
+
+      // expect(radixXWBTC.toString()).toBe(
+      //   "RADIX.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
+      // )
     });
   });
 
@@ -254,7 +255,7 @@ describe("AssetValue", () => {
       );
     });
 
-    test("creates AssetValue with _ symbol", async () => {
+    test.todo("creates AssetValue with _ symbol", async () => {
       const radixXWBTC = await AssetValue.from({
         asset: "XRD.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
         asyncTokenLookup: true,

package/src/modules/assetValue.ts

@@ -1,3 +1,4 @@
+import { red, yellow } from "picocolors";
 import {
   type CommonAssetString,
   CommonAssetStrings,
@@ -6,6 +7,7 @@ import {
   getDecimal,
   isGasAsset,
 } from "../helpers/asset.ts";
+import { warnOnce } from "../helpers/others.ts";
 import { validateIdentifier } from "../helpers/validators.ts";
 import { BaseDecimal, Chain, type ChainId, ChainToChainId } from "../types/chains.ts";
 import type { TokenNames, TokenTax } from "../types/tokens.ts";
@@ -112,9 +114,7 @@ export class AssetValue extends BigIntArithmetics {
     ...fromAssetOrChain
   }: T & AssetValueFromParams): ConditionalAssetValueReturn<T> {
     const parsedValue = value instanceof BigIntArithmetics ? value.getValue("string") : value;
-
     const isFromChain = "chain" in fromAssetOrChain;
-
     const assetOrChain = isFromChain ? fromAssetOrChain.chain : fromAssetOrChain.asset;
 
     const isFromCommonAssetOrChain =
@@ -126,11 +126,21 @@ export class AssetValue extends BigIntArithmetics {
       : { identifier: assetOrChain, decimal: undefined };
 
     const { chain, isSynthetic } = getAssetInfo(unsafeIdentifier);
+    const token = staticTokensMap.get(unsafeIdentifier.toUpperCase() as TokenNames);
+    const tokenDecimal = token?.decimal || commonAssetDecimal;
+
+    warnOnce(
+      !(asyncTokenLookup || tokenDecimal),
+      yellow(
+        `Couldn't find static decimal for ${red(unsafeIdentifier)} (Using default ${red(BaseDecimal[chain])} decimal as fallback).
+This can result in incorrect calculations and mess with amount sent on transactions.
+You can load static assets by installing @swapkit/tokens package and calling AssetValue.loadStaticAssets()
+or by passing asyncTokenLookup: true to the from() function, which will make it async and return a promise.`,
+      ),
+    );
 
-    const { tax, decimal, identifier } = staticTokensMap.get(
-      unsafeIdentifier.toUpperCase() as TokenNames,
-    ) || {
-      decimal: commonAssetDecimal || BaseDecimal[chain],
+    const { decimal, identifier, tax } = token || {
+      decimal: tokenDecimal || BaseDecimal[chain],
       identifier: unsafeIdentifier,
     };
 

package/src/modules/swapKitError.ts

@@ -10,8 +10,11 @@ const errorCodes = {
   core_plugin_swap_not_found: 10007,
   core_approve_asset_target_invalid: 10008,
   core_explorer_unsupported_chain: 10009,
+  core_verify_message_not_supported: 10010,
   core_chain_halted: 10099,
-
+  /**
+   * Core - Wallet
+   */
   core_wallet_connection_not_found: 10100,
   core_wallet_xdefi_not_installed: 10101,
   core_wallet_evmwallet_not_installed: 10102,
@@ -24,6 +27,7 @@ const errorCodes = {
   core_wallet_keepkey_not_installed: 10109,
   core_wallet_talisman_not_installed: 10110,
   core_wallet_not_keypair_wallet: 10111,
+  core_wallet_sign_message_not_supported: 10110,
   /**
    * Core - Swap
    */
@@ -80,6 +84,7 @@ const errorCodes = {
   wallet_trezor_failed_to_get_address: 20503,
   wallet_talisman_not_enabled: 20601,
   wallet_talisman_not_found: 20602,
+  wallet_polkadot_not_found: 20701,
   /**
    * Chainflip
    */
@@ -105,12 +110,24 @@ const errorCodes = {
    * SwapKit API
    */
   api_v2_invalid_response: 50001,
-
   /**
    * Toolboxes
    */
   toolbox_cosmos_signer_not_defined: 90101,
   toolbox_cosmos_no_accounts_found: 90102,
+  toolbox_cosmos_verify_signature_no_pubkey: 90103,
+  toolbox_evm_no_abi_fragment: 90201,
+  toolbox_evm_no_signer: 90202,
+  toolbox_evm_no_signer_address: 90203,
+  toolbox_evm_no_from_address: 90204,
+  toolbox_evm_no_contract_address: 90205,
+  toolbox_evm_no_fee_data: 90206,
+  toolbox_evm_no_gas_price: 90207,
+  toolbox_evm_no_to_address: 90208,
+  toolbox_evm_invalid_gas_asset_address: 90209,
+  toolbox_evm_provider_not_eip1193_compatible: 90210,
+  toolbox_evm_error_estimating_gas_limit: 90211,
+  toolbox_evm_error_sending_transaction: 90212,
   /**
    * Helpers
    */
@@ -122,6 +139,10 @@ const errorCodes = {
   helpers_invalid_memo_type: 99005,
   helpers_failed_to_switch_network: 99103,
   helpers_not_found_provider: 99200,
+  /**
+   * Anything else
+   */
+  not_implemented: 99999,
 } as const;
 
 export type ErrorKeys = keyof typeof errorCodes;

package/src/types/wallet.ts

@@ -22,6 +22,7 @@ export enum WalletOption {
   OKX = "OKX",
   OKX_MOBILE = "OKX_MOBILE",
   PHANTOM = "PHANTOM",
+  POLKADOT_JS = "POLKADOT_JS",
   RADIX_WALLET = "RADIX_WALLET",
   TREZOR = "TREZOR",
   TALISMAN = "TALISMAN",
@@ -42,11 +43,13 @@ export type ChainWallet = {
   balance: AssetValue[];
   walletType: WalletOption;
   disconnect?: () => void;
+  signMessage?: (message: string) => Promise<string>;
 };
 
 export type EmptyWallet = { [key in Chain]?: unknown };
 export type BaseWallet<T extends EmptyWallet | Record<string, unknown>> = {
-  [key in Chain]: ChainWallet & (T extends EmptyWallet ? T[key] : unknown);
+  [key in Chain]: ChainWallet &
+    (T extends EmptyWallet ? T[key] : T[key] extends ChainWallet ? T[key] : never);
 };
 
 export type EIP6963ProviderInfo = {