@swapkit/core 1.0.0-rc.121 → 1.0.0-rc.122

package/package.json

@@ -1,26 +1,21 @@
 {
   "author": "swapkit-oss",
   "dependencies": {
-    "@swapkit/helpers": "1.0.0-rc.85",
-    "@swapkit/types": "1.0.0-rc.49"
+    "@swapkit/api": "1.0.0-rc.51",
+    "@swapkit/helpers": "1.0.0-rc.86"
   },
   "description": "SwapKit - Core",
   "devDependencies": {
-    "@swapkit/tokens": "1.0.0-rc.46",
-    "@swapkit/toolbox-cosmos": "1.0.0-rc.102",
-    "@swapkit/toolbox-evm": "1.0.0-rc.91",
-    "@swapkit/toolbox-substrate": "1.0.0-rc.20",
-    "@swapkit/toolbox-utxo": "1.0.0-rc.93",
-    "bun-types": "1.1.1"
+    "@swapkit/tokens": "1.0.0-rc.47",
+    "@swapkit/toolbox-cosmos": "1.0.0-rc.103",
+    "@swapkit/toolbox-evm": "1.0.0-rc.92",
+    "@swapkit/toolbox-substrate": "1.0.0-rc.21",
+    "@swapkit/toolbox-utxo": "1.0.0-rc.94",
+    "bun-types": "1.1.2"
   },
   "peerDependencies": {
-    "@swapkit/helpers": "1.0.0-rc.85",
-    "@swapkit/tokens": "1.0.0-rc.46",
-    "@swapkit/toolbox-cosmos": "1.0.0-rc.102",
-    "@swapkit/toolbox-evm": "1.0.0-rc.91",
-    "@swapkit/toolbox-substrate": "1.0.0-rc.20",
-    "@swapkit/toolbox-utxo": "1.0.0-rc.93",
-    "@swapkit/types": "1.0.0-rc.49"
+    "@swapkit/api": "1.0.0-rc.51",
+    "@swapkit/helpers": "1.0.0-rc.86"
   },
   "files": [
     "src/",
@@ -37,7 +32,7 @@
   },
   "scripts": {
     "build": "bun run ./build.ts",
-    "clean": "rm -rf .turbo dist node_modules tsconfig.tsbuildinfo",
+    "clean": "rm -rf .turbo dist node_modules *.tsbuildinfo",
     "lint": "biome check --apply ./src",
     "test": "echo 'bun test'",
     "test:coverage": "echo 'bun test --coverage'",
@@ -45,5 +40,5 @@
   },
   "type": "module",
   "types": "./src/index.ts",
-  "version": "1.0.0-rc.121"
+  "version": "1.0.0-rc.122"
 }

package/src/__tests__/helpers.test.ts

@@ -1,5 +1,5 @@
 import { describe, expect, test } from "bun:test";
-import { Chain, ChainToExplorerUrl, CosmosChains, EVMChains, UTXOChains } from "@swapkit/types";
+import { Chain, ChainToExplorerUrl, CosmosChains, EVMChains, UTXOChains } from "@swapkit/helpers";
 import { getExplorerAddressUrl, getExplorerTxUrl } from "../helpers/explorerUrls.ts";
 
 describe("Explorer URLs", () => {

package/src/aggregator/getSwapParams.ts

@@ -1,4 +1,4 @@
-import type { QuoteRoute } from "@swapkit/helpers";
+import type { QuoteRoute } from "@swapkit/api";
 
 import type { AGG_CONTRACT_ADDRESS } from "./contracts/index.ts";
 import { lowercasedGenericAbiMappings } from "./contracts/index.ts";

package/src/{client/index.ts → client.ts}

@@ -1,51 +1,32 @@
-import { AssetValue, SwapKitError } from "@swapkit/helpers";
-import { Chain } from "@swapkit/types";
+import {
+  ApproveMode,
+  type ApproveReturnType,
+  AssetValue,
+  type AvailableProviders,
+  type BaseWallet,
+  Chain,
+  type ChainWallet,
+  type PluginName,
+  SwapKitError,
+  type SwapKitPlugin,
+  type SwapKitPlugins,
+  type SwapParams,
+} from "@swapkit/helpers";
+import type { CosmosWallets, ThorchainWallets } from "@swapkit/toolbox-cosmos";
+import type { BaseEVMWallet, EVMWallets } from "@swapkit/toolbox-evm";
+import type { SubstrateWallets } from "@swapkit/toolbox-substrate";
+import type { UTXOWallets } from "@swapkit/toolbox-utxo";
 import {
   getExplorerAddressUrl as getAddressUrl,
   getExplorerTxUrl as getTxUrl,
-} from "../helpers/explorerUrls.ts";
-import type {
-  ChainWallet,
-  ConnectWalletParamsLocal as ConnectWalletParams,
-  SwapWithRouteParams,
-} from "../types.ts";
-
-export type PluginName = "thorchain" | "chainflip" | "mayachain";
-
-export enum ApproveMode {
-  Approve = "approve",
-  CheckOnly = "checkOnly",
-}
-
-export type ApproveReturnType<T extends ApproveMode> = T extends "checkOnly"
-  ? Promise<boolean>
-  : Promise<string>;
-
-type SwapKitPlugins = {
-  [K in PluginName]?: ProviderMethods;
-};
-
-type GenericSwapParams = {
-  buyAsset: AssetValue;
-  sellAsset: AssetValue;
-  recipient: string;
-};
-
-export type SwapParams = (SwapWithRouteParams | GenericSwapParams) & {
-  provider?: {
-    name: PluginName;
-    config: Record<string, Todo>;
-  };
-};
+} from "./helpers/explorerUrls.ts";
+import type { ConnectWalletParamsLocal as ConnectWalletParams } from "./types.ts";
 
 export type SwapKitReturnType = SwapKitPlugins & {
   getAddress: (chain: Chain) => string;
-  getWallet: (chain: Chain) => ChainWallet<Chain> | undefined;
-  getWalletWithBalance: (
-    chain: Chain,
-    potentialScamFilter?: boolean,
-  ) => Promise<ChainWallet<Chain>>;
-  getBalance: (chain: Chain, potentialScamFilter?: boolean) => AssetValue[];
+  getWallet: (chain: Chain) => ChainWallet | undefined;
+  getWalletWithBalance: (chain: Chain, potentialScamFilter?: boolean) => Promise<ChainWallet>;
+  getBalance: (chain: Chain, refresh?: boolean) => Promise<AssetValue[]>;
   getExplorerTxUrl: typeof getTxUrl;
   getExplorerAddressUrl: typeof getAddressUrl;
   swap: (params: SwapParams) => Promise<string>;
@@ -60,17 +41,9 @@ export type SwapKitReturnType = SwapKitPlugins & {
   ) => boolean | Promise<boolean>;
 };
 
-export type Wallets = { [K in Chain]?: ChainWallet<K> };
-export type AvailableProviders<T> = T | { [K in PluginName]?: ProviderMethods };
-export type ProviderMethods = {
-  swap: (swapParams: SwapParams) => Promise<string>;
-  [key: string]: Todo;
-};
-
-export type SwapKitPlugin = ({ wallets, stagenet }: { wallets: Wallets; stagenet?: boolean }) => {
-  name: PluginName;
-  methods: ProviderMethods;
-};
+export type Wallet = BaseWallet<
+  EVMWallets & CosmosWallets & ThorchainWallets & UTXOWallets & SubstrateWallets
+>;
 
 export type SwapKitWallet = {
   connectMethodName: string;
@@ -94,8 +67,8 @@ export function SwapKit<
   config?: Record<string, Todo>;
   apis: Record<string, Todo>;
   rpcUrls: Record<string, Todo>;
-}): SwapKitReturnType & ConnectWalletMethods & AvailableProviders<ExtendedProviders> {
-  const connectedWallets: Wallets = {};
+}) {
+  const connectedWallets = {} as Wallet;
   const availablePlugins: AvailableProviders<ExtendedProviders> = {};
 
   for (const plugin of plugins) {
@@ -105,8 +78,9 @@ export function SwapKit<
   }
 
   const connectWalletMethods = wallets.reduce((acc, wallet) => {
-    // @ts-expect-error
+    // @ts-expect-error TODO
     acc[wallet.connectMethodName] = wallet.connect({
+      // @ts-expect-error TODO
       addChain,
       config,
       apis,
@@ -132,8 +106,9 @@ export function SwapKit<
     return plugin;
   }
 
-  function addChain(connectWallet: ChainWallet<Chain>) {
-    (connectedWallets[connectWallet.chain as Chain] as ChainWallet<Chain>) = connectWallet;
+  function addChain(connectWallet: Wallet[Chain]) {
+    // @ts-expect-error TODO
+    connectedWallets[connectWallet.chain] = connectWallet;
   }
 
   /**
@@ -143,7 +118,7 @@ export function SwapKit<
   function approve<T extends ApproveMode>({
     assetValue,
     type = "checkOnly" as T,
-    contractAddress,
+    contractAddress: spenderAddress,
   }: {
     type: T;
     assetValue: AssetValue;
@@ -157,18 +132,14 @@ export function SwapKit<
       return Promise.resolve(type === "checkOnly" ? true : "approved") as ApproveReturnType<T>;
     }
 
-    const walletMethods =
-      connectedWallets[chain as Chain.Ethereum | Chain.BinanceSmartChain | Chain.Avalanche];
-
+    const walletMethods = connectedWallets[chain] as BaseEVMWallet;
     const walletAction = type === "checkOnly" ? walletMethods?.isApproved : walletMethods?.approve;
-
     if (!walletAction) throw new SwapKitError("core_wallet_connection_not_found");
 
     const from = getAddress(chain);
-
-    if (!(address && from)) throw new SwapKitError("core_approve_asset_address_or_from_not_found");
-
-    const spenderAddress = contractAddress;
+    if (!(address && from)) {
+      throw new SwapKitError("core_approve_asset_address_or_from_not_found");
+    }
 
     return walletAction({
       amount: assetValue.getBaseValue("bigint"),
@@ -188,17 +159,22 @@ export function SwapKit<
   function getAddress(chain: Chain) {
     return getWallet(chain)?.address || "";
   }
-  function getBalance(chain: Chain) {
+  async function getBalance(chain: Chain, refresh?: boolean) {
+    if (refresh) {
+      const wallet = await getWalletWithBalance(chain, true);
+      return wallet.balance || [];
+    }
+
     return getWallet(chain)?.balance || [];
   }
   /**
    * TODO: Figure out validation without connecting to wallet
    */
   function validateAddress({ address, chain }: { address: string; chain: Chain }) {
-    return getWallet(chain)?.validateAddress?.(address);
+    getWallet(chain)?.validateAddress?.(address);
   }
 
-  async function getWalletWithBalance(chain: Chain, potentialScamFilter?: boolean) {
+  async function getWalletWithBalance(chain: Chain, potentialScamFilter = true) {
     const defaultBalance = [AssetValue.fromChainOrSignature(chain)];
     const wallet = getWallet(chain);
 
@@ -206,8 +182,10 @@ export function SwapKit<
       throw new SwapKitError("core_wallet_connection_not_found");
     }
 
-    const balance = await wallet?.getBalance(wallet.address, potentialScamFilter);
-    wallet.balance = balance?.length ? balance : defaultBalance;
+    if ("getBalance" in wallet) {
+      const balance = await wallet.getBalance(wallet.address, potentialScamFilter);
+      wallet.balance = balance?.length ? balance : defaultBalance;
+    }
 
     return wallet;
   }
@@ -247,3 +225,5 @@ export function SwapKit<
     validateAddress,
   };
 }
+
+export type SwapKitClient<T extends {}, K> = ReturnType<typeof SwapKit<T, K>>;

package/src/helpers/explorerUrls.ts

@@ -1,4 +1,4 @@
-import { Chain, ChainToExplorerUrl } from "@swapkit/types";
+import { Chain, ChainToExplorerUrl } from "@swapkit/helpers";
 
 export function getExplorerTxUrl({ chain, txHash }: { txHash: string; chain: Chain }) {
   const baseUrl = ChainToExplorerUrl[chain];

package/src/index.ts

@@ -1,6 +1,6 @@
-export { SwapKit } from "./client/index.ts";
-export * from "./client/old.ts";
-export * from "./client/index.ts";
-export * from "./types.ts";
+export * from "@swapkit/api";
 export * from "@swapkit/helpers";
-export * from "@swapkit/types";
+
+export { SwapKit } from "./client.ts";
+export * from "./client.ts";
+export * from "./types.ts";

package/src/types.ts

@@ -1,149 +1,89 @@
-import type { AssetValue, QuoteRoute, SwapKitNumber } from "@swapkit/helpers";
+import type { ChainWallet } from "@swapkit/helpers";
 import type {
-  BinanceToolbox,
-  DepositParam,
-  GaiaToolbox,
-  KujiraToolbox,
-  ThorchainToolboxType,
-} from "@swapkit/toolbox-cosmos";
-import type {
-  ARBToolbox,
-  AVAXToolbox,
-  BSCToolbox,
-  ETHToolbox,
-  MATICToolbox,
-  OPToolbox,
-} from "@swapkit/toolbox-evm";
-import type { ChainflipToolbox, PolkadotToolbox } from "@swapkit/toolbox-substrate";
-import type {
-  BCHToolbox,
-  BTCToolbox,
-  DASHToolbox,
-  DOGEToolbox,
-  LTCToolbox,
-} from "@swapkit/toolbox-utxo";
-import {
   Chain,
-  type ConnectConfig,
-  type CosmosChain,
-  type EVMChain,
-  type FeeOption,
-  type UTXOChain,
-  type WalletOption,
-} from "@swapkit/types";
-
-export type CoreTxParams = {
-  assetValue: AssetValue;
-  recipient: string;
-  memo?: string;
-  feeOptionKey?: FeeOption;
-  feeRate?: number;
-  data?: string;
-  from?: string;
-  expiration?: number;
-};
-
-export type AddLiquidityTxns = {
-  runeTx?: string;
-  assetTx?: string;
-};
-
-export type UpgradeParams = {
-  runeAmount: SwapKitNumber;
-  recipient: string;
-};
-
-export type OldChainWallet = {
-  address: string;
-  balance: AssetValue[];
-  walletType: WalletOption;
-};
-
-export type OldWallet = { [key in Chain]: OldChainWallet | null };
-
-export type ChainWallet<T extends Chain> = WalletMethods[T] & {
-  chain: Chain;
-  address: string;
-  balance: AssetValue[];
-  walletType: WalletOption;
-};
-
-export type Wallet = {
-  [key in Chain]?: ChainWallet<key>;
-};
-
-export type ThorchainWallet = ThorchainToolboxType & {
-  transfer: (params: CoreTxParams) => Promise<string>;
-  deposit: (params: DepositParam) => Promise<string>;
-};
-
-export type CosmosBasedWallet<T extends typeof BinanceToolbox | typeof GaiaToolbox> =
-  ReturnType<T> & {
-    transfer: (params: CoreTxParams) => Promise<string>;
-  };
-
-export type SubstrateBasedWallet<T extends typeof PolkadotToolbox | typeof ChainflipToolbox> =
-  Awaited<ReturnType<T>>;
-
-export type EVMWallet<
-  T extends typeof AVAXToolbox | typeof BSCToolbox | typeof ETHToolbox | typeof OPToolbox,
-> = ReturnType<T> & {
-  transfer: (params: CoreTxParams) => Promise<string>;
-};
-
-export type UTXOWallet<
-  T extends typeof BCHToolbox | typeof BTCToolbox | typeof DOGEToolbox | typeof LTCToolbox,
-> = ReturnType<T> & {
-  transfer: (prams: CoreTxParams) => Promise<string>;
-};
-
-export type WalletMethods = {
-  [Chain.Arbitrum]: EVMWallet<typeof ARBToolbox> | null;
-  [Chain.Avalanche]: EVMWallet<typeof AVAXToolbox> | null;
-  [Chain.BinanceSmartChain]: EVMWallet<typeof BSCToolbox> | null;
-  [Chain.Binance]: CosmosBasedWallet<typeof BinanceToolbox> | null;
-  [Chain.BitcoinCash]: UTXOWallet<typeof BCHToolbox> | null;
-  [Chain.Bitcoin]: UTXOWallet<typeof BTCToolbox> | null;
-  [Chain.Chainflip]: SubstrateBasedWallet<typeof ChainflipToolbox> | null;
-  [Chain.Cosmos]: CosmosBasedWallet<typeof GaiaToolbox> | null;
-  [Chain.Dash]: UTXOWallet<typeof DASHToolbox> | null;
-  [Chain.Dogecoin]: UTXOWallet<typeof DOGEToolbox> | null;
-  [Chain.Ethereum]: EVMWallet<typeof ETHToolbox> | null;
-  [Chain.Kujira]: CosmosBasedWallet<typeof KujiraToolbox> | null;
-  [Chain.Litecoin]: UTXOWallet<typeof LTCToolbox> | null;
-  [Chain.Maya]: ThorchainWallet | null;
-  [Chain.Optimism]: EVMWallet<typeof OPToolbox> | null;
-  [Chain.Polkadot]: SubstrateBasedWallet<typeof PolkadotToolbox> | null;
-  [Chain.Polygon]: EVMWallet<typeof MATICToolbox> | null;
-  [Chain.THORChain]: ThorchainWallet | null;
-};
-
-export type QuoteRouteV2 = {
-  buyAsset: string;
-  sellAsset: string;
-  sellAmount: number;
-  destinationAddress: string;
-  sourceAddress: string;
-  providers: string[];
-};
-
-export type SwapWithRouteParams = {
-  recipient: string;
-  route: QuoteRoute | QuoteRouteV2;
-  feeOptionKey?: FeeOption;
-  quoteId?: string;
-  streamSwap?: boolean;
-};
-
-type ApisType = { [key in UTXOChain]?: string | Todo } & {
-  [key in EVMChain]?: string | Todo;
-} & {
+  ConnectConfig,
+  CosmosChain,
+  EVMChain,
+  // type FeeOption,
+  UTXOChain,
+} from "@swapkit/helpers";
+// import type {
+//   BinanceToolbox,
+//   DepositParam,
+//   GaiaToolbox,
+//   KujiraToolbox,
+//   ThorchainToolboxType,
+// } from "@swapkit/toolbox-cosmos";
+// import type {
+//   ARBToolbox,
+//   AVAXToolbox,
+//   BSCToolbox,
+//   ETHToolbox,
+//   MATICToolbox,
+//   OPToolbox,
+// } from "@swapkit/toolbox-evm";
+// import type { ChainflipToolbox, PolkadotToolbox } from "@swapkit/toolbox-substrate";
+// import type {
+//   BCHToolbox,
+//   BTCToolbox,
+//   DASHToolbox,
+//   DOGEToolbox,
+//   LTCToolbox,
+// } from "@swapkit/toolbox-utxo";
+
+// export type ThorchainWallet = ThorchainToolboxType & {
+//   transfer: (params: CoreTxParams) => Promise<string>;
+//   deposit: (params: DepositParam) => Promise<string>;
+// };
+
+// export type CosmosBasedWallet<T extends typeof BinanceToolbox | typeof GaiaToolbox> =
+//   ReturnType<T> & {
+//     transfer: (params: CoreTxParams) => Promise<string>;
+//   };
+
+// export type SubstrateBasedWallet<T extends typeof PolkadotToolbox | typeof ChainflipToolbox> =
+//   Awaited<ReturnType<T>>;
+
+// export type EVMWallet<
+//   T extends typeof AVAXToolbox | typeof BSCToolbox | typeof ETHToolbox | typeof OPToolbox,
+// > = ReturnType<T> & {
+//   transfer: (params: CoreTxParams) => Promise<string>;
+// };
+
+// export type UTXOWallet<
+//   T extends typeof BCHToolbox | typeof BTCToolbox | typeof DOGEToolbox | typeof LTCToolbox,
+// > = ReturnType<T> & {
+//   transfer: (prams: CoreTxParams) => Promise<string>;
+// };
+
+// export type WalletMethods = {
+//   [Chain.Arbitrum]: EVMWallet<typeof ARBToolbox> | null;
+//   [Chain.Avalanche]: EVMWallet<typeof AVAXToolbox> | null;
+//   [Chain.BinanceSmartChain]: EVMWallet<typeof BSCToolbox> | null;
+//   [Chain.Binance]: CosmosBasedWallet<typeof BinanceToolbox> | null;
+//   [Chain.BitcoinCash]: UTXOWallet<typeof BCHToolbox> | null;
+//   [Chain.Bitcoin]: UTXOWallet<typeof BTCToolbox> | null;
+//   [Chain.Chainflip]: SubstrateBasedWallet<typeof ChainflipToolbox> | null;
+//   [Chain.Cosmos]: CosmosBasedWallet<typeof GaiaToolbox> | null;
+//   [Chain.Dash]: UTXOWallet<typeof DASHToolbox> | null;
+//   [Chain.Dogecoin]: UTXOWallet<typeof DOGEToolbox> | null;
+//   [Chain.Ethereum]: EVMWallet<typeof ETHToolbox> | null;
+//   [Chain.Kujira]: CosmosBasedWallet<typeof KujiraToolbox> | null;
+//   [Chain.Litecoin]: UTXOWallet<typeof LTCToolbox> | null;
+//   [Chain.Maya]: ThorchainWallet | null;
+//   [Chain.Optimism]: EVMWallet<typeof OPToolbox> | null;
+//   [Chain.Polkadot]: SubstrateBasedWallet<typeof PolkadotToolbox> | null;
+//   [Chain.Polygon]: EVMWallet<typeof MATICToolbox> | null;
+//   [Chain.THORChain]: ThorchainWallet | null;
+// };
+
+type ApisType = { [key in UTXOChain]?: string } & { [key in EVMChain]?: string } & {
   [key in CosmosChain]?: string;
 };
 
 export type ConnectWalletParamsLocal = {
-  addChain: (params: ChainWallet<Chain>) => void;
+  addChain: (params: ChainWallet) => void;
+  apis: ApisType;
   config: ConnectConfig;
   rpcUrls: { [chain in Chain]?: string };
-  apis: ApisType;
 };