@merkl/api 0.9.15

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

@@ -0,0 +1,155 @@
+import { HttpErrorDto, NotFoundError, NotFoundErrorDto } from "@/errors";
+import { BackOfficeGuard } from "@/guards/BackOffice.guard";
+import { AuthorizationHeadersDto, TokenAuthGuard } from "@/guards/TokenAuth.guard";
+import Elysia, { t } from "elysia";
+import { GetCampaignQueryDto } from "../campaign";
+import { CreateOpportunityDto, GetOpportunitiesQueryDto, GetOpportunityQueryDto, OpportunityAggregateFieldDto, OpportunityIdDto, OpportunityResourceDto, OpportunityUniqueDto, OpportunityUniqueUpdateDto, OpportunityWithCampaignsResourceDto, UpdateOpportunityDto, } from "./opportunity.model";
+import { OpportunityService } from "./opportunity.service";
+import { transformId } from "./transform-id.pipe";
+import { validateId } from "./validate-id.pipe";
+// ─── Opportunities Controller ────────────────────────────────────────────────
+export const OpportunityController = new Elysia({
+    prefix: "/opportunities",
+    detail: {
+        tags: ["Opportunities"],
+    },
+})
+    // ─── Create An Opportunity ───────────────────────────────────────────
+    .post("/", async ({ body }) => await OpportunityService.create(body), {
+    beforeHandle: TokenAuthGuard,
+    headers: AuthorizationHeadersDto,
+    body: CreateOpportunityDto,
+    detail: { hide: true },
+})
+    // ─── Tries to reparse An Opportunity ─────────────────────────────────
+    .post("/:id", async ({ params }) => {
+    try {
+        if (!params.id.includes("-"))
+            return await OpportunityService.recreate(params.id);
+        const [chainId, type, identifier] = params.id.split("-");
+        return await OpportunityService.recreate({
+            chainId: +chainId,
+            type: type,
+            identifier,
+        });
+    }
+    catch (err) {
+        if (err.code && err.code === "P2025")
+            throw new NotFoundError();
+        throw err;
+    }
+}, {
+    beforeHandle: BackOfficeGuard,
+    headers: AuthorizationHeadersDto,
+    params: OpportunityUniqueUpdateDto,
+    detail: { hide: true },
+})
+    // ─── Get All Opportunities ───────────────────────────────────────────
+    .get("/", async ({ query }) => OpportunityService.findMany(query), {
+    query: GetOpportunitiesQueryDto,
+    detail: {
+        description: `**Retrieve Multiple Opportunities**
+      <p>This endpoint enables you to search for opportunities by providing specific criteria through query parameters.</p>`,
+    },
+    response: t.Array(t.Union([OpportunityResourceDto, t.Null()])),
+})
+    // ─── Get Opportunities Count ─────────────────────────────────────────
+    .get("/count", async ({ query }) => await OpportunityService.countMany(query), {
+    query: GetOpportunitiesQueryDto,
+    detail: { description: "Get the count of opportunities corresponding to the query." },
+    response: { 200: t.Number() },
+})
+    // ─── Get An Opportunity By Id ────────────────────────────────────────
+    .get("/:id", async ({ params, query }) => {
+    try {
+        if (!params.id.includes("-"))
+            return await OpportunityService.getUniqueOrThrow(params.id, query.test ?? false);
+        const [chainId, type, identifier] = params.id.split("-");
+        return await OpportunityService.getUniqueOrThrow({
+            chainId: +chainId,
+            type: type,
+            identifier,
+        }, query.test ?? false);
+    }
+    catch (err) {
+        if (err.code && err.code === "P2025")
+            throw new NotFoundError();
+        throw err;
+    }
+}, {
+    params: OpportunityUniqueDto,
+    query: GetOpportunityQueryDto,
+    transform: transformId,
+    beforeHandle: validateId,
+    response: {
+        200: OpportunityResourceDto,
+        404: NotFoundErrorDto,
+        500: HttpErrorDto,
+    },
+    detail: { description: "Get a unique opportunity." },
+})
+    .get("/campaigns", async ({ query }) => OpportunityService.findManyByCampaigns(query), {
+    query: GetCampaignQueryDto,
+    response: {
+        200: t.Array(OpportunityWithCampaignsResourceDto),
+        404: NotFoundErrorDto,
+        500: HttpErrorDto,
+    },
+    detail: {
+        description: "Get many opportunities, including related [campaigns](#tag/campaigns/).",
+    },
+})
+    // ─── Get An Opportunity By Id With Related Campaigns ─────────────────
+    .get("/:id/campaigns", async ({ query, params }) => {
+    try {
+        if (!params.id.includes("-"))
+            return await OpportunityService.getUniqueWithCampaignsOrThrow(params.id, query.test ?? false);
+        const [chainId, type, identifier] = params.id.split("-");
+        return await OpportunityService.getUniqueWithCampaignsOrThrow({
+            chainId: +chainId,
+            type: type,
+            identifier,
+        }, query.test ?? false);
+    }
+    catch (err) {
+        if (err.code && err.code === "P2025")
+            throw new NotFoundError();
+        throw err;
+    }
+}, {
+    query: GetOpportunityQueryDto,
+    params: OpportunityUniqueDto,
+    transform: transformId,
+    beforeHandle: validateId,
+    response: {
+        200: OpportunityWithCampaignsResourceDto,
+        404: NotFoundErrorDto,
+        500: HttpErrorDto,
+    },
+    detail: {
+        description: "Get a unique opportunity, including related [campaigns](#tag/campaigns/).",
+    },
+})
+    // ─── Get Aggregate Fields ────────────────────────────────────────────
+    .get("/aggregate/:field", async ({ query, params }) => await OpportunityService.aggregate(query, params.field), {
+    params: OpportunityAggregateFieldDto,
+    query: GetOpportunitiesQueryDto,
+})
+    // ─── Get Aggregate Fields ────────────────────────────────────────────
+    .get("/aggregate/max/:field", async ({ query, params }) => await OpportunityService.aggregateMax(query, params.field), {
+    params: OpportunityAggregateFieldDto,
+    query: GetOpportunitiesQueryDto,
+})
+    // ─── Get Aggregate Fields ────────────────────────────────────────────
+    .get("/aggregate/min/:field", async ({ query, params }) => await OpportunityService.aggregateMin(query, params.field), {
+    params: OpportunityAggregateFieldDto,
+    query: GetOpportunitiesQueryDto,
+})
+    // ─── Update An Opportunity ───────────────────────────────────────────
+    .patch("/:id", async ({ params, body }) => await OpportunityService.update(params.id, body), {
+    params: OpportunityIdDto,
+    body: UpdateOpportunityDto,
+    headers: AuthorizationHeadersDto,
+    beforeHandle: BackOfficeGuard,
+    detail: { hide: true },
+});

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

