@xswap-link/sdk 0.3.5 → 0.4.0

package/src/contracts/abi/XSwapTokenFeeDistributor.json

@@ -0,0 +1,350 @@
+[
+  {
+    "inputs": [],
+    "stateMutability": "nonpayable",
+    "type": "constructor"
+  },
+  {
+    "inputs": [],
+    "name": "FailedToSendNative",
+    "type": "error"
+  },
+  {
+    "inputs": [],
+    "name": "ZeroAddressProvided",
+    "type": "error"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": false,
+        "internalType": "address",
+        "name": "previousAdmin",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "address",
+        "name": "newAdmin",
+        "type": "address"
+      }
+    ],
+    "name": "AdminChanged",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "beacon",
+        "type": "address"
+      }
+    ],
+    "name": "BeaconUpgraded",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": false,
+        "internalType": "uint8",
+        "name": "version",
+        "type": "uint8"
+      }
+    ],
+    "name": "Initialized",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "previousOwner",
+        "type": "address"
+      },
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "newOwner",
+        "type": "address"
+      }
+    ],
+    "name": "OwnershipTransferStarted",
+    "type": "event"
+  },
+  {
+    "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": "newFeeCollector",
+        "type": "address"
+      }
+    ],
+    "name": "SetFeeCollector",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": false,
+        "internalType": "address",
+        "name": "token",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "address",
+        "name": "reciever",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "amount",
+        "type": "uint256"
+      },
+      {
+        "indexed": false,
+        "internalType": "address",
+        "name": "feeCollector",
+        "type": "address"
+      },
+      {
+        "indexed": false,
+        "internalType": "uint256",
+        "name": "remainingAmount",
+        "type": "uint256"
+      }
+    ],
+    "name": "TokensDistributed",
+    "type": "event"
+  },
+  {
+    "anonymous": false,
+    "inputs": [
+      {
+        "indexed": true,
+        "internalType": "address",
+        "name": "implementation",
+        "type": "address"
+      }
+    ],
+    "name": "Upgraded",
+    "type": "event"
+  },
+  {
+    "inputs": [],
+    "name": "acceptOwnership",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "token",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "reciever",
+        "type": "address"
+      },
+      {
+        "internalType": "uint256",
+        "name": "originalAmount",
+        "type": "uint256"
+      },
+      {
+        "internalType": "uint256",
+        "name": "percentage",
+        "type": "uint256"
+      },
+      {
+        "internalType": "uint256",
+        "name": "maxAmount",
+        "type": "uint256"
+      }
+    ],
+    "name": "distributeTokensFee",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "feeCollector",
+    "outputs": [
+      {
+        "internalType": "contract IFeeCollector",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "_feeCollector",
+        "type": "address"
+      },
+      {
+        "internalType": "address",
+        "name": "owner",
+        "type": "address"
+      }
+    ],
+    "name": "initialize",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "owner",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "pendingOwner",
+    "outputs": [
+      {
+        "internalType": "address",
+        "name": "",
+        "type": "address"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "precision",
+    "outputs": [
+      {
+        "internalType": "uint256",
+        "name": "",
+        "type": "uint256"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "proxiableUUID",
+    "outputs": [
+      {
+        "internalType": "bytes32",
+        "name": "",
+        "type": "bytes32"
+      }
+    ],
+    "stateMutability": "view",
+    "type": "function"
+  },
+  {
+    "inputs": [],
+    "name": "renounceOwnership",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "_feeCollector",
+        "type": "address"
+      }
+    ],
+    "name": "setFeeCollectorAddress",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "newOwner",
+        "type": "address"
+      }
+    ],
+    "name": "transferOwnership",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "newImplementation",
+        "type": "address"
+      }
+    ],
+    "name": "upgradeTo",
+    "outputs": [],
+    "stateMutability": "nonpayable",
+    "type": "function"
+  },
+  {
+    "inputs": [
+      {
+        "internalType": "address",
+        "name": "newImplementation",
+        "type": "address"
+      },
+      {
+        "internalType": "bytes",
+        "name": "data",
+        "type": "bytes"
+      }
+    ],
+    "name": "upgradeToAndCall",
+    "outputs": [],
+    "stateMutability": "payable",
+    "type": "function"
+  }
+]

