@merkl/api 0.19.33 → 0.19.35

package/dist/src/modules/v4/campaign/campaign.controller.js

@@ -7,7 +7,8 @@ import Elysia, { t } from "elysia";
 import { throwOnUnsupportedChainId } from "src/utils/throw";
 import { DynamicDataService } from "../dynamicData/dynamicData.service";
 import { OpportunityService } from "../opportunity";
-import { CampaignResourceDto, CreateCampaignDto, GetCampaignQueryDto, RemoveManualOverrideDto, UpdateCampaignCreatorDto, UpdateCampaignDto, UpdateMetaDataCampaignDto, } from "./campaign.model";
+import { OpportunityConvertorService } from "../opportunity/opportunity.converter";
+import { CampaignResourceDto, CampaignUniqueDto, CreateCampaignDto, GetCampaignQueryDto, RemoveManualOverrideDto, UpdateCampaignCreatorDto, UpdateCampaignDto, UpdateMetaDataCampaignDto, } from "./campaign.model";
 import { CampaignService } from "./campaign.service";
 // ─── Campaigns Controller ────────────────────────────────────────────────────
 export const CampaignController = new Elysia({ prefix: "/campaigns", detail: { tags: ["Campaigns"] } })
@@ -50,71 +51,36 @@ export const CampaignController = new Elysia({ prefix: "/campaigns", detail: { t
     if (!id)
         throw new NotFoundError();
     const campaign = await CampaignService.findUniqueOrThrow(id, true);
-    const campaignV3 = {
-        amount: campaign.amount,
-        campaignId: campaign.campaignId,
-        mainParameter: campaign.Opportunity.identifier,
-        campaignParameters: campaign.params,
-        campaignSubType: campaign.subType,
-        campaignType: Campaign[campaign.type],
-        chainId: campaign.distributionChainId,
-        computeChainId: campaign.computeChainId,
-        creator: campaign.creatorAddress,
-        endTimestamp: Number(campaign.endTimestamp),
-        rewardToken: campaign.RewardToken.address,
-        startTimestamp: Number(campaign.startTimestamp),
-        index: 0,
-    };
+    const campaignV3 = OpportunityConvertorService.convertV4CampaignToV3(Campaign[campaign.type], CampaignService.format(campaign), campaign.Opportunity.identifier);
     return await DynamicDataService.updateForCampaigns([campaignV3]);
 }, { beforeHandle: BackOfficeGuard, headers: AuthorizationHeadersDto, detail: { hide: true } })
-    // ─── Test Dynamic and MetaData ──────────────────────────────────────────────
-    .get("/dry-run/:campaignId/dynamic-data", async ({ params }) => {
+    // ─── Route for dev and test only ──────────────────────────────────────────────
+    .group("/dry-run", app => app
+    // ─── Test Dynamic data computation given a campaignId ───────────────────────
+    .get("/:campaignId/dynamic-data", async ({ params }) => {
     const id = (await CampaignService.findMany({ campaignId: params.campaignId, test: true }))[0].id;
     if (!id)
         throw new NotFoundError();
     const campaign = await CampaignService.findUniqueOrThrow(id, true);
-    const campaignV3 = {
-        amount: campaign.amount,
-        campaignId: campaign.campaignId,
-        mainParameter: campaign.Opportunity.identifier,
-        campaignParameters: campaign.params,
-        campaignSubType: campaign.subType,
-        campaignType: Campaign[campaign.type],
-        chainId: campaign.distributionChainId,
-        computeChainId: campaign.computeChainId,
-        creator: campaign.creatorAddress,
-        endTimestamp: Number(campaign.endTimestamp),
-        rewardToken: campaign.RewardToken.address,
-        startTimestamp: Number(campaign.startTimestamp),
-        index: 0,
-    };
+    const campaignV3 = OpportunityConvertorService.convertV4CampaignToV3(Campaign[campaign.type], CampaignService.format(campaign), campaign.Opportunity.identifier);
     return await DynamicDataService.updateForCampaigns([campaignV3], true);
 }, { beforeHandle: BackOfficeGuard, headers: AuthorizationHeadersDto, detail: { hide: true } })
-    .get("/dry-run/:campaignId/meta-data", async ({ params }) => {
-    const id = (await CampaignService.findMany({ campaignId: params.campaignId, test: true }))[0].id;
-    if (!id)
-        throw new NotFoundError();
-    const campaign = await CampaignService.findUniqueOrThrow(id, true);
-    const campaignV3 = {
-        amount: campaign.amount,
-        campaignId: campaign.campaignId,
-        mainParameter: campaign.Opportunity.identifier,
-        campaignParameters: campaign.params,
-        campaignSubType: campaign.subType,
-        chainId: campaign.distributionChainId,
-        computeChainId: campaign.computeChainId,
-        creator: campaign.creatorAddress,
-        endTimestamp: campaign.endTimestamp.toString(),
-        rewardToken: campaign.RewardToken.address,
-        startTimestamp: campaign.startTimestamp.toString(),
-        index: 0,
-        type: Campaign[campaign.type],
-        params: JSON.stringify(campaign.params),
-        rewardTokenAddress: campaign.RewardToken.address,
-        opportunityIdentifier: campaign.Opportunity.identifier,
-    };
-    return await OpportunityService.fakeCreateFromCampaign(campaignV3);
-}, { beforeHandle: BackOfficeGuard, headers: AuthorizationHeadersDto, detail: { hide: true } })
+    // ─── Test Opportunity creation through a campaign Id and a chain ───────────────────────
+    // @dev Starts from the engine db to debug opportunity creation failing and preventing the api db to be filled
+    .get("/metadata", async ({ query }) => {
+    const [campaign] = await CampaignService.findEngineCampaigns([
+        {
+            distributionChain: query.distributionChain,
+            campaignId: query.campaignId,
+        },
+    ]);
+    return await OpportunityService.createFromCampaign(campaign, false, false);
+}, {
+    beforeHandle: BackOfficeGuard,
+    headers: AuthorizationHeadersDto,
+    query: CampaignUniqueDto,
+    detail: { hide: true },
+}))
     // ─── Get Many Campaigns ──────────────────────────────────────────────
     .get("/", async ({ query }) => {
     if (query.items === 0)

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

@@ -715,7 +715,7 @@ export declare abstract class CampaignRepository {
     static removeManualOverride(id: string, field: CampaignManualOverride): Promise<void>;
     static updateOpportunity(id: string, data: extendedUpdateCampaignModel): Promise<void>;
     static updateCreator(id: string, creatorAddress: string): Promise<void>;
-    static updateMetaData(id: string, params: string): Promise<{
+    static updateParams(id: string, params: string): Promise<{
         id: string;
         type: string;
         params: Prisma.JsonValue;

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

@@ -439,7 +439,7 @@ export class CampaignRepository {
         });
         await CampaignRepository.addManualOverride(id, "creatorAddress");
     }
-    static async updateMetaData(id, params) {
+    static async updateParams(id, params) {
         const updateData = {
             params: JSON.parse(params),
         };

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

@@ -616,6 +616,20 @@ export declare abstract class CampaignService {
     static pickCampaignToProcess(chainId: ChainId): Promise<{
         campaignId: string;
     }>;
+    static findEngineCampaigns(campaigns: CampaignUnique[]): Promise<{
+        amount: string;
+        chainId: number;
+        computeChainId: number;
+        creator: string;
+        endTimestamp: string;
+        campaignId: string;
+        opportunityIdentifier: string;
+        params: string;
+        rewardTokenAddress: string;
+        startTimestamp: string;
+        type: number;
+        subType: number;
+    }[]>;
     static fill(campaigns: CampaignUnique[]): Promise<{
         success: number;
         fail: number;

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

@@ -36,7 +36,8 @@ export class CampaignService {
         try {
             await OpportunityService.createFromCampaign(campaign);
         }
-        catch {
+        catch (e) {
+            console.error(e);
             throw new CannotParseOpportunity(campaign.campaignId, campaign.chainId, campaign.type);
         }
         return await CampaignRepository.upsert({ id, ...campaign });
@@ -46,17 +47,22 @@ export class CampaignService {
      * @dev deprecated should be replaced with a manual override
      */
     static async updateMetaData(campaign) {
-        const id = CampaignService.hashId({
+        const campaignUnique = {
             distributionChain: campaign.distributionChain,
             campaignId: campaign.campaignId,
-        });
-        const existingCampaign = await CampaignService.findUniqueOrThrow(campaign);
+        };
+        const id = CampaignService.hashId(campaignUnique);
+        let existingCampaign = await CampaignService.findUnique(campaign);
+        if (!existingCampaign) {
+            await CampaignService.fill([campaignUnique]);
+            existingCampaign = await CampaignService.findUniqueOrThrow(campaign);
+        }
         const params = existingCampaign.params;
         if ("url" in params) {
             params.url = campaign.url;
         }
         const updatedParams = JSON.stringify(params);
-        return await CampaignRepository.updateMetaData(id, updatedParams);
+        return await CampaignRepository.updateParams(id, updatedParams);
     }
     /**
      * @dev back-office function for manual overrides
@@ -181,8 +187,8 @@ export class CampaignService {
     }
     static async findCampaignsToProcess(distributionChainId) {
         return (await CampaignRepository.findCampaignsToProcess(distributionChainId))
-            .filter(campaign => campaign.endTimestamp > (campaign?.CampaignStatus?.[0]?.computedUntil ?? 0n))
-            ?.sort((a, b) => Number((a.CampaignStatus?.[0]?.processingStarted ?? 0n) - (b.CampaignStatus?.[0]?.processingStarted ?? 0n)));
+            .filter(campaign => campaign.endTimestamp > (campaign?.CampaignStatus?.[0]?.computedUntil ?? 0n)) // Filter out campaigns that have already been processed
+            ?.sort((a, b) => Number((a.CampaignStatus?.[0]?.processingStarted ?? 0n) - (b.CampaignStatus?.[0]?.processingStarted ?? 0n))); // Sort by processingStarted, that is to say campaigns that were processed the most long ago
     }
     static async findNextCampaignToProcess(chainId) {
         const campaigns = await CampaignService.findCampaignsToProcess(chainId);
@@ -202,31 +208,37 @@ export class CampaignService {
         }
         throw new Error(`No campaign to process found on ${NETWORK_LABELS[chainId]}`);
     }
-    static async fill(campaigns) {
+    static async findEngineCampaigns(campaigns) {
         const campaignsFromEngine = await CampaignRepository.getFromEngineDbWithId(campaigns);
         for (const campaign of campaigns) {
             if (campaignsFromEngine.findIndex(c => c.campaignId === campaign.campaignId) === -1) {
                 log.warn(`Campaign ${campaign.campaignId} on ${NETWORK_LABELS[campaign.distributionChain]} not found in engine db`);
             }
         }
+        return campaignsFromEngine.map(campaign => {
+            return {
+                amount: campaign.amount,
+                chainId: campaign.chainId,
+                computeChainId: campaign.computeChainId,
+                creator: campaign.creator,
+                endTimestamp: campaign.endTimestamp.toString(),
+                campaignId: campaign.campaignId,
+                opportunityIdentifier: campaign.mainParameter,
+                params: JSON.stringify(campaign.campaignParameters),
+                rewardTokenAddress: campaign.rewardToken,
+                startTimestamp: campaign.startTimestamp.toString(),
+                type: campaign.campaignType,
+                subType: campaign.campaignSubType,
+            };
+        });
+    }
+    static async fill(campaigns) {
+        const campaignsFromEngine = await CampaignService.findEngineCampaigns(campaigns);
         let success = 0;
         let fail = 0;
         for (const engineCampaign of campaignsFromEngine) {
             try {
-                await CampaignService.create({
-                    amount: engineCampaign.amount,
-                    chainId: engineCampaign.chainId,
-                    computeChainId: engineCampaign.computeChainId,
-                    creator: engineCampaign.creator,
-                    endTimestamp: engineCampaign.endTimestamp.toString(),
-                    campaignId: engineCampaign.campaignId,
-                    opportunityIdentifier: engineCampaign.mainParameter,
-                    params: JSON.stringify(engineCampaign.campaignParameters),
-                    rewardTokenAddress: engineCampaign.rewardToken,
-                    startTimestamp: engineCampaign.startTimestamp.toString(),
-                    type: engineCampaign.campaignType,
-                    subType: engineCampaign.campaignSubType,
-                });
+                await CampaignService.create(engineCampaign);
                 success++;
             }
             catch {

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

@@ -26,34 +26,12 @@ export declare abstract class OpportunityService {
         apr: number;
         dailyRewards: number;
     } | null>;
-    static fakeCreateFromCampaign(campaign: Omit<CreateCampaignModel, "id">): Promise<{
-        id: string;
-        chainId: number;
-        type: string;
-        identifier: string;
-        name: string;
-        status: "PAST" | "LIVE" | "SOON";
-        action: OpportunityAction;
-        tokens: ({
-            symbol: string;
-            id: string;
-            name: string | null;
-            icon: string;
-            address: string;
-            chainId: number;
-            decimals: number;
-            verified: boolean;
-            isTest: boolean;
-            isPoint: boolean;
-            isNative: boolean;
-        } & {
-            price?: number | null | undefined;
-        })[][];
-        mainProtocol: "splice" | "morpho" | "euler" | "ambient" | "uniswap" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "quick-swap" | "ramses" | "retro" | "stryke" | "sushiswap" | "swapr" | "thruster" | "voltage" | "zero" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "fraxlend" | "ironclad" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "satlayer" | undefined;
-        depositUrl: any;
-        tags: string[];
-    }>;
-    static createFromCampaign(campaign: Omit<CreateCampaignModel, "id">, upsert?: boolean): Promise<{
+    /**
+     * @param upsert whether to update the opportunity if it already exists in database
+     * @param dryRun whether to skip the opportunity table interaction and just return the computed opportunity
+     * @returns the opportunity entity computed
+     */
+    static createFromCampaign(campaign: Omit<CreateCampaignModel, "id">, upsert?: boolean, dryRun?: boolean): Promise<{
         id: string;
         chainId: number;
         type: string;

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

@@ -36,50 +36,12 @@ export class OpportunityService {
         const distributionChainId = campaign.chainId;
         return await metadataBuilderFactory(campaignType).build(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);
-        const tags = [...((await UserService.findUnique(campaign.creator))?.tags ?? []), ...(campaign?.tags ?? [])];
-        const opportunityId = OpportunityService.hashId({
-            chainId: campaign.computeChainId,
-            identifier: campaign.opportunityIdentifier,
-            type: campaignType,
-        });
-        const protocol = (await ProtocolService.findMany({ id: metadata.mainProtocol }))?.[0];
-        const tokens = await Promise.all(metadata.tokens.map(async (t) => {
-            return await TokenService.findMany(t);
-        }));
-        const params = JSON.parse(campaign.params);
-        const now = moment().unix();
-        const opportunity = {
-            id: opportunityId,
-            chainId: campaign.computeChainId,
-            type: campaignType,
-            identifier: campaign.opportunityIdentifier, // mainParameter
-            name: metadata.name,
-            status: now >= +campaign.startTimestamp && now < +campaign.endTimestamp
-                ? Status.LIVE
-                : now > +campaign.endTimestamp
-                    ? Status.PAST
-                    : Status.SOON,
-            action: metadata.action,
-            tokens,
-            mainProtocol: metadata.mainProtocol,
-            // 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
-            depositUrl: !!params.url
-                ? params.url
-                : !!metadata.depositUrl
-                    ? metadata.depositUrl
-                    : !!metadata.mainProtocol && !!protocol.url
-                        ? protocol.url
-                        : undefined,
-            tags,
-        };
-        return opportunity;
-    }
-    static async createFromCampaign(campaign, upsert = false) {
+    /**
+     * @param upsert whether to update the opportunity if it already exists in database
+     * @param dryRun whether to skip the opportunity table interaction and just return the computed opportunity
+     * @returns the opportunity entity computed
+     */
+    static async createFromCampaign(campaign, upsert = false, dryRun = false) {
         const campaignType = CampaignService.getTypeFromV3(campaign.type);
         const metadata = await OpportunityService.#getMetadata(campaign);
         const tags = [...((await UserService.findUnique(campaign.creator))?.tags ?? []), ...(campaign?.tags ?? [])];
@@ -118,7 +80,8 @@ export class OpportunityService {
                         : undefined,
             tags,
         };
-        await OpportunityRepository.create(opportunity, upsert);
+        if (!dryRun)
+            await OpportunityRepository.create(opportunity, upsert);
         return opportunity;
     }
     static async updateStatus(opportunityId, status) {

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

@@ -1143,45 +1143,44 @@ export declare const v4: Elysia<"/v4", false, {
             };
         } & {
             "dry-run": {
-                ":campaignId": {
-                    "meta-data": {
-                        get: {
-                            body: unknown;
-                            params: {
-                                campaignId: string;
-                            };
-                            query: unknown;
-                            headers: {
-                                authorization: string;
-                            };
-                            response: {
-                                200: {
+                metadata: {
+                    get: {
+                        body: unknown;
+                        params: {};
+                        query: {
+                            campaignId: string;
+                            distributionChain: number;
+                        };
+                        headers: {
+                            authorization: string;
+                        };
+                        response: {
+                            200: {
+                                id: string;
+                                chainId: number;
+                                type: string;
+                                identifier: string;
+                                name: string;
+                                status: "PAST" | "LIVE" | "SOON";
+                                action: any;
+                                tokens: ({
+                                    symbol: string;
                                     id: string;
+                                    name: string | null;
+                                    icon: string;
+                                    address: string;
                                     chainId: number;
-                                    type: string;
-                                    identifier: string;
-                                    name: string;
-                                    status: "PAST" | "LIVE" | "SOON";
-                                    action: any;
-                                    tokens: ({
-                                        symbol: string;
-                                        id: string;
-                                        name: string | null;
-                                        icon: string;
-                                        address: string;
-                                        chainId: number;
-                                        decimals: number;
-                                        verified: boolean;
-                                        isTest: boolean;
-                                        isPoint: boolean;
-                                        isNative: boolean;
-                                    } & {
-                                        price?: number | null | undefined;
-                                    })[][];
-                                    mainProtocol: "splice" | "morpho" | "euler" | "ambient" | "uniswap" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "quick-swap" | "ramses" | "retro" | "stryke" | "sushiswap" | "swapr" | "thruster" | "voltage" | "zero" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "fraxlend" | "ironclad" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "satlayer" | undefined;
-                                    depositUrl: any;
-                                    tags: string[];
-                                };
+                                    decimals: number;
+                                    verified: boolean;
+                                    isTest: boolean;
+                                    isPoint: boolean;
+                                    isNative: boolean;
+                                } & {
+                                    price?: number | null | undefined;
+                                })[];
+                                mainProtocol: "splice" | "morpho" | "euler" | "ambient" | "uniswap" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "quick-swap" | "ramses" | "retro" | "stryke" | "sushiswap" | "swapr" | "thruster" | "voltage" | "zero" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "fraxlend" | "ironclad" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "satlayer" | undefined;
+                                depositUrl: any;
+                                tags: string[];
                             };
                         };
                     };