@swapkit/helpers 1.0.0-rc.115 → 1.0.0-rc.116

package/package.json

@@ -2,7 +2,7 @@
   "author": "swapkit-oss",
   "description": "SwapKit - Helpers",
   "dependencies": {
-    "@swapkit/tokens": "1.0.0-rc.57",
+    "@swapkit/tokens": "undefined",
     "ky": "1.3.0",
     "zod": "3.23.8"
   },
@@ -29,5 +29,5 @@
   },
   "type": "module",
   "types": "./src/index.ts",
-  "version": "1.0.0-rc.115"
+  "version": "1.0.0-rc.116"
 }

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

@@ -34,7 +34,7 @@ describe("getTHORNameCost", () => {
   });
 
   test("throws an error for negative years", () => {
-    expect(() => getTHORNameCost(-1)).toThrow("Invalid number of year");
+    expect(() => getTHORNameCost(-1)).toThrow("helpers_invalid_number_of_years");
   });
 });
 

package/src/helpers/memo.ts

@@ -1,3 +1,4 @@
+import { SwapKitError } from "../modules/swapKitError";
 import { Chain } from "../types/chains";
 import { MemoType } from "../types/sdk";
 
@@ -195,6 +196,9 @@ export const getMemoFor = <T extends MemoType>(memoType: T, options: MemoOptions
     }
 
     default:
-      throw new Error(`Unsupported memo type: ${memoType}`);
+      throw new SwapKitError({
+        errorKey: "helpers_invalid_memo_type",
+        info: { memoType },
+      });
   }
 };

package/src/helpers/others.ts

@@ -5,14 +5,22 @@ import type { DerivationPathArray } from "../types/derivationPath";
 // 10 rune for register, 1 rune per year
 // MINIMUM_REGISTRATION_FEE = 11
 export function getTHORNameCost(numberOfYears: number) {
-  if (numberOfYears < 0) throw new Error("Invalid number of years");
+  if (numberOfYears < 0)
+    throw new SwapKitError({
+      errorKey: "helpers_invalid_number_of_years",
+      info: { numberOfYears },
+    });
   return 10 + numberOfYears;
 }
 
 // 10 CACAO for register
 // 1.0512 CACAO per year
 export function getMAYANameCost(numberOfYears: number) {
-  if (numberOfYears < 0) throw new Error("Invalid number of year");
+  if (numberOfYears < 0)
+    throw new SwapKitError({
+      errorKey: "helpers_invalid_number_of_years",
+      info: { numberOfYears },
+    });
   // round to max 10 decimals
   return Math.round((10 + numberOfYears * 1.0512) * 1e10) / 1e10;
 }

package/src/helpers/validators.ts

@@ -1,3 +1,4 @@
+import { SwapKitError } from "../modules/swapKitError";
 import { Chain } from "../types/chains";
 
 // Backward compatibility
@@ -12,9 +13,13 @@ export function validateIdentifier(identifier = "") {
   const [synthChain] = uppercasedIdentifier.split("/") as [Chain, string];
   if (supportedChains.includes(synthChain)) return true;
 
-  throw new Error(
-    `Invalid identifier: ${identifier}. Expected format: <Chain>.<Ticker> or <Chain>.<Ticker>-<ContractAddress>`,
-  );
+  throw new SwapKitError({
+    errorKey: "helpers_invalid_identifier",
+    info: {
+      message: `Invalid identifier: ${identifier}. Expected format: <Chain>.<Ticker> or <Chain>.<Ticker>-<ContractAddress>`,
+      identifier,
+    },
+  });
 }
 
 export function validateTNS(name: string) {

package/src/helpers/web3wallets.ts

@@ -1,4 +1,5 @@
 import type { BrowserProvider } from "ethers";
+import { SwapKitError } from "../modules/swapKitError";
 import {
   ChainId,
   type EIP6963AnnounceProviderEvent,
@@ -85,13 +86,18 @@ export const wrapMethodWithNetworkSwitch = <T extends (...args: Todo[]) => Todo>
     try {
       await switchEVMWalletNetwork(provider, chainId);
     } catch (error) {
-      throw new Error(`Failed to switch network: ${error}`);
+      throw new SwapKitError({
+        errorKey: "helpers_failed_to_switch_network",
+        info: { error },
+      });
     }
     return func(...args);
   }) as unknown as T;
 
 const providerRequest = ({ provider, params, method }: ProviderRequestParams) => {
-  if (!provider?.send) throw new Error("Provider not found");
+  if (!provider?.send) {
+    throw new SwapKitError("helpers_not_found_provider");
+  }
 
   const providerParams = params ? (Array.isArray(params) ? params : [params]) : [];
   return provider.send(method, providerParams);

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

@@ -411,8 +411,8 @@ describe("AssetValue", () => {
           decimal: 8,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "BTC.b-0x152b9d0fdc40c096757f570a51e494bd4b943e50",
-          ticker: "BTC.b",
+          symbol: "BTC.B-0x152b9d0fdc40c096757f570a51e494bd4b943e50",
+          ticker: "BTC.B",
         }),
       );
     });