@@ -0,0 +1,10 @@
+import { Campaign as CampaignEnum, type CampaignParameters, type Opportunity as OpportunityV3 } from "@sdk";
+import { OpportunityService } from "./opportunity.service";
+export declare abstract class OpportunityConvertorService {
+    #private;
+    static convertV4CampaignToV3<C extends CampaignEnum>(campaignType: C, campaign: Exclude<Awaited<ReturnType<(typeof OpportunityService)["findMany"]>>[number]["campaigns"], undefined>[number], opportunityIdentifier: string): 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 logKeyAndTTLV3Opportunities(showCampaigns: boolean, test: boolean | undefined, identifier: string | undefined, chainId: string | undefined): Promise<void>;
+    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,174 @@
+import { kebabToPascalCase } from "@/utils/caseChanges";
+import { log } from "@/utils/logger";
+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, opportunityIdentifier) {
+        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: opportunityIdentifier,
+            endTimestamp: Number(campaign.endTimestamp),
+            startTimestamp: Number(campaign.startTimestamp),
+            rewardToken: campaign.rewardToken.address,
+            amm: campaign.params?.amm,
+        };
+    }
+    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?.filter(token => token.icon?.length > 0).map(token => token.symbol), // Do not return tokens without icons,
+            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
+                ?.filter(campaign => campaign.rewardToken.icon?.length > 0) // Do not return tokens without icons
+                ?.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.identifier))
+                    : undefined,
+                inactive: withCampaigns
+                    ? opportunity.campaigns
+                        ?.filter(campaign => !(campaign.startTimestamp < BigInt(now) && BigInt(now) < campaign.endTimestamp))
+                        .map(campaign => OpportunityConvertorService.convertV4CampaignToV3(CampaignEnum[campaign.type], campaign, opportunity.identifier))
+                    : undefined,
+            },
+        };
+    }
+    static async #extractV3Opportunities(showCampaigns, test, identifier, chainId) {
+        let opportunities = [];
+        let page = 0;
+        while (true) {
+            try {
+                const opportunitiesPage = await OpportunityService.findMany({
+                    items: 100, // HARDCODED LIMIT
+                    page,
+                    test,
+                    identifier,
+                    chainId,
+                    campaigns: true,
+                });
+                opportunities = opportunities.concat(opportunitiesPage);
+                if (opportunitiesPage.length === 0)
+                    break;
+            }
+            catch {
+                break;
+            }
+            page++;
+        }
+        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.HOUR_4, OpportunityConvertorService.#extractV3Opportunities, showCampaigns, test, identifier, chainId);
+    }
+    static async logKeyAndTTLV3Opportunities(showCampaigns, test, identifier, chainId) {
+        const [key, ttl] = await CacheService.keyAndTTL(OpportunityConvertorService.#extractV3Opportunities, showCampaigns, test, identifier, chainId);
+        log.info(`Args: ${showCampaigns}, ${test}, ${identifier}, ${chainId}, Key: ${key}, TTL: ${ttl}`);
+    }
+    static async wrapV3Opportunities(showCampaigns, test, identifier, chainId) {
+        return await CacheService.wrap(TTLPresets.MIN_10, OpportunityConvertorService.#extractV3Opportunities, showCampaigns, test, identifier, chainId);
+    }
+}