@merkl/api 0.20.106 → 0.20.109

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

@@ -9,7 +9,7 @@ import { log } from "@/utils/logger";
 import { Status } from "@db/api";
 import { Campaign as CampaignEnum } from "@sdk";
 import moment from "moment";
-import { metadataBuilderFactory } from "../../../engine/opportunityMetadata/factory";
+import { metadataBuilderFactory } from "../../../engine/metadata/factory";
 import { ProtocolService } from "../protocol/protocol.service";
 import { OpportunityRepository } from "./opportunity.repository";
 export class OpportunityService {
@@ -42,38 +42,34 @@ export class OpportunityService {
      * build/fetch metadata of a campaign's opportunity
      * @param campaign
      */
-    static async #getMetadata(campaign) {
-        const campaignType = campaign.type;
-        const campaignParams = JSON.parse(campaign.params);
-        const computeChainId = campaign.computeChainId === 0 ? campaign.chainId : campaign.computeChainId;
-        const distributionChainId = campaign.chainId;
-        return await metadataBuilderFactory(campaignType).build(computeChainId, campaignParams, campaign.subType, campaign.rewardTokenAddress, distributionChainId, campaign.campaignId, campaign.creator);
+    static async #getMetadata(campaign, opportunityIdentifier) {
+        const campaignType = CampaignEnum[campaign.type];
+        return await metadataBuilderFactory(campaignType).build(campaign, opportunityIdentifier);
     }
     /**
      * @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);
+    static async createFromCampaign(campaign, opportunityIdentifier, upsert = false, dryRun = false) {
         if (dryRun)
-            log.info(`opportunity creation dry run for ${campaign.campaignId} of type ${campaignType}`);
-        const metadata = await OpportunityService.#getMetadata(campaign);
-        const tags = [...((await UserService.findUnique(campaign.creator))?.tags ?? []), ...(campaign?.tags ?? [])];
+            log.info(`opportunity creation dry run for ${campaign.campaignId} of type ${campaign.type}`);
+        const metadata = await OpportunityService.#getMetadata(campaign, opportunityIdentifier);
+        const tags = (await UserService.findUnique(campaign.creatorAddress))?.tags ?? [];
         const opportunityId = OpportunityService.hashId({
             chainId: campaign.computeChainId,
-            identifier: campaign.opportunityIdentifier,
-            type: campaignType,
+            identifier: opportunityIdentifier,
+            type: campaign.type,
         });
         const tokens = (await TokenService.findManyOrCreate(metadata.tokens)).filter(t => t !== undefined);
         const now = moment().unix();
         const protocol = (await ProtocolService.findMany({ id: metadata.mainProtocol }))?.[0];
-        const params = JSON.parse(campaign.params);
+        const campaignUrl = campaign.params?.url;
         const opportunity = {
             id: opportunityId,
             chainId: campaign.computeChainId,
-            type: campaignType,
-            identifier: campaign.opportunityIdentifier, // mainParameter
+            type: campaign.type,
+            identifier: opportunityIdentifier, // mainParameter
             name: metadata.name,
             status: now >= +campaign.startTimestamp && now < +campaign.endTimestamp
                 ? Status.LIVE
@@ -86,8 +82,8 @@ export class OpportunityService {
             // 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
+            depositUrl: campaignUrl
+                ? campaignUrl
                 : !!metadata.depositUrl
                     ? metadata.depositUrl
                     : !!metadata.mainProtocol && !!protocol?.url
@@ -112,19 +108,7 @@ export class OpportunityService {
         const firstCampaigns = sortedCampaigns.filter(campaign => campaign.startTimestamp <= BigInt(moment().unix()));
         if (firstCampaigns.length > 0)
             firstCampaign = firstCampaigns[0];
-        return await OpportunityService.createFromCampaign({
-            ...firstCampaign,
-            type: CampaignEnum[firstCampaign.type],
-            chainId: firstCampaign.distributionChainId,
-            computeChainId: firstCampaign.computeChainId,
-            creator: firstCampaign.creatorAddress,
-            rewardTokenAddress: firstCampaign.RewardToken.address,
-            opportunityIdentifier: opportunity.identifier,
-            subType: firstCampaign.subType ?? undefined,
-            params: JSON.stringify(firstCampaign.params),
-            startTimestamp: firstCampaign.startTimestamp.toString(),
-            endTimestamp: firstCampaign.endTimestamp.toString(),
-        }, true // Upserting
+        return await OpportunityService.createFromCampaign(CampaignService.format(await CampaignService.findUniqueOrThrow(firstCampaign.campaignId)), opportunity.identifier, true // Upserting
         );
     }
     /**

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

@@ -18,7 +18,7 @@ export declare const ProgramPayloadController: Elysia<"/program-payload", false,
                 body: unknown;
                 params: {};
                 query: {
-                    apr?: number | undefined;
+                    apr?: string | undefined;
                     creator: string;
                     campaign: string;
                     distributionChainId: number;
@@ -51,7 +51,7 @@ export declare const ProgramPayloadController: Elysia<"/program-payload", false,
                 body: unknown;
                 params: {};
                 query: {
-                    apr?: number | undefined;
+                    apr?: string | undefined;
                     creator: string;
                     campaign: string;
                     distributionChainId: number;
@@ -96,7 +96,7 @@ export declare const ProgramPayloadController: Elysia<"/program-payload", false,
                 body: unknown;
                 params: {};
                 query: {
-                    apr?: number | undefined;
+                    apr?: string | undefined;
                     creator: string;
                     campaign: string;
                     distributionChainId: number;
@@ -123,7 +123,7 @@ export declare const ProgramPayloadController: Elysia<"/program-payload", false,
                 params: {};
                 query: {
                     amount?: string | undefined;
-                    apr?: number | undefined;
+                    apr?: string | undefined;
                     creator: string;
                     distributionChainId: number;
                     startTimestamp: number;
@@ -158,7 +158,7 @@ export declare const ProgramPayloadController: Elysia<"/program-payload", false,
                     params: {};
                     query: {
                         amount?: string | undefined;
-                        apr?: number | undefined;
+                        apr?: string | undefined;
                         creator: string;
                         distributionChainId: number;
                         startTimestamp: number;
@@ -194,13 +194,13 @@ export declare const ProgramPayloadController: Elysia<"/program-payload", false,
                         endTimestamp?: number | undefined;
                         blacklist?: string[] | undefined;
                         poolAddress?: string | undefined;
-                        contract?: string | undefined;
                         tokenId?: string | undefined;
                         marketId?: string | undefined;
                         strategy?: string | undefined;
                         poolId?: string | undefined;
-                        targetToken?: string | undefined;
+                        contract?: string | undefined;
                         forwarders?: (string | {})[] | undefined;
+                        targetToken?: string | undefined;
                         whitelist?: string[] | undefined;
                         isOutOfRangeIncentivized?: boolean | undefined;
                         weightFees?: number | undefined;

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

@@ -8,7 +8,7 @@ export declare const CampaignPayloadInputDto: import("@sinclair/typebox").TObjec
     startTimestamp: import("@sinclair/typebox").TNumber;
     endTimestamp: import("@sinclair/typebox").TNumber;
     amount: import("@sinclair/typebox").TString;
-    apr: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    apr: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
 }>;
 export declare const CampaignDataDto: import("@sinclair/typebox").TObject<{
     campaignType: import("@sinclair/typebox").TNumber;
@@ -64,7 +64,7 @@ export declare const ProgramPayloadInputDto: import("@sinclair/typebox").TObject
     startTimestamp: import("@sinclair/typebox").TNumber;
     endTimestamp: import("@sinclair/typebox").TNumber;
     amount: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
-    apr: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    apr: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
 }>;
 export declare const CampaignAmountsInputDto: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TString>;
 export type CampaignPayloadInputModel = typeof CampaignPayloadInputDto.static;
@@ -153,7 +153,7 @@ export type partialConfigERC20 = {
     blacklist: string[];
     url?: string;
     forwarders: ForwarderParameters<Forwarder>[];
-    apr?: number;
+    apr?: string;
 };
 export type partialConfigCompoundV3 = {
     computeChainId?: MerklChainId;

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

@@ -9,7 +9,7 @@ export const CampaignPayloadInputDto = t.Object({
     startTimestamp: t.Numeric({ description: "Start timestamp for the campaign" }),
     endTimestamp: t.Numeric({ description: "End timestamp for the campaign" }),
     amount: t.String({ description: "Amount of the reward token to be distributed" }),
-    apr: t.Optional(t.Numeric({ description: "APR for the campaign (Fixed APR campaigns)" })),
+    apr: t.Optional(t.String({ description: "APR for the campaign (Fixed APR campaigns)" })),
 });
 export const CampaignDataDto = t.Object({
     campaignType: t.Numeric({ description: "Type of the campaign 1 : ERC20, 2: CLAMM , ..." }),
@@ -65,7 +65,7 @@ export const ProgramPayloadInputDto = t.Object({
     startTimestamp: t.Numeric({ description: "Start timestamp for the campaign" }),
     endTimestamp: t.Numeric({ description: "End timestamp for the campaign" }),
     amount: t.Optional(t.String({ description: "Amount of the reward token to be distributed" })),
-    apr: t.Optional(t.Numeric({ description: "APR for the campaign (Fixed APR campaigns)" })),
+    apr: t.Optional(t.String({ description: "APR for the campaign (Fixed APR campaigns)" })),
 });
 export const CampaignAmountsInputDto = t.Record(t.String(), t.String());
 // ---- Template below ----

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

@@ -495,7 +495,24 @@ declare const RoninInterfaceCampaigns: {
 export declare enum tacCampaigns {
     TAC_Supply_TACETH = "TAC Supply tacETH 0x294eecec65A0142e84AEdfD8eB2FBEA8c9a9fbad",
     TAC_Supply_TACBTC = "TAC Supply tacBTC 0x6Bf340dB729d82af1F6443A0Ea0d79647b1c3DDf",
-    TAC_Supply_TACUSD = "TAC Supply tacUSD 0x699e04F98dE2Fc395a7dcBf36B48EC837A976490"
+    TAC_Supply_TACUSD = "TAC Supply tacUSD 0x699e04F98dE2Fc395a7dcBf36B48EC837A976490",
+    TAC_Supply_TACrsEth = "TAC Supply TACrsEth 0x419386E3Ef42368e602720CC458e00c0B28c47A7",
+    TAC_Supply_TACmBTC = "TAC Supply TACmBTC 0x307267989A7bec3A57FD7fd96017C49803589Fd0",
+    TAC_Supply_TACcbBTC = "TAC Supply TACcbBTC 0xeb402fc96C7ed2f889d837C9976D6d821c1B5f01",
+    TAC_Supply_TACmMEV = "TAC Supply TACmMEV 0xC2C26520256D5920B8aa1DA91F211222B2083B46",
+    TAC_Supply_TACmEDGE = "TAC Supply TACmEDGE 0xaa7BeE2d7dE06cB4E30564323Fb17C5029e7D567",
+    TAC_Supply_tacLBTCv = "TAC Supply tacLBTCv 0xD86fC1CaA0a5B82cC16B16B70DFC59F6f034C348",
+    TAC_Supply_tacUSR = "TAC Supply tacUSR 0x686c83Aa81ba206354fDcbc2cd282B4531365E29",
+    TAC_Supply_ctTACezETH = "TAC Supply ctTACezETH 0x25763b6597c9e0f10cb8481ef924472851480376",
+    TAC_Supply_ctTACSTONE = "TAC Supply ctTACSTONE 0x83a197fc495881d149e6843b20f0027a622dfb0a",
+    TAC_Supply_ctTACpufETH = "TAC Supply ctTACpufETH 0x78f314241df1ac151bfd0413eeb51979515f6abd",
+    TAC_Supply_ctTAClvlUSD = "TAC Supply ctTAClvlUSD 0x2119787c73c95d0c4d54ed8395c3f9593f70e136",
+    TAC_Supply_ylxSolvBTCs = "TAC Supply ylxSolvBTCs 0x0982eB22086183bF10acd2991A2dBeD1e3B9Ac2A",
+    TAC_Supply_ylpumpBTC = "TAC Supply ylpumpBTC 0xd72c3a44b51C8D6631C004ecf3A318b9D2c58F80",
+    TAC_Supply_ylxSolvBTC = "TAC Supply ylxSolvBTC 0x76f31800eFdE39A5f98189447c7a514d974f4364",
+    TAC_Supply_ctTACUSDB = "TAC Supply ctTACUSDB 0x729fcddf4cbbc9dce721a8378c25a726fe7e43d3",
+    TAC_Supply_ylFBTC = "TAC Supply ylFBTC 0x6945f516413cB2d7311297e8A39E7D004dEB5566",
+    TAC_Supply_ylMBTC = "TAC Supply ylMBTC 0x2B11527e1fab84a5382D20efD198BF3d332f7E73"
 }
 declare const AnglesInterfaceCampaigns: {
     "0x15E96CDecA34B9DE1B31586c1206206aDb92E69D": {
@@ -1118,13 +1135,14 @@ declare const TACInterfaceCampaigns: {
         distributionChainId: any;
         targetToken: string;
         rewardToken: string;
+        creator: string;
         hooks: never[];
         whitelist: never[];
         blacklist: never[];
         forwarders: never[];
         rewardTokenPricing: boolean;
         targetTokenPricing: boolean;
-        apr: number;
+        apr: string;
     };
     "TAC Supply tacBTC 0x6Bf340dB729d82af1F6443A0Ea0d79647b1c3DDf": {
         campaignType: any;
@@ -1132,13 +1150,14 @@ declare const TACInterfaceCampaigns: {
         distributionChainId: any;
         targetToken: string;
         rewardToken: string;
+        creator: string;
         hooks: never[];
         whitelist: never[];
         blacklist: never[];
         forwarders: never[];
         rewardTokenPricing: boolean;
         targetTokenPricing: boolean;
-        apr: number;
+        apr: string;
     };
     "TAC Supply tacUSD 0x699e04F98dE2Fc395a7dcBf36B48EC837A976490": {
         campaignType: any;
@@ -1146,13 +1165,269 @@ declare const TACInterfaceCampaigns: {
         distributionChainId: any;
         targetToken: string;
         rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply TACrsEth 0x419386E3Ef42368e602720CC458e00c0B28c47A7": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply TACmBTC 0x307267989A7bec3A57FD7fd96017C49803589Fd0": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply TACcbBTC 0xeb402fc96C7ed2f889d837C9976D6d821c1B5f01": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply TACmMEV 0xC2C26520256D5920B8aa1DA91F211222B2083B46": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply TACmEDGE 0xaa7BeE2d7dE06cB4E30564323Fb17C5029e7D567": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply tacLBTCv 0xD86fC1CaA0a5B82cC16B16B70DFC59F6f034C348": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply tacUSR 0x686c83Aa81ba206354fDcbc2cd282B4531365E29": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ctTACezETH 0x25763b6597c9e0f10cb8481ef924472851480376": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ctTACSTONE 0x83a197fc495881d149e6843b20f0027a622dfb0a": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ctTACpufETH 0x78f314241df1ac151bfd0413eeb51979515f6abd": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ctTAClvlUSD 0x2119787c73c95d0c4d54ed8395c3f9593f70e136": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ylxSolvBTCs 0x0982eB22086183bF10acd2991A2dBeD1e3B9Ac2A": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ylpumpBTC 0xd72c3a44b51C8D6631C004ecf3A318b9D2c58F80": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ylxSolvBTC 0x76f31800eFdE39A5f98189447c7a514d974f4364": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ctTACUSDB 0x729fcddf4cbbc9dce721a8378c25a726fe7e43d3": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
+    };
+    "TAC Supply ylFBTC 0x6945f516413cB2d7311297e8A39E7D004dEB5566": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
         hooks: never[];
         whitelist: never[];
         blacklist: never[];
         forwarders: never[];
         rewardTokenPricing: boolean;
         targetTokenPricing: boolean;
-        apr: number;
+        apr: string;
+    };
+    "TAC Supply ylMBTC 0x2B11527e1fab84a5382D20efD198BF3d332f7E73": {
+        campaignType: any;
+        computeChainId: any;
+        distributionChainId: any;
+        targetToken: string;
+        rewardToken: string;
+        creator: string;
+        hooks: never[];
+        whitelist: never[];
+        blacklist: never[];
+        forwarders: never[];
+        rewardTokenPricing: boolean;
+        targetTokenPricing: boolean;
+        apr: string;
     };
 };
 export declare const MerklInterfaceCampaigns: {