@gearbox-protocol/sdk 3.0.0-next.102 → 3.0.0-next.104

package/lib/pathfinder/utils.d.ts

@@ -0,0 +1,35 @@
+import { providers, utils } from "ethers";
+import { MultiCall } from "./core";
+export interface FeeInfo {
+    type: KnownFeeTypes;
+    value: bigint;
+}
+type KnownFeeTypes = "curve" | "lido" | "uniswap_v2" | "uniswap_v3" | "balancer";
+export declare const BALANCER_VAULT_ABI: {
+    inputs: never[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+}[];
+export declare const BALANCER_VAULT_INTERFACE: utils.Interface;
+interface FindPathFeesProps {
+    calls: Array<MultiCall>;
+    provider: providers.Provider;
+    contractsByAdapter: Record<string, string>;
+}
+export declare class PathFinderUtils {
+    static findPathFees({ calls, provider, contractsByAdapter, }: FindPathFeesProps): Promise<FeeInfo[]>;
+    private static getUniswapV2Fee;
+    private static getUniswapV3Fee;
+    private static getCurveFeeCall;
+    private static getCurveFee;
+    private static getBalancerFeeCall;
+    private static getBalancerFee;
+    private static getLidoFee;
+}
+export {};

package/lib/pathfinder/utils.js

@@ -0,0 +1,182 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PathFinderUtils = exports.BALANCER_VAULT_INTERFACE = exports.BALANCER_VAULT_ABI = void 0;
+const sdk_gov_1 = require("@gearbox-protocol/sdk-gov");
+const ethers_1 = require("ethers");
+const utils_1 = require("ethers/lib/utils");
+const balancerV2VaultParser_1 = require("../parsers/balancerV2VaultParser");
+const curveAdapterParser_1 = require("../parsers/curveAdapterParser");
+const lidoAdapterParser_1 = require("../parsers/lidoAdapterParser");
+const txParser_1 = require("../parsers/txParser");
+const uniV2AdapterParser_1 = require("../parsers/uniV2AdapterParser");
+const uniV3AdapterParser_1 = require("../parsers/uniV3AdapterParser");
+const types_1 = require("../types");
+const CURVE_FEE_DECIMALS = 100000000n;
+const BALANCER_FEE_DECIMALS = 10000000000000000n;
+exports.BALANCER_VAULT_ABI = [
+    {
+        inputs: [],
+        name: "getSwapFeePercentage",
+        outputs: [
+            {
+                internalType: "uint256",
+                name: "",
+                type: "uint256",
+            },
+        ],
+        stateMutability: "view",
+        type: "function",
+    },
+];
+exports.BALANCER_VAULT_INTERFACE = new utils_1.Interface(exports.BALANCER_VAULT_ABI);
+class PathFinderUtils {
+    static async findPathFees({ calls, provider, contractsByAdapter, }) {
+        const pathObjects = txParser_1.TxParser.parseToObjectMultiCall(calls);
+        const { simpleFees, curve, balancer } = pathObjects.reduce((acc, pathSegment) => {
+            if (!pathSegment)
+                return acc;
+            const { callObject, parser } = pathSegment;
+            switch (true) {
+                case parser instanceof uniV2AdapterParser_1.UniswapV2AdapterParser: {
+                    const f = this.getUniswapV2Fee(callObject);
+                    if (f)
+                        acc.simpleFees.push(f);
+                    break;
+                }
+                case parser instanceof uniV3AdapterParser_1.UniswapV3AdapterParser: {
+                    const f = this.getUniswapV3Fee(callObject);
+                    if (f)
+                        acc.simpleFees.push(f);
+                    break;
+                }
+                case parser instanceof lidoAdapterParser_1.LidoAdapterParser: {
+                    const f = this.getLidoFee();
+                    if (f)
+                        acc.simpleFees.push(f);
+                    break;
+                }
+                case parser instanceof curveAdapterParser_1.CurveAdapterParser: {
+                    const call = this.getCurveFeeCall(callObject, contractsByAdapter);
+                    if (call)
+                        acc.curve.push(call);
+                    break;
+                }
+                case parser instanceof balancerV2VaultParser_1.BalancerV2VaultParser: {
+                    const call = this.getBalancerFeeCall(callObject);
+                    if (call)
+                        acc.balancer.push(call);
+                    break;
+                }
+            }
+            return acc;
+        }, {
+            simpleFees: [],
+            curve: [],
+            balancer: [],
+        });
+        const response = await (0, sdk_gov_1.safeMulticall)([...curve, ...balancer], provider);
+        const curveEnds = curve.length;
+        const curveResponse = response.slice(0, curveEnds);
+        const balancerEnds = balancer.length;
+        const balancerResponse = response.slice(curveEnds, balancerEnds);
+        const curveFees = curveResponse.map(r => this.getCurveFee(r));
+        const balancerFees = balancerResponse.map(r => this.getBalancerFee(r));
+        const fees = [...simpleFees, ...curveFees, ...balancerFees];
+        return fees;
+    }
+    static getUniswapV2Fee(callObject) {
+        const { name } = callObject.functionFragment;
+        switch (name) {
+            case "swapExactTokensForTokens":
+            case "swapTokensForExactTokens":
+            case "swapDiffTokensForTokens": {
+                // 0.3%
+                return {
+                    type: "uniswap_v2",
+                    value: 3000n,
+                };
+            }
+            default:
+                return null;
+        }
+    }
+    static getUniswapV3Fee(callObject) {
+        const { name } = callObject.functionFragment;
+        switch (name) {
+            case "exactInputSingle":
+            case "exactDiffInputSingle":
+            case "exactOutputSingle": {
+                const { params } = callObject.args || {};
+                const { fee = 0 } = params || {};
+                return {
+                    type: "uniswap_v3",
+                    value: (0, sdk_gov_1.toBigInt)(fee),
+                };
+            }
+            default:
+                return null;
+        }
+    }
+    static getCurveFeeCall(callObject, contractsByAdapter) {
+        const { name } = callObject.functionFragment;
+        switch (name) {
+            case "exchange":
+            case "exchange_underlying":
+            case "exchange_diff":
+            case "exchange_diff_underlying": {
+                const adapter = (callObject.address || "").toLowerCase();
+                const contract = contractsByAdapter[adapter];
+                return contract
+                    ? {
+                        address: contract,
+                        interface: types_1.ICurvePool__factory.createInterface(),
+                        method: "fee()",
+                    }
+                    : null;
+            }
+            default:
+                return null;
+        }
+    }
+    static getCurveFee({ value }) {
+        const feeOriginal = (0, sdk_gov_1.toBigInt)(value || 0n);
+        return {
+            type: "curve",
+            value: (feeOriginal * sdk_gov_1.PERCENTAGE_FACTOR) / CURVE_FEE_DECIMALS,
+        };
+    }
+    static getBalancerFeeCall(callObject) {
+        const { name } = callObject.functionFragment;
+        switch (name) {
+            case "swapDiff":
+            case "swap": {
+                const { poolId = "" } = callObject.args?.[0] || {};
+                // !&
+                const [contract] = ethers_1.utils.defaultAbiCoder.decode(["address", "unit16"], poolId);
+                return contract
+                    ? {
+                        address: contract,
+                        interface: exports.BALANCER_VAULT_INTERFACE,
+                        method: "getSwapFeePercentage()",
+                    }
+                    : null;
+            }
+            default:
+                return null;
+        }
+    }
+    static getBalancerFee({ value }) {
+        const feeOriginal = (0, sdk_gov_1.toBigInt)(value || 0n);
+        return {
+            type: "balancer",
+            value: (feeOriginal * sdk_gov_1.PERCENTAGE_FACTOR) / BALANCER_FEE_DECIMALS,
+        };
+    }
+    static getLidoFee() {
+        return {
+            type: "lido",
+            value: 0n,
+        };
+    }
+}
+exports.PathFinderUtils = PathFinderUtils;

package/lib/types/contracts/index.d.ts

@@ -0,0 +1,2 @@
+import type * as interfaces from "./interfaces";
+export type { interfaces };

package/lib/types/contracts/interfaces/IGasPricer.d.ts

@@ -0,0 +1,44 @@
+import type { BaseContract, BigNumber, BytesLike, CallOverrides, PopulatedTransaction, Signer, utils } from "ethers";
+import type { FunctionFragment, Result } from "@ethersproject/abi";
+import type { Listener, Provider } from "@ethersproject/providers";
+import type { TypedEventFilter, TypedEvent, TypedListener, OnEvent, PromiseOrValue } from "../../common";
+export interface IGasPricerInterface extends utils.Interface {
+    functions: {
+        "getGasPriceTokenOutRAY(address)": FunctionFragment;
+    };
+    getFunction(nameOrSignatureOrTopic: "getGasPriceTokenOutRAY"): FunctionFragment;
+    encodeFunctionData(functionFragment: "getGasPriceTokenOutRAY", values: [PromiseOrValue<string>]): string;
+    decodeFunctionResult(functionFragment: "getGasPriceTokenOutRAY", data: BytesLike): Result;
+    events: {};
+}
+export interface IGasPricer extends BaseContract {
+    connect(signerOrProvider: Signer | Provider | string): this;
+    attach(addressOrName: string): this;
+    deployed(): Promise<this>;
+    interface: IGasPricerInterface;
+    queryFilter<TEvent extends TypedEvent>(event: TypedEventFilter<TEvent>, fromBlockOrBlockhash?: string | number | undefined, toBlock?: string | number | undefined): Promise<Array<TEvent>>;
+    listeners<TEvent extends TypedEvent>(eventFilter?: TypedEventFilter<TEvent>): Array<TypedListener<TEvent>>;
+    listeners(eventName?: string): Array<Listener>;
+    removeAllListeners<TEvent extends TypedEvent>(eventFilter: TypedEventFilter<TEvent>): this;
+    removeAllListeners(eventName?: string): this;
+    off: OnEvent<this>;
+    on: OnEvent<this>;
+    once: OnEvent<this>;
+    removeListener: OnEvent<this>;
+    functions: {
+        getGasPriceTokenOutRAY(token: PromiseOrValue<string>, overrides?: CallOverrides): Promise<[BigNumber] & {
+            gasPrice: BigNumber;
+        }>;
+    };
+    getGasPriceTokenOutRAY(token: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
+    callStatic: {
+        getGasPriceTokenOutRAY(token: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
+    };
+    filters: {};
+    estimateGas: {
+        getGasPriceTokenOutRAY(token: PromiseOrValue<string>, overrides?: CallOverrides): Promise<BigNumber>;
+    };
+    populateTransaction: {
+        getGasPriceTokenOutRAY(token: PromiseOrValue<string>, overrides?: CallOverrides): Promise<PopulatedTransaction>;
+    };
+}

package/lib/types/contracts/interfaces/IGasPricer.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/contracts/interfaces/index.d.ts

@@ -0,0 +1 @@
+export type { IGasPricer } from "./IGasPricer";

package/lib/types/contracts/interfaces/index.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });