@swapkit/helpers 2.6.0 → 3.0.0-beta.1

package/src/contracts/routers/woofi.ts

@@ -0,0 +1,171 @@
+export const woofiRouter = [
+  {
+    inputs: [
+      { internalType: "address", name: "_weth", type: "address" },
+      { internalType: "address", name: "_pool", type: "address" },
+    ],
+    stateMutability: "nonpayable",
+    type: "constructor",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      { indexed: true, internalType: "address", name: "previousOwner", type: "address" },
+      { indexed: true, internalType: "address", name: "newOwner", type: "address" },
+    ],
+    name: "OwnershipTransferred",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [{ indexed: false, internalType: "address", name: "newPool", type: "address" }],
+    name: "WooPoolChanged",
+    type: "event",
+  },
+  {
+    anonymous: false,
+    inputs: [
+      {
+        indexed: false,
+        internalType: "enum IWooRouterV2.SwapType",
+        name: "swapType",
+        type: "uint8",
+      },
+      { indexed: true, internalType: "address", name: "fromToken", type: "address" },
+      { indexed: true, internalType: "address", name: "toToken", type: "address" },
+      { indexed: false, internalType: "uint256", name: "fromAmount", type: "uint256" },
+      { indexed: false, internalType: "uint256", name: "toAmount", type: "uint256" },
+      { indexed: false, internalType: "address", name: "from", type: "address" },
+      { indexed: true, internalType: "address", name: "to", type: "address" },
+      { indexed: false, internalType: "address", name: "rebateTo", type: "address" },
+    ],
+    name: "WooRouterSwap",
+    type: "event",
+  },
+  {
+    inputs: [],
+    name: "WETH",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "approveTarget", type: "address" },
+      { internalType: "address", name: "swapTarget", type: "address" },
+      { internalType: "address", name: "fromToken", type: "address" },
+      { internalType: "address", name: "toToken", type: "address" },
+      { internalType: "uint256", name: "fromAmount", type: "uint256" },
+      { internalType: "uint256", name: "minToAmount", type: "uint256" },
+      { internalType: "address payable", name: "to", type: "address" },
+      { internalType: "bytes", name: "data", type: "bytes" },
+    ],
+    name: "externalSwap",
+    outputs: [{ internalType: "uint256", name: "realToAmount", type: "uint256" }],
+    stateMutability: "payable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "stuckToken", type: "address" }],
+    name: "inCaseTokenGotStuck",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "", type: "address" }],
+    name: "isWhitelisted",
+    outputs: [{ internalType: "bool", name: "", type: "bool" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "owner",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "fromToken", type: "address" },
+      { internalType: "address", name: "toToken", type: "address" },
+      { internalType: "uint256", name: "fromAmount", type: "uint256" },
+    ],
+    name: "querySwap",
+    outputs: [{ internalType: "uint256", name: "toAmount", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "quoteToken",
+    outputs: [{ internalType: "address", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "renounceOwnership",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "newPool", type: "address" }],
+    name: "setPool",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "target", type: "address" },
+      { internalType: "bool", name: "whitelisted", type: "bool" },
+    ],
+    name: "setWhitelisted",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "fromToken", type: "address" },
+      { internalType: "address", name: "toToken", type: "address" },
+      { internalType: "uint256", name: "fromAmount", type: "uint256" },
+      { internalType: "uint256", name: "minToAmount", type: "uint256" },
+      { internalType: "address payable", name: "to", type: "address" },
+      { internalType: "address", name: "rebateTo", type: "address" },
+    ],
+    name: "swap",
+    outputs: [{ internalType: "uint256", name: "realToAmount", type: "uint256" }],
+    stateMutability: "payable",
+    type: "function",
+  },
+  {
+    inputs: [{ internalType: "address", name: "newOwner", type: "address" }],
+    name: "transferOwnership",
+    outputs: [],
+    stateMutability: "nonpayable",
+    type: "function",
+  },
+  {
+    inputs: [
+      { internalType: "address", name: "fromToken", type: "address" },
+      { internalType: "address", name: "toToken", type: "address" },
+      { internalType: "uint256", name: "fromAmount", type: "uint256" },
+    ],
+    name: "tryQuerySwap",
+    outputs: [{ internalType: "uint256", name: "toAmount", type: "uint256" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  {
+    inputs: [],
+    name: "wooPool",
+    outputs: [{ internalType: "contract IWooPPV2", name: "", type: "address" }],
+    stateMutability: "view",
+    type: "function",
+  },
+  { stateMutability: "payable", type: "receive" },
+];

package/src/index.ts

@@ -1,17 +1,3 @@
-export * from "@swapkit/contracts";
-export * from "./types/index";
-
-/**
- * Helpers
- */
-export * from "./helpers/asset";
-export * from "./helpers/derivationPath";
-export * from "./helpers/liquidity";
-export * from "./helpers/memo";
-export * from "./helpers/others";
-export * from "./helpers/validators";
-export * from "./helpers/web3wallets";
-
 /**
  * Modules
  */
@@ -20,4 +6,22 @@ export * from "./modules/bigIntArithmetics";
 export * from "./modules/requestClient";
 export * from "./modules/swapKitError";
 export * from "./modules/swapKitNumber";
-export * from "./modules/walletUtils";
+export * from "./modules/swapKitConfig";
+
+/**
+ * Utils
+ */
+export * from "./utils/asset";
+export * from "./utils/derivationPath";
+export * from "./utils/liquidity";
+export * from "./utils/memo";
+export * from "./utils/others";
+export * from "./utils/plugin";
+export * from "./utils/validators";
+export * from "./utils/wallets";
+export * from "./utils/tokens";
+
+/**
+ * Types
+ */
+export * from "./types";

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

@@ -79,13 +79,15 @@ describe("AssetValue", () => {
 
       expect(atomDerived.toString()).toBe("THOR.ATOM");
 
+      const value = 10;
       const mayaCacao = AssetValue.from({
         asset: "MAYA.CACAO",
-        value: 10,
+        value,
       });
 
       expect(mayaCacao.toString()).toBe("MAYA.CACAO");
-      expect(mayaCacao.getBaseValue("string")).toBe("1000000000");
+      const expectedValue = value * 10_000_000_000;
+      expect(mayaCacao.getBaseValue("string")).toBe(expectedValue.toString());
 
       const ethMayaSynth = AssetValue.from({
         asset: "MAYA.ETH/ETH",
@@ -105,29 +107,38 @@ describe("AssetValue", () => {
       expect(ethTCSynthFallback.toString({ includeSynthProtocol: true })).toBe("THOR.ETH/ETH");
       expect(ethTCSynthFallback.getBaseValue("string")).toBe("1000000000");
 
-      // TODO:
-      // const radixXWBTC = new AssetValue({
-      //   identifier:
-      //     "RADIX.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
-      //   decimal: 8,
-      //   value: 11112222,
-      // });
-
-      // expect(radixXWBTC.toString()).toBe(
-      //   "RADIX.XWBTC-resource_rdx1t580qxc7upat7lww4l2c4jckacafjeudxj5wpjrrct0p3e82sq4y75",
-      // )
+      const solFromString = AssetValue.from({ asset: "SOL.SOL" });
+      expect(solFromString.toString()).toBe("SOL.SOL");
+    });
+
+    test("regres cases", () => {
+      const arbWeth = AssetValue.from({
+        asset: "ARB.WETH-0x82aF49447D8a07e3bd95BD0d56f35241523fBab1",
+      });
+      expect(arbWeth.toString()).toBe("ARB.WETH-0x82af49447d8a07e3bd95bd0d56f35241523fbab1");
+
+      const baseAssetFromString = AssetValue.from({
+        asset: "BASE.USDC-0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
+      });
+      expect(baseAssetFromString.toString()).toBe(
+        "BASE.USDC-0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
+      );
+
+      const avaxSolanaAsset = AssetValue.from({
+        asset: "AVAX.SOL-0XFE6B19286885A4F7F55ADAD09C3CD1F906D2478F",
+      });
+      expect(avaxSolanaAsset.toString()).toBe(
+        "AVAX.SOL-0xfe6b19286885a4f7f55adad09c3cd1f906d2478f",
+      );
     });
   });
 
   describe("set", () => {
     test("get a copy of an assetValue with a new value", () => {
-      const btc = AssetValue.from({
-        asset: "BTC.BTC",
-      });
+      const btc = AssetValue.from({ asset: "BTC.BTC" });
 
       const btc2 = btc.set(10);
 
-      expect(btc2).toBeDefined();
       expect(btc2).toEqual(
         expect.objectContaining({
           chain: Chain.Bitcoin,
@@ -293,8 +304,21 @@ describe("AssetValue", () => {
       const thor = AssetValue.from({ asset: "ETH.THOR" });
       expect(thor.toString()).toBe("ETH.THOR-0xa5f2211b9b8170f694421f2046281775e8468044");
 
-      const ethSynth = await AssetValue.from({ asset: "ETH/ETH", asyncTokenLookup: true });
+      const ethSynth = await AssetValue.from({
+        asset: "ETH/ETH",
+        asyncTokenLookup: true,
+      });
       expect(ethSynth.toString()).toBe("ETH/ETH");
+
+      const eth = await AssetValue.from({
+        asset: "eth.eth",
+      });
+      expect(eth.toString()).toBe("ETH.ETH");
+
+      const ethFromChain = await AssetValue.from({
+        chain: Chain.Ethereum,
+      });
+      expect(ethFromChain.toString()).toBe("ETH.ETH");
     });
   });
 
@@ -509,7 +533,9 @@ describe("AssetValue", () => {
     test("returns safe decimals if string is not in `@swapkit/tokens` lists", async () => {
       await AssetValue.loadStaticAssets();
       const fakeAvaxUSDCAssetString = "AVAX.USDC-1234";
-      const fakeAvaxUSDCAsset = AssetValue.from({ asset: fakeAvaxUSDCAssetString });
+      const fakeAvaxUSDCAsset = AssetValue.from({
+        asset: fakeAvaxUSDCAssetString,
+      });
 
       expect(fakeAvaxUSDCAsset).toBeDefined();
       expect(fakeAvaxUSDCAsset).toEqual(
@@ -528,7 +554,9 @@ describe("AssetValue", () => {
     test("returns safe decimals if string is not in `@swapkit/tokens` lists with multiple dashes", async () => {
       await AssetValue.loadStaticAssets();
       const fakeAvaxUSDCAssetString = "AVAX.USDC-LPT-1234";
-      const fakeAvaxUSDCAsset2 = AssetValue.from({ asset: fakeAvaxUSDCAssetString });
+      const fakeAvaxUSDCAsset2 = AssetValue.from({
+        asset: fakeAvaxUSDCAssetString,
+      });
 
       expect(fakeAvaxUSDCAsset2).toBeDefined();
       expect(fakeAvaxUSDCAsset2).toEqual(
@@ -557,8 +585,8 @@ describe("AssetValue", () => {
           decimal: 8,
           isGasAsset: false,
           isSynthetic: false,
-          symbol: "BTC.b-0x152b9d0fdc40c096757f570a51e494bd4b943e50",
-          ticker: "BTC.b",
+          symbol: "BTC.B-0x152b9d0fdc40c096757f570a51e494bd4b943e50",
+          ticker: "BTC.B",
         }),
       );
     });
@@ -758,12 +786,10 @@ describe("AssetValue", () => {
       const xrdAsset = AssetValue.from({ chain: Chain.Radix });
       expect(xrdAsset).toEqual(
         expect.objectContaining({
-          address: undefined,
           chain: Chain.Radix,
           decimal: BaseDecimal.XRD,
           isGasAsset: true,
           isSynthetic: false,
-          symbol: "XRD",
           ticker: "XRD",
           type: "Native",
         }),

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

@@ -0,0 +1,37 @@
+import { describe, expect, test } from "bun:test";
+import { Chain } from "../../types";
+import { SKConfig } from "../swapKitConfig";
+
+describe("swapKitConfig", () => {
+  test("properly sets api keys", () => {
+    const initialState = SKConfig.get("apiKeys").swapKit;
+    expect(initialState).toBe("");
+
+    SKConfig.setApiKey("swapKit", "123");
+
+    const changedState = SKConfig.get("apiKeys").swapKit;
+    expect(changedState).toBe("123");
+  });
+
+  test("do not drop if other keys are changed", () => {
+    SKConfig.setApiKey("swapKit", "123");
+    expect(SKConfig.get("apiKeys").swapKit).toBe("123");
+
+    SKConfig.setApiKey("walletConnectProjectId", "123");
+    expect(SKConfig.get("apiKeys")).toMatchObject({
+      swapKit: "123",
+      walletConnectProjectId: "123",
+    });
+
+    SKConfig.setExplorerUrl(Chain.Ethereum, "https://lul.xyz");
+    expect(SKConfig.getState()).toMatchObject({
+      apiKeys: {
+        swapKit: "123",
+        walletConnectProjectId: "123",
+      },
+      explorerUrls: {
+        [Chain.Ethereum]: "https://lul.xyz",
+      },
+    });
+  });
+});