@swapkit/toolboxes 1.0.0-beta.0

package/src/evm/helpers.ts

@@ -0,0 +1,145 @@
+import {
+  AssetValue,
+  BaseDecimal,
+  type EVMChain,
+  FeeOption,
+  SwapKitNumber,
+  filterAssets,
+  formatBigIntToSafeValue,
+  isGasAsset,
+} from "@swapkit/helpers";
+import type { BrowserProvider, JsonRpcProvider, Provider } from "ethers";
+
+import { getEvmApi } from "./api";
+import { type EIP1559TxParams, type EVMMaxSendableAmountsParams, estimateGasPrices } from "./index";
+
+export const estimateMaxSendableAmount = async ({
+  toolbox,
+  from,
+  memo = "",
+  feeOptionKey = FeeOption.Fastest,
+  assetValue,
+  abi,
+  funcName,
+  funcParams,
+  contractAddress,
+  txOverrides,
+}: EVMMaxSendableAmountsParams): Promise<AssetValue> => {
+  const balance = (await toolbox.getBalance(from)).find(({ symbol, chain }) =>
+    assetValue ? symbol === assetValue.symbol : symbol === AssetValue.from({ chain })?.symbol,
+  );
+
+  const gasRate = (await toolbox.estimateGasPrices())[feeOptionKey];
+
+  if (!balance) return AssetValue.from({ chain: assetValue.chain });
+
+  if (assetValue && (balance.chain !== assetValue.chain || balance.symbol !== assetValue?.symbol)) {
+    return balance;
+  }
+
+  const gasLimit =
+    abi && funcName && funcParams && contractAddress
+      ? await toolbox.estimateCall({
+          contractAddress,
+          abi,
+          funcName,
+          funcParams,
+          txOverrides,
+        })
+      : await toolbox.estimateGasLimit({
+          from,
+          recipient: from,
+          memo,
+          assetValue,
+        });
+
+  const isFeeEIP1559Compatible = "maxFeePerGas" in gasRate;
+  const isFeeEVMLegacyCompatible = "gasPrice" in gasRate;
+
+  if (!(isFeeEVMLegacyCompatible || isFeeEIP1559Compatible)) {
+    throw new Error("Could not fetch fee data");
+  }
+
+  const fee =
+    gasLimit *
+    (isFeeEIP1559Compatible
+      ? (gasRate.maxFeePerGas || 1n) + (gasRate.maxPriorityFeePerGas || 1n)
+      : gasRate.gasPrice);
+  const maxSendableAmount = SwapKitNumber.fromBigInt(balance.getBaseValue("bigint")).sub(
+    fee.toString(),
+  );
+
+  return AssetValue.from({ chain: balance.chain, value: maxSendableAmount.getValue("string") });
+};
+
+export const toHexString = (value: bigint) => (value > 0n ? `0x${value.toString(16)}` : "0x0");
+
+export const getBalance = async ({
+  provider,
+  address,
+  chain,
+  potentialScamFilter,
+}: {
+  provider: JsonRpcProvider | BrowserProvider;
+  address: string;
+  chain: EVMChain;
+  potentialScamFilter?: boolean;
+}) => {
+  const tokenBalances = await getEvmApi(chain).getBalance(address);
+  const evmGasTokenBalance = await provider.getBalance(address);
+
+  const balances = [
+    {
+      chain,
+      symbol: AssetValue.from({ chain }).symbol,
+      value: formatBigIntToSafeValue({
+        value: BigInt(evmGasTokenBalance),
+        decimal: 18,
+        bigIntDecimal: 18,
+      }),
+      decimal: BaseDecimal[chain],
+    },
+    ...tokenBalances.filter((token) => !isGasAsset(token)),
+  ];
+
+  const filteredBalances = potentialScamFilter ? filterAssets(balances) : balances;
+
+  return filteredBalances.map(
+    ({ symbol, value, decimal }) =>
+      new AssetValue({
+        decimal: decimal || BaseDecimal[chain],
+        value,
+        identifier: `${chain}.${symbol}`,
+      }),
+  );
+};
+
+export const estimateTransactionFee = async (
+  txObject: EIP1559TxParams,
+  // biome-ignore lint/style/useDefaultParameterLast: Should only be used through wrapped toolboxes
+  feeOption: FeeOption = FeeOption.Fast,
+  chain: EVMChain,
+  provider: Provider | BrowserProvider,
+  isEIP1559Compatible = true,
+) => {
+  const gasPrices = (await estimateGasPrices(provider, isEIP1559Compatible))[feeOption];
+  const gasLimit = await provider.estimateGas(txObject);
+  const assetValue = AssetValue.from({ chain });
+
+  if (!isEIP1559Compatible && gasPrices.gasPrice) {
+    return assetValue.set(
+      SwapKitNumber.fromBigInt(gasPrices.gasPrice * gasLimit, assetValue.decimal),
+    );
+  }
+
+  if (gasPrices.maxFeePerGas && gasPrices.maxPriorityFeePerGas) {
+    return assetValue.set(
+      SwapKitNumber.fromBigInt(
+        (gasPrices.maxFeePerGas + gasPrices.maxPriorityFeePerGas) * gasLimit,
+        assetValue.decimal,
+      ),
+    );
+  }
+
+  throw new Error("No gas price found");
+};

package/src/evm/index.ts

@@ -0,0 +1,20 @@
+/**
+ * Package
+ */
+export * from "./api";
+export * from "./helpers";
+export * from "./provider";
+export * from "./toolbox/EVMToolbox";
+export * from "./types";
+
+/**
+ * Toolboxes
+ */
+export * from "./toolbox/arb";
+export * from "./toolbox/avax";
+export * from "./toolbox/bsc";
+export * from "./toolbox/eth";
+export * from "./toolbox/getToolboxByChain";
+export * from "./toolbox/matic";
+export * from "./toolbox/op";
+export * from "./toolbox/base";

package/src/evm/provider.ts

@@ -0,0 +1,6 @@
+import { type EVMChain, SKConfig } from "@swapkit/helpers";
+import { JsonRpcProvider } from "ethers";
+
+export const getProvider = (chain: EVMChain, customUrl?: string) => {
+  return new JsonRpcProvider(customUrl || SKConfig.get("rpcUrls")[chain]);
+};