@strkfarm/sdk 1.0.45 → 1.0.47

package/src/strategies/ekubo-cl-vault.tsx

@@ -57,7 +57,7 @@ export interface CLVaultStrategySettings {
   newBounds: {
     lower: number;
     upper: number;
-  };
+  } | string; // if no bounds are set, can say `Managed by Re7`
   // to get true price
   lstContract?: ContractAddr;
   truePrice?: number; // useful for pools where price is known (e.g. USDC/USDT as 1)
@@ -589,7 +589,9 @@ export class EkuboCLVault extends BaseStrategy<
     console.log(
       `EkuboCLVault: getCurrentPrice: blockIdentifier: ${blockIdentifier}, sqrtRatio: ${sqrtRatio}, ${priceInfo.sqrt_ratio.toString()}`
     );
-    const price = sqrtRatio * sqrtRatio;
+    const token0Info = await Global.getTokenInfoFromAddr(poolKey.token0);
+    const token1Info = await Global.getTokenInfoFromAddr(poolKey.token1);
+    const price = sqrtRatio * sqrtRatio * (10 ** token0Info.decimals) / ( 10 ** token1Info.decimals);
     const tick = EkuboCLVault.priceToTick(
       price,
       true,
@@ -619,7 +621,7 @@ export class EkuboCLVault extends BaseStrategy<
 
   static div2Power128(num: BigInt): number {
     return (
-      Number((BigInt(num.toString()) * 1000000n) / BigInt(2 ** 128)) / 1000000
+      Number((BigInt(num.toString()) * BigInt(1e18)) / BigInt(2 ** 128)) / 1e18
     );
   }
 
@@ -647,12 +649,6 @@ export class EkuboCLVault extends BaseStrategy<
       tick_spacing: result.pool_key.tick_spacing.toString(),
       extension: result.pool_key.extension.toString(),
     };
-    const token0Info = await Global.getTokenInfoFromAddr(poolKey.token0);
-    const token1Info = await Global.getTokenInfoFromAddr(poolKey.token1);
-    assert(
-      token0Info.decimals == token1Info.decimals,
-      "Tested only for equal decimals"
-    );
     this.poolKey = poolKey;
     return poolKey;
   }
@@ -661,6 +657,10 @@ export class EkuboCLVault extends BaseStrategy<
     const poolKey = await this.getPoolKey();
     const currentPrice = await this._getCurrentPrice(poolKey);
 
+    if (typeof this.metadata.additionalInfo.newBounds === "string") {
+      throw new Error(`New bounds are managed known, to be set manually/externally`);
+    }
+
     const newLower =
       currentPrice.tick +
       Number(this.metadata.additionalInfo.newBounds.lower) *
@@ -684,12 +684,12 @@ export class EkuboCLVault extends BaseStrategy<
    * @returns {amount0, amount1}
    */
   private async _getExpectedAmountsForLiquidity(
-    amount0: Web3Number,
-    amount1: Web3Number,
+    inputAmount0: Web3Number,
+    inputAmount1: Web3Number,
     bounds: EkuboBounds,
     justUseInputAmount = true
   ) {
-    assert(amount0.greaterThan(0) || amount1.greaterThan(0), "Amount is 0");
+    assert(inputAmount0.greaterThan(0) || inputAmount1.greaterThan(0), "Amount is 0");
 
     // get amount ratio for 1e18 liquidity
     const sampleLiq = 1e20;
@@ -713,47 +713,45 @@ export class EkuboCLVault extends BaseStrategy<
     );
     // Account for edge cases
     // i.e. when liquidity is out of range