package/src/modules/assetValue.ts

@@ -6,6 +6,7 @@ import type { TokenNames, TokenTax } from "../types/tokens.ts";
 
 import type { NumberPrimitives } from "./bigIntArithmetics.ts";
 import { BigIntArithmetics, formatBigIntToSafeValue } from "./bigIntArithmetics.ts";
+import { SwapKitError } from "./swapKitError.ts";
 import { SwapKitNumber, type SwapKitValueType } from "./swapKitNumber.ts";
 
 const staticTokensMap = new Map<
@@ -71,7 +72,12 @@ export class AssetValue extends BigIntArithmetics {
   // ETH.THOR-0x1234567890
   static fromUrl(urlAsset: string, value: NumberPrimitives = 0) {
     const [chain, ticker, symbol] = urlAsset.split(".");
-    if (!(chain && ticker)) throw new Error("Invalid asset url");
+    if (!(chain && ticker)) {
+      throw new SwapKitError({
+        errorKey: "helpers_invalid_asset_url",
+        info: { urlAsset },
+      });
+    }
 
     const assetString =
       chain === Chain.THORChain && symbol ? `${chain}.${ticker}/${symbol}` : urlAsset;
@@ -83,11 +89,7 @@ export class AssetValue extends BigIntArithmetics {
     return createAssetValue(assetString, value);
   }
   static fromIdentifier(
-    assetString:
-      | `${Chain}.${string}`
-      | `${Chain}/${string}`
-      | `${Chain}.${string}-${string}`
-      | TokenNames,
+    assetString: `${Chain}.${string}` | `${Chain}/${string}` | TokenNames,
     value: NumberPrimitives = 0,
   ) {
     return createAssetValue(assetString, value);
@@ -128,7 +130,7 @@ export class AssetValue extends BigIntArithmetics {
       from: 0,
       to: baseDecimal,
     }).getBaseValue("string");
-    const assetValue = await AssetValue.fromString(assetString, value);
+    const assetValue = await AssetValue.fromString(assetString);
 
     return assetValue.set(shiftedAmount);
   }
@@ -257,7 +259,12 @@ function createSyntheticAssetValue(identifier: string, value: NumberPrimitives =
       ? identifier.split(".").slice(1).join().split("/")
       : identifier.split("/");
 
-  if (!(synthChain && symbol)) throw new Error("Invalid asset identifier");
+  if (!(synthChain && symbol)) {
+    throw new SwapKitError({
+      errorKey: "helpers_invalid_asset_identifier",
+      info: { identifier },
+    });
+  }
 
   return new AssetValue({
     decimal: 8,
@@ -284,7 +291,12 @@ function getAssetInfo(identifier: string) {
       ? identifier.split(".").slice(1).join().split("/")
       : identifier.split("/");
 
-  if (isSynthetic && !(synthChain && synthSymbol)) throw new Error("Invalid asset identifier");
+  if (isSynthetic && !(synthChain && synthSymbol)) {
+    throw new SwapKitError({
+      errorKey: "helpers_invalid_asset_identifier",
+      info: { identifier },
+    });
+  }
 
   const adjustedIdentifier =
     identifier.includes(".") && !isSynthetic

package/src/modules/swapKitError.ts

@@ -1,8 +1,7 @@
-const errorMessages = {
+const errorCodes = {
   /**
    * Core
    */
-  core_wallet_connection_not_found: 10001,
   core_estimated_max_spendable_chain_not_supported: 10002,
   core_extend_error: 10003,
   core_inbound_data_not_found: 10004,
@@ -10,10 +9,10 @@ const errorMessages = {
   core_plugin_not_found: 10006,
   core_plugin_swap_not_found: 10007,
   core_approve_asset_target_invalid: 10008,
+  core_explorer_unsupported_chain: 10009,
   core_chain_halted: 10099,
-  /**
-   * Core - Wallet Connection
-   */
+
+  core_wallet_connection_not_found: 10100,
   core_wallet_xdefi_not_installed: 10101,
   core_wallet_evmwallet_not_installed: 10102,
   core_wallet_walletconnect_not_installed: 10103,
@@ -56,40 +55,86 @@ const errorMessages = {
    * Wallets
    */
   wallet_connection_rejected_by_user: 20000,
-  wallet_ledger_connection_error: 20001,
-  wallet_ledger_connection_claimed: 20002,
-  wallet_ledger_get_address_error: 20003,
-  wallet_ledger_device_not_found: 20004,
-  wallet_ledger_device_locked: 20005,
-  wallet_phantom_not_found: 20101,
-  wallet_xdefi_not_found: 20201,
-  wallet_xdefi_failed_to_add_or_switch_network: 20202,
+  wallet_missing_api_key: 20001,
+  wallet_chain_not_supported: 20002,
+  wallet_missing_params: 20003,
+  wallet_provider_not_found: 20004,
+  wallet_failed_to_add_or_switch_network: 20005,
+  wallet_ledger_connection_error: 20101,
+  wallet_ledger_connection_claimed: 20102,
+  wallet_ledger_get_address_error: 20103,
+  wallet_ledger_device_not_found: 20104,
+  wallet_ledger_device_locked: 20105,
+  wallet_phantom_not_found: 20201,
+  wallet_xdefi_not_found: 20301,
+  wallet_xdefi_send_transaction_no_address: 20302,
+  wallet_xdefi_contract_address_not_provided: 20303,
+  wallet_xdefi_asset_not_defined: 20304,
+  wallet_walletconnect_project_id_not_specified: 20401,
+  wallet_walletconnect_connection_not_established: 20402,
+  wallet_walletconnect_namespace_not_supported: 20403,
+  wallet_trezor_failed_to_sign_transaction: 20501,
+  wallet_trezor_derivation_path_not_supported: 20502,
+  wallet_trezor_failed_to_get_address: 20503,
+  wallet_talisman_not_enabled: 20601,
+  wallet_talisman_not_found: 20602,
   /**
    * Chainflip
    */
   chainflip_channel_error: 30001,
-  chainflip_broker_recipient_error: 30002,
-  chainflip_unknown_asset: 30003,
+  chainflip_unknown_asset: 30002,
+  chainflip_broker_invalid_params: 30100,
+  chainflip_broker_recipient_error: 30101,
+  chainflip_broker_register: 30102,
+  chainflip_broker_tx_error: 30103,
+  chainflip_broker_withdraw: 30104,
+  chainflip_broker_fund_only_flip_supported: 30105,
+  chainflip_broker_fund_invalid_address: 30106,
   /**
    * THORChain
    */
   thorchain_chain_halted: 40001,
   thorchain_trading_halted: 40002,
+  thorchain_swapin_router_required: 40100,
+  thorchain_swapin_vault_required: 40101,
+  thorchain_swapin_memo_required: 40102,
+  thorchain_swapin_token_required: 40103,
   /**
    * SwapKit API
    */
   api_v2_invalid_response: 50001,
 
+  /**
+   * Toolboxes
+   */
+  toolbox_cosmos_signer_not_defined: 90101,
+  toolbox_cosmos_no_accounts_found: 90102,
   /**
    * Helpers
    */
-  helpers_number_different_decimals: 99001,
+  helpers_invalid_number_different_decimals: 99000,
+  helpers_invalid_number_of_years: 99001,
+  helpers_invalid_identifier: 99002,
+  helpers_invalid_asset_url: 99003,
+  helpers_invalid_asset_identifier: 99004,
+  helpers_invalid_memo_type: 99005,
+  helpers_failed_to_switch_network: 99103,
+  helpers_not_found_provider: 99200,
 } as const;
 
-export type ErrorKeys = keyof typeof errorMessages;
+export type ErrorKeys = keyof typeof errorCodes;
 
 export class SwapKitError extends Error {
-  constructor(errorKey: ErrorKeys, sourceError?: NotWorth) {
+  static ErrorCode = errorCodes;
+
+  constructor(
+    errorOrErrorKey: ErrorKeys | { errorKey: ErrorKeys; info?: Record<string, NotWorth> },
+    sourceError?: NotWorth,
+  ) {
+    const isErrorString = typeof errorOrErrorKey === "string";
+
+    const errorKey = isErrorString ? errorOrErrorKey : errorOrErrorKey.errorKey;
+
     if (sourceError) {
       console.error(sourceError, {
         stack: sourceError?.stack,
@@ -98,8 +143,12 @@ export class SwapKitError extends Error {
     }
 
     super(errorKey, {
-      cause: { code: errorMessages[errorKey], message: errorKey },
+      cause: {
+        code: SwapKitError.ErrorCode[errorKey],
+        message: `${errorKey}${isErrorString ? "" : `: ${JSON.stringify(errorOrErrorKey.info)}`}`,
+      },
     });
+
     Object.setPrototypeOf(this, SwapKitError.prototype);
   }
 }