@wardenswap/bestrate-sdk-beta 2.10.0 → 2.12.0

package/dist/index.d.ts

@@ -8,7 +8,8 @@ declare enum BESTRATE_NETWORK {
     polygon = "polygon",
     ethereum = "ethereum",
     avalanche = "avalanche",
-    optimism = "optimism"
+    optimism = "optimism",
+    base = "base"
 }
 type TokenInfo = {
     address: string;
@@ -292,46 +293,71 @@ interface Multicall2 extends BaseContract {
     };
 }
 
+type Params = {
+    alpha: bigint;
+    beta: bigint;
+    c: bigint;
+    s: bigint;
+    lambda: bigint;
+};
+type DerivedParams = {
+    tauAlpha: Vector2;
+    tauBeta: Vector2;
+    u: bigint;
+    v: bigint;
+    w: bigint;
+    z: bigint;
+    dSq: bigint;
+};
+type Vector2 = {
+    x: bigint;
+    y: bigint;
+};
+
 declare enum DexModel {
     UniswapV2 = 0,
     UniswapV3 = 1,
     PancakeV3 = 2,
     VelodromeSS = 3,
     AlgebraV1CL = 4,
-    DMM = 5,
-    CurvePlain = 6,
-    CurveMeta = 7,
-    CurvePlainSol = 8,
-    Iron = 9,
-    Synapse = 10,
-    CurveMetaSol = 11,
-    CurveCrypto = 12,
-    CurveTriCryptoNG = 13,
-    CurveStableNG = 14,
-    CurveLendingA = 15,
-    CurveLendingCryptoZap = 16,
-    CurveLendingCryptoTwoZap = 17,
-    CurveLido = 18,
-    PolyDex = 19,
-    FireBirdWeighted = 20,
-    BalancerWeighted = 21,
-    BalancerStable = 22,
-    BalancerMetaStable = 23,
-    BalancerBoostedStable = 24,
-    BalancerLinear = 25,
-    BalancerLiquidityBootstrapping = 26,
-    Biswap = 27,
-    DodoV1 = 28,
-    DodoV2 = 29,
-    Mdex = 30,
-    Mars = 31,
-    Smoothy = 32,
-    Shibaswap = 33,
-    GmxDex = 34,
-    Solidly = 35,
-    VelodromeV2 = 36,
-    Synthetix = 37,
-    Unknown = 38
+    SolidlyV3 = 5,
+    DMM = 6,
+    CurvePlain = 7,
+    CurveMeta = 8,
+    CurvePlainSol = 9,
+    Iron = 10,
+    Synapse = 11,
+    CurveMetaSol = 12,
+    CurveCrypto = 13,
+    CurveTriCryptoNG = 14,
+    CurveStableNG = 15,
+    CurveLendingA = 16,
+    CurveLendingCryptoZap = 17,
+    CurveLendingCryptoTwoZap = 18,
+    CurveLido = 19,
+    PolyDex = 20,
+    FireBirdWeighted = 21,
+    BalancerWeighted = 22,
+    BalancerStable = 23,
+    BalancerComposableStableV6 = 24,
+    BalancerWeightedV4 = 25,
+    BalancerGyroECLP = 26,
+    BalancerMetaStable = 27,
+    BalancerBoostedStable = 28,
+    BalancerLinear = 29,
+    BalancerLiquidityBootstrapping = 30,
+    Biswap = 31,
+    DodoV1 = 32,
+    DodoV2 = 33,
+    Mdex = 34,
+    Mars = 35,
+    Smoothy = 36,
+    Shibaswap = 37,
+    GmxDex = 38,
+    Solidly = 39,
+    VelodromeV2 = 40,
+    Synthetix = 41,
+    Unknown = 42
 }
 interface UniswapV2BasedModelInfo {
     model: DexModel.UniswapV2 | DexModel.Mdex | DexModel.Biswap | DexModel.Mars | DexModel.Shibaswap;
@@ -348,6 +374,10 @@ interface UniswapV3ModelInfo extends Omit<UniswapV2BasedModelInfo, 'model' | 'fe
     gasPerInitializedTick: bigint;
     gasPerTick: bigint;
 }
