@swapkit/core 1.0.0-rc.100 → 1.0.0-rc.103

package/package.json

@@ -1,26 +1,26 @@
 {
   "author": "swapkit-oss",
   "dependencies": {
-    "@swapkit/helpers": "1.0.0-rc.72",
-    "@swapkit/types": "1.0.0-rc.38"
+    "@swapkit/helpers": "1.0.0-rc.74",
+    "@swapkit/types": "1.0.0-rc.40"
   },
   "description": "SwapKit Lib core",
   "devDependencies": {
     "@vitest/coverage-istanbul": "1.3.1",
     "vite": "5.1.3",
     "vitest": "1.3.1",
-    "@swapkit/tokens": "1.0.0-rc.35",
-    "@swapkit/toolbox-cosmos": "1.0.0-rc.83",
-    "@swapkit/toolbox-evm": "1.0.0-rc.78",
-    "@swapkit/toolbox-substrate": "1.0.0-rc.6",
-    "@swapkit/toolbox-utxo": "1.0.0-rc.77"
+    "@swapkit/tokens": "1.0.0-rc.36",
+    "@swapkit/toolbox-cosmos": "1.0.0-rc.85",
+    "@swapkit/toolbox-evm": "1.0.0-rc.80",
+    "@swapkit/toolbox-substrate": "1.0.0-rc.9",
+    "@swapkit/toolbox-utxo": "1.0.0-rc.80"
   },
   "peerDependencies": {
-    "@swapkit/tokens": "1.0.0-rc.35",
-    "@swapkit/toolbox-cosmos": "1.0.0-rc.83",
-    "@swapkit/toolbox-evm": "1.0.0-rc.78",
-    "@swapkit/toolbox-substrate": "1.0.0-rc.6",
-    "@swapkit/toolbox-utxo": "1.0.0-rc.77"
+    "@swapkit/tokens": "1.0.0-rc.36",
+    "@swapkit/toolbox-cosmos": "1.0.0-rc.85",
+    "@swapkit/toolbox-evm": "1.0.0-rc.80",
+    "@swapkit/toolbox-substrate": "1.0.0-rc.9",
+    "@swapkit/toolbox-utxo": "1.0.0-rc.80"
   },
   "exports": {
     ".": {
@@ -45,7 +45,7 @@
   },
   "type": "module",
   "types": "./dist/index.d.ts",
-  "version": "1.0.0-rc.100",
+  "version": "1.0.0-rc.103",
   "scripts": {
     "build": "NODE_OPTIONS=--max_old_space_size=16384 vite build",
     "clean": "rm -rf dist vite.config.ts.* node_modules",

package/src/__tests__/helpers.test.ts

@@ -1,79 +1,84 @@
-import { Chain, ChainToExplorerUrl, CosmosChains, EVMChains, UTXOChains } from "@swapkit/types";
+import {
+  Chain,
+  ChainToExplorerUrl,
+  CosmosChains,
+  EVMChains,
+  SubstrateChains,
+  UTXOChains,
+} from "@swapkit/types";
 import { describe, expect, test } from "vitest";
 import { getExplorerAddressUrl, getExplorerTxUrl } from "../helpers/explorerUrls.ts";
 
 describe("Explorer URLs", () => {
-  for (const chain of CosmosChains.filter((c) => c !== Chain.Cosmos)) {
-    test(`getExplorerTxUrl returns correct URL for ${chain}`, () => {
-      expect(getExplorerTxUrl({ chain, txHash: "0x123456789" })).toBe(
-        `${ChainToExplorerUrl[chain]}/tx/123456789`,
-      );
+  describe("CosmosChains", () => {
+    for (const chain of CosmosChains.filter((c) => c !== Chain.Cosmos)) {
+      test(`getExplorerTxUrl returns correct URL for ${chain}`, () => {
+        expect(getExplorerTxUrl({ chain, txHash: "0x123456789" })).toBe(
+          `${ChainToExplorerUrl[chain]}/tx/123456789`,
+        );
 
-      expect(getExplorerAddressUrl({ chain, address: "asdfg" })).toBe(
-        `${ChainToExplorerUrl[chain]}/address/asdfg`,
-      );
-    });
-  }
+        expect(getExplorerAddressUrl({ chain, address: "asdfg" })).toBe(
+          `${ChainToExplorerUrl[chain]}/address/asdfg`,
+        );
+      });
+    }
 
-  for (const chain of EVMChains) {
-    test(`getExplorerTxUrl returns correct URL for ${chain}`, () => {
-      expect(getExplorerTxUrl({ chain, txHash: "0x123456789" })).toBe(
-        `${ChainToExplorerUrl[chain]}/tx/0x123456789`,
+    test(`getExplorerTxUrl returns correct URL for ${Chain.Cosmos}`, () => {
+      expect(getExplorerTxUrl({ chain: Chain.Cosmos, txHash: "0x123456789" })).toBe(
+        `${ChainToExplorerUrl[Chain.Cosmos]}/transactions/0x123456789`,
       );
 
-      expect(getExplorerAddressUrl({ chain, address: "asdfg" })).toBe(
-        `${ChainToExplorerUrl[chain]}/address/asdfg`,
+      expect(getExplorerAddressUrl({ chain: Chain.Cosmos, address: "asdfg" })).toBe(
+        `${ChainToExplorerUrl[Chain.Cosmos]}/account/asdfg`,
       );
     });
-  }
+  });
 
-  for (const chain of UTXOChains.filter((c) => c !== Chain.Dash)) {
-    test(`getExplorerTxUrl returns correct URL for ${chain}`, () => {
-      expect(getExplorerTxUrl({ chain, txHash: "0x123456789" })).toBe(
-        `${ChainToExplorerUrl[chain]}/transaction/0x123456789`,
-      );
+  describe("EVMChains & SubstrateChains", () => {
+    for (const chain of [...EVMChains, Chain.Polkadot]) {
+      test(`getExplorerTxUrl returns correct URL for ${chain}`, () => {
+        expect(getExplorerTxUrl({ chain, txHash: "0x123456789" })).toBe(
+          `${ChainToExplorerUrl[chain]}/tx/0x123456789`,
+        );
+
+        expect(getExplorerAddressUrl({ chain, address: "asdfg" })).toBe(
+          `${ChainToExplorerUrl[chain]}/address/asdfg`,
+        );
+      });
+    }
 
-      expect(getExplorerAddressUrl({ chain, address: "asdfg" })).toBe(
-        `${ChainToExplorerUrl[chain]}/address/asdfg`,
+    test("getExplorerTxUrl adds 0x for EVM like chains", () => {
+      expect(getExplorerTxUrl({ chain: Chain.Ethereum, txHash: "12345" })).toBe(
+        "https://etherscan.io/tx/0x12345",
       );
     });
-  }
-
-  test(`getExplorerTxUrl returns correct URL for ${Chain.Cosmos}`, () => {
-    expect(getExplorerTxUrl({ chain: Chain.Cosmos, txHash: "0x123456789" })).toBe(
-      `${ChainToExplorerUrl[Chain.Cosmos]}/transactions/0x123456789`,
-    );
-
-    expect(getExplorerAddressUrl({ chain: Chain.Cosmos, address: "asdfg" })).toBe(
-      `${ChainToExplorerUrl[Chain.Cosmos]}/account/asdfg`,
-    );
   });
 
-  test("getExplorerTxUrl throws Error for unsupported Chain", () => {
-    expect(() =>
-      getExplorerTxUrl({ chain: "unsupported" as Chain, txHash: "0x12345" }),
-    ).toThrowError("Unsupported chain: unsupported");
-  });
+  describe("UTXOChains", () => {
+    for (const chain of UTXOChains.filter((c) => c !== Chain.Dash)) {
+      test(`getExplorerTxUrl returns correct URL for ${chain}`, () => {
+        expect(getExplorerTxUrl({ chain, txHash: "0x123456789" })).toBe(
+          `${ChainToExplorerUrl[chain]}/transaction/0x123456789`,
+        );
 
-  test("getExplorerAddressUrl throws Error for unsupported Chain", () => {
-    expect(() =>
-      getExplorerAddressUrl({ chain: "unsupported" as Chain, address: "asdfg" }),
-    ).toThrowError("Unsupported chain: unsupported");
-  });
-  test("getExplorerTxUrl adds 0x for EVM like chains", () => {
-    expect(getExplorerTxUrl({ chain: Chain.Ethereum, txHash: "12345" })).toBe(
-      "https://etherscan.io/tx/0x12345",
-    );
+        expect(getExplorerAddressUrl({ chain, address: "asdfg" })).toBe(
+          `${ChainToExplorerUrl[chain]}/address/asdfg`,
+        );
+      });
+    }
   });
 
-  test("getExplorerTxUrl returns correct URL for Cosmos", () => {
-    expect(getExplorerTxUrl({ chain: Chain.Cosmos, txHash: "pqrst" })).toBe(
-      "https://cosmos.bigdipper.live/transactions/pqrst",
-    );
-  });
-  test("getExplorerAddressUrl returns correct URL for Cosmos", () => {
-    expect(getExplorerAddressUrl({ chain: Chain.Cosmos, address: "zabcd" })).toBe(
-      "https://cosmos.bigdipper.live/account/zabcd",
-    );
+  describe("Unsupported chains", () => {
+    test("getExplorerTxUrl throws Error for unsupported Chain", () => {
+      expect(() =>
+        getExplorerTxUrl({ chain: "unsupported" as Chain, txHash: "0x12345" }),
+      ).toThrowError("Unsupported chain: unsupported");
+    });
+
+    test("getExplorerAddressUrl throws Error for unsupported Chain", () => {
+      expect(() =>
+        getExplorerAddressUrl({ chain: "unsupported" as Chain, address: "asdfg" }),
+      ).toThrowError("Unsupported chain: unsupported");
+    });
   });
 });

package/src/client/index.ts

@@ -1,18 +1,22 @@
 import { AssetValue, SwapKitError } from "@swapkit/helpers";
 import { Chain } from "@swapkit/types";
+import {
+  getExplorerAddressUrl as getAddressUrl,
+  getExplorerTxUrl as getTxUrl,
+} from "../helpers/explorerUrls.ts";
 import type {
   ChainWallet,
   ConnectWalletParamsLocal as ConnectWalletParams,
   SwapWithRouteParams,
 } from "../types.ts";
 
-type ProviderName = "thorchain" | "chainflip" | "mayachain";
-enum ApproveMode {
+export type ProviderName = "thorchain" | "chainflip" | "mayachain";
+export enum ApproveMode {
   Approve = "approve",
   CheckOnly = "checkOnly",
 }
 
-type ApproveReturnType<T extends ApproveMode> = T extends "checkOnly"
+export type ApproveReturnType<T extends ApproveMode> = T extends "checkOnly"
   ? Promise<boolean>
   : Promise<string>;
 
@@ -33,7 +37,7 @@ export type SwapParams = (SwapWithRouteParams | GenericSwapParams) & {
   };
 };
 
-type SwapKitReturnType = SwapKitProviders & {
+export type SwapKitReturnType = SwapKitProviders & {
   getAddress: (chain: Chain) => string;
   getWallet: (chain: Chain) => ChainWallet<Chain> | undefined;
   getWalletWithBalance: (
@@ -41,6 +45,8 @@ type SwapKitReturnType = SwapKitProviders & {
     potentialScamFilter?: boolean,
   ) => Promise<ChainWallet<Chain>>;
   getBalance: (chain: Chain, potentialScamFilter?: boolean) => AssetValue[];
+  getExplorerTxUrl: (chain: Chain, txHash: string) => string;
+  getExplorerAddressUrl: (chain: Chain, address: string) => string;
   swap: (params: SwapParams) => Promise<string>;
   validateAddress: (params: { address: string; chain: Chain }) =>
     | boolean
@@ -53,9 +59,9 @@ type SwapKitReturnType = SwapKitProviders & {
   ) => boolean | Promise<boolean>;
 };
 
-type Wallets = { [K in Chain]?: ChainWallet<K> };
-type AvailableProviders<T> = T | { [K in ProviderName]?: ProviderMethods };
-type ProviderMethods = {
+export type Wallets = { [K in Chain]?: ChainWallet<K> };
+export type AvailableProviders<T> = T | { [K in ProviderName]?: ProviderMethods };
+export type ProviderMethods = {
   swap: (swapParams: SwapParams) => Promise<string>;
   [key: string]: any;
 };
@@ -65,20 +71,9 @@ export type SwapKitProvider = ({ wallets, stagenet }: { wallets: Wallets; stagen
   methods: ProviderMethods;
 };
 
-type BaseSwapkitWalletConnectParams = {
-  chains: Chain[];
-};
-
-type KeystoreWalletConnectParams = BaseSwapkitWalletConnectParams & {
-  phrase: string;
-  index?: number;
-};
-
-type WalletConnectParams = KeystoreWalletConnectParams;
-
-type SwapKitWallet = {
+export type SwapKitWallet = {
   connectMethodName: string;
-  connect: (params: ConnectWalletParams) => (connectParams: WalletConnectParams) => void;
+  connect: (params: ConnectWalletParams) => (connectParams: any) => void;
 };
 
 export function SwapKit<
@@ -98,7 +93,7 @@ export function SwapKit<
   config?: Record<string, any>;
   apis: Record<string, any>;
   rpcUrls: Record<string, any>;
-}): SwapKitReturnType & ConnectWalletMethods {
+}): SwapKitReturnType & ConnectWalletMethods & AvailableProviders<ExtendedProviders> {
   const connectedWallets: Wallets = {};
   const availableProviders: AvailableProviders<ExtendedProviders> = {};
 
@@ -197,6 +192,12 @@ export function SwapKit<
   function getBalance(chain: Chain) {
     return getWallet(chain)?.balance || [];
   }
+  function getExplorerTxUrl(chain: Chain, txHash: string) {
+    return getTxUrl({ chain, txHash });
+  }
+  function getExplorerAddressUrl(chain: Chain, address: string) {
+    return getAddressUrl({ chain, address });
+  }
   /**
    * TODO: Figure out validation without connecting to wallet
    */
@@ -244,6 +245,8 @@ export function SwapKit<
     approveAssetValue,
     getAddress,
     getBalance,
+    getExplorerAddressUrl,
+    getExplorerTxUrl,
     getWallet,
     getWalletWithBalance,
     isAssetValueApproved,

package/src/helpers/explorerUrls.ts

@@ -15,6 +15,7 @@ export const getExplorerTxUrl = ({ chain, txHash }: { txHash: string; chain: Cha
     case Chain.BinanceSmartChain:
     case Chain.Ethereum:
     case Chain.Optimism:
+    case Chain.Polkadot:
     case Chain.Polygon:
       return `${baseUrl}/tx/${txHash.startsWith("0x") ? txHash : `0x${txHash}`}`;
 
@@ -48,6 +49,7 @@ export const getExplorerAddressUrl = ({ chain, address }: { address: string; cha
     case Chain.Litecoin:
     case Chain.Maya:
     case Chain.Optimism:
+    case Chain.Polkadot:
     case Chain.Polygon:
     case Chain.THORChain:
       return `${baseUrl}/address/${address}`;