-    if (amount1.eq(0) && amount0.greaterThan(0)) {
+    if (inputAmount1.eq(0) && inputAmount0.greaterThan(0)) {
       if (sampleAmount1.eq(0)) {
         return {
-          amount0: amount0,
-          amount1: Web3Number.fromWei("0", amount1.decimals),
+          amount0: inputAmount0,
+          amount1: Web3Number.fromWei("0", inputAmount1.decimals),
           ratio: Infinity,
         };
       } else if (sampleAmount0.eq(0)) {
         // swap all to token1
         return {
-          amount0: Web3Number.fromWei("0", amount0.decimals),
-          amount1: amount0.multipliedBy(price),
+          amount0: Web3Number.fromWei("0", inputAmount0.decimals),
+          // to ensure decimal consistency, we start with 0
+          amount1: Web3Number.fromWei("0", inputAmount1.decimals).plus(inputAmount0.toString()).multipliedBy(price),
           ratio: 0,
         };
       }
-    } else if (amount0.eq(0) && amount1.greaterThan(0)) {
+    } else if (inputAmount0.eq(0) && inputAmount1.greaterThan(0)) {
       if (sampleAmount0.eq(0)) {
         return {
-          amount0: Web3Number.fromWei("0", amount0.decimals),
-          amount1: amount1,
+          amount0: Web3Number.fromWei("0", inputAmount0.decimals),
+          amount1: inputAmount1,
           ratio: 0,
         };
       } else if (sampleAmount1.eq(0)) {
         // swap all to token0
         return {
-          amount0: amount1.dividedBy(price),
-          amount1: Web3Number.fromWei("0", amount1.decimals),
+          // to ensure decimal consistency, we start with 0
+          amount0: Web3Number.fromWei("0", inputAmount0.decimals).plus(inputAmount1.toString()).dividedBy(price),
+          amount1: Web3Number.fromWei("0", inputAmount1.decimals),
           ratio: Infinity,
         };
       }
     }
 
-    // must make it general later
-    assert(
-      sampleAmount0.decimals == sampleAmount1.decimals,
-      "Sample amounts have different decimals"
-    );
     const ratioWeb3Number = sampleAmount0
       .multipliedBy(1e18)
       .dividedBy(sampleAmount1.toString())
       .dividedBy(1e18);
+
     const ratio: number = Number(ratioWeb3Number.toFixed(18));
     logger.verbose(
       `${EkuboCLVault.name}: ${
@@ -763,8 +761,8 @@ export class EkuboCLVault extends BaseStrategy<
 
     if (justUseInputAmount)
       return this._solveExpectedAmountsEq(
-        amount0,
-        amount1,
+        inputAmount0,
+        inputAmount1,
         ratioWeb3Number,
         price
       );
@@ -772,20 +770,20 @@ export class EkuboCLVault extends BaseStrategy<
     // we are at liberty to propose amounts outside the propsed amount
     // assuming amount0 and amount1 as independent values, compute other amounts
     // Also, if code came till here, it means both sample amounts are non-zero
-    if (amount1.eq(0) && amount0.greaterThan(0)) {
+    if (inputAmount1.eq(0) && inputAmount0.greaterThan(0)) {
       // use amount0 as base and compute amount1 using ratio
-      const _amount1 = amount0.dividedBy(ratioWeb3Number);
+      const _amount1 = new Web3Number(inputAmount0.toString(), inputAmount1.decimals).dividedBy(ratioWeb3Number);
       return {
-        amount0: amount0,
+        amount0: inputAmount0,
         amount1: _amount1,
         ratio,
       };
-    } else if (amount0.eq(0) && amount1.greaterThan(0)) {
+    } else if (inputAmount0.eq(0) && inputAmount1.greaterThan(0)) {
       // use amount1 as base and compute amount0 using ratio
-      const _amount0 = amount1.multipliedBy(ratio);
+      const _amount0 = new Web3Number(inputAmount1.toString(), inputAmount0.decimals).multipliedBy(ratio);
       return {
         amount0: _amount0,
-        amount1: amount1,
+        amount1: inputAmount1,
         ratio,
       };
     } else {
@@ -876,7 +874,7 @@ export class EkuboCLVault extends BaseStrategy<
     };
   }
 
-  async getSwapInfoToHandleUnused(considerRebalance: boolean = true) {
+  async getSwapInfoToHandleUnused(considerRebalance: boolean = true, newBounds: EkuboBounds | null = null): Promise<SwapInfo> {
     const poolKey = await this.getPoolKey();
 
     // fetch current unused balances of vault
@@ -921,7 +919,9 @@ export class EkuboCLVault extends BaseStrategy<
 
     // get expected amounts for liquidity
     let ekuboBounds: EkuboBounds;
-    if (considerRebalance) {
+    if (newBounds) {
+      ekuboBounds = newBounds;
+    } else if (considerRebalance) {
       ekuboBounds = await this.getNewBounds();
     } else {
       ekuboBounds = await this.getCurrentBounds();
@@ -1269,7 +1269,11 @@ export class EkuboCLVault extends BaseStrategy<
     );
   }
 
-  static i129ToNumber(i129: { mag: bigint; sign: number }) {
+  static i129ToNumber(i129: { mag: bigint; sign: 0 | 1 | "true" | "false" }): bigint {
+    if (i129.sign == 0 || i129.sign == 1) {
+      return EkuboCLVault.i129ToNumber({mag: i129.mag, sign: i129.sign == 1 ? "true" : "false"});
+    }
+    assert(i129.sign.toString() == 'false' || i129.sign.toString() == 'true', "Invalid sign value");
     return i129.mag * (i129.sign.toString() == "false" ? 1n : -1n);
   }
 
@@ -1483,7 +1487,9 @@ export class EkuboCLVault extends BaseStrategy<
       subItems: [
         {
           key: "Range selection",
-          value: `${
+          value: (typeof this.metadata.additionalInfo.newBounds == 'string') ? 
+          this.metadata.additionalInfo.newBounds : 
+          `${
             this.metadata.additionalInfo.newBounds.lower *
             Number(poolKey.tick_spacing)
           } to ${
@@ -1551,86 +1557,89 @@ const faqs: FAQ[] = [
     ),
   },
 ];
+
+const xSTRKSTRK: IStrategyMetadata<CLVaultStrategySettings> = {
+  name: "Ekubo xSTRK/STRK",
+  description: (
+    <div>
+      <p>{_description.replace("{{POOL_NAME}}", "xSTRK/STRK")}</p>
+      <ul
+        style={{
+          marginLeft: "20px",
+          listStyle: "circle",
+          fontSize: "12px",
+        }}
+      >
+        <li style={{ marginTop: "10px" }}>
+          During withdrawal, you may receive either or both tokens depending
+          on market conditions and prevailing prices.
+        </li>
+        <li style={{ marginTop: "10px" }}>
+          Sometimes you might see a negative APY — this is usually not a big
+          deal. It happens when xSTRK's price drops on DEXes, but things
+          typically bounce back within a few days or a week.
+        </li>
+      </ul>
+    </div>
+  ),
+  address: ContractAddr.from(
+    "0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324"
+  ),
+  launchBlock: 1209881,
+  type: "Other",
+  // must be same order as poolKey token0 and token1
+  depositTokens: [
+    Global.getDefaultTokens().find((t) => t.symbol === "xSTRK")!,
+    Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
+  ],
+  protocols: [_protocol],
+  auditUrl: AUDIT_URL,
+  maxTVL: Web3Number.fromWei("0", 18),
+  risk: {
+    riskFactor: _riskFactor,
+    netRisk:
+      _riskFactor.reduce((acc, curr) => acc + curr.value * curr.weight, 0) /
+      _riskFactor.reduce((acc, curr) => acc + curr.weight, 0),
+    notARisks: getNoRiskTags(_riskFactor),
+  },
+  apyMethodology:
+    "APY based on 7-day historical performance, including fees and rewards.",
+  additionalInfo: {
+    newBounds: {
+      lower: -1,
+      upper: 1,
+    },
+    lstContract: ContractAddr.from(
+      "0x028d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a"
+    ),
+    feeBps: 1000,
+    rebalanceConditions: {
+      customShouldRebalance: async (currentPrice: number) => true,
+      minWaitHours: 24,
+      direction: "uponly",
+    },
+  },
+  faqs: [
+    ...faqs,
+    {
+      question: "Why might I see a negative APY?",
+      answer:
+        "A negative APY can occur when xSTRK's price drops on DEXes. This is usually temporary and tends to recover within a few days or a week.",
+    },
+  ],
+  points: [{
+    multiplier: 1, 
+    logo: 'https://endur.fi/favicon.ico',
+    toolTip: "This strategy holds xSTRK and STRK tokens. Earn 1x Endur points on your xSTRK portion of Liquidity. STRK portion will earn Endur's DEX Bonus points. Points can be found on endur.fi.",
+  }]
+};
+
 /**
  * Represents the Vesu Rebalance Strategies.
  */
 export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[] =
   [
-    {
-      name: "Ekubo xSTRK/STRK",
-      description: (
-        <div>
-          <p>{_description.replace("{{POOL_NAME}}", "xSTRK/STRK")}</p>
-          <ul
-            style={{
-              marginLeft: "20px",
-              listStyle: "circle",
-              fontSize: "12px",
-            }}
-          >
-            <li style={{ marginTop: "10px" }}>
-              During withdrawal, you may receive either or both tokens depending
-              on market conditions and prevailing prices.
-            </li>
-            <li style={{ marginTop: "10px" }}>
-              Sometimes you might see a negative APY — this is usually not a big
-              deal. It happens when xSTRK's price drops on DEXes, but things
-              typically bounce back within a few days or a week.
-            </li>
-          </ul>
-        </div>
-      ),
-      address: ContractAddr.from(
-        "0x01f083b98674bc21effee29ef443a00c7b9a500fd92cf30341a3da12c73f2324"
-      ),
-      launchBlock: 1209881,
-      type: "Other",
-      // must be same order as poolKey token0 and token1
-      depositTokens: [
-        Global.getDefaultTokens().find((t) => t.symbol === "xSTRK")!,
-        Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
-      ],
-      protocols: [_protocol],
-      auditUrl: AUDIT_URL,
-      maxTVL: Web3Number.fromWei("0", 18),
-      risk: {
-        riskFactor: _riskFactor,
-        netRisk:
-          _riskFactor.reduce((acc, curr) => acc + curr.value * curr.weight, 0) /
-          _riskFactor.reduce((acc, curr) => acc + curr.weight, 0),
-        notARisks: getNoRiskTags(_riskFactor),
-      },
-      apyMethodology:
-        "APY based on 7-day historical performance, including fees and rewards.",
-      additionalInfo: {
-        newBounds: {
-          lower: -1,
-          upper: 1,
-        },
-        lstContract: ContractAddr.from(
-          "0x028d709c875c0ceac3dce7065bec5328186dc89fe254527084d1689910954b0a"
-        ),
-        feeBps: 1000,
-        rebalanceConditions: {
-          customShouldRebalance: async (currentPrice: number) => true,
-          minWaitHours: 24,
-          direction: "uponly",
-        },
-      },
-      faqs: [
-        ...faqs,
-        {
-          question: "Why might I see a negative APY?",
-          answer:
-            "A negative APY can occur when xSTRK's price drops on DEXes. This is usually temporary and tends to recover within a few days or a week.",
-        },
-      ],
-      points: [{
-        multiplier: 1, 
-        logo: 'https://endur.fi/favicon.ico',
-        toolTip: "This strategy holds xSTRK and STRK tokens. Earn 1x Endur points on your xSTRK portion of Liquidity. STRK portion will earn Endur's DEX Bonus points. Points can be found on endur.fi.",
-      }]
-    },
+    xSTRKSTRK,
     {
       name: "Ekubo USDC/USDT",
       description: (
@@ -1690,4 +1699,46 @@ export const EkuboCLVaultStrategies: IStrategyMetadata<CLVaultStrategySettings>[
       },
       faqs: [...faqs],
     },
-  ];
+    // {
+    //   ...xSTRKSTRK,
+    //   name: "Ekubo STRK/USDC",
+    //   description: (
+    //     <div>
+    //       <p>{_description.replace("{{POOL_NAME}}", "STRK/USDC")}</p>
+    //       <ul
+    //         style={{
+    //           marginLeft: "20px",
+    //           listStyle: "circle",
+    //           fontSize: "12px",
+    //         }}
+    //       >
+    //         <li style={{ marginTop: "10px" }}>
+    //           During withdrawal, you may receive either or both tokens depending
+    //           on market conditions and prevailing prices.
+    //         </li>
+    //       </ul>
+    //     </div>
+    //   ),
+    //   address: ContractAddr.from(
+    //     "0xb7bd37121041261446d8eedec618955a4490641034942da688e8cbddea7b23"
+    //   ),
+    //   launchBlock: 1492136,
+    //   // must be same order as poolKey token0 and token1
+    //   depositTokens: [
+    //     Global.getDefaultTokens().find((t) => t.symbol === "STRK")!,
+    //     Global.getDefaultTokens().find((t) => t.symbol === "USDC")!,
+    //   ],
+    //   maxTVL: Web3Number.fromWei("0", 6),
+    //   additionalInfo: {
+    //     newBounds: "Managed by Re7",
+    //     feeBps: 1000,
+    //     rebalanceConditions: {
+    //       customShouldRebalance: async (currentPrice: number) =>
+    //         true,
+    //       minWaitHours: 6,
+    //       direction: "any",
+    //     },
+    //   },
+    // },
+];
+