@swapkit/helpers 1.0.4 → 1.1.1

package/package.json

@@ -2,10 +2,19 @@
   "author": "swapkit-oss",
   "description": "SwapKit - Helpers",
   "dependencies": {
-    "@swapkit/tokens": "1.0.1",
+    "@swapkit/tokens": "1.0.2",
     "ky": "1.4.0",
+    "picocolors": "1.0.1",
     "zod": "3.23.8"
   },
+  "devDependencies": {
+    "@swapkit/toolbox-cosmos": "1.0.6",
+    "@swapkit/toolbox-evm": "1.1.1",
+    "@swapkit/toolbox-solana": "1.0.6",
+    "@swapkit/toolbox-radix": "1.0.6",
+    "@swapkit/toolbox-substrate": "1.1.1",
+    "@swapkit/toolbox-utxo": "1.0.6"
+  },
   "files": [
     "src/",
     "dist/"
@@ -29,5 +38,5 @@
   },
   "type": "module",
   "types": "./src/index.ts",
-  "version": "1.0.4"
+  "version": "1.1.1"
 }

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/__tests__/derivationPath.ts

@@ -0,0 +1,16 @@
+import { describe, expect, test } from "bun:test";
+
+import type { DerivationPathArray } from "../../types";
+import { derivationPathToString } from "../derivationPath";
+
+describe("derivationPathToString", () => {
+  test("should return the correct string for a full path", () => {
+    const path = [1, 2, 3, 4, 5] as DerivationPathArray;
+    expect(derivationPathToString(path)).toEqual("m/1'/2'/3'/4/5");
+  });
+
+  test("should return the correct string for a short path", () => {
+    const path = [1, 2, 3, 4] as DerivationPathArray;
+    expect(derivationPathToString(path)).toEqual("m/1'/2'/3'/4");
+  });
+});

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

@@ -4,6 +4,7 @@ import { Chain, MemoType } from "../../types";
 import {
   getMemoForDeposit,
   getMemoForLeaveAndBond,
+  getMemoForNamePreferredAssetRegister,
   getMemoForNameRegister,
   getMemoForSaverDeposit,
   getMemoForSaverWithdraw,
@@ -52,6 +53,21 @@ describe("getMemoForNameRegister", () => {
   });
 });
 