package/src/contracts/abi/index.ts

@@ -1,5 +1,13 @@
 import BatchQuery from "./BatchQuery.json";
 import ERC20 from "./ERC20.json";
+import XSwapRouter from "./XSwapRouter.json";
+import XSwapTokenFeeDistributor from "./XSwapTokenFeeDistributor.json";
+import CustomXSwapRouter from "./CustomXSwapRouter.json";
+import StakingStableAPR from "./StakingStableAPR.json";
 
 export const BatchQueryAbi = BatchQuery;
 export const ERC20Abi = ERC20;
+export const XSwapRouterAbi = XSwapRouter;
+export const XSwapTokenFeeDistributorAbi = XSwapTokenFeeDistributor;
+export const CustomXSwapRouterAbi = CustomXSwapRouter;
+export const StakingStableAPRAbi = StakingStableAPR;

package/src/contracts/addresses.ts

@@ -3,38 +3,56 @@ import { Addresses, ContractName } from "@src/models";
 export const ADDRESSES: Addresses = {
   // arbitrum
   "42161": {
+    [ContractName.USDC]: "0xaf88d065e77c8cc2239327c5edb3a432268e5831",
     [ContractName.BatchQuery]: "0xb5f9934ea0810ef5faa677e8c68c6983b88664b1",
-    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
     [ContractName.FeeCollector]: "0xb37275558f02f05104c2ba35199d16adeb43432f",
+    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
   },
   // avalanche
   "43114": {
+    [ContractName.USDC]: "0xb97ef9ef8734c71904d8002f8b6bc66dd9c48a6e",
     [ContractName.BatchQuery]: "0xb5f9934ea0810ef5faa677e8c68c6983b88664b1",
-    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
     [ContractName.FeeCollector]: "0xb37275558f02f05104c2ba35199d16adeb43432f",
+    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
   },
   // base
   "8453": {
+    [ContractName.USDC]: "0x833589fcd6edb6e08f4c7c32d4f71b54bda02913",
     [ContractName.BatchQuery]: "0xb5f9934ea0810ef5faa677e8c68c6983b88664b1",
-    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
+    [ContractName.CustomXSwapRouter]:
+      "0x9B64aC0aD647768838a3957Bc12c40E1C539cb93",
     [ContractName.FeeCollector]: "0xb37275558f02f05104c2ba35199d16adeb43432f",
+    [ContractName.StakingCosmicCadets]:
+      "0x67798736bFb7d9A1F143215E258fe15Da68c85F0",
+    [ContractName.StakingSolarDivision]:
+      "0xF86e9f328e840658bAc6C5726a76ba4db1eFe923",
+    [ContractName.StakingIntergalacticCommand]:
+      "0x29A09C1642222eE5ae14EF19445f1326BCFCAC01",
+    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
+    [ContractName.XSwapToken]: "0x8fe815417913a93ea99049fc0718ee1647a2a07c",
   },
   // ethereum
   "1": {
+    [ContractName.USDC]: "0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48",
     [ContractName.BatchQuery]: "0xb5f9934ea0810ef5faa677e8c68c6983b88664b1",
-    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
+    [ContractName.CustomXSwapRouter]:
+      "0x9B64aC0aD647768838a3957Bc12c40E1C539cb93",
     [ContractName.FeeCollector]: "0xb37275558f02f05104c2ba35199d16adeb43432f",
+    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
+    [ContractName.XSwapToken]: "0x8fe815417913a93ea99049fc0718ee1647a2a07c",
   },
   // optimism
   "10": {
+    [ContractName.USDC]: "0x0b2c639c533813f4aa9d7837caf62653d097ff85",
     [ContractName.BatchQuery]: "0xb5f9934ea0810ef5faa677e8c68c6983b88664b1",
-    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
     [ContractName.FeeCollector]: "0xb37275558f02f05104c2ba35199d16adeb43432f",
+    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
   },
   // polygon
   "137": {
+    [ContractName.USDC]: "0xf1e3a5842eeef51f2967b3f05d45dd4f4205ff40",
     [ContractName.BatchQuery]: "0xb5f9934ea0810ef5faa677e8c68c6983b88664b1",
-    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
     [ContractName.FeeCollector]: "0xb37275558f02f05104c2ba35199d16adeb43432f",
+    [ContractName.XSwapRouter]: "0xe1c14b9f065dead2e89ee35382f8bd42bdb87a04",
   },
 };

package/src/hooks/index.ts

@@ -0,0 +1,5 @@
+export * from "./useBatchQuery";
+export * from "./useDebounce";
+export * from "./useEvmContractApi";
+export * from "./usePortal";
+export * from "./useXPower";

package/src/hooks/networkManagement/clientToSigner.tsx

@@ -0,0 +1,17 @@
+import { providers } from "ethers";
+import { useMemo } from "react";
+import type { Account, Chain, Client, Transport } from "viem";
+import { Config, useConnectorClient } from "wagmi";
+
+export function clientToSigner(client: Client<Transport, Chain, Account>) {
+  const { account, transport } = client;
+  const provider = new providers.Web3Provider(transport, "any");
+  const signer = provider.getSigner(account.address);
+  return signer;
+}
+
+/** Hook to convert a Viem Client to an ethers.js Signer. */
+export async function useEthersSigner({ chainId }: { chainId?: number } = {}) {
+  const { data: client } = useConnectorClient<Config>({ chainId });
+  return useMemo(() => (client ? clientToSigner(client) : undefined), [client]);
+}

package/src/hooks/networkManagement/useNetworks.ts

@@ -0,0 +1,51 @@
+import { JsonRpcProvider, JsonRpcSigner } from "@ethersproject/providers";
+import { useEffect, useMemo, useState } from "react";
+import { useAccount } from "wagmi";
+import { useEthersSigner } from "./clientToSigner";
+
+export interface Network {
+  networkName: string;
+  chainId: string;
+  address?: string;
+}
+export interface EvmNetwork extends Network {
+  provider?: JsonRpcProvider;
+  signer?: JsonRpcSigner;
+}
+
+export const useNetworks = (): {
+  networks: {
+    evm: EvmNetwork;
+  };
+} => {
+  const [signer, setSigner] = useState<JsonRpcSigner>();
+
+  const ethersSigner = useEthersSigner();
+
+  useEffect(() => {
+    ethersSigner.then((signer) => setSigner(signer));
+  }, [ethersSigner]);
+
+  // Evm
+  const account = useAccount();
+
+  const evm = useMemo(
+    () => ({
+      networkName: "EVM",
+      // Is non-nullable assertion here safe?
+      // In xswap-dapp we fallback to the default chain, but it doesn't seem to be enforced anywhere.
+      // So that fallback is probably not right as well.
+      chainId: account.chainId!.toString(),
+      address: account.address,
+      signer: signer,
+      provider: signer?.provider,
+    }),
+    [account.address, account.chainId, signer],
+  );
+
+  return {
+    networks: { evm },
+  };
+};
+
+export default useNetworks;

package/src/hooks/useBatchQuery.ts

