@merkl/api 0.20.155 → 0.20.157

package/dist/src/modules/v4/opportunity/opportunity.model.js

@@ -13,8 +13,8 @@ export const OpportunityResourceDto = t.Object({
     type: t.String(),
     identifier: t.String(),
     name: t.String(),
-    description: t.Optional(t.String()),
-    howToSteps: t.Optional(t.Array(t.String())),
+    description: t.String(),
+    howToSteps: t.Array(t.String()),
     status: t.String(),
     action: t.String(),
     tvl: t.Number(),
@@ -103,6 +103,8 @@ export const CreateOpportunityDto = t.Object({
     name: t.Optional(t.String()),
     status: t.Enum(Status),
     action: t.Enum(OpportunityAction),
+    description: t.Optional(t.String()),
+    howToSteps: t.Optional(t.Array(t.String())),
     tokens: t.Array(TokenDto),
     protocols: t.Optional(t.Array(t.String())),
     mainProtocol: t.Optional(t.String()),

package/dist/src/modules/v4/opportunity/opportunity.repository.js

@@ -204,6 +204,8 @@ export class OpportunityRepository {
             status: newOpp.status,
             type: newOpp.type,
             tags: newOpp.tags,
+            description: newOpp.description,
+            howToSteps: newOpp.howToSteps,
             depositUrl: !previousOpportunity?.manualOverrides.includes("depositUrl")
                 ? newOpp.depositUrl
                 : previousOpportunity.depositUrl,
@@ -231,6 +233,8 @@ export class OpportunityRepository {
             status: newOpp.status,
             type: newOpp.type,
             tags: newOpp.tags,
+            description: newOpp.description,
+            howToSteps: newOpp.howToSteps,
             depositUrl: !previousOpportunity?.manualOverrides.includes("depositUrl") ? newOpp.depositUrl : undefined,
             explorerAddress: !previousOpportunity?.manualOverrides.includes("explorerAddress")
                 ? newOpp.explorerAddress

package/dist/src/modules/v4/opportunity/opportunity.service.d.ts

@@ -1,6 +1,8 @@
 import type { CampaignWithParams, GetCampaignQueryModel } from "@/modules/v4/campaign/campaign.model";
-import { type OpportunityManualOverride, type Prisma } from "@db/api";
+import { type OpportunityAction, type OpportunityManualOverride, type Prisma } from "@db/api";
 import { type MerklChainId } from "@sdk";
+import type { Protocol } from "../protocol/protocol.model";
+import type { Token } from "../token/token.model";
 import type { CreateOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, Opportunity, OpportunityOverrideModel, OpportunityResourceModel, OpportunityUnique } from "./opportunity.model";
 import { OpportunityRepository } from "./opportunity.repository";
 export declare abstract class OpportunityService {
@@ -95,6 +97,8 @@ export declare abstract class OpportunityService {
             price?: number | null | undefined;
         })[];
         mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "aura" | "poolside" | "gearbox" | "filament" | "fluid" | "compound" | "ionic" | "layerbank" | "moonwell" | "fraxlend" | "fenix" | "ra" | "syncswap" | "beefy" | "aerodrome" | "velodrome" | "curve" | "toros" | "akron" | "enzyme" | "dragonswap" | "koi" | "rfx" | "woofi" | "pendle" | "zkSwapThreePool" | "maha" | "tempest" | "holdstation" | "venus" | "reactor_fusion" | "vicuna" | "curveNPool" | "satlayer" | "veda" | "cian" | "concrete" | "hourglass" | "katana" | "gamma" | "stability" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "balancer" | "cross_curve" | "neptune" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "ironclad" | "sturdy" | "frax" | "silo" | "dolomite" | "badger" | "ajna" | "ion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "hyperdrive" | "oku" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "angles" | "bunni" | "beratrax" | "yei" | "gammaswap" | "uranium" | undefined;
+        description: string;
+        howToSteps: string[];
         depositUrl: string | undefined;
         explorerAddress: string | undefined;
         tags: string[];
@@ -223,6 +227,8 @@ export declare abstract class OpportunityService {
             price?: number | null | undefined;
         })[];
         mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "aura" | "poolside" | "gearbox" | "filament" | "fluid" | "compound" | "ionic" | "layerbank" | "moonwell" | "fraxlend" | "fenix" | "ra" | "syncswap" | "beefy" | "aerodrome" | "velodrome" | "curve" | "toros" | "akron" | "enzyme" | "dragonswap" | "koi" | "rfx" | "woofi" | "pendle" | "zkSwapThreePool" | "maha" | "tempest" | "holdstation" | "venus" | "reactor_fusion" | "vicuna" | "curveNPool" | "satlayer" | "veda" | "cian" | "concrete" | "hourglass" | "katana" | "gamma" | "stability" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "balancer" | "cross_curve" | "neptune" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "ironclad" | "sturdy" | "frax" | "silo" | "dolomite" | "badger" | "ajna" | "ion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "hyperdrive" | "oku" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "angles" | "bunni" | "beratrax" | "yei" | "gammaswap" | "uranium" | undefined;
+        description: string;
+        howToSteps: string[];
         depositUrl: string | undefined;
         explorerAddress: string | undefined;
         tags: string[];
@@ -299,6 +305,8 @@ export declare abstract class OpportunityService {
             price?: number | null | undefined;
         })[];
         mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "aura" | "poolside" | "gearbox" | "filament" | "fluid" | "compound" | "ionic" | "layerbank" | "moonwell" | "fraxlend" | "fenix" | "ra" | "syncswap" | "beefy" | "aerodrome" | "velodrome" | "curve" | "toros" | "akron" | "enzyme" | "dragonswap" | "koi" | "rfx" | "woofi" | "pendle" | "zkSwapThreePool" | "maha" | "tempest" | "holdstation" | "venus" | "reactor_fusion" | "vicuna" | "curveNPool" | "satlayer" | "veda" | "cian" | "concrete" | "hourglass" | "katana" | "gamma" | "stability" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "balancer" | "cross_curve" | "neptune" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "ironclad" | "sturdy" | "frax" | "silo" | "dolomite" | "badger" | "ajna" | "ion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "hyperdrive" | "oku" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "angles" | "bunni" | "beratrax" | "yei" | "gammaswap" | "uranium" | undefined;
+        description: string;
+        howToSteps: string[];
         depositUrl: string | undefined;
         explorerAddress: string | undefined;
         tags: string[];
@@ -318,9 +326,7 @@ export declare abstract class OpportunityService {
             tags: string[];
             icon: string;
         } | null | undefined;
-        description?: string | undefined;
         distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
-        howToSteps?: string[] | undefined;
         depositUrl?: string | undefined;
         explorerAddress?: string | undefined;
         aprRecord?: {
@@ -389,6 +395,7 @@ export declare abstract class OpportunityService {
             isPoint: boolean;
             isPreTGE: boolean;
         }[];
+        description: string;
         tags: string[];
         identifier: string;
         chain: {
@@ -398,6 +405,7 @@ export declare abstract class OpportunityService {
         };
         action: string;
         chainId: number;
+        howToSteps: string[];
         tvl: number;
         apr: number;
         dailyRewards: number;
@@ -466,9 +474,7 @@ export declare abstract class OpportunityService {
             tags: string[];
             icon: string;
         } | null | undefined;
-        description?: string | undefined;
         distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
-        howToSteps?: string[] | undefined;
         depositUrl?: string | undefined;
         explorerAddress?: string | undefined;
         aprRecord?: {
@@ -537,6 +543,7 @@ export declare abstract class OpportunityService {
             isPoint: boolean;
             isPreTGE: boolean;
         }[];
+        description: string;
         tags: string[];
         identifier: string;
         chain: {
@@ -546,6 +553,7 @@ export declare abstract class OpportunityService {
         };
         action: string;
         chainId: number;
+        howToSteps: string[];
         tvl: number;
         apr: number;
         dailyRewards: number;
@@ -1244,4 +1252,6 @@ export declare abstract class OpportunityService {
         lastCampaignCreatedAt: Date;
     }>;
     static updateMany(ids: string[], data: Partial<Opportunity["raw"]>): Promise<import("database/api/.generated/runtime/library").GetBatchResult>;
+    static description(action: OpportunityAction, tokens: Token["model"][], protocol: Protocol["model"], chainId: number): Promise<string>;
+    static howToSteps(action: OpportunityAction, tokens: Token["model"][], protocol: Protocol["model"]): string[];
 }

package/dist/src/modules/v4/opportunity/opportunity.service.js

@@ -10,6 +10,7 @@ import { AprType, Status } from "@db/api";
 import { Campaign as CampaignType } from "@sdk";
 import moment from "moment";
 import { metadataBuilderFactory } from "../../../engine/metadata/factory";
+import { ChainService } from "../chain/chain.service";
 import { ProtocolService } from "../protocol/protocol.service";
 import { OpportunityRepository } from "./opportunity.repository";
 export class OpportunityService {
@@ -79,6 +80,8 @@ export class OpportunityService {
             action: metadata.action,
             tokens,
             mainProtocol: metadata.mainProtocol,
+            description: await OpportunityService.description(metadata.action, tokens, protocol, campaign.computeChainId),
+            howToSteps: OpportunityService.howToSteps(metadata.action, tokens, protocol),
             // If creator has specified a deposit URL, use it
             // Else if we have the specific logic to handle the deposit URL, use it
             // Else if the protocol has a deposit URL, use it
@@ -271,4 +274,45 @@ export class OpportunityService {
     static async updateMany(ids, data) {
         return await OpportunityRepository.updateMany(ids, data);
     }
+    static async description(action, tokens, protocol, chainId) {
+        const chain = await ChainService.findUniqueOrThrow(chainId);
+        const symbols = tokens?.map(t => t.symbol).join("-");
+        if (action === "POOL")
+            return `Earn rewards by providing liquidity to the ${protocol?.name} ${symbols} pool on ${chain.name}, or through a liquidity manager supported by Merkl`;
+        if (action === "HOLD")
+            return `Earn rewards by holding ${symbols} or by staking it in a supported contract`;
+        if (action === "LEND")
+            return `Earn rewards by lending ${symbols} to ${protocol?.name} on ${chain.name}`;
+        if (action === "BORROW")
+            return `Earn rewards by taking a long position on ${protocol?.name} ${symbols} on ${chain.name}`;
+        if (action === "DROP")
+            return `Visit your dashboard to check if you've earned rewards from this airdrop`;
+        if (action === "LONG")
+            return `Borrow ${symbols} on ${protocol?.name} on ${chain.name}`;
+        if (action === "SHORT")
+            return `Earn rewards by taking a short position on ${protocol?.name} ${symbols} on ${chain.name}`;
+        if (action === "SWAP")
+            return `Earn rewards by trading ${symbols} on ${chain.name}`;
+        return "";
+    }
+    static howToSteps(action, tokens, protocol) {
+        const symbols = tokens?.map(t => t.symbol).join("-");
+        if (action === "POOL")
+            return [`Provide liquidity on ${protocol?.name}.`, "Earn rewards based on your liquidity position."];
+        if (action === "HOLD")
+            return [`Hold ${symbols}.`, "Rewards accumulate automatically."];
+        if (action === "LEND")
+            return [`Lend assets on ${protocol?.name}.`, "Rewards accumulate automatically."];
+        if (action === "BORROW")
+            return [`Borrow assets on ${protocol?.name}.`, "Rewards accumulate automatically."];
+        if (action === "DROP")
+            return ["Check your eligibility on Merkl."];
+        if (action === "LONG")
+            return [`Open a long position on ${protocol?.name}.`, "Rewards accumulate automatically."];
+        if (action === "SHORT")
+            return [`Open a short position on ${protocol?.name}.`, "Rewards accumulate automatically."];
+        if (action === "SWAP")
+            return [`Swap on ${protocol?.name}.`, "Rewards accumulate automatically."];
+        return [];
+    }
 }

package/dist/src/modules/v4/router.d.ts

@@ -32,7 +32,9 @@ export declare const v4: Elysia<"/v4", false, {
                 post: {
                     body: {
                         name?: string | undefined;
+                        description?: string | undefined;
                         tags?: string[] | undefined;
+                        howToSteps?: string[] | undefined;
                         depositUrl?: string | undefined;
                         explorerAddress?: string | undefined;
                         protocols?: string[] | undefined;
@@ -229,6 +231,8 @@ export declare const v4: Elysia<"/v4", false, {
                                     price?: number | null | undefined;
                                 })[];
                                 mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "aura" | "poolside" | "gearbox" | "filament" | "fluid" | "compound" | "ionic" | "layerbank" | "moonwell" | "fraxlend" | "fenix" | "ra" | "syncswap" | "beefy" | "aerodrome" | "velodrome" | "curve" | "toros" | "akron" | "enzyme" | "dragonswap" | "koi" | "rfx" | "woofi" | "pendle" | "zkSwapThreePool" | "maha" | "tempest" | "holdstation" | "venus" | "reactor_fusion" | "vicuna" | "curveNPool" | "satlayer" | "veda" | "cian" | "concrete" | "hourglass" | "katana" | "gamma" | "stability" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "balancer" | "cross_curve" | "neptune" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "ironclad" | "sturdy" | "frax" | "silo" | "dolomite" | "badger" | "ajna" | "ion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "hyperdrive" | "oku" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "angles" | "bunni" | "beratrax" | "yei" | "gammaswap" | "uranium" | undefined;
+                                description: string;
+                                howToSteps: string[];
                                 depositUrl: string | undefined;
                                 explorerAddress: string | undefined;
                                 tags: string[];
@@ -320,6 +324,8 @@ export declare const v4: Elysia<"/v4", false, {
                                 price?: number | null | undefined;
                             })[];
                             mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "aura" | "poolside" | "gearbox" | "filament" | "fluid" | "compound" | "ionic" | "layerbank" | "moonwell" | "fraxlend" | "fenix" | "ra" | "syncswap" | "beefy" | "aerodrome" | "velodrome" | "curve" | "toros" | "akron" | "enzyme" | "dragonswap" | "koi" | "rfx" | "woofi" | "pendle" | "zkSwapThreePool" | "maha" | "tempest" | "holdstation" | "venus" | "reactor_fusion" | "vicuna" | "curveNPool" | "satlayer" | "veda" | "cian" | "concrete" | "hourglass" | "katana" | "gamma" | "stability" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "balancer" | "cross_curve" | "neptune" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "ironclad" | "sturdy" | "frax" | "silo" | "dolomite" | "badger" | "ajna" | "ion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "hyperdrive" | "oku" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "angles" | "bunni" | "beratrax" | "yei" | "gammaswap" | "uranium" | undefined;
+                            description: string;
+                            howToSteps: string[];
                             depositUrl: string | undefined;
                             explorerAddress: string | undefined;
                             tags: string[];
@@ -605,9 +611,7 @@ export declare const v4: Elysia<"/v4", false, {
                                 tags: string[];
                                 icon: string;
                             } | null | undefined;
-                            description?: string | undefined;
                             distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
-                            howToSteps?: string[] | undefined;
                             depositUrl?: string | undefined;
                             explorerAddress?: string | undefined;
                             aprRecord?: {
@@ -676,6 +680,7 @@ export declare const v4: Elysia<"/v4", false, {
                                 isPoint: boolean;
                                 isPreTGE: boolean;
                             }[];
+                            description: string;
                             tags: string[];
                             identifier: string;
                             chain: {
@@ -685,6 +690,7 @@ export declare const v4: Elysia<"/v4", false, {
                             };
                             action: string;
                             chainId: number;
+                            howToSteps: string[];
                             tvl: number;
                             apr: number;
                             dailyRewards: number;
@@ -744,9 +750,7 @@ export declare const v4: Elysia<"/v4", false, {
                                 tags: string[];
                                 icon: string;
                             } | null | undefined;
-                            description?: string | undefined;
                             distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
-                            howToSteps?: string[] | undefined;
                             depositUrl?: string | undefined;
                             explorerAddress?: string | undefined;
                             aprRecord?: {
@@ -815,6 +819,7 @@ export declare const v4: Elysia<"/v4", false, {
                                 isPoint: boolean;
                                 isPreTGE: boolean;
                             }[];
+                            description: string;
                             tags: string[];
                             identifier: string;
                             chain: {
@@ -824,6 +829,7 @@ export declare const v4: Elysia<"/v4", false, {
                             };
                             action: string;
                             chainId: number;
+                            howToSteps: string[];
                             tvl: number;
                             apr: number;
                             dailyRewards: number;
@@ -920,9 +926,7 @@ export declare const v4: Elysia<"/v4", false, {
                                     tags: string[];
                                     icon: string;
                                 } | null | undefined;
-                                description?: string | undefined;
                                 distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
-                                howToSteps?: string[] | undefined;
                                 depositUrl?: string | undefined;
                                 explorerAddress?: string | undefined;
                                 aprRecord?: {
@@ -991,6 +995,7 @@ export declare const v4: Elysia<"/v4", false, {
                                     isPoint: boolean;
                                     isPreTGE: boolean;
                                 }[];
+                                description: string;
                                 tags: string[];
                                 identifier: string;
                                 chain: {
@@ -1000,6 +1005,7 @@ export declare const v4: Elysia<"/v4", false, {
                                 };
                                 action: string;
                                 chainId: number;
+                                howToSteps: string[];
                                 tvl: number;
                                 apr: number;
                                 dailyRewards: number;
@@ -1317,6 +1323,8 @@ export declare const v4: Elysia<"/v4", false, {
                                 price?: number | null | undefined;
                             })[];
                             mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "aura" | "poolside" | "gearbox" | "filament" | "fluid" | "compound" | "ionic" | "layerbank" | "moonwell" | "fraxlend" | "fenix" | "ra" | "syncswap" | "beefy" | "aerodrome" | "velodrome" | "curve" | "toros" | "akron" | "enzyme" | "dragonswap" | "koi" | "rfx" | "woofi" | "pendle" | "zkSwapThreePool" | "maha" | "tempest" | "holdstation" | "venus" | "reactor_fusion" | "vicuna" | "curveNPool" | "satlayer" | "veda" | "cian" | "concrete" | "hourglass" | "katana" | "gamma" | "stability" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "balancer" | "cross_curve" | "neptune" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "ironclad" | "sturdy" | "frax" | "silo" | "dolomite" | "badger" | "ajna" | "ion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "hyperdrive" | "oku" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "angles" | "bunni" | "beratrax" | "yei" | "gammaswap" | "uranium" | undefined;
+                            description: string;
+                            howToSteps: string[];
                             depositUrl: string | undefined;
                             explorerAddress: string | undefined;
                             tags: string[];
@@ -1414,6 +1422,24 @@ export declare const v4: Elysia<"/v4", false, {
                     };
                 };
             };
+        } & {
+            tvls: {
+                ":opportunityId": {
+                    put: {
+                        body: unknown;
+                        params: {
+                            opportunityId: string;
+                        };
+                        query: unknown;
+                        headers: {
+                            authorization: string;
+                        };
+                        response: {
+                            200: unknown[];
+                        };
+                    };
+                };
+            };
         } & {
             index: {
                 get: {
@@ -1694,21 +1720,6 @@ export declare const v4: Elysia<"/v4", false, {
                 };
             };
         };
-        campaignstvls: {
-            ":opportunityId": {
-                put: {
-                    body: unknown;
-                    params: {
-                        opportunityId: string;
-                    };
-                    query: unknown;
-                    headers: unknown;
-                    response: {
-                        200: unknown[];
-                    };
-                };
-            };
-        };
     } & {
         campaigns: {
             index: {
@@ -1990,37 +2001,41 @@ export declare const v4: Elysia<"/v4", false, {
 } & {
     v4: {
         campaigns: {
-            "dry-runtvl": {
-                ":campaignId": {
-                    get: {
-                        body: unknown;
-                        params: {
-                            campaignId: string;
-                        };
-                        query: unknown;
-                        headers: {
-                            authorization: string;
-                        };
-                        response: {
-                            200: unknown[];
+            "dry-run": {
+                tvl: {
+                    ":campaignId": {
+                        get: {
+                            body: unknown;
+                            params: {
+                                campaignId: string;
+                            };
+                            query: unknown;
+                            headers: {
+                                authorization: string;
+                            };
+                            response: {
+                                200: unknown[];
+                            };
                         };
                     };
                 };
             };
         } & {
-            "dry-runtvls": {
-                ":opportunityId": {
-                    get: {
-                        body: unknown;
-                        params: {
-                            opportunityId: string;
-                        };
-                        query: unknown;
-                        headers: {
-                            authorization: string;
-                        };
-                        response: {
-                            200: unknown[];
+            "dry-run": {
+                tvls: {
+                    ":opportunityId": {
+                        get: {
+                            body: unknown;
+                            params: {
+                                opportunityId: string;
+                            };
+                            query: unknown;
+                            headers: {
+                                authorization: string;
+                            };
+                            response: {
+                                200: unknown[];
+                            };
                         };
                     };
                 };
@@ -2211,6 +2226,8 @@ export declare const v4: Elysia<"/v4", false, {
                                     price?: number | null | undefined;
                                 })[];
                                 mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "aura" | "poolside" | "gearbox" | "filament" | "fluid" | "compound" | "ionic" | "layerbank" | "moonwell" | "fraxlend" | "fenix" | "ra" | "syncswap" | "beefy" | "aerodrome" | "velodrome" | "curve" | "toros" | "akron" | "enzyme" | "dragonswap" | "koi" | "rfx" | "woofi" | "pendle" | "zkSwapThreePool" | "maha" | "tempest" | "holdstation" | "venus" | "reactor_fusion" | "vicuna" | "curveNPool" | "satlayer" | "veda" | "cian" | "concrete" | "hourglass" | "katana" | "gamma" | "stability" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "balancer" | "cross_curve" | "neptune" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "ironclad" | "sturdy" | "frax" | "silo" | "dolomite" | "badger" | "ajna" | "ion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "hyperdrive" | "oku" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "angles" | "bunni" | "beratrax" | "yei" | "gammaswap" | "uranium" | undefined;
+                                description: string;
+                                howToSteps: string[];
                                 depositUrl: string | undefined;
                                 explorerAddress: string | undefined;
                                 tags: string[];
@@ -2319,6 +2336,8 @@ export declare const v4: Elysia<"/v4", false, {
                                     price?: number | null | undefined;
                                 })[];
                                 mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "aura" | "poolside" | "gearbox" | "filament" | "fluid" | "compound" | "ionic" | "layerbank" | "moonwell" | "fraxlend" | "fenix" | "ra" | "syncswap" | "beefy" | "aerodrome" | "velodrome" | "curve" | "toros" | "akron" | "enzyme" | "dragonswap" | "koi" | "rfx" | "woofi" | "pendle" | "zkSwapThreePool" | "maha" | "tempest" | "holdstation" | "venus" | "reactor_fusion" | "vicuna" | "curveNPool" | "satlayer" | "veda" | "cian" | "concrete" | "hourglass" | "katana" | "gamma" | "stability" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "balancer" | "cross_curve" | "neptune" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "ironclad" | "sturdy" | "frax" | "silo" | "dolomite" | "badger" | "ajna" | "ion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "hyperdrive" | "oku" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "angles" | "bunni" | "beratrax" | "yei" | "gammaswap" | "uranium" | undefined;
+                                description: string;
+                                howToSteps: string[];
                                 depositUrl: string | undefined;
                                 explorerAddress: string | undefined;
                                 tags: string[];

package/dist/src/scripts/fill-descriptions.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/src/scripts/fill-descriptions.js

@@ -0,0 +1,101 @@
+import { OpportunityService } from "@/modules/v4/opportunity/opportunity.service";
+import { apiDbClient } from "@db";
+let page = 0;
+while (true) {
+    const opportunities = await apiDbClient.opportunity.findMany({
+        select: {
+            id: true,
+            name: true,
+            explorerAddress: true,
+            depositUrl: true,
+            identifier: true,
+            MainProtocol: {
+                select: {
+                    url: true,
+                    name: true,
+                },
+            },
+            Chain: {
+                select: {
+                    name: true,
+                },
+            },
+            type: true,
+            action: true,
+            Tokens: {
+                select: {
+                    symbol: true,
+                    address: true,
+                    name: true,
+                },
+            },
+            Campaigns: {
+                take: 1,
+                include: {
+                    RewardToken: {
+                        select: {
+                            address: true,
+                        },
+                    },
+                },
+            },
+            description: true,
+        },
+        take: 1000,
+        skip: page * 1000,
+    });
+    page += 1;
+    if (opportunities.length === 0) {
+        break;
+    }
+    for (const opportunity of opportunities) {
+        const { action, Tokens: tokens, MainProtocol: protocol, Chain: chain } = opportunity;
+        const symbols = tokens?.map(t => t.symbol).join("-");
+        let description = "";
+        switch (action) {
+            case "POOL":
+                description = `Earn rewards by providing liquidity to the ${protocol?.name} ${symbols} pool on ${chain.name}, or through a liquidity manager supported by Merkl`;
+                break;
+            case "HOLD":
+                description = `Earn rewards by holding ${symbols} or by staking it in a supported contract`;
+                break;
+            case "LEND":
+                description = `Earn rewards by lending ${symbols} to ${protocol?.name} on ${chain.name}`;
+                break;
+            case "BORROW":
+                description = `Earn rewards by taking a long position on ${protocol?.name} ${symbols} on ${chain.name}`;
+                break;
+            case "DROP":
+                description = `Visit your dashboard to check if you've earned rewards from this airdrop`;
+                break;
+            case "LONG":
+                description = `Borrow ${symbols} on ${protocol?.name} on ${chain.name}`;
+                break;
+            case "SHORT":
+                description = `Earn rewards by taking a short position on ${protocol?.name} ${symbols} on ${chain.name}`;
+                break;
+            case "SWAP":
+                description = `Earn rewards by trading ${symbols} on ${chain.name}`;
+                break;
+            default:
+                break;
+        }
+        const howToSteps = OpportunityService.howToSteps(action, tokens, protocol);
+        if (description !== opportunity.description) {
+            await apiDbClient.opportunity.update({
+                where: {
+                    id: opportunity.id,
+                },
+                data: {
+                    description,
+                    howToSteps,
+                },
+            });
+            console.log(`updated description for ${opportunity.id} - ${opportunity.name} to ${description}`);
+        }
+        else {
+            console.log(`no description for ${opportunity.id} - ${opportunity.name}`);
+        }
+    }
+}
+process.exit(0);