Merge pull request #289 from Gearbox-protocol/lp-tokens

fix: lp tokens

Author: essserrr

package.json

@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "@gearbox-protocol/bots-v3": "^1.5.1",
-    "@gearbox-protocol/sdk-gov": "^2.15.1",
+    "@gearbox-protocol/sdk-gov": "^2.18.0",
     "@wagmi/cli": "^2.1.13",
     "axios": "^1.2.6",
     "decimal.js-light": "^2.5.1",

src/apy/index.ts

@@ -5,13 +5,14 @@ import {
   SupportedToken,
 } from "@gearbox-protocol/sdk-gov";
 
-type AdditionalTokensWithAPY = Extract<
-  SupportedToken,
-  "STETH" | "rETH" | "osETH" | "cbETH" | "wstETH" | "sfrxETH"
->;
-
-type AdditionalLPTokens = Extract<
+// all extra tokens
+type ExtraFarmTokens = Extract<
   SupportedToken,
+  | "STETH"
+  | "rETH"
+  | "osETH"
+  | "cbETH"
+  | "wstETH"
   | "weETH"
   | "ezETH"
   | "sfrxETH"
@@ -23,30 +24,24 @@ type AdditionalLPTokens = Extract<
   | "rstETH"
   | "steakLRT"
   | "amphrETH"
+  | "LBTC"
 >;
 
-type ExtraFarmTokens = AdditionalTokensWithAPY | AdditionalLPTokens;
-export type LRTAndLSDTokens = Extract<
+// tokens with apy among them
+type ExtraTokensWithAPY = Extract<
   ExtraFarmTokens,
-  | "weETH"
-  | "rsETH"
-  | "rswETH"
-  | "pufETH"
-  | "ezETH"
-  | "STETH"
-  | "wstETH"
-  | "sfrxETH"
-  | "osETH"
-  | "cbETH"
-  | "rETH"
+  "STETH" | "rETH" | "osETH" | "cbETH" | "wstETH" | "sfrxETH"
 >;
 
-export type TokensWithAPY = LPTokens | AdditionalTokensWithAPY;
-export type TokensWithApyRecord = PartialRecord<TokensWithAPY, number>;
-
-export type AllLPTokens = LPTokens | ExtraFarmTokens;
+// LRT & LST tokens among them
+type LRTAndLSTTokens = Exclude<ExtraFarmTokens, "USDe">;
 
-const ADDITIONAL_LP_TOKENS: Record<AdditionalLPTokens, true> = {
+const EXTRA_FARM_TOKENS: Record<ExtraFarmTokens, true> = {
+  STETH: true,
+  rETH: true,
+  osETH: true,
+  cbETH: true,
+  wstETH: true,
   weETH: true,
   ezETH: true,
   sfrxETH: true,
@@ -58,9 +53,15 @@ const ADDITIONAL_LP_TOKENS: Record<AdditionalLPTokens, true> = {
   rstETH: true,
   steakLRT: true,
   amphrETH: true,
+  LBTC: true,
+};
+
+export const isExtraFarmToken = (t: unknown): t is ExtraFarmTokens => {
+  if (typeof t !== "string") return false;
+  return !!EXTRA_FARM_TOKENS[t as ExtraFarmTokens];
 };
 
-const TOKENS_WITH_APY: Record<AdditionalTokensWithAPY, true> = {
+const EXTRA_TOKENS_WITH_APY: Record<ExtraTokensWithAPY, true> = {
   STETH: true,
   osETH: true,
   rETH: true,
@@ -69,45 +70,29 @@ const TOKENS_WITH_APY: Record<AdditionalTokensWithAPY, true> = {
   sfrxETH: true,
 };
 
-const LRT_LSD: Record<LRTAndLSDTokens, true> = {
-  weETH: true,
-  rsETH: true,
-  rswETH: true,
-  pufETH: true,
-  ezETH: true,
-  STETH: true,
-  wstETH: true,
-  sfrxETH: true,
-  osETH: true,
-  cbETH: true,
-  rETH: true,
-};
-
-export const isLRT_LSDToken = (t: unknown): t is LRTAndLSDTokens => {
+const isExtraTokenWithAPY = (t: unknown): t is ExtraTokensWithAPY => {
   if (typeof t !== "string") return false;
-  return !!LRT_LSD[t as LRTAndLSDTokens];
+  return !!EXTRA_TOKENS_WITH_APY[t as ExtraTokensWithAPY];
 };
 
-export const isAdditionalLPToken = (t: unknown): t is AdditionalLPTokens => {
-  if (typeof t !== "string") return false;
-  return !!ADDITIONAL_LP_TOKENS[t as AdditionalLPTokens];
-};
+const { USDe, ...rest } = EXTRA_FARM_TOKENS;
+const LRT_LST: Record<LRTAndLSTTokens, true> = rest;
 
-export const isAdditionalTokenWithAPY = (
-  t: unknown,
-): t is AdditionalTokensWithAPY => {
+export const isLRT_LSTToken = (t: unknown): t is LRTAndLSTTokens => {
   if (typeof t !== "string") return false;
-  return !!TOKENS_WITH_APY[t as AdditionalTokensWithAPY];
+  return !!LRT_LST[t as LRTAndLSTTokens];
 };
 
-export const isExtraFarmToken = (t: unknown): t is ExtraFarmTokens =>
-  isAdditionalLPToken(t) || isAdditionalTokenWithAPY(t);
+export type TokensWithAPY = LPTokens | ExtraTokensWithAPY;
+export type TokensWithApyRecord = PartialRecord<TokensWithAPY, number>;
 
 export const isTokenWithAPY = (t: unknown): t is TokensWithAPY => {
   if (typeof t !== "string") return false;
-  return isLPToken(t) || isAdditionalTokenWithAPY(t);
+  return isLPToken(t) || isExtraTokenWithAPY(t);
 };
 
+export type AllLPTokens = LPTokens | ExtraFarmTokens;
+
 export const isFarmToken = (t: unknown): t is AllLPTokens => {
   return isLPToken(t) || isExtraFarmToken(t);
 };

yarn.lock

@@ -1516,10 +1516,10 @@
     yarn "^1.22.19"
     zod "^3.22.2"
 
-"@gearbox-protocol/sdk-gov@^2.15.1":
-  version "2.15.1"
-  resolved "https://registry.yarnpkg.com/@gearbox-protocol/sdk-gov/-/sdk-gov-2.15.1.tgz#328ebb5c6c53b6e76431f4ace857e4088f3d7b6f"
-  integrity sha512-GwC4CgL0V0c6pOMPy2LpY3uP2H2p8me3DeOCSIGD4ZPpT3cvF/22mpojO9IoeLBg+bg53W8l2+gX/+Fkyz06vw==
+"@gearbox-protocol/sdk-gov@^2.18.0":
+  version "2.18.0"
+  resolved "https://registry.yarnpkg.com/@gearbox-protocol/sdk-gov/-/sdk-gov-2.18.0.tgz#bfef8a51355434d20d95998abb7cb3cbb84304e1"
+  integrity sha512-Gqf8mHOWFXwn2Nk8f926OsjDYHrTSh3QN3RL9fKCv8uv0vktPDg8KWZFfifljwQQ3nVGNKwqWaa8RcGr/rdAxw==
   dependencies:
     ethers "6.12.1"
     humanize-duration-ts "^2.1.1"