@merkl/api 0.17.34 → 0.17.36

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

@@ -77,7 +77,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                         identifier: string;
                         name: string;
                         status: "PAST" | "LIVE" | "SOON";
-                        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+                        action: any;
                         tokens: ({
                             symbol: string;
                             name: string | null;

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

@@ -5,7 +5,6 @@ import { type Protocol } from "../protocol/protocol.model";
 import { type DailyRewardsRecord } from "../reward/reward.model";
 import { type Token } from "../token/token.model";
 import { type TvlRecord } from "../tvl/tvl.model";
-import { OpportunityAction } from "../../../../database/api/.generated";
 import type { ChainId } from "@sdk";
 import { type Chain } from "../chain/chain.model";
 import type { OpportunityRepository } from "./opportunity.repository";
@@ -25,16 +24,6 @@ export type Opportunity = Resource<"Opportunity", "mainProtocolId", {
     campaigns?: Campaign["model"][];
 }>;
 export type LightOpportunityFromDB = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns">;
-export type OpportunityMetadata = {
-    name: string;
-    action: OpportunityAction;
-    tokens: {
-        chainId: number;
-        address: string;
-    }[];
-    mainProtocol?: string;
-    tags?: string[];
-};
 export type OpportunityUnique = {
     chainId: ChainId;
     type: string;

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

@@ -33,7 +33,7 @@ export declare abstract class OpportunityService {
         identifier: string;
         name: string;
         status: "SOON";
-        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+        action: OpportunityAction;
         mainProtocol: string | undefined;
         depositUrl: any;
         tags: string[];
@@ -45,7 +45,7 @@ export declare abstract class OpportunityService {
         identifier: string;
         name: string;
         status: "PAST" | "LIVE" | "SOON";
-        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+        action: OpportunityAction;
         tokens: ({
             symbol: string;
             name: string | null;
@@ -86,7 +86,7 @@ export declare abstract class OpportunityService {
         identifier: string;
         name: string;
         status: "PAST" | "LIVE" | "SOON";
-        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+        action: OpportunityAction;
         tokens: {
             price?: number | null | undefined;
             symbol: string;
@@ -113,7 +113,7 @@ export declare abstract class OpportunityService {
         identifier: string;
         name: string;
         status: "PAST" | "LIVE" | "SOON";
-        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+        action: OpportunityAction;
         tokens: ({
             symbol: string;
             name: string | null;

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

@@ -6,30 +6,12 @@ import { CampaignRepository } from "../campaign/campaign.repository";
 import { TokenService } from "../token/token.service";
 import { UserService } from "../user/user.service";
 import { log } from "../../../utils/logger";
-import { OpportunityAction, Prisma, Status } from "../../../../database/api/.generated";
+import { Prisma, Status } from "../../../../database/api/.generated";
 import { record } from "@elysiajs/opentelemetry";
 import { Campaign as CampaignEnum } from "@sdk";
 import moment from "moment";
+import { metadataBuilderFactory } from "../../../factories/metadataFactory/factory";
 import { OpportunityRepository } from "./opportunity.repository";
-import { getAjnaMetadata } from "./subservices/getAjnaMetadata.service";
-import { getAmbientMetadata } from "./subservices/getAmbientMetadata.service";
-import { getBadgerMetadata } from "./subservices/getBadgerMetadata.service";
-import { getClammMetadata } from "./subservices/getClammMetadata.service";
-import { getCompoundMetadata } from "./subservices/getCompoundMetadata.service";
-import { getDolomiteMetadata } from "./subservices/getDolomiteMetadata.service";
-import { getEigenLayerMetadata } from "./subservices/getEigenLayerMetadata.service";
-import { getEncompassingMetadata } from "./subservices/getEncompassingMetadata.service";
-import { getErc20Metadata } from "./subservices/getErc20Metadata.service";
-import { getErc20SnapshotMetadata } from "./subservices/getErc20SnapshotMetadata.service";
-import { getEulerMetadata } from "./subservices/getEulerMetadata.service";
-import { getEventBasedMetadata } from "./subservices/getEventBasedMetadata.service.ts";
-import { getHyperdriveMetadata } from "./subservices/getHyperdriveMetadata.service";
-import { getJsonAirdropMetadata } from "./subservices/getJsonAirDropMetadata.service";
-import { getMorphoMetadata } from "./subservices/getMorphoMetadata.service";
-import { getRadiantMetadata } from "./subservices/getRadiantMetadata.service";
-import { getSiloMetadata } from "./subservices/getSiloMetadata.service";
-import { getUniswapV4Metadata } from "./subservices/getUniswapV4Metadata.service";
-import { getVestMetadata } from "./subservices/getVestMetadata.service";
 export class OpportunityService {
     static hashId(opportunity) {
         return Bun.hash(`${opportunity.chainId}${opportunity.type}${opportunity.identifier}`).toString();
@@ -46,76 +28,18 @@ export class OpportunityService {
     /**
      * build/fetch metadata of a campaign's opportunity
      * @param campaign
-     * @returns {OpportunityMetadata}
      */
     static async #getMetadata(campaign) {
-        const campaignType = CampaignService.getTypeFromV3(campaign.type);
+        const campaignType = campaign.type;
         const campaignParams = JSON.parse(campaign.params);
-        const chainId = campaign.computeChainId === 0 ? campaign.chainId : campaign.computeChainId;
-        switch (campaignType) {
-            case "CLAMM":
-                return getClammMetadata(chainId, campaignParams);
-            case "ERC20":
-                return getErc20Metadata(chainId, campaign.chainId, // distributionChainId
-                campaign.campaignId, campaign.rewardTokenAddress, campaign.amount, campaignParams);
-            case "ERC20LOGPROCESSOR":
-                return getErc20Metadata(chainId, campaign.chainId, // distributionChainId
-                campaign.campaignId, campaign.rewardTokenAddress, campaign.amount, campaignParams);
-            case "ERC20REBASELOGPROCESSOR":
-                return getErc20Metadata(chainId, campaign.chainId, // distributionChainId
-                campaign.campaignId, campaign.rewardTokenAddress, campaign.amount, campaignParams);
-            case "ERC20_SNAPSHOT":
-                return getErc20SnapshotMetadata(chainId, campaignParams);
-            case "ERC20_FIX_APR":
-                return getErc20Metadata(chainId, campaign.chainId, // distributionChainId
-                campaign.campaignId, campaign.rewardTokenAddress, campaign.amount, campaignParams);
-            case "JSON_AIRDROP":
-                return getJsonAirdropMetadata(chainId, campaign.creator, campaignParams);
-            case "SILO":
-                return getSiloMetadata(chainId, campaign.subType, campaignParams);
-            case "RADIANT":
-                return getRadiantMetadata(chainId, campaign.subType, campaignParams);
-            case "MORPHO":
-                return getMorphoMetadata(chainId, campaign.subType, campaignParams);
-            case "DOLOMITE":
-                return getDolomiteMetadata(chainId, campaign.subType, campaignParams);
-            case "BADGER":
-                return getBadgerMetadata(chainId, campaignParams);
-            case "COMPOUND":
-                return getCompoundMetadata(chainId, campaign.subType, campaignParams);
-            case "AJNA":
-                return getAjnaMetadata(chainId, campaign.subType, campaignParams);
-            case "EIGENLAYER":
-                return getEigenLayerMetadata(chainId, campaignParams);
-            case "VEST":
-                return getVestMetadata(chainId, campaignParams);
-            case "EULER":
-                return getEulerMetadata(chainId, campaign.campaignId, campaign.subType, campaign.rewardTokenAddress, campaign.amount, campaignParams);
-            case "HYPERDRIVELOGPROCESSOR":
-            case "HYPERDRIVELOGFIXPROCESSOR":
-                return getHyperdriveMetadata(chainId, campaign.subType, campaignParams);
-            case "AMBIENTPROCESSOR":
-                return getAmbientMetadata(chainId, campaignParams);
-            case "UNISWAP_V4":
-                return getUniswapV4Metadata(chainId, campaignParams);
-            case "ENCOMPASSING":
-                return getEncompassingMetadata(chainId, campaign.rewardTokenAddress, campaignParams);
-            case "EVENT_BASED":
-                return getEventBasedMetadata(chainId, campaign.computeChainId, campaign.campaignId, campaign.rewardTokenAddress, campaign.amount, campaignParams);
-            case "INVALID":
-                return {
-                    name: "Invalid Campaigns",
-                    action: OpportunityAction.INVALID,
-                    tokens: [],
-                };
-            default:
-                throw "UNKNOWN CAMPAIGN TYPE";
-        }
+        const computeChainId = campaign.computeChainId === 0 ? campaign.chainId : campaign.computeChainId;
+        const distributionChainId = campaign.chainId;
+        return await metadataBuilderFactory(campaignType).getMetadata(computeChainId, campaignParams, campaign.subType, campaign.rewardTokenAddress, distributionChainId, campaign.campaignId, campaign.creator);
     }
     static async fakeCreateFromCampaign(campaign) {
         const campaignType = CampaignService.getTypeFromV3(campaign.type);
         const metadata = await OpportunityService.#getMetadata(campaign);
-        metadata.tags = [...((await UserService.findUnique(campaign.creator))?.tags ?? []), ...(campaign?.tags ?? [])];
+        const tags = [...((await UserService.findUnique(campaign.creator))?.tags ?? []), ...(campaign?.tags ?? [])];
         const opportunityId = OpportunityService.hashId({
             chainId: campaign.computeChainId,
             identifier: campaign.opportunityIdentifier,
@@ -132,14 +56,14 @@ export class OpportunityService {
             action: metadata.action,
             mainProtocol: metadata.mainProtocol,
             depositUrl: !!params.url ? params.url : undefined,
-            tags: metadata.tags,
+            tags,
         };
         return opportunity;
     }
     static async createFromCampaign(campaign, upsert = false) {
         const campaignType = CampaignService.getTypeFromV3(campaign.type);
         const metadata = await OpportunityService.#getMetadata(campaign);
-        metadata.tags = [...((await UserService.findUnique(campaign.creator))?.tags ?? []), ...(campaign?.tags ?? [])];
+        const tags = [...((await UserService.findUnique(campaign.creator))?.tags ?? []), ...(campaign?.tags ?? [])];
         const opportunityId = OpportunityService.hashId({
             chainId: campaign.computeChainId,
             identifier: campaign.opportunityIdentifier,
@@ -163,7 +87,7 @@ export class OpportunityService {
             tokens,
             mainProtocol: metadata.mainProtocol,
             depositUrl: !!params.url ? params.url : undefined,
-            tags: metadata.tags,
+            tags,
         };
         await OpportunityRepository.create(opportunity, upsert);
         return opportunity;

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

@@ -92,7 +92,7 @@ export declare const v4: Elysia<"/v4", false, {
                             identifier: string;
                             name: string;
                             status: "PAST" | "LIVE" | "SOON";
-                            action: import("../../../database/api/.generated").$Enums.OpportunityAction;
+                            action: any;
                             tokens: ({
                                 symbol: string;
                                 name: string | null;

package/dist/src/routes/v3/opportunity.js

@@ -1,7 +1,5 @@
-import { Redis } from "../../cache";
 import { OpportunityConvertorService } from "../../modules/v4/opportunity/opportunity.converter";
 import { t } from "elysia";
-import { fillCampaigns } from "../../entities/opportunity";
 import param from "../../types/parameters";
 export const query = t.Object({
     campaigns: t.Optional(t.Boolean()),
@@ -14,34 +12,8 @@ export const query = t.Object({
 });
 export default (app) => {
     return app.get("/opportunity", async ({ query: { campaigns: showCampaigns, ...filters } }) => {
-        if (process.env.FF_OPPORTUNITY === "true" || !!filters.testTokens) {
-            await OpportunityConvertorService.logKeyAndTTLV3Opportunities(showCampaigns ?? false, !!filters.testTokens ? filters.testTokens : undefined, !!filters.mainParameter ? filters.mainParameter : undefined, !!filters.chainId ? filters.chainId.toString() : undefined);
-            return await OpportunityConvertorService.wrapV3Opportunities(showCampaigns ?? false, !!filters.testTokens ? filters.testTokens : undefined, !!filters.mainParameter ? filters.mainParameter : undefined, !!filters.chainId ? filters.chainId.toString() : undefined);
-        }
-        const opportunities = await Redis.get(filters?.testTokens ? "OpportunitiesWithTest" : "Opportunities");
-        const returnedOpportunities = {};
-        const corresponds = (opp) => {
-            if (filters.type !== undefined && filters.type !== opp.campaigns.type)
-                return false;
-            if (filters.action !== undefined && filters.action !== opp.action)
-                return false;
-            if (filters.chainId !== undefined && filters.chainId !== opp.chainId)
-                return false;
-            if (filters.mainParameter !== undefined &&
-                filters.mainParameter?.toLowerCase() !== opp.id.split("_")?.[1]?.toLowerCase())
-                return false;
-            if (filters.tag !== undefined && !opp.tags?.includes(filters.tag))
-                return false;
-            return true;
-        };
-        for (const [id, opportunity] of Object.entries(opportunities)) {
-            if (!corresponds(opportunity))
-                continue;
-            returnedOpportunities[id] = opportunity;
-        }
-        if (!showCampaigns)
-            return returnedOpportunities;
-        return await fillCampaigns(returnedOpportunities, !showCampaigns, filters.testTokens);
+        await OpportunityConvertorService.logKeyAndTTLV3Opportunities(showCampaigns ?? false, !!filters.testTokens ? filters.testTokens : false, !!filters.mainParameter ? filters.mainParameter : undefined, !!filters.chainId ? filters.chainId.toString() : undefined);
+        return await OpportunityConvertorService.wrapV3Opportunities(showCampaigns ?? false, !!filters.testTokens ? filters.testTokens : false, !!filters.mainParameter ? filters.mainParameter : undefined, !!filters.chainId ? filters.chainId.toString() : undefined);
     }, {
         transform({ query }) {
             query.chainId = !query.chainId ? undefined : Number.parseInt(query.chainId.toString());