@@ -0,0 +1,46 @@
+import { ADDRESSES, BatchQueryAbi } from "@src/contracts";
+import { useSwapContext } from "@src/context";
+import useEvmContractApi from "./useEvmContractApi";
+import { Ecosystem } from "@src/models";
+import { ethers } from "ethers";
+import { useCallback } from "react";
+
+export const useBatchQuery = () => {
+  const evmContractApi = useEvmContractApi();
+  const { supportedChains } = useSwapContext();
+
+  const contract = useCallback(
+    (chainId: string) => {
+      const rpcUrl = supportedChains.find(
+        (chain) =>
+          chain.ecosystem === Ecosystem.EVM && chain.chainId === chainId,
+      )?.publicRpcUrls[0];
+      const contractAddress = ADDRESSES[chainId]?.BatchQuery;
+      if (rpcUrl && contractAddress) {
+        return new ethers.Contract(
+          contractAddress,
+          BatchQueryAbi,
+          ethers.getDefaultProvider(rpcUrl),
+        );
+      }
+      return null;
+    },
+    [supportedChains],
+  );
+
+  return {
+    batchQuery: useCallback(
+      async (
+        chainId: string,
+        targetAddresses: string[],
+        calldatas: string[],
+      ) => {
+        return await evmContractApi.query(contract(chainId), "batchQuery", [
+          targetAddresses,
+          calldatas,
+        ]);
+      },
+      [contract, evmContractApi],
+    ),
+  };
+};

package/src/hooks/useDebounce.tsx

@@ -0,0 +1,28 @@
+import { useCallback, useRef } from "react";
+
+export const useDebounce = ({
+  delayMs,
+  instantExecution,
+}: {
+  delayMs: number;
+  instantExecution?: () => void;
+}) => {
+  const timerRef = useRef<NodeJS.Timeout | null>(null);
+
+  const debounce = useCallback(
+    (callback: () => void) => {
+      if (timerRef.current) {
+        clearTimeout(timerRef.current);
+        timerRef.current = null;
+      }
+
+      if (instantExecution) {
+        instantExecution();
+      }
+      timerRef.current = setTimeout(callback, delayMs);
+    },
+    [delayMs, instantExecution],
+  );
+
+  return { debounce };
+};

package/src/hooks/useEvmContractApi.ts

@@ -0,0 +1,85 @@
+import { GAS_LIMIT_MULTIPLIER } from "@src/constants";
+import { ethers } from "ethers";
+import { useMemo } from "react";
+
+export const useEvmContractApi = () =>
+  useMemo(
+    () => ({
+      // TODO check if we can avoid nullable contract (think about error handling)
+      query: async (
+        contract: ethers.Contract | null,
+        method: string,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        args: any[] = [],
+      ) => {
+        if (contract?.provider) {
+          return await contract[method](...args);
+        }
+        return null;
+      },
+      execute: async (
+        contract: ethers.Contract | null,
+        method: string,
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        args: any[] = [],
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        options: Record<string, any> = {},
+      ) => {
+        try {
+          if (contract?.provider) {
+            // @ts-expect-error idk, needs to be handled another time in the future
+            const gasEstimation = await contract.estimateGas[method](
+              ...args,
+              options,
+            );
+            if (!options.gasLimit) {
+              options.gasLimit = Math.floor(
+                gasEstimation.toNumber() * GAS_LIMIT_MULTIPLIER,
+              );
+            }
+            return await contract[method](...args, options);
+          }
+          return null;
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        } catch (err: any) {
+          let decodedError;
+          try {
+            // Try to decode custom error from smart contract
+            decodedError = contract?.interface.parseError(
+              err?.error?.data?.data,
+            );
+          } catch (_) {
+            // If it fails but there is a message - throw that message
+            if (err?.error?.data?.message) {
+              throw new Error(err?.error?.data?.message);
+            }
+            // Else throw whole error to be handled by TransactionProvider
+            throw err;
+          }
+          throw new Error(decodedError?.name);
+        }
+      },
+      executeCalldata: async (signer, transaction) => {
+        try {
+          const gasEstimation = await signer.estimateGas({
+            ...transaction,
+          });
+          return await signer.sendTransaction({
+            ...transaction,
+            gasLimit: Math.floor(
+              gasEstimation.toNumber() * GAS_LIMIT_MULTIPLIER,
+            ),
+          });
+          // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        } catch (err: any) {
+          if (err?.error?.data?.message) {
+            throw new Error(err?.error?.data?.message);
+          }
+          throw err;
+        }
+      },
+    }),
+    [],
+  );
+
+export default useEvmContractApi;