@merkl/api 0.20.5 → 0.20.7

package/dist/src/backgroundJobs/jobs/campaignsCacheUpdater.d.ts

@@ -1,5 +1,8 @@
 import { Campaign, type CampaignDynamicData, ChainId } from "@sdk";
 import { Elysia } from "elysia";
+/**
+ * @deprecated Used only for the v3/campaigns route
+ */
 export type CampaignsCacheUpdaterReturnType = {
     [type_mainParameter: string]: {
         [campaignId: string]: CampaignDynamicData<Campaign>;

package/dist/src/backgroundJobs/jobs/opportunityUpdater.d.ts

@@ -1,4 +1,7 @@
 import type Elysia from "elysia";
+/**
+ * @deprecated Used only for the v3/opportunity route
+ */
 export declare const opportunityUpdater: (app: Elysia) => Elysia<"", false, {
     decorator: {};
     store: {};

package/dist/src/backgroundJobs/jobs/opportunityUpdater.js

@@ -1,6 +1,9 @@
 // @ts-nocheck
 import { OpportunityConvertorService } from "@/modules/v4/opportunity/opportunity.converter";
 import { log } from "../../utils/logger";
+/**
+ * @deprecated Used only for the v3/opportunity route
+ */
 export const opportunityUpdater = (app) => {
     return app.get("/v3/updateOpportunities", async () => {
         log.info("✅ opportunity cache updated successfully");

package/dist/src/engine/opportunityMetadata/implementations/Clamm.js

@@ -75,7 +75,11 @@ export class ClammMetadata {
         if (mainProtocolId?.includes("stryke"))
             mainProtocolId = "stryke";
         else if (mainProtocolId?.includes("quickswap"))
-            mainProtocolId = "quickswap";
+            mainProtocolId = "quick-swap";
+        else if (mainProtocolId?.includes("quick-swap"))
+            mainProtocolId = "quick-swap";
+        else if (mainProtocolId?.includes("sushi-swap"))
+            mainProtocolId = "sushiswap";
         if (!!mainProtocolId) {
             // Make sure the protocol exist in the correct type
             const protocol = (await ProtocolService.findMany({ id: mainProtocolId }))?.[0];
@@ -136,13 +140,13 @@ export class ClammMetadata {
                 return "https:/app.horiza.io/liquidity";
             }
             case AMM.QuickswapAlgebra: {
-                return `https://quickswap.exchange/pools?currency0=${params.token0}&currency1=${params.token1}`;
+                return `https://quickswap.exchange/#/pools?currency0=${params.token0}&currency1=${params.token1}`;
             }
             case AMM.QuickswapUni: {
-                return `https://quickswap.exchange/pools?currency0=${params.token0}&currency1=${params.token1}`;
+                return `https://quickswap.exchange/#/pools?currency0=${params.token0}&currency1=${params.token1}`;
             }
             case AMM.QuickswapAlgebraV1_2: {
-                return `https://quickswap.exchange/pools?currency0=${params.token0}&currency1=${params.token1}`;
+                return `https://quickswap.exchange/#/pools?currency0=${params.token0}&currency1=${params.token1}`;
             }
             case AMM.Swapr: {
                 return "https://v3.swapr.eth.limo/#/swap";

package/dist/src/jobs/update-dynamic-data.js

@@ -46,6 +46,8 @@ const main = async () => {
             else if (status !== "LIVE" && campaign.startTimestamp > now)
                 status = "SOON";
         }
+        if (status === "PAST" && opportunity.apr !== 0)
+            await OpportunityService.update(opportunity.id, { status, apr: 0 });
         if (opportunity.status !== status)
             await OpportunityService.updateStatus(opportunity.id, status);
     }

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

@@ -102,11 +102,8 @@ export class DynamicDataService {
         const campaignTypeToCampaigns = new Map();
         for (const campaign of campaigns) {
             const type = campaign.campaignType;
-            let campaigns = campaignTypeToCampaigns.get(campaign.campaignType);
-            if (!campaigns)
-                campaigns = [campaign];
-            else
-                campaigns.push(campaign);
+            const campaigns = campaignTypeToCampaigns.get(campaign.campaignType) ?? [];
+            campaigns.push(campaign);
             campaignTypeToCampaigns.set(type, campaigns);
         }
         const dynamicDataArray = [];

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

@@ -4,7 +4,7 @@ import { type AprRecord } from "../apr";
 import type { Campaign } from "../campaign";
 import { type DailyRewardsRecord } from "../reward";
 import { type TvlRecord } from "../tvl";
-import type { CreateOpportunityModel, GetOpportunitiesQueryModel, UpdateOpportunityModel } from "./opportunity.model";
+import type { CreateOpportunityModel, GetOpportunitiesQueryModel, Opportunity, UpdateOpportunityModel } from "./opportunity.model";
 export declare abstract class OpportunityRepository {
     #private;
     static create(newOpp: CreateOpportunityModel, upsert?: boolean): Promise<{
@@ -981,7 +981,7 @@ export declare abstract class OpportunityRepository {
     static aggregateMax(field: keyof Prisma.OpportunityMaxAggregateInputType, query: GetOpportunitiesQueryModel): Promise<{
         max: string;
     }>;
-    static update(id: string, data: UpdateOpportunityModel): Promise<{
+    static update(id: string, data: Partial<Opportunity["raw"]>): Promise<{
         id: string;
         name: string;
         type: string;

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

@@ -287,7 +287,7 @@ export class OpportunityRepository {
                 MainProtocol: true,
                 Protocols: true,
                 Tokens: {
-                    where: !withTest ? { isTest: false, isPoint: withPoints } : undefined,
+                    where: !withTest ? { isTest: false } : undefined,
                 },
             },
             where: { id },
@@ -342,7 +342,7 @@ export class OpportunityRepository {
                 },
                 Protocols: true,
                 Tokens: {
-                    where: !withTest ? { isTest: false, isPoint: withPoints } : undefined,
+                    where: !withTest ? { isTest: false } : undefined,
                 },
             },
             ...args,

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

@@ -1,7 +1,7 @@
 import { type CreateCampaignModel, type GetCampaignQueryModel } from "@/modules/v4/campaign";
 import { Prisma, Status } from "@db/api";
 import { type ChainId, type MerklChainId } from "@sdk";
-import type { CreateOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, OpportunityResourceModel, OpportunityUnique, UpdateOpportunityModel } from "./opportunity.model";
+import type { CreateOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, Opportunity, OpportunityResourceModel, OpportunityUnique, UpdateOpportunityModel } from "./opportunity.model";
 import { OpportunityRepository } from "./opportunity.repository";
 export declare abstract class OpportunityService {
     #private;
@@ -945,7 +945,7 @@ export declare abstract class OpportunityService {
     static aggregateMax(query: GetOpportunitiesQueryModel, field: keyof Prisma.OpportunityMaxAggregateInputType): Promise<{
         max: string;
     }>;
-    static update(id: string, data: UpdateOpportunityModel): Promise<{
+    static update(id: string, data: Partial<Opportunity["raw"]>): Promise<{
         id: string;
         name: string;
         type: string;

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

@@ -206,7 +206,7 @@ export class OpportunityService {
             };
         const formated = {
             ...OpportunityService.formatResponseBase(opp),
-            apr: opp.status === "LIVE" ? opp.apr : 0,
+            apr: opp.apr,
             aprRecord,
             tvlRecord: TvlRecords?.map(({ id, total, timestamp, TvlBreakdown: breakdowns }) => ({
                 id,

package/dist/src/utils/generateCardName.js

@@ -1,5 +1,6 @@
 import { tokenType } from "@/engine/erc20SubTypeProcessors/helpers/tokenType";
 import { ChainId } from "@sdk";
+import { capitalize } from "lodash";
 export const stakingContractToStakingSymbol = {
     "0x18eeD20f71BEf84B605253C89A7576E3634134C0": "CyberStaking",
     "0x68754d29f2e97B837Cb622ccfF325adAC27E9977": "Karak",
@@ -39,21 +40,21 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
         case tokenType.pancakeswap:
         case tokenType.traderJoe:
         case tokenType.katana:
-            return `Provide liquidity to ${typeInfo.protocol} ${typeInfo.symbolToken0}-${typeInfo.symbolToken1}`;
+            return `Provide liquidity to ${capitalize(typeInfo.protocol)} ${typeInfo.symbolToken0}-${typeInfo.symbolToken1}`;
         case tokenType.pendleYT:
-            return `Hold ${typeInfo.protocol} ${typeInfo.name}`;
+            return `Hold ${capitalize(typeInfo.protocol)} ${typeInfo.name}`;
         case tokenType.pendle:
-            return `Provide ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
+            return `Provide ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.balancerGauge:
-            return `${typeInfo.protocol} ${symbols.join("-")}`;
+            return `${capitalize(typeInfo.protocol)} ${symbols.join("-")}`;
         case tokenType.beraborrow_gauge:
         case tokenType.beratrax_vault:
-            return `Deposit ${symbols.join("-")} on ${typeInfo.protocol}`;
+            return `Deposit ${symbols.join("-")} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.balancerPool: {
             if (campaign.computeChainId === ChainId.SONIC) {
                 typeInfo.protocol = "Beets";
             }
-            let cardName = `Provide liquidity to ${typeInfo.protocol} ${symbols.join("-")}`;
+            let cardName = `Provide liquidity to ${capitalize(typeInfo.protocol)} ${symbols.join("-")}`;
             if (typeInfo.vault === "0xFB43069f6d0473B85686a85F4Ce4Fc1FD8F00875") {
                 cardName = `Provide liquidity to Jellyverse Pool ${symbols.join("-")}`;
             }
@@ -63,23 +64,23 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
             if (campaign.computeChainId === ChainId.SONIC) {
                 typeInfo.protocol = "Beets";
             }
-            return `Provide liquidity to ${typeInfo.protocol} Boosted ${symbols.join("-")}`;
+            return `Provide liquidity to ${capitalize(typeInfo.protocol)} Boosted ${symbols.join("-")}`;
         }
         case tokenType.aura:
-            return `Provide liquidity to ${typeInfo.protocol} ${symbols.join("-")}`;
+            return `Provide liquidity to ${capitalize(typeInfo.protocol)} ${symbols.join("-")}`;
         case tokenType.gearbox:
-            return `${typeInfo.protocol} ${typeInfo.symbolUnderlyingToken} Deposit`;
+            return `${capitalize(typeInfo.protocol)} ${typeInfo.symbolUnderlyingToken} Deposit`;
         case tokenType.compound:
-            return `Lend ${typeInfo.symbolBaseToken} on ${typeInfo.protocol}`;
+            return `Lend ${typeInfo.symbolBaseToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.radiant_lend: {
             let cardToken = typeInfo.symbolUnderlyingToken;
             if (campaign.campaignParameters.symbolTargetToken.startsWith("r")) {
                 cardToken = campaign.campaignParameters.symbolTargetToken.substring(1);
             }
-            return `Lend ${cardToken} on ${typeInfo.protocol}`;
+            return `Lend ${cardToken} on ${capitalize(typeInfo.protocol)}`;
         }
         case tokenType.rfx:
-            return `Supply ${typeInfo.symbolShortToken}-${typeInfo.symbolLongToken} on ${typeInfo.protocol}`;
+            return `Supply ${typeInfo.symbolShortToken}-${typeInfo.symbolLongToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.radiant_borrow:
         case tokenType.aave_borrowing:
         case tokenType.vicuna_borrowing:
@@ -91,7 +92,7 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
         case tokenType.takotako_borrowing:
         case tokenType.lendle_borrowing:
         case tokenType.euler_borrow:
-            return `Borrow ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
+            return `Borrow ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.ionic:
         case tokenType.layerbank:
         case tokenType.moonwell:
@@ -109,45 +110,45 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
         case tokenType.venus:
         case tokenType.reactor_fusion:
         case tokenType.euler_lend:
-            return `Supply ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
+            return `Supply ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.metamorpho:
-            return `Supply to ${typeInfo.name} on ${typeInfo.protocol}`;
+            return `Supply to ${typeInfo.name} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.sturdy_aggregator:
-            return `Supply ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol} ${typeInfo.name}`;
+            return `Supply ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)} ${typeInfo.name}`;
         case tokenType.sturdy_silo:
-            return `Supply ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol} ${typeInfo.symbolCollateral} Silo`;
+            return `Supply ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)} ${typeInfo.symbolCollateral} Silo`;
         case tokenType.curve:
         case tokenType.curve_2:
-            return `Provide liquidity to ${typeInfo.protocol} ${Object.values(typeInfo.poolTokens).join("-")}`;
+            return `Provide liquidity to ${capitalize(typeInfo.protocol)} ${Object.values(typeInfo.poolTokens).join("-")}`;
         case tokenType.fluid:
-            return `Lend ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
+            return `Lend ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.enzyme:
-            return `Supply to the ${typeInfo.name} on ${typeInfo.protocol}`;
+            return `Supply to the ${typeInfo.name} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.filament:
-            return `Earn Yield on ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
+            return `Earn Yield on ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.silostaking:
-            return `Stake ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
+            return `Stake ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.beefy:
-            return `Provide liquidity to ${typeInfo.protocol} ${typeInfo.symbolToken0}-${typeInfo.symbolToken1}`;
+            return `Provide liquidity to ${capitalize(typeInfo.protocol)} ${typeInfo.symbolToken0}-${typeInfo.symbolToken1}`;
         case tokenType.toros:
-            return `${typeInfo.name} (${campaign.campaignParameters.symbolTargetToken}) on ${typeInfo.protocol}`;
+            return `${typeInfo.name} (${campaign.campaignParameters.symbolTargetToken}) on ${capitalize(typeInfo.protocol)}`;
         case tokenType.ironcladStaking:
-            return `Stake ${campaign.campaignParameters.symbolTargetToken} on ${typeInfo.protocol}`;
+            return `Stake ${campaign.campaignParameters.symbolTargetToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.woofi:
-            return `Supercharge ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
+            return `Supercharge ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.maverickBoostedPosition:
             return `Maverick Boosted Position ${campaign.campaignParameters.symbolTargetToken}`;
         case tokenType.zkSwapThreePool:
-            return `Provide liquidity to ${typeInfo.protocol} ${typeInfo.symbolToken0}-${typeInfo.symbolToken1}-${typeInfo.symbolToken2}`;
+            return `Provide liquidity to ${capitalize(typeInfo.protocol)} ${typeInfo.symbolToken0}-${typeInfo.symbolToken1}-${typeInfo.symbolToken2}`;
         case tokenType.maha:
-            return `Stake ${typeInfo.symbolToken0}-${typeInfo.symbolToken1} LP on ${typeInfo.protocol}`;
+            return `Stake ${typeInfo.symbolToken0}-${typeInfo.symbolToken1} LP on ${capitalize(typeInfo.protocol)}`;
         case tokenType.tempest:
         case tokenType.tempestStaking:
-            return `Deposit into ${typeInfo.symbolToken0}-${typeInfo.symbolToken1} vault on ${typeInfo.protocol}`;
+            return `Deposit into ${typeInfo.symbolToken0}-${typeInfo.symbolToken1} vault on ${capitalize(typeInfo.protocol)}`;
         case tokenType.holdstation:
-            return `Hold vault token ${campaign.campaignParameters.symbolTargetToken} on ${typeInfo.protocol}`;
+            return `Hold vault token ${campaign.campaignParameters.symbolTargetToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.cpmmGamma:
-            return `Provide ${typeInfo.symbolToken0}-${typeInfo.symbolToken1} on ${typeInfo.protocol}`;
+            return `Provide ${typeInfo.symbolToken0}-${typeInfo.symbolToken1} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.crosscurve:
             if (typeInfo.name.toLowerCase() === "eywa/usdt") {
                 return `Curve ${typeInfo.name}`;
@@ -162,7 +163,7 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
             return `Deposit liquidity on ${parsedNameForCard.replace("BALANCER", "Beets")} vault on Vicuna`;
         }
         case tokenType.satlayer:
-            return `Restake ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
+            return `Restake ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.veda:
             return `Deposit into ${typeInfo.name.replace("Ether.Fi", "Veda")}`;
         case tokenType.concrete: