@gearbox-protocol/sdk 3.0.0-vfourabi.1 → 3.0.0-vfourabi.3

package/src/adapters/AbstractAdapter.ts

@@ -0,0 +1,28 @@
+import type { Abi, Address } from "viem";
+
+import type { AdapterData, GearboxSDK } from "../sdk";
+import { BaseContract } from "../sdk";
+import type { AdapterContractType } from "./types";
+
+export interface AbstractAdapterContractOptions<
+  abi extends Abi | readonly unknown[],
+> extends AdapterData {
+  abi: abi;
+  name?: string;
+}
+
+export class AbstractAdapterContract<
+  const abi extends Abi | readonly unknown[],
+> extends BaseContract<abi> {
+  public readonly targetContract: Address;
+
+  constructor(sdk: GearboxSDK, args: AbstractAdapterContractOptions<abi>) {
+    const { baseParams, targetContract, ...rest } = args;
+    super(sdk, { ...rest, ...baseParams });
+    this.targetContract = args.targetContract;
+  }
+
+  public get adapterType(): AdapterContractType {
+    return this.contractType as AdapterContractType;
+  }
+}

package/src/adapters/BalancerV2VaultAdapterContract.ts

@@ -0,0 +1,19 @@
+import type { GearboxSDK } from "../sdk";
+import { iBalancerV2VaultAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iBalancerV2VaultAdapterAbi;
+type abi = typeof abi;
+
+export class BalancerV2VaultAdapterContract extends AbstractAdapterContract<abi> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/BalancerV3RouterAdapterContract.ts

@@ -0,0 +1,19 @@
+import type { GearboxSDK } from "../sdk";
+import { iBalancerV3RouterAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iBalancerV3RouterAdapterAbi;
+type abi = typeof abi;
+
+export class BalancerV3RouterAdapterContract extends AbstractAdapterContract<abi> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/CamelotV3AdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iCamelotV3AdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iCamelotV3AdapterAbi;
+
+export class CamelotV3AdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/ConvexV1BaseRewardPoolAdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iConvexV1BaseRewardPoolAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iConvexV1BaseRewardPoolAdapterAbi;
+
+export class ConvexV1BaseRewardPoolAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/ConvexV1BoosterAdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iConvexV1BoosterAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iConvexV1BoosterAdapterAbi;
+
+export class ConvexV1BoosterAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/Curve2AssetsAdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iCurveV1_2AssetsAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iCurveV1_2AssetsAdapterAbi;
+
+export class Curve2AssetsAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/Curve3AssetsAdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iCurveV1_3AssetsAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iCurveV1_3AssetsAdapterAbi;
+
+export class Curve3AssetsAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/Curve4AssetsAdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iCurveV1_4AssetsAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iCurveV1_4AssetsAdapterAbi;
+
+export class Curve4AssetsAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/CurveV1AdapterStETHContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iCurveV1_2AssetsAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iCurveV1_2AssetsAdapterAbi;
+
+export class CurveV1AdapterStETHContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/CurveV1StableNGAdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iCurveV1StableNgAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iCurveV1StableNgAdapterAbi;
+
+export class CurveV1StableNGAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/DaiUsdsAdapterContract.ts

@@ -0,0 +1,21 @@
+import type { GearboxSDK } from "../sdk";
+import { iDaiUsdsAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iDaiUsdsAdapterAbi;
+type abi = typeof abi;
+
+export class DaiUsdsAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/ERC4626AdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { ierc4626AdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = ierc4626AdapterAbi;
+
+export class ERC4626AdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/MellowERC4626VaultAdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { ierc4626AdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = ierc4626AdapterAbi;
+
+export class MellowERC4626VaultAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/MellowVaultAdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iMellowVaultAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iMellowVaultAdapterAbi;
+
+export class MellowVaultAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/PendleRouterAdapterContract.ts

@@ -0,0 +1,21 @@
+import type { GearboxSDK } from "../sdk";
+import { iPendleRouterAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iPendleRouterAdapterAbi;
+type abi = typeof abi;
+
+export class PendleRouterAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/StakingRewardsAdapterContract.ts

@@ -0,0 +1,21 @@
+import type { GearboxSDK } from "../sdk";
+import { iStakingRewardsAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iStakingRewardsAdapterAbi;
+type abi = typeof abi;
+
+export class StakingRewardsAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/UniswapV2AdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iUniswapV2AdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iUniswapV2AdapterAbi;
+
+export class UniswapV2AdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/UniswapV3AdapterContract.ts

@@ -0,0 +1,170 @@
+import type { Address, DecodeFunctionDataReturnType } from "viem";
+
+import type { GearboxSDK } from "../sdk";
+import { formatBN } from "../sdk";
+import { iUniswapV3AdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iUniswapV3AdapterAbi;
+
+export class UniswapV3AdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+
+  public parseFunctionParams(
+    params: DecodeFunctionDataReturnType<typeof abi>,
+  ): string[] | undefined {
+    switch (params.functionName) {
+      case "exactInputSingle": {
+        const [{ tokenIn, tokenOut, fee, amountIn, amountOutMinimum }] =
+          params.args;
+        const tokenInSym = this.sdk.tokensMeta.symbol(tokenIn);
+        const tokenOutSym = this.sdk.tokensMeta.symbol(tokenOut);
+
+        const amountInStr = this.sdk.tokensMeta.formatBN(tokenIn, amountIn);
+        const amountOutMinimumStr = this.sdk.tokensMeta.formatBN(
+          tokenOut,
+          amountOutMinimum,
+        );
+
+        return [
+          `(amountIn: ${amountInStr}, amountOutMinimum: ${amountOutMinimumStr},  path: ${tokenInSym} ==(fee: ${fee})==> ${tokenOutSym})`,
+        ];
+      }
+      case "exactDiffInputSingle": {
+        const [{ tokenIn, tokenOut, fee, leftoverAmount, rateMinRAY }] =
+          params.args;
+        const tokenInSym = this.sdk.tokensMeta.symbol(tokenIn);
+        const tokenOutSym = this.sdk.tokensMeta.symbol(tokenOut);
+
+        const leftoverAmountStr = this.sdk.tokensMeta.formatBN(
+          tokenIn,
+          leftoverAmount,
+        );
+        const rateStr = formatBN(rateMinRAY, 27);
+        return [
+          `(leftoverAmount: ${leftoverAmountStr}, rate: ${rateStr},  path: ${tokenInSym} ==(fee: ${fee})==> ${tokenOutSym})`,
+        ];
+      }
+      case "exactInput": {
+        const [{ amountIn, amountOutMinimum, path }] = params.args;
+
+        const pathStr = this.trackInputPath(path);
+        const token = `0x${path.replace("0x", "").slice(0, 40)}` as Address;
+        const amountInStr = this.sdk.tokensMeta.formatBN(token, amountIn);
+
+        const amountOutMinimumStr = this.sdk.tokensMeta.formatBN(
+          `0x${path.slice(-40, path.length)}`,
+          amountOutMinimum,
+        );
+
+        return [
+          `(amountIn: ${amountInStr}, amountOutMinimum: ${amountOutMinimumStr},  path: ${pathStr}`,
+        ];
+      }
+      case "exactDiffInput": {
+        const [{ leftoverAmount, rateMinRAY, path }] = params.args;
+
+        const leftoverAmountStr = this.sdk.tokensMeta.formatBN(
+          `0x${path.replace("0x", "").slice(0, 40)}`,
+          leftoverAmount,
+        );
+
+        const pathStr = this.trackInputPath(path);
+
+        return [
+          `(leftoverAmount: ${leftoverAmountStr}, rate: ${formatBN(
+            rateMinRAY,
+            27,
+          )},  path: ${pathStr}`,
+        ];
+      }
+      case "exactOutput": {
+        const [{ amountInMaximum, amountOut, path }] = params.args;
+
+        const pathStr = this.trackOutputPath(path);
+        const amountInMaximumStr = this.sdk.tokensMeta.formatBN(
+          `0x${path.slice(-40, path.length)}`,
+          amountInMaximum,
+        );
+
+        const amountOutStr = this.sdk.tokensMeta.formatBN(
+          `0x${path.replace("0x", "").slice(0, 40)}`,
+          amountOut,
+        );
+
+        return [
+          `(amountInMaximum: ${amountInMaximumStr}, amountOut: ${amountOutStr},  path: ${pathStr}`,
+        ];
+      }
+      case "exactOutputSingle": {
+        const [{ tokenIn, tokenOut, fee, amountOut, amountInMaximum }] =
+          params.args;
+
+        const tokenInSym = this.sdk.tokensMeta.symbol(tokenIn);
+        const tokenOutSym = this.sdk.tokensMeta.symbol(tokenOut);
+
+        const amountInMaximumStr = this.sdk.tokensMeta.formatBN(
+          tokenIn,
+          amountInMaximum,
+        );
+        const amountOutStr = this.sdk.tokensMeta.formatBN(tokenOut, amountOut);
+
+        return [
+          `(amountInMaximum: ${amountInMaximumStr}, amountOut: ${amountOutStr},  path: ${tokenInSym} ==(fee: ${fee})==> ${tokenOutSym})`,
+        ];
+      }
+
+      default:
+        return undefined;
+    }
+  }
+
+  private trackInputPath(path: string): string {
+    let result = "";
+    let pointer = path.startsWith("0x") ? 2 : 0;
+    while (pointer <= path.length - 40) {
+      const from =
+        `0x${path.slice(pointer, pointer + 40)}`.toLowerCase() as Address;
+      result += this.sdk.tokensMeta.symbol(from) || from;
+      pointer += 40;
+
+      if (pointer > path.length - 6) return result;
+
+      const fee = parseInt(path.slice(pointer, pointer + 6), 16);
+
+      pointer += 6;
+      result += ` ==(fee: ${fee})==> `;
+    }
+
+    return result;
+  }
+
+  private trackOutputPath(path: string): string {
+    let result = "";
+    let pointer = path.length;
+    while (pointer >= 40) {
+      pointer -= 40;
+      const from = `0x${path.slice(pointer, pointer + 40)}` as Address;
+      result += this.sdk.tokensMeta.symbol(from) || from;
+
+      if (pointer < 6) return result;
+      pointer -= 6;
+      const fee = parseInt(path.slice(pointer, pointer + 6), 16);
+
+      result += ` ==(fee: ${fee})==> `;
+    }
+
+    return result;
+  }
+}

package/src/adapters/VelodromeV2AdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iVelodromeV2RouterAdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iVelodromeV2RouterAdapterAbi;
+
+export class VelodromeV2RouterAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/WstETHV1AdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iwstEthv1AdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iwstEthv1AdapterAbi;
+
+export class WstETHV1AdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}

package/src/adapters/YearnV2AdapterContract.ts

@@ -0,0 +1,20 @@
+import type { GearboxSDK } from "../sdk";
+import { iYearnV2AdapterAbi } from "./abi";
+import type { AbstractAdapterContractOptions } from "./AbstractAdapter";
+import { AbstractAdapterContract } from "./AbstractAdapter";
+
+const abi = iYearnV2AdapterAbi;
+
+export class YearnV2RouterAdapterContract extends AbstractAdapterContract<
+  typeof abi
+> {
+  constructor(
+    sdk: GearboxSDK,
+    args: Omit<AbstractAdapterContractOptions<typeof abi>, "abi">,
+  ) {
+    super(sdk, {
+      ...args,
+      abi,
+    });
+  }
+}