@merkl/api 0.16.33 → 0.16.35

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

@@ -113,11 +113,13 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                     status?: string | undefined;
                     items?: number | undefined;
                     tags?: string | undefined;
+                    identifier?: string | undefined;
                     page?: number | undefined;
                     chainId?: string | undefined;
                     action?: string | undefined;
                     creatorAddress?: string | undefined;
                     mainProtocolId?: string | undefined;
+                    campaigns?: boolean | undefined;
                     order?: string | undefined;
                     test?: boolean | undefined;
                     minimumTvl?: number | undefined;
@@ -174,6 +176,57 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                                 amount: bigint;
                             }[];
                         };
+                        campaigns: {
+                            params: any;
+                            chain: {
+                                name: string;
+                                id: number;
+                                icon: string;
+                            };
+                            rewardToken: {
+                                symbol: string;
+                                name: string | null;
+                                id: string;
+                                icon: string;
+                                chainId: number;
+                                address: string;
+                                decimals: number;
+                                verified: boolean;
+                                isTest: boolean;
+                            } & {
+                                price?: number | null | undefined;
+                            };
+                            distributionChain: {
+                                name: string;
+                                id: number;
+                                icon: string;
+                            } | undefined;
+                            campaignStatus: {
+                                error: string;
+                                details: import("database/api/.generated/runtime/library").JsonValue;
+                                status: import("../../../../database/api/.generated").$Enums.RunStatus;
+                                campaignId: string;
+                                computedUntil: bigint;
+                                processingStarted: bigint;
+                            };
+                            creatorAddress: string;
+                            Creator: {
+                                tags: string[];
+                                address: string;
+                                creatorId: string | null;
+                            };
+                            type: string;
+                            id: string;
+                            subType: number | null;
+                            startTimestamp: bigint;
+                            endTimestamp: bigint;
+                            computeChainId: number;
+                            distributionChainId: number;
+                            campaignId: string;
+                            rewardTokenId: string;
+                            amount: string;
+                            opportunityId: string;
+                        }[];
                         id: string;
                         depositUrl: string | undefined;
                         tokens: ({
@@ -230,11 +283,13 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                     status?: string | undefined;
                     items?: number | undefined;
                     tags?: string | undefined;
+                    identifier?: string | undefined;
                     page?: number | undefined;
                     chainId?: string | undefined;
                     action?: string | undefined;
                     creatorAddress?: string | undefined;
                     mainProtocolId?: string | undefined;
+                    campaigns?: boolean | undefined;
                     order?: string | undefined;
                     test?: boolean | undefined;
                     minimumTvl?: number | undefined;
@@ -383,45 +438,41 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                 };
                 headers: unknown;
                 response: {
-                    200: ({
-                        protocol?: {
-                            name: string;
-                            url: string;
-                            description: string;
-                            id: string;
-                            tags: string[];
-                            icon: string;
-                        } | null | undefined;
-                        depositUrl?: string | undefined;
-                        aprRecord?: {
-                            timestamp: string | bigint;
+                    200: {
+                        apr: number;
+                        aprRecord: {
                             cumulated: number;
+                            timestamp: bigint;
                             breakdowns: {
-                                type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
+                                type: import("../../../../database/api/.generated").$Enums.AprType;
                                 id: number;
                                 identifier: string;
                                 value: number;
                                 aprRecordId: string;
                             }[];
-                        } | undefined;
-                        tvlRecord?: {
+                        };
+                        tvlRecord: {
+                            id: string;
                             total: number;
-                            timestamp: string | bigint;
+                            timestamp: bigint;
                             breakdowns: {
-                                type: "TOKEN" | "PROTOCOL";
+                                type: import("../../../../database/api/.generated").$Enums.TvlType;
                                 id: number;
                                 identifier: string;
                                 value: number;
                                 tvlRecordId: string;
                             }[];
-                        } | undefined;
-                        rewardsRecord?: {
-                            total: number;
+                        };
+                        rewardsRecord: {
                             id: string;
-                            timestamp: string | bigint;
+                            total: number;
+                            timestamp: bigint;
                             breakdowns: {
+                                id: number;
+                                value: number;
+                                campaignId: string;
+                                dailyRewardsRecordId: string;
                                 token: {
-                                    price?: number | null | undefined;
                                     symbol: string;
                                     name: string | null;
                                     id: string;
@@ -429,45 +480,14 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                                     chainId: number;
                                     address: string;
                                     decimals: number;
+                                    displaySymbol: string;
                                     verified: boolean;
                                     isTest: boolean;
+                                    price: number | null;
                                 };
-                                id: number;
-                                value: number;
-                                campaignId: string;
-                                amount: string | bigint;
-                                dailyRewardsRecordId: string;
+                                amount: bigint;
                             }[];
-                        } | undefined;
-                        name: string;
-                        type: string;
-                        tokens: {
-                            price?: number | null | undefined;
-                            symbol: string;
-                            name: string | null;
-                            id: string;
-                            icon: string;
-                            chainId: number;
-                            address: string;
-                            decimals: number;
-                            verified: boolean;
-                            isTest: boolean;
-                        }[];
-                        id: string;
-                        status: string;
-                        tags: string[];
-                        identifier: string;
-                        chain: {
-                            name: string;
-                            id: number;
-                            icon: string;
                         };
-                        chainId: number;
-                        action: string;
-                        tvl: number;
-                        apr: number;
-                        dailyRewards: number;
-                    } & {
                         campaigns: {
                             params: any;
                             chain: {
@@ -519,7 +539,44 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                             amount: string;
                             opportunityId: string;
                         }[];
-                    })[];
+                        id: string;
+                        depositUrl: string | undefined;
+                        tokens: ({
+                            symbol: string;
+                            name: string | null;
+                            id: string;
+                            icon: string;
+                            chainId: number;
+                            address: string;
+                            decimals: number;
+                            verified: boolean;
+                            isTest: boolean;
+                        } & {
+                            price?: number | null | undefined;
+                        })[];
+                        chain: {
+                            name: string;
+                            id: number;
+                            icon: string;
+                        };
+                        protocol: {
+                            name: string;
+                            url: string;
+                            description: string;
+                            id: string;
+                            tags: string[];
+                            icon: string;
+                        } | undefined;
+                        name: string;
+                        type: string;
+                        status: import("../../../../database/api/.generated").$Enums.Status;
+                        tags: string[];
+                        identifier: string;
+                        chainId: number;
+                        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+                        tvl: number;
+                        dailyRewards: number;
+                    }[];
                     readonly 404: {
                         message: string;
                         name: string;
@@ -708,11 +765,13 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                         status?: string | undefined;
                         items?: number | undefined;
                         tags?: string | undefined;
+                        identifier?: string | undefined;
                         page?: number | undefined;
                         chainId?: string | undefined;
                         action?: string | undefined;
                         creatorAddress?: string | undefined;
                         mainProtocolId?: string | undefined;
+                        campaigns?: boolean | undefined;
                         order?: string | undefined;
                         test?: boolean | undefined;
                         minimumTvl?: number | undefined;
@@ -745,11 +804,13 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                             status?: string | undefined;
                             items?: number | undefined;
                             tags?: string | undefined;
+                            identifier?: string | undefined;
                             page?: number | undefined;
                             chainId?: string | undefined;
                             action?: string | undefined;
                             creatorAddress?: string | undefined;
                             mainProtocolId?: string | undefined;
+                            campaigns?: boolean | undefined;
                             order?: string | undefined;
                             test?: boolean | undefined;
                             minimumTvl?: number | undefined;
@@ -783,11 +844,13 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                             status?: string | undefined;
                             items?: number | undefined;
                             tags?: string | undefined;
+                            identifier?: string | undefined;
                             page?: number | undefined;
                             chainId?: string | undefined;
                             action?: string | undefined;
                             creatorAddress?: string | undefined;
                             mainProtocolId?: string | undefined;
+                            campaigns?: boolean | undefined;
                             order?: string | undefined;
                             test?: boolean | undefined;
                             minimumTvl?: number | undefined;

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

@@ -89,7 +89,7 @@ export const OpportunityController = new Elysia({
     detail: { description: "Get a unique opportunity." },
 })
     .get("/campaigns", async ({ query }) => {
-    return await OpportunityService.getManyByCampaigns(query);
+    return await OpportunityService.findManyByCampaigns(query);
 }, {
     query: GetCampaignQueryDto,
     response: {

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

@@ -0,0 +1,9 @@
+import { type CampaignParameters, type Opportunity as OpportunityV3, type ValidCampaign } from "@sdk";
+import { OpportunityService } from "./opportunity.service";
+export declare abstract class OpportunityConvertorService {
+    #private;
+    static convertV4CampaignToV3<C extends ValidCampaign>(campaignType: C, campaign: Awaited<ReturnType<(typeof OpportunityService)["findMany"]>>[number]["campaigns"][number], opportunity: Awaited<ReturnType<(typeof OpportunityService)["findMany"]>>[number]): CampaignParameters<C>;
+    static convertV4toV3(opportunity: Awaited<ReturnType<(typeof OpportunityService)["findMany"]>>[number], withCampaigns?: boolean): OpportunityV3;
+    static setV3Opportunities(showCampaigns: boolean, test: boolean | undefined, identifier: string | undefined, chainId: string | undefined): Promise<{}>;
+    static wrapV3Opportunities(showCampaigns: boolean, test: boolean | undefined, identifier: string | undefined, chainId: string | undefined): Promise<{}>;
+}

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

@@ -0,0 +1,153 @@
+import { kebabToPascalCase } from "../../../utils/camelToKebabCase";
+import { Campaign as CampaignEnum, EAprBreakdownType, opportunityActions, } from "@sdk";
+import moment from "moment";
+import { CacheService } from "../cache";
+import { TTLPresets } from "../cache/cache.model";
+import { OpportunityService } from "./opportunity.service";
+export class OpportunityConvertorService {
+    static convertV4CampaignToV3(campaignType, campaign, opportunity) {
+        return {
+            amount: campaign.amount.toString(),
+            campaignId: campaign.campaignId,
+            computeChainId: campaign.computeChainId,
+            campaignParameters: campaign.params,
+            campaignSubType: campaign.subType ?? 0,
+            campaignType,
+            chainId: campaign.distributionChain?.id ?? 0,
+            creator: campaign.Creator.address,
+            index: 0, // DEPRECATED
+            mainParameter: opportunity.identifier,
+            endTimestamp: Number(campaign.endTimestamp),
+            startTimestamp: Number(campaign.startTimestamp),
+            rewardToken: campaign.rewardToken.address,
+        };
+    }
+    static convertV4toV3(opportunity, withCampaigns = false) {
+        const now = moment().unix();
+        const id = `${CampaignEnum[opportunity.type]}_${opportunity.identifier}`; // V3 id
+        // Convert v4 actions to old type
+        let action = opportunity.action.toLowerCase();
+        if (!opportunityActions.includes(action)) {
+            action = "hold";
+        }
+        const tvlBreakdownTokens = [];
+        const tvlBreakdownDetails = {};
+        if (!!opportunity?.tvlRecord?.breakdowns) {
+            for (const breakdown of opportunity.tvlRecord.breakdowns) {
+                if (breakdown.type === "TOKEN") {
+                    const token = opportunity.tokens.find(token => token.address === breakdown.identifier);
+                    if (!!token)
+                        tvlBreakdownTokens.push({
+                            symbol: token?.symbol,
+                            amount: breakdown.value,
+                        });
+                }
+                else {
+                    tvlBreakdownDetails[breakdown.identifier] = {
+                        value: breakdown.value,
+                        address: breakdown.identifier.split(" ")[breakdown.identifier.split(" ").length - 1],
+                        label: breakdown.identifier.split(" ")[0],
+                    };
+                }
+            }
+        }
+        const aprBreakdown = {};
+        const aprBreakdown2 = [];
+        if (!!opportunity?.aprRecord?.breakdowns) {
+            for (const breakdown of opportunity.aprRecord.breakdowns) {
+                if (breakdown.type === "CAMPAIGN") {
+                    aprBreakdown2.push({
+                        value: breakdown.value,
+                        label: `Campaign ${breakdown.identifier.slice(0, 8)}`,
+                        type: EAprBreakdownType.CAMPAIGN,
+                        address: breakdown.identifier,
+                    });
+                }
+                else if (breakdown.type === "PROTOCOL") {
+                    const address = breakdown.identifier.split(" ")[breakdown.identifier.split(" ").length - 1];
+                    const detail = {
+                        value: breakdown.value,
+                        label: breakdown.identifier.replace(address, "").trim(),
+                        type: EAprBreakdownType.FORWARDER,
+                        address,
+                    };
+                    aprBreakdown[breakdown.identifier] = detail;
+                    aprBreakdown2.push(detail);
+                }
+                else {
+                    console.log(breakdown);
+                }
+            }
+        }
+        return {
+            id,
+            chainId: opportunity.chainId,
+            name: opportunity.name,
+            status: opportunity.status.toLowerCase(),
+            action,
+            tokenIcons: opportunity.tokens.map(token => token.symbol),
+            tvl: opportunity?.tvlRecord?.total,
+            tvlBreakdown: tvlBreakdownTokens.length > 0 || Object.keys(tvlBreakdownDetails).length > 0
+                ? {
+                    tokens: tvlBreakdownTokens,
+                    details: tvlBreakdownDetails,
+                }
+                : undefined,
+            platform: kebabToPascalCase(opportunity.protocol?.id ?? ""),
+            apr: opportunity.apr,
+            aprBreakdown: Object.keys(aprBreakdown).length > 0 ? aprBreakdown : undefined,
+            aprBreakdown2: aprBreakdown2.length > 0 ? aprBreakdown2 : undefined,
+            dailyrewards: opportunity.dailyRewards,
+            dailyRewardTokens: !!opportunity?.rewardsRecord?.breakdowns
+                ? opportunity.rewardsRecord.breakdowns.map(reward => ({
+                    symbol: reward.token.symbol,
+                    amount: reward.amount.toString(),
+                    address: reward.token.address,
+                }))
+                : undefined,
+            tags: opportunity.tags,
+            rewardTokenIcons: opportunity.campaigns
+                .map(campaign => campaign.rewardToken.symbol)
+                .reduce((acc, curr) => {
+                if (!acc.includes(curr))
+                    acc.push(curr);
+                return acc;
+            }, []),
+            campaigns: {
+                type: CampaignEnum[opportunity.type],
+                ids: opportunity.campaigns.map(campaign => campaign.campaignId),
+                active: withCampaigns
+                    ? opportunity.campaigns
+                        .filter(campaign => campaign.startTimestamp < BigInt(now) && BigInt(now) < campaign.endTimestamp)
+                        .map(campaign => OpportunityConvertorService.convertV4CampaignToV3(CampaignEnum[campaign.type], campaign, opportunity))
+                    : undefined,
+                inactive: withCampaigns
+                    ? opportunity.campaigns
+                        .filter(campaign => !(campaign.startTimestamp < BigInt(now) && BigInt(now) < campaign.endTimestamp))
+                        .map(campaign => OpportunityConvertorService.convertV4CampaignToV3(CampaignEnum[campaign.type], campaign, opportunity))
+                    : undefined,
+            },
+        };
+    }
+    static async #extractV3Opportunities(showCampaigns, test, identifier, chainId) {
+        const opportunities = await OpportunityService.findMany({
+            items: 10_000, // HARDCODED LIMIT
+            test,
+            identifier,
+            chainId,
+            campaigns: true,
+        });
+        const res = {};
+        for (const opportunity of opportunities) {
+            const opportunityV3 = OpportunityConvertorService.convertV4toV3(opportunity, showCampaigns);
+            res[opportunityV3.id] = opportunityV3;
+        }
+        return res;
+    }
+    static async setV3Opportunities(showCampaigns, test, identifier, chainId) {
+        return await CacheService.set(TTLPresets.MIN_5, OpportunityConvertorService.#extractV3Opportunities, showCampaigns, test, identifier, chainId);
+    }
+    static async wrapV3Opportunities(showCampaigns, test, identifier, chainId) {
+        return await CacheService.wrap(TTLPresets.MIN_30, OpportunityConvertorService.#extractV3Opportunities, showCampaigns, test, identifier, chainId);
+    }
+}

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

@@ -24,7 +24,7 @@ export type Opportunity = Resource<"Opportunity", "mainProtocolId", {
     rewardsRecord?: DailyRewardsRecord["model"];
     campaigns?: Campaign["model"][];
 }>;
-export type LightOpportunityFromDB = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords">;
+export type LightOpportunityFromDB = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns">;
 export type OpportunityMetadata = {
     name: string;
     action: OpportunityAction;
@@ -289,6 +289,8 @@ export declare const GetOpportunitiesQueryDto: import("@sinclair/typebox").TObje
     test: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
     minimumTvl: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
     status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;
+    identifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    campaigns: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
     tokens: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     sort: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;
     order: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TRegExp>;

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

@@ -66,6 +66,8 @@ export const GetOpportunitiesQueryDto = t.Object({
     status: t.Optional(t.RegExp(/^(LIVE|PAST|SOON)(,(LIVE|PAST|SOON)){0,2}$/, {
         description: "A comma separeted list of status. Legal values are: `LIVE`, `PAST`, `SOON`",
     })),
+    identifier: t.Optional(t.String({ description: "Filter by identifier" })),
+    campaigns: t.Optional(t.Boolean({ description: "Include campaign data. Will slow down the request. Default: false" })),
     tokens: t.Optional(t.String({ description: "A comma separated list of token symbol. Use to filter by token" })),
     sort: t.Optional(t.RegExp(/(apr|tvl|rewards)/, { description: "Sort by `apr`, `tvl` or `rewards`" })),
     order: t.Optional(t.RegExp(/desc|asc/, {