@swapkit/core 1.0.0-rc.111 → 1.0.0-rc.113

package/package.json

@@ -1,26 +1,26 @@
 {
   "author": "swapkit-oss",
   "dependencies": {
-    "@swapkit/helpers": "1.0.0-rc.75",
-    "@swapkit/types": "1.0.0-rc.41"
+    "@swapkit/types": "1.0.0-rc.43",
+    "@swapkit/helpers": "1.0.0-rc.77"
   },
   "description": "SwapKit Lib core",
   "devDependencies": {
     "@vitest/coverage-istanbul": "1.3.1",
-    "vite": "5.1.3",
+    "vite": "5.1.6",
     "vitest": "1.3.1",
-    "@swapkit/tokens": "1.0.0-rc.37",
-    "@swapkit/toolbox-cosmos": "1.0.0-rc.92",
-    "@swapkit/toolbox-evm": "1.0.0-rc.81",
-    "@swapkit/toolbox-substrate": "1.0.0-rc.10",
-    "@swapkit/toolbox-utxo": "1.0.0-rc.83"
+    "@swapkit/tokens": "1.0.0-rc.39",
+    "@swapkit/toolbox-cosmos": "1.0.0-rc.94",
+    "@swapkit/toolbox-substrate": "1.0.0-rc.12",
+    "@swapkit/toolbox-utxo": "1.0.0-rc.85",
+    "@swapkit/toolbox-evm": "1.0.0-rc.83"
   },
   "peerDependencies": {
-    "@swapkit/tokens": "1.0.0-rc.37",
-    "@swapkit/toolbox-cosmos": "1.0.0-rc.92",
-    "@swapkit/toolbox-evm": "1.0.0-rc.81",
-    "@swapkit/toolbox-substrate": "1.0.0-rc.10",
-    "@swapkit/toolbox-utxo": "1.0.0-rc.83"
+    "@swapkit/toolbox-cosmos": "1.0.0-rc.94",
+    "@swapkit/toolbox-substrate": "1.0.0-rc.12",
+    "@swapkit/toolbox-evm": "1.0.0-rc.83",
+    "@swapkit/tokens": "1.0.0-rc.39",
+    "@swapkit/toolbox-utxo": "1.0.0-rc.85"
   },
   "exports": {
     ".": {
@@ -45,7 +45,7 @@
   },
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "1.0.0-rc.111",
+  "version": "1.0.0-rc.113",
   "scripts": {
     "build": "NODE_OPTIONS=--max_old_space_size=16384 vite build",
     "clean": "rm -rf dist vite.config.ts.* node_modules",

package/src/client/index.ts

@@ -10,7 +10,8 @@ import type {
   SwapWithRouteParams,
 } from "../types.ts";
 
-export type ProviderName = "thorchain" | "chainflip" | "mayachain";
+export type PluginName = "thorchain" | "chainflip" | "mayachain";
+
 export enum ApproveMode {
   Approve = "approve",
   CheckOnly = "checkOnly",
@@ -20,8 +21,8 @@ export type ApproveReturnType<T extends ApproveMode> = T extends "checkOnly"
   ? Promise<boolean>
   : Promise<string>;
 
-type SwapKitProviders = {
-  [K in ProviderName]?: ProviderMethods;
+type SwapKitPlugins = {
+  [K in PluginName]?: ProviderMethods;
 };
 
 type GenericSwapParams = {
@@ -32,12 +33,12 @@ type GenericSwapParams = {
 
 export type SwapParams = (SwapWithRouteParams | GenericSwapParams) & {
   provider?: {
-    name: ProviderName;
+    name: PluginName;
     config: Record<string, any>;
   };
 };
 
-export type SwapKitReturnType = SwapKitProviders & {
+export type SwapKitReturnType = SwapKitPlugins & {
   getAddress: (chain: Chain) => string;
   getWallet: (chain: Chain) => ChainWallet<Chain> | undefined;
   getWalletWithBalance: (
@@ -60,14 +61,14 @@ export type SwapKitReturnType = SwapKitProviders & {
 };
 
 export type Wallets = { [K in Chain]?: ChainWallet<K> };
-export type AvailableProviders<T> = T | { [K in ProviderName]?: ProviderMethods };
+export type AvailableProviders<T> = T | { [K in PluginName]?: ProviderMethods };
 export type ProviderMethods = {
   swap: (swapParams: SwapParams) => Promise<string>;
   [key: string]: any;
 };
 
-export type SwapKitProvider = ({ wallets, stagenet }: { wallets: Wallets; stagenet?: boolean }) => {
-  name: ProviderName;
+export type SwapKitPlugin = ({ wallets, stagenet }: { wallets: Wallets; stagenet?: boolean }) => {
+  name: PluginName;
   methods: ProviderMethods;
 };
 
@@ -82,12 +83,12 @@ export function SwapKit<
 >({
   stagenet,
   wallets,
-  providers,
+  plugins,
   config = {},
   apis,
   rpcUrls,
 }: {
-  providers: SwapKitProvider[];
+  plugins: SwapKitPlugin[];
   stagenet: boolean;
   wallets: SwapKitWallet[];
   config?: Record<string, any>;
@@ -95,12 +96,12 @@ export function SwapKit<
   rpcUrls: Record<string, any>;
 }): SwapKitReturnType & ConnectWalletMethods & AvailableProviders<ExtendedProviders> {
   const connectedWallets: Wallets = {};
-  const availableProviders: AvailableProviders<ExtendedProviders> = {};
+  const availablePlugins: AvailableProviders<ExtendedProviders> = {};
 
-  for (const provider of providers) {
-    const { name, methods } = provider({ wallets: connectedWallets, stagenet });
+  for (const plugin of plugins) {
+    const { name, methods } = plugin({ wallets: connectedWallets, stagenet });
 
-    availableProviders[name] = methods;
+    availablePlugins[name] = methods;
   }
 
   const connectWalletMethods = wallets.reduce((acc, wallet) => {
@@ -118,19 +119,16 @@ export function SwapKit<
    * @Private
    * Internal helpers
    */
-  function getProvider(providerName?: ProviderName) {
-    const provider =
-      (availableProviders as SwapKitProviders)[providerName as ProviderName] ||
-      Object.values(availableProviders)[0];
-
-    if (!provider) {
-      throw new SwapKitError(
-        "core_swap_provider_not_found",
-        "Could not find the requested provider",
-      );
+  function getSwapKitPlugin(pluginName?: PluginName) {
+    const plugin =
+      (availablePlugins as SwapKitPlugins)[pluginName as PluginName] ||
+      Object.values(availablePlugins)[0];
+
+    if (!plugin) {
+      throw new SwapKitError("core_plugin_not_found", "Could not find the requested plugin");
     }
 
-    return provider;
+    return plugin;
   }
 
   function addChain(connectWallet: ChainWallet<Chain>) {
@@ -233,14 +231,14 @@ export function SwapKit<
     return approve({ assetValue, contractAddress, type: ApproveMode.CheckOnly });
   }
 
-  function swap({ provider: providerConfig, ...rest }: SwapParams) {
-    const provider = getProvider(providerConfig?.name);
+  function swap({ provider, ...rest }: SwapParams) {
+    const plugin = getSwapKitPlugin(provider?.name);
 
-    return provider.swap({ provider: providerConfig, ...rest });
+    return plugin.swap({ provider, ...rest });
   }
 
   return {
-    ...availableProviders,
+    ...availablePlugins,
     ...connectWalletMethods,
     approveAssetValue,
     getAddress,

package/src/client/old.ts

@@ -1,9 +1,4 @@
-import type {
-  ErrorKeys,
-  MayanameRegisterParam,
-  QuoteRoute,
-  ThornameRegisterParam,
-} from "@swapkit/helpers";
+import type { ErrorKeys, QuoteRoute, ThornameRegisterParam } from "@swapkit/helpers";
 import {
   AssetValue,
   SwapKitError,
@@ -337,7 +332,8 @@ export class SwapKitCore<T = ""> {
               getChecksumAddressFromAsset({ chain, symbol, ticker }, chain),
               assetValue.getBaseValue("string"),
               params.memo,
-              rest.expiration || parseInt(`${(new Date().getTime() + 15 * 60 * 1000) / 1000}`),
+              rest.expiration ||
+                Number.parseInt(`${(new Date().getTime() + 15 * 60 * 1000) / 1000}`),
             ],
             txOverrides: {
               from: params.from,
@@ -623,7 +619,7 @@ export class SwapKitCore<T = ""> {
   registerMayaname = ({
     assetValue,
     ...param
-  }: MayanameRegisterParam & { assetValue: AssetValue }) =>
+  }: ThornameRegisterParam & { assetValue: AssetValue }) =>
     this.#mayachainTransfer({
       assetValue,
       memo: getMemoFor(MemoType.THORNAME_REGISTER, param),
@@ -692,39 +688,39 @@ export class SwapKitCore<T = ""> {
   /**
    * Wallet connection methods
    */
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectXDEFI = async (_chains: Chain[]): Promise<void> => {
     throw new SwapKitError("core_wallet_xdefi_not_installed");
   };
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectEVMWallet = async (_chains: Chain[] | Chain, _wallet: EVMWalletOptions): Promise<void> => {
     throw new SwapKitError("core_wallet_evmwallet_not_installed");
   };
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectWalletconnect = async (_chains: Chain[], _options?: any): Promise<void> => {
     throw new SwapKitError("core_wallet_walletconnect_not_installed");
   };
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectKeepkey = async (_chains: Chain[], _derivationPath: number[][]): Promise<string> => {
     throw new SwapKitError("core_wallet_keepkey_not_installed");
   };
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectKeystore = async (_chains: Chain[], _phrase: string): Promise<void> => {
     throw new SwapKitError("core_wallet_keystore_not_installed");
   };
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectLedger = async (_chains: Chain, _derivationPath: number[]): Promise<void> => {
     throw new SwapKitError("core_wallet_ledger_not_installed");
   };
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectTrezor = async (_chains: Chain, _derivationPath: number[]): Promise<void> => {
     throw new SwapKitError("core_wallet_trezor_not_installed");
   };
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectKeplr = async (_chain: Chain): Promise<void> => {
     throw new SwapKitError("core_wallet_keplr_not_installed");
   };
-  // biome-ignore lint/nursery/useAwait: Extended methods
+  // biome-ignore lint/suspicious/useAwait: Extended methods
   connectOkx = async (_chains: Chain[]): Promise<void> => {
     throw new SwapKitError("core_wallet_okx_not_installed");
   };
@@ -816,7 +812,7 @@ export class SwapKitCore<T = ""> {
       router,
       address: poolAddress,
     } = await this.#getInboundDataByChain(assetValue.chain);
-    const feeRate = (parseInt(gas_rate) || 0) * gasFeeMultiplier[feeOptionKey];
+    const feeRate = (Number.parseInt(gas_rate) || 0) * gasFeeMultiplier[feeOptionKey];
 
     return this.deposit({
       assetValue,