+interface SolidlyV3ModelInfo extends Omit<UniswapV3ModelInfo, 'model' | 'fee'> {
+    model: DexModel.SolidlyV3;
+    tickSpacing: bigint;
+}
 interface AlgebraV1CLModelInfo extends Omit<UniswapV3ModelInfo, 'model' | 'fee' | 'feePrecision' | 'factory'> {
     model: DexModel.AlgebraV1CL;
     poolDeployer: string;
@@ -456,8 +486,14 @@ interface BalancerWeightedModelInfo extends Omit<BalancerStableModelInfo, 'model
 interface BalancerStableModelInfo {
     model: DexModel.BalancerStable;
     tokens: string[];
+    /**
+     * Calculated from 1e18 * 10^(18-decimals)
+     */
     scalingFactors: bigint[];
     vaultContract: string;
+    /**
+     * Get from getPoolId() of pool contract
+     */
     poolId: string;
     aPrecision: bigint;
     depositAddress: string;
@@ -484,6 +520,43 @@ interface BalancerMetaStableModelInfo extends Omit<BalancerStableModelInfo, 'mod
     rateProviders: string[];
     multicall: string;
 }
+interface BalancerComposableStableModelInfo extends Omit<BalancerStableModelInfo, 'model' | 'aPrecision'> {
+    model: DexModel.BalancerComposableStableV6;
+    /**
+     * BPT token index
+     * Get from getBptIndex() at pool contract
+     */
+    bptIndex: number;
+    /**
+     * Rate providers, zero means no providers
+     * Get from getRateProviders() at pool contract
+     */
+    rateProviders: string[];
+    multicall: string;
+    /**
+     * A flag whether exempt from yield protocol fee
+     * Get from isExemptFromYieldProtocolFee() at pool contract
+     */
+    isExemptFromYieldProtocolFee: boolean;
+    /**
+     * A flag whether protocol swap fee delegation
+     * Get from getProtocolSwapFeeDelegation() at pool contract
+     */
+    isProtocolSwapFeeDelegation: boolean;
+    /**
+     * Maximum protocol's swap fee percentage
+     * Get from _MAX_PROTOCOL_SWAP_FEE_PERCENTAGE at ComposableStablePoolFactory.getProtocolFeePercenragesProvider
+     */
+    maxProtocolSwapFeePercentage: bigint;
+}
+interface BalancerWeightedV4ModelInfo extends Omit<BalancerWeightedModelInfo, 'model'> {
+    model: DexModel.BalancerWeightedV4;
+}
+interface BalancerGyroECLPModelInfo extends Omit<BalancerWeightedModelInfo, 'model'> {
+    model: DexModel.BalancerGyroECLP;
+    params: Params;
+    derivedParams: DerivedParams;
+}
 interface DodoV2ModelInfo {
     model: DexModel.DodoV2 | DexModel.DodoV1;
     factoryContract: string;
@@ -536,7 +609,7 @@ interface RouteInfo {
 type RouteInfoModel = RouteInfo & {
     gas: bigint;
     isTradingAllowed: boolean;
-} & (UniswapV2BasedModelInfo | UniswapV3ModelInfo | PancakeV3ModelInfo | VelodromeSSModelInfo | AlgebraV1CLModelInfo | CurvePlainModelInfo | CurvePlainNGModelInfo | CurveMetaModelInfo | CurveCryptoModelInfo | CurveCryptoNGModelInfo | CurveCryptoZapModelInfo | CurveCryptoTwoZapModelInfo | CurveLendingModelInfo | CurveLidoModelInfo | DodoV2ModelInfo | SmoothyModelInfo | DMMModelInfo | BalancerWeightedModelInfo | BalancerStableModelInfo | BalancerMetaStableModelInfo | BalancerBoostedStableModelInfo | BalancerLinearModelInfo | PolyDexModelInfo | GmxDexModelInfo | SolidlyModelInfo | VelodromeV2ModelInfo | SynthetixModelInfo | {
+} & (UniswapV2BasedModelInfo | UniswapV3ModelInfo | PancakeV3ModelInfo | VelodromeSSModelInfo | AlgebraV1CLModelInfo | SolidlyV3ModelInfo | CurvePlainModelInfo | CurvePlainNGModelInfo | CurveMetaModelInfo | CurveCryptoModelInfo | CurveCryptoNGModelInfo | CurveCryptoZapModelInfo | CurveCryptoTwoZapModelInfo | CurveLendingModelInfo | CurveLidoModelInfo | DodoV2ModelInfo | SmoothyModelInfo | DMMModelInfo | BalancerWeightedModelInfo | BalancerStableModelInfo | BalancerMetaStableModelInfo | BalancerBoostedStableModelInfo | BalancerLinearModelInfo | BalancerComposableStableModelInfo | BalancerWeightedV4ModelInfo | BalancerGyroECLPModelInfo | PolyDexModelInfo | GmxDexModelInfo | SolidlyModelInfo | VelodromeV2ModelInfo | SynthetixModelInfo | {
     model: DexModel.Unknown;
 });
 
@@ -765,7 +838,7 @@ declare class WardenBestRate {
      * @param amountIn Amount of src asset to be traded
      * @param gasPrice Amount of gas price per unit in native currency (18 decimals)
      *                 e.g. BSC = BNB, Polygon = MATIC, Ethereum = ETH. For L2 chains,
-     *                 this is Ethereum (L1) gas price.
+     *                 this is price per byte of data.
      * @param opts Options for getting quote
      * @returns Trading routes which provide the best rate
      */

package/dist/index.es.d.ts

@@ -8,7 +8,8 @@ declare enum BESTRATE_NETWORK {
     polygon = "polygon",
     ethereum = "ethereum",
     avalanche = "avalanche",
-    optimism = "optimism"
+    optimism = "optimism",
+    base = "base"
 }
 type TokenInfo = {
     address: string;
@@ -292,46 +293,71 @@ interface Multicall2 extends BaseContract {
     };
 }
 
+type Params = {
+    alpha: bigint;
+    beta: bigint;
+    c: bigint;
+    s: bigint;
+    lambda: bigint;
+};
+type DerivedParams = {
+    tauAlpha: Vector2;
+    tauBeta: Vector2;
+    u: bigint;
+    v: bigint;
+    w: bigint;
+    z: bigint;
+    dSq: bigint;
+};
+type Vector2 = {
+    x: bigint;
+    y: bigint;
+};
+
 declare enum DexModel {
     UniswapV2 = 0,
     UniswapV3 = 1,
     PancakeV3 = 2,
     VelodromeSS = 3,
     AlgebraV1CL = 4,
-    DMM = 5,
-    CurvePlain = 6,
-    CurveMeta = 7,
-    CurvePlainSol = 8,
-    Iron = 9,
-    Synapse = 10,
-    CurveMetaSol = 11,
-    CurveCrypto = 12,
-    CurveTriCryptoNG = 13,
-    CurveStableNG = 14,
-    CurveLendingA = 15,
-    CurveLendingCryptoZap = 16,
-    CurveLendingCryptoTwoZap = 17,
-    CurveLido = 18,
-    PolyDex = 19,
-    FireBirdWeighted = 20,
-    BalancerWeighted = 21,
-    BalancerStable = 22,
-    BalancerMetaStable = 23,
-    BalancerBoostedStable = 24,
-    BalancerLinear = 25,
-    BalancerLiquidityBootstrapping = 26,
-    Biswap = 27,
-    DodoV1 = 28,
-    DodoV2 = 29,
-    Mdex = 30,
-    Mars = 31,
-    Smoothy = 32,
-    Shibaswap = 33,
-    GmxDex = 34,
-    Solidly = 35,
-    VelodromeV2 = 36,
-    Synthetix = 37,
-    Unknown = 38
+    SolidlyV3 = 5,
+    DMM = 6,
+    CurvePlain = 7,
+    CurveMeta = 8,
+    CurvePlainSol = 9,
+    Iron = 10,
+    Synapse = 11,
+    CurveMetaSol = 12,
+    CurveCrypto = 13,
+    CurveTriCryptoNG = 14,
+    CurveStableNG = 15,
+    CurveLendingA = 16,
+    CurveLendingCryptoZap = 17,
+    CurveLendingCryptoTwoZap = 18,
+    CurveLido = 19,
+    PolyDex = 20,
+    FireBirdWeighted = 21,
+    BalancerWeighted = 22,
+    BalancerStable = 23,
+    BalancerComposableStableV6 = 24,
+    BalancerWeightedV4 = 25,
+    BalancerGyroECLP = 26,
+    BalancerMetaStable = 27,
+    BalancerBoostedStable = 28,
+    BalancerLinear = 29,
+    BalancerLiquidityBootstrapping = 30,
+    Biswap = 31,
+    DodoV1 = 32,
+    DodoV2 = 33,
+    Mdex = 34,
+    Mars = 35,
+    Smoothy = 36,
+    Shibaswap = 37,
+    GmxDex = 38,
+    Solidly = 39,
+    VelodromeV2 = 40,
+    Synthetix = 41,
+    Unknown = 42
 }
 interface UniswapV2BasedModelInfo {
     model: DexModel.UniswapV2 | DexModel.Mdex | DexModel.Biswap | DexModel.Mars | DexModel.Shibaswap;
@@ -348,6 +374,10 @@ interface UniswapV3ModelInfo extends Omit<UniswapV2BasedModelInfo, 'model' | 'fe
     gasPerInitializedTick: bigint;
     gasPerTick: bigint;
 }
+interface SolidlyV3ModelInfo extends Omit<UniswapV3ModelInfo, 'model' | 'fee'> {
+    model: DexModel.SolidlyV3;
+    tickSpacing: bigint;
+}
 interface AlgebraV1CLModelInfo extends Omit<UniswapV3ModelInfo, 'model' | 'fee' | 'feePrecision' | 'factory'> {
     model: DexModel.AlgebraV1CL;
     poolDeployer: string;
@@ -456,8 +486,14 @@ interface BalancerWeightedModelInfo extends Omit<BalancerStableModelInfo, 'model
 interface BalancerStableModelInfo {
     model: DexModel.BalancerStable;
     tokens: string[];
+    /**
+     * Calculated from 1e18 * 10^(18-decimals)
+     */
     scalingFactors: bigint[];
     vaultContract: string;
+    /**
+     * Get from getPoolId() of pool contract
+     */
     poolId: string;
     aPrecision: bigint;
     depositAddress: string;
@@ -484,6 +520,43 @@ interface BalancerMetaStableModelInfo extends Omit<BalancerStableModelInfo, 'mod
     rateProviders: string[];
     multicall: string;
 }
+interface BalancerComposableStableModelInfo extends Omit<BalancerStableModelInfo, 'model' | 'aPrecision'> {
+    model: DexModel.BalancerComposableStableV6;
+    /**
+     * BPT token index
+     * Get from getBptIndex() at pool contract
+     */
+    bptIndex: number;
+    /**
+     * Rate providers, zero means no providers
+     * Get from getRateProviders() at pool contract
+     */
+    rateProviders: string[];
+    multicall: string;
+    /**
+     * A flag whether exempt from yield protocol fee
+     * Get from isExemptFromYieldProtocolFee() at pool contract
+     */
+    isExemptFromYieldProtocolFee: boolean;
+    /**
+     * A flag whether protocol swap fee delegation
+     * Get from getProtocolSwapFeeDelegation() at pool contract
+     */
+    isProtocolSwapFeeDelegation: boolean;
+    /**
+     * Maximum protocol's swap fee percentage
+     * Get from _MAX_PROTOCOL_SWAP_FEE_PERCENTAGE at ComposableStablePoolFactory.getProtocolFeePercenragesProvider
+     */
+    maxProtocolSwapFeePercentage: bigint;
+}
+interface BalancerWeightedV4ModelInfo extends Omit<BalancerWeightedModelInfo, 'model'> {
+    model: DexModel.BalancerWeightedV4;
+}
+interface BalancerGyroECLPModelInfo extends Omit<BalancerWeightedModelInfo, 'model'> {
+    model: DexModel.BalancerGyroECLP;
+    params: Params;
+    derivedParams: DerivedParams;
+}
 interface DodoV2ModelInfo {
     model: DexModel.DodoV2 | DexModel.DodoV1;
     factoryContract: string;
@@ -536,7 +609,7 @@ interface RouteInfo {
 type RouteInfoModel = RouteInfo & {
     gas: bigint;
     isTradingAllowed: boolean;
-} & (UniswapV2BasedModelInfo | UniswapV3ModelInfo | PancakeV3ModelInfo | VelodromeSSModelInfo | AlgebraV1CLModelInfo | CurvePlainModelInfo | CurvePlainNGModelInfo | CurveMetaModelInfo | CurveCryptoModelInfo | CurveCryptoNGModelInfo | CurveCryptoZapModelInfo | CurveCryptoTwoZapModelInfo | CurveLendingModelInfo | CurveLidoModelInfo | DodoV2ModelInfo | SmoothyModelInfo | DMMModelInfo | BalancerWeightedModelInfo | BalancerStableModelInfo | BalancerMetaStableModelInfo | BalancerBoostedStableModelInfo | BalancerLinearModelInfo | PolyDexModelInfo | GmxDexModelInfo | SolidlyModelInfo | VelodromeV2ModelInfo | SynthetixModelInfo | {
+} & (UniswapV2BasedModelInfo | UniswapV3ModelInfo | PancakeV3ModelInfo | VelodromeSSModelInfo | AlgebraV1CLModelInfo | SolidlyV3ModelInfo | CurvePlainModelInfo | CurvePlainNGModelInfo | CurveMetaModelInfo | CurveCryptoModelInfo | CurveCryptoNGModelInfo | CurveCryptoZapModelInfo | CurveCryptoTwoZapModelInfo | CurveLendingModelInfo | CurveLidoModelInfo | DodoV2ModelInfo | SmoothyModelInfo | DMMModelInfo | BalancerWeightedModelInfo | BalancerStableModelInfo | BalancerMetaStableModelInfo | BalancerBoostedStableModelInfo | BalancerLinearModelInfo | BalancerComposableStableModelInfo | BalancerWeightedV4ModelInfo | BalancerGyroECLPModelInfo | PolyDexModelInfo | GmxDexModelInfo | SolidlyModelInfo | VelodromeV2ModelInfo | SynthetixModelInfo | {
     model: DexModel.Unknown;
 });
 
@@ -765,7 +838,7 @@ declare class WardenBestRate {
      * @param amountIn Amount of src asset to be traded
      * @param gasPrice Amount of gas price per unit in native currency (18 decimals)
      *                 e.g. BSC = BNB, Polygon = MATIC, Ethereum = ETH. For L2 chains,
-     *                 this is Ethereum (L1) gas price.
+     *                 this is price per byte of data.
      * @param opts Options for getting quote
      * @returns Trading routes which provide the best rate
      */