+describe("getMemoForNamePreferredAssetRegister", () => {
+  test("returns correct memo for single side", () => {
+    const result = getMemoForNamePreferredAssetRegister({
+      name: "asdfg",
+      chain: Chain.Ethereum,
+      owner: "thor1234",
+      asset: "ETH.USDC-0XA0B86991C6218B36C1D19D4A2E9EB0CE3606EB48",
+      payout: "0x6621d872f17109d6601c49edba526ebcfd332d5d",
+    });
+    expect(result).toBe(
+      "~:asdfg:ETH:0x6621d872f17109d6601c49edba526ebcfd332d5d:thor1234:ETH.USDC-0XA0B86991C6218B36C1D19D4A2E9EB0CE3606EB48",
+    );
+  });
+});
+
 describe("getMemoForDeposit", () => {
   test("returns correct memo for single side", () => {
     const result = getMemoForDeposit({ chain: Chain.Ethereum, symbol: "ETH" });

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

@@ -1,20 +1,8 @@
 import { describe, expect, test } from "bun:test";
-import { Chain, type DerivationPathArray } from "../../types";
+import { Chain } from "../../types";
 
 import { findAssetBy } from "../asset.ts";
-import { derivationPathToString, getTHORNameCost } from "../others.ts";
-
-describe("derivationPathToString", () => {
-  test("should return the correct string for a full path", () => {
-    const path = [1, 2, 3, 4, 5] as DerivationPathArray;
-    expect(derivationPathToString(path)).toEqual("m/1'/2'/3'/4/5");
-  });
-
-  test("should return the correct string for a short path", () => {
-    const path = [1, 2, 3, 4] as DerivationPathArray;
-    expect(derivationPathToString(path)).toEqual("m/1'/2'/3'/4");
-  });
-});
+import { getTHORNameCost } from "../others.ts";
 
 describe("getTHORNameCost", () => {
   describe("for correct values", () => {

package/src/helpers/asset.ts

@@ -8,6 +8,10 @@ const getDecimalMethodHex = "0x313ce567";
 
 export type CommonAssetString = (typeof CommonAssetStrings)[number] | Chain;
 
+export type ConditionalAssetValueReturn<T extends boolean> = T extends true
+  ? Promise<AssetValue[]>
+  : AssetValue[];
+
 export const CommonAssetStrings = [
   `${Chain.Maya}.MAYA`,
   `${Chain.Ethereum}.THOR`,

package/src/helpers/derivationPath.ts

@@ -13,28 +13,38 @@ type Params = {
   type?: "legacy" | "ledgerLive" | "nativeSegwitMiddleAccount" | "segwit";
 };
 
-const updatedLastIndex = (path: DerivationPathArray, index: number) => [
-  ...path.slice(0, path.length - 1),
-  index,
-];
+const updatedLastIndex = (path: DerivationPathArray, index: number) => {
+  const newPath = [...path.slice(0, path.length - 1), index];
+  return newPath as DerivationPathArray;
+};
+
+export function derivationPathToString([network, chainId, account, change, index]:
+  | [number, number, number, number, number | undefined]
+  | DerivationPathArray) {
+  const shortPath = typeof index !== "number";
+
+  return `m/${network}'/${chainId}'/${account}'/${change}${shortPath ? "" : `/${index}`}`;
+}
 
 export function getDerivationPathFor({ chain, index, addressIndex = 0, type }: Params) {
   if (EVMChains.includes(chain as EVMChain)) {
-    if (type === "legacy") return [44, 60, 0, index];
-    if (type === "ledgerLive") return [44, 60, index, 0, addressIndex];
+    if (type === "legacy") return [44, 60, 0, index] as DerivationPathArray;
+    if (type === "ledgerLive") return [44, 60, index, 0, addressIndex] as DerivationPathArray;
     return updatedLastIndex(NetworkDerivationPath[chain], index);
   }
 
-  if ([Chain.Bitcoin, Chain.Litecoin].includes(chain)) {
-    const chainId = chain === Chain.Bitcoin ? 0 : 2;
+  const chainId = chain === Chain.Litecoin ? 2 : 0;
 
-    if (type === "nativeSegwitMiddleAccount") return [84, chainId, index, 0, addressIndex];
-    if (type === "segwit") return [49, chainId, 0, 0, index];
-    if (type === "legacy") return [44, chainId, 0, 0, index];
-    return updatedLastIndex(NetworkDerivationPath[chain], index);
+  switch (type) {
+    case "nativeSegwitMiddleAccount":
+      return [84, chainId, index, 0, addressIndex] as DerivationPathArray;
+    case "segwit":
+      return [49, chainId, 0, 0, index] as DerivationPathArray;
+    case "legacy":
+      return [44, chainId, 0, 0, index] as DerivationPathArray;
+    default:
+      return updatedLastIndex(NetworkDerivationPath[chain], index);
   }
-
-  return updatedLastIndex(NetworkDerivationPath[chain], index);
 }
 
 export function getWalletFormatFor(path: string) {

package/src/helpers/memo.ts

@@ -72,6 +72,24 @@ export function getMemoForNameRegister({
   return `${baseMemo}${ownerAssignmentOrChangePart}`;
 }
 
+export function getMemoForNamePreferredAssetRegister({
+  name,
+  chain,
+  asset,
+  payout,
+  owner,
+}: {
+  name: string;
+  chain: Chain;
+  asset: string;
+  payout: string;
+  owner: string;
+}) {
+  const memo = [name, chain, payout, owner, asset].join(":");
+
+  return `${MemoType.NAME_REGISTER}:${memo}`;
+}
+
 export function getMemoForLoan(
   memoType: MemoType.OPEN_LOAN | MemoType.CLOSE_LOAN,
   {

package/src/helpers/others.ts

@@ -1,6 +1,5 @@
 import { type ErrorKeys, SwapKitError } from "../modules/swapKitError";
 import { Chain } from "../types";
-import type { DerivationPathArray } from "../types/derivationPath";
 
 // 10 rune for register, 1 rune per year
 // MINIMUM_REGISTRATION_FEE = 11
@@ -25,14 +24,6 @@ export function getMAYANameCost(numberOfYears: number) {
   return Math.round((10 + numberOfYears * 1.0512) * 1e10) / 1e10;
 }
 
-export function derivationPathToString([network, chainId, account, change, index]:
-  | [number, number, number, number, number | undefined]
-  | DerivationPathArray) {
-  const shortPath = typeof index !== "number";
-
-  return `m/${network}'/${chainId}'/${account}'/${change}${shortPath ? "" : `/${index}`}`;
-}
-
 export function wrapWithThrow<T>(fn: () => T, errorKey?: ErrorKeys) {
   try {
     return fn();
@@ -45,7 +36,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 +50,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/helpers/web3wallets.ts

@@ -28,15 +28,6 @@ declare const window: {
   braveSolana: Todo;
 } & Window;
 
-// declare global {
-//   interface Window {
-//     ethereum: EthereumWindowProvider;
-//     trustwallet: EthereumWindowProvider;
-//     coinbaseWalletExtension: EthereumWindowProvider;
-//     braveSolana: Todo;
-//   }
-// }
-
 type NetworkParams = {
   chainId: ChainId;
   chainName: string;

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/commonTypes.ts

@@ -1,6 +1,5 @@
-import type { AssetValue } from "../modules/assetValue.ts";
 import type { Chain, CosmosChain, EVMChain, UTXOChain } from "./chains.ts";
-import type { WalletOption } from "./wallet.ts";
+import type { ChainWallet } from "./wallet.ts";
 
 export type ConnectConfig = {
   stagenet?: boolean;
@@ -49,22 +48,14 @@ export type ConnectConfig = {
   chainflipBrokerUrl?: string;
 };
 
-export type AddChainWalletParams<T extends Chain> = {
-  address: string;
-  balance: AssetValue[];
-  walletType: WalletOption;
-  chain: T;
-  [key: string]: Todo;
-};
-
 type ApisType = { [key in UTXOChain]?: string | Todo } & {
   [key in EVMChain]?: string | Todo;
 } & {
   [key in CosmosChain]?: string;
 };
 
-export type ConnectWalletParams = {
-  addChain: <T extends Chain>(params: AddChainWalletParams<T>) => void;
+export type ConnectWalletParams<M = { [key in string]: NotWorth }> = {
+  addChain: <T extends Chain>(params: ChainWallet<T> & M) => void;
   apis: ApisType;
   config: ConnectConfig;
   rpcUrls: { [chain in Chain]?: string };

package/src/types/sdk.ts

@@ -1,7 +1,24 @@
+import type { CovalentApiType, EthplorerApiType } from "@swapkit/toolbox-evm";
+import type { BlockchairApiType } from "@swapkit/toolbox-utxo";
 import { z } from "zod";
+
 import type { AssetValue } from "../modules/assetValue";
+import type { Chain, CosmosChain, UTXOChain } from "./chains";
 import type { QuoteResponseRoute } from "./quotes";
 
+type CovalentChains =
+  | Chain.BinanceSmartChain
+  | Chain.Polygon
+  | Chain.Avalanche
+  | Chain.Arbitrum
+  | Chain.Optimism;
+
+export type ChainApis = { [key in CovalentChains]?: CovalentApiType } & {
+  [key in Chain.Ethereum]?: EthplorerApiType;
+} & { [key in CosmosChain]?: Todo } & {
+  [key in UTXOChain]?: BlockchairApiType;
+};
+
 export type GenericSwapParams = {
   buyAsset?: AssetValue;
   sellAsset?: AssetValue;
@@ -37,10 +54,10 @@ export type WalletTxParams = {
 };
 
 export enum MemoType {
+  NAME_REGISTER = "~",
   BOND = "BOND",
   DEPOSIT = "+",
   LEAVE = "LEAVE",
-  NAME_REGISTER = "~",
   UNBOND = "UNBOND",
   WITHDRAW = "-",
   OPEN_LOAN = "$+",

package/src/types/wallet.ts

@@ -1,6 +1,13 @@
+import type { CosmosWallets, ThorchainWallets } from "@swapkit/toolbox-cosmos";
+import type { EVMWallets } from "@swapkit/toolbox-evm";
+import type { SolanaWallet } from "@swapkit/toolbox-solana";
+import type { SubstrateWallets } from "@swapkit/toolbox-substrate";
+import type { UTXOWallets } from "@swapkit/toolbox-utxo";
 import type { Eip1193Provider } from "ethers";
+
 import type { AssetValue } from "../modules/assetValue";
 import type { Chain } from "./chains";
+import type { ConnectWalletParams } from "./commonTypes";
 
 declare global {
   interface WindowEventMap {
@@ -8,6 +15,8 @@ declare global {
   }
 }
 
+export type { CosmosWallets, ThorchainWallets, EVMWallets, SubstrateWallets, UTXOWallets };
+
 export enum WalletOption {
   BRAVE = "BRAVE",
   COINBASE_MOBILE = "COINBASE_MOBILE",
@@ -22,6 +31,7 @@ export enum WalletOption {
   OKX = "OKX",
   OKX_MOBILE = "OKX_MOBILE",
   PHANTOM = "PHANTOM",
+  POLKADOT_JS = "POLKADOT_JS",
   RADIX_WALLET = "RADIX_WALLET",
   TREZOR = "TREZOR",
   TALISMAN = "TALISMAN",
@@ -36,17 +46,37 @@ export enum LedgerErrorCode {
   TC_NotFound = 65535,
 }
 
-export type ChainWallet = {
-  chain: Chain;
+export type ChainWallet<T extends Chain> = {
+  chain: T;
   address: string;
   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<key> & (T extends EmptyWallet ? T[key] : never);
+};
+
+export type FullWallet = BaseWallet<
+  EVMWallets & UTXOWallets & CosmosWallets & ThorchainWallets & SubstrateWallets & SolanaWallet
+>;
+
+/**
+ * @deprecated use FullWallet instead
+ */
+export type Wallet = FullWallet;
+
+export type SwapKitWallet<ConnectParams extends Todo[]> = (
+  params: ConnectWalletParams,
+) => (...connectParams: ConnectParams) => boolean | Promise<boolean>;
+
+export type SwapKitPluginParams<Config = {}> = {
+  getWallet: <T extends Chain>(chain: T) => FullWallet[T];
+  stagenet?: boolean;
+  config: Config;
 };
 
 export type EIP6963ProviderInfo = {