@merkl/api 0.20.46 → 0.20.48

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

@@ -7,6 +7,7 @@ import { AprService } from "../apr";
 import { RewardService } from "../reward";
 import { TvlService } from "../tvl";
 export class OpportunityRepository {
+    // ─── Utils ───────────────────────────────────────────────────────────
     static #transformQueryToPrismaFilters(query) {
         const { page: _page, items: _items, ...filters } = query;
         //TODO: abstract away query to not be strictly equal to controller
@@ -24,9 +25,7 @@ export class OpportunityRepository {
         const point = query.point ?? false;
         const creatorAddress = query.creatorAddress ?? null;
         const identifier = query.identifier ?? null;
-        const orderBy = {
-            [sort]: order,
-        };
+        const orderBy = { [sort]: order };
         return {
             orderBy,
             where: {
@@ -60,26 +59,14 @@ export class OpportunityRepository {
     }
     static #getRecordInclusion(withTest = true, withPoints = true) {
         return {
-            AprRecords: {
-                take: 1,
-                orderBy: { timestamp: "desc" },
-                include: { AprBreakdown: true },
-            },
-            TvlRecords: {
-                take: 1,
-                orderBy: { timestamp: "desc" },
-                include: { TvlBreakdown: true },
-            },
+            AprRecords: { take: 1, orderBy: { timestamp: "desc" }, include: { AprBreakdown: true } },
+            TvlRecords: { take: 1, orderBy: { timestamp: "desc" }, include: { TvlBreakdown: true } },
             DailyRewardsRecords: {
                 take: 1,
                 orderBy: { timestamp: "desc" },
                 include: {
                     DailyRewardsBreakdown: {
-                        where: {
-                            Campaign: {
-                                RewardToken: withTest ? undefined : { isTest: false, isPoint: withPoints },
-                            },
-                        },
+                        where: { Campaign: { RewardToken: withTest ? undefined : { isTest: false, isPoint: withPoints } } },
                         include: {
                             Campaign: {
                                 select: {
@@ -98,41 +85,28 @@ export class OpportunityRepository {
     }
     static #getCampaignInclusion(withTest = true, withPoints = true) {
         return {
-            orderBy: {
-                endTimestamp: "desc",
-            },
-            where: withTest
-                ? undefined
-                : {
-                    RewardToken: {
-                        isTest: false,
-                        isPoint: withPoints,
-                    },
-                },
+            orderBy: { endTimestamp: "desc" },
+            where: withTest ? undefined : { RewardToken: { isTest: false, isPoint: withPoints } },
             include: {
                 RewardToken: true,
                 ComputeChain: true,
-                DistributionChain: {
-                    include: {
-                        Explorer: true,
-                    },
-                },
+                DistributionChain: { include: { Explorer: true } },
                 Creator: true,
                 CampaignStatus: true, // [][0]
             },
         };
     }
+    // ─── Create ──────────────────────────────────────────────────────────
     static async create(newOpp, upsert = false) {
         const previousOpportunity = await apiDbClient.opportunity.findUnique({
             where: { id: newOpp.id },
             include: { Tokens: true, Protocols: true },
         });
-        if (!!previousOpportunity && !upsert) {
+        if (!!previousOpportunity && !upsert)
             return previousOpportunity;
-        }
         if (!!newOpp.mainProtocol) {
             let mainProtocol = await apiDbClient.protocol.findUnique({ where: { id: newOpp.mainProtocol } });
-            if (!mainProtocol) {
+            if (!mainProtocol)
                 mainProtocol = await ProtocolService.create({
                     id: newOpp.mainProtocol,
                     name: newOpp.mainProtocol,
@@ -141,54 +115,47 @@ export class OpportunityRepository {
                     icon: "",
                     description: "",
                 });
+            if (!previousOpportunity?.manualOverrides.includes("action")) {
+                // Override action with the protocol's action if it differs
+                if (mainProtocol.tags.includes("AMM") || mainProtocol.tags.includes("DEX"))
+                    newOpp.action = "POOL";
+                if (mainProtocol.tags.includes("BORROWING"))
+                    newOpp.action = "BORROW";
+                if (mainProtocol.tags.includes("LENDING") && !!newOpp.name && newOpp.name.includes("Supply"))
+                    newOpp.action = "LEND";
             }
-            // Override action with the protocol's action if it differs
-            if (mainProtocol.tags.includes("AMM"))
-                newOpp.action = "POOL";
-            if (mainProtocol.tags.includes("DEX"))
-                newOpp.action = "POOL";
-            if (mainProtocol.tags.includes("BORROWING"))
-                newOpp.action = "BORROW";
-            if (mainProtocol.tags.includes("LENDING") && !!newOpp.name && newOpp.name.includes("Supply"))
-                newOpp.action = "LEND";
         }
         // Safety check on urls:
-        if (!!newOpp.depositUrl && !newOpp.depositUrl.includes("http")) {
+        if (!previousOpportunity?.manualOverrides.includes("depositUrl") &&
+            !!newOpp.depositUrl &&
+            !newOpp.depositUrl.includes("http")) {
             newOpp.depositUrl = undefined;
             log.warn(`deposit URL for opportunity ${newOpp.id} is not a valid URL`);
         }
-        const toDisconnect = {
-            mainProtocol: "",
-            protocols: [],
-            tokens: [],
-        };
+        const toDisconnect = { mainProtocol: "", protocols: [], tokens: [] };
         if (!!previousOpportunity) {
-            if (previousOpportunity.mainProtocolId !== newOpp.mainProtocol) {
+            if (previousOpportunity.mainProtocolId !== newOpp.mainProtocol)
                 toDisconnect.mainProtocol = previousOpportunity.mainProtocolId ?? "";
-            }
-            for (const protocol of previousOpportunity.Protocols) {
-                if (!newOpp.protocols || !newOpp.protocols.includes(protocol.id)) {
+            for (const protocol of previousOpportunity.Protocols)
+                if (!newOpp.protocols || !newOpp.protocols.includes(protocol.id))
                     toDisconnect.protocols.push(protocol.id);
-                }
-            }
-            for (const token of previousOpportunity.Tokens) {
-                if (!newOpp.tokens.some(newToken => newToken.chainId === token.chainId && newToken.address === token.address)) {
-                    toDisconnect.tokens.push({
-                        chainId: token.chainId,
-                        address: token.address,
-                    });
-                }
-            }
+            for (const token of previousOpportunity.Tokens)
+                if (!newOpp.tokens.some(newToken => newToken.chainId === token.chainId && newToken.address === token.address))
+                    toDisconnect.tokens.push({ chainId: token.chainId, address: token.address });
         }
         const data = {
             id: newOpp.id,
             action: newOpp.action ?? "HOLD",
             identifier: newOpp.identifier,
-            name: newOpp.name,
+            name: !previousOpportunity?.manualOverrides.includes("name") ? newOpp.name : previousOpportunity.name,
             status: newOpp.status,
             type: newOpp.type,
-            depositUrl: newOpp.depositUrl,
-            explorerAddress: newOpp.explorerAddress,
+            depositUrl: !previousOpportunity?.manualOverrides.includes("depositUrl")
+                ? newOpp.depositUrl
+                : previousOpportunity.depositUrl,
+            explorerAddress: !previousOpportunity?.manualOverrides.includes("explorerAddress")
+                ? newOpp.explorerAddress
+                : previousOpportunity.explorerAddress,
             Chain: { connect: { id: newOpp.chainId } },
             MainProtocol: !!newOpp.mainProtocol ? { connect: { id: newOpp.mainProtocol } } : undefined,
             Protocols: {
@@ -198,12 +165,7 @@ export class OpportunityRepository {
             },
             Tokens: {
                 connect: newOpp.tokens.map((token) => {
-                    return {
-                        chainId_address: {
-                            chainId: token.chainId,
-                            address: token.address,
-                        },
-                    };
+                    return { chainId_address: { chainId: token.chainId, address: token.address } };
                 }),
             },
         };
@@ -211,11 +173,13 @@ export class OpportunityRepository {
             id: newOpp.id,
             action: newOpp.action ?? "HOLD",
             identifier: newOpp.identifier,
-            name: newOpp.name,
+            name: !previousOpportunity?.manualOverrides.includes("name") ? newOpp.name : undefined,
             status: newOpp.status,
             type: newOpp.type,
-            depositUrl: newOpp.depositUrl,
-            explorerAddress: newOpp.explorerAddress,
+            depositUrl: !previousOpportunity?.manualOverrides.includes("depositUrl") ? newOpp.depositUrl : undefined,
+            explorerAddress: !previousOpportunity?.manualOverrides.includes("explorerAddress")
+                ? newOpp.explorerAddress
+                : undefined,
             Chain: { connect: { id: newOpp.chainId } },
             MainProtocol: !!newOpp.mainProtocol
                 ? { connect: { id: newOpp.mainProtocol } }
@@ -232,45 +196,30 @@ export class OpportunityRepository {
             },
             Tokens: {
                 connect: newOpp.tokens.map((token) => {
-                    return {
-                        chainId_address: {
-                            chainId: token.chainId,
-                            address: token.address,
-                        },
-                    };
+                    return { chainId_address: { chainId: token.chainId, address: token.address } };
                 }),
                 disconnect: toDisconnect.tokens.map((token) => {
-                    return {
-                        chainId_address: {
-                            chainId: token.chainId,
-                            address: token.address,
-                        },
-                    };
+                    return { chainId_address: { chainId: token.chainId, address: token.address } };
                 }),
             },
         };
-        if (upsert) {
+        if (upsert)
             await apiDbClient.opportunity.upsert({
                 where: { id: newOpp.id },
                 create: data,
                 update: dataWithDisconnect,
             });
-        }
-        else {
+        else
             await apiDbClient.opportunity.create({ data });
-        }
         return await apiDbClient.opportunity.findUnique({ where: { id: newOpp.id } });
     }
+    // ─── Find ────────────────────────────────────────────────────────────
     static async findUnique(id) {
         return await apiDbClient.opportunity.findUnique({
             include: {
                 ...OpportunityRepository.#getRecordInclusion(),
                 Chain: true,
-                Campaigns: {
-                    include: {
-                        RewardToken: true,
-                    },
-                },
+                Campaigns: { include: { RewardToken: true } },
                 MainProtocol: true,
                 Protocols: true,
                 Tokens: true,
@@ -278,6 +227,7 @@ export class OpportunityRepository {
             where: { id },
         });
     }
+    // wrong return type if you include campaigns (RewardToken is missing from the return type)
     static async findUniqueOrThrow(id, withTest = true, withPoints = true, withCampaigns = false) {
         return await apiDbClient.opportunity.findUniqueOrThrow({
             include: {
@@ -286,9 +236,7 @@ export class OpportunityRepository {
                 Chain: { include: { Explorer: true } },
                 MainProtocol: true,
                 Protocols: true,
-                Tokens: {
-                    where: !withTest ? { isTest: false } : undefined,
-                },
+                Tokens: { where: !withTest ? { isTest: false } : undefined },
             },
             where: { id },
         });
@@ -300,19 +248,11 @@ export class OpportunityRepository {
      */
     static async findManyByCampaigns(where) {
         return await apiDbClient.opportunity.findMany({
-            where: {
-                Campaigns: {
-                    some: where,
-                },
-            },
+            where: { Campaigns: { some: where } },
             include: {
                 ...OpportunityRepository.#getRecordInclusion(),
                 Campaigns: OpportunityRepository.#getCampaignInclusion(true),
-                Chain: {
-                    include: {
-                        Explorer: true,
-                    },
-                },
+                Chain: { include: { Explorer: true } },
                 MainProtocol: true,
                 Protocols: true,
                 Tokens: true,
@@ -335,15 +275,9 @@ export class OpportunityRepository {
                 ...OpportunityRepository.#getRecordInclusion(withTest, withPoints),
                 Campaigns: withCampaigns ? OpportunityRepository.#getCampaignInclusion(withTest, withPoints) : undefined,
                 MainProtocol: true,
-                Chain: {
-                    include: {
-                        Explorer: true,
-                    },
-                },
+                Chain: { include: { Explorer: true } },
                 Protocols: true,
-                Tokens: {
-                    where: !withTest ? { isTest: false } : undefined,
-                },
+                Tokens: { where: !withTest ? { isTest: false } : undefined },
             },
             ...args,
         });
@@ -363,11 +297,7 @@ export class OpportunityRepository {
                     include: {
                         RewardToken: true,
                         ComputeChain: true,
-                        DistributionChain: {
-                            include: {
-                                Explorer: true,
-                            },
-                        },
+                        DistributionChain: { include: { Explorer: true } },
                         CampaignStatus: true,
                         Creator: true,
                     },
@@ -375,11 +305,7 @@ export class OpportunityRepository {
                     orderBy: { endTimestamp: "desc" },
                 },
                 MainProtocol: true,
-                Chain: {
-                    include: {
-                        Explorer: true,
-                    },
-                },
+                Chain: { include: { Explorer: true } },
                 Protocols: true,
                 Tokens: true,
             },
@@ -389,15 +315,7 @@ export class OpportunityRepository {
                     { status: "LIVE" },
                     {
                         Campaigns: {
-                            some: {
-                                RewardToken: { isTest: false },
-                                startTimestamp: {
-                                    lte: now,
-                                },
-                                endTimestamp: {
-                                    gte: now,
-                                },
-                            },
+                            some: { RewardToken: { isTest: false }, startTimestamp: { lte: now }, endTimestamp: { gte: now } },
                         },
                     },
                 ],
@@ -408,20 +326,15 @@ export class OpportunityRepository {
         const args = OpportunityRepository.#transformQueryToPrismaFilters(query);
         return await apiDbClient.opportunity.count(args);
     }
-    static async getAllIdsForDynamicOpp() {
-        return await apiDbClient.opportunity.findMany({
-            where: { type: { notIn: ["ERC20_SNAPSHOT", "JSON_AIRDROP"] } },
-            select: { id: true },
-        });
-    }
+    // ─── Update ──────────────────────────────────────────────────────────
     /**
-     * Updates Apr, Tvl and DailyRewards record
+     * Updates Apr, Tvl and DailyRewards records
      * @param opportunityId
      * @param apr
      * @param tvl
      * @returns
      */
-    static async updateRecords(opportunityId, apr, tvl, dailyRewards) {
+    static async updateDynamicData(opportunityId, apr, tvl, dailyRewards) {
         const aprRecord = apr.cumulated >= 0 &&
             (await apiDbClient.aprRecord.create({
                 data: {
@@ -450,12 +363,10 @@ export class OpportunityRepository {
                 total: dailyRewards.total,
                 DailyRewardsBreakdown: {
                     createMany: {
-                        data: dailyRewards.breakdowns.map(breakdown => {
-                            return {
-                                campaignId: breakdown.campaignId,
-                                value: breakdown.value,
-                            };
-                        }),
+                        data: dailyRewards.breakdowns.map(breakdown => ({
+                            campaignId: breakdown.campaignId,
+                            value: breakdown.value,
+                        })),
                     },
                 },
             },
@@ -477,46 +388,26 @@ export class OpportunityRepository {
             return await apiDbClient.opportunity.update({ where: { id }, data: { status, apr: 0, dailyRewards: 0 } });
         return await apiDbClient.opportunity.update({ where: { id }, data: { status } });
     }
-    static async updateName(id, name) {
-        return await apiDbClient.opportunity.update({ where: { id }, data: { name } });
+    static async update(id, data) {
+        return await apiDbClient.opportunity.update({ where: { id }, data });
     }
-    static async updateChainId(id, chainId) {
-        return await apiDbClient.opportunity.update({ where: { id }, data: { chainId } });
+    static async updateMany(ids, data) {
+        return await apiDbClient.opportunity.updateMany({ where: { id: { in: ids } }, data });
     }
+    // ─── Aggregation ─────────────────────────────────────────────────────
     static async aggregateSum(field, query) {
         const args = OpportunityRepository.#transformQueryToPrismaFilters(query);
-        const result = await apiDbClient.opportunity.aggregate({
-            _sum: {
-                [field]: true,
-            },
-            ...args,
-        });
+        const result = await apiDbClient.opportunity.aggregate({ _sum: { [field]: true }, ...args });
         return { sum: result._sum[field] ?? null };
     }
     static async aggregateMin(field, query) {
         const args = OpportunityRepository.#transformQueryToPrismaFilters(query);
-        const result = await apiDbClient.opportunity.aggregate({
-            _min: {
-                [field]: true,
-            },
-            ...args,
-        });
+        const result = await apiDbClient.opportunity.aggregate({ _min: { [field]: true }, ...args });
         return { min: result._min[field] ?? null };
     }
     static async aggregateMax(field, query) {
         const args = OpportunityRepository.#transformQueryToPrismaFilters(query);
-        const result = await apiDbClient.opportunity.aggregate({
-            _max: {
-                [field]: true,
-            },
-            ...args,
-        });
+        const result = await apiDbClient.opportunity.aggregate({ _max: { [field]: true }, ...args });
         return { max: result._max[field] ?? null };
     }
-    static async update(id, data) {
-        return await apiDbClient.opportunity.update({ where: { id }, data });
-    }
-    static async updateMany(ids, data) {
-        return await apiDbClient.opportunity.updateMany({ where: { id: { in: ids } }, data });
-    }
 }

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

@@ -1,17 +1,51 @@
 import { type CreateCampaignModel, type GetCampaignQueryModel } from "@/modules/v4/campaign";
-import { Prisma, Status } from "@db/api";
-import { type ChainId, type MerklChainId } from "@sdk";
-import type { CreateOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, Opportunity, OpportunityResourceModel, OpportunityUnique, UpdateOpportunityModel } from "./opportunity.model";
+import { type OpportunityManualOverride, type Prisma } from "@db/api";
+import { type MerklChainId } from "@sdk";
+import type { CreateOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, Opportunity, OpportunityOverrideModel, OpportunityResourceModel, OpportunityUnique, UpdateOpportunityModel } from "./opportunity.model";
 import { OpportunityRepository } from "./opportunity.repository";
 export declare abstract class OpportunityService {
     #private;
     static hashId(opportunity: OpportunityUnique): string;
+    static override(id: string, data: OpportunityOverrideModel): Promise<{
+        id: string;
+        name: string;
+        type: string;
+        status: import("@db/api").$Enums.Status;
+        tags: string[];
+        identifier: string;
+        action: import("@db/api").$Enums.OpportunityAction;
+        manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
+        chainId: number;
+        depositUrl: string | null;
+        explorerAddress: string | null;
+        mainProtocolId: string | null;
+        tvl: number;
+        apr: number;
+        dailyRewards: number;
+    }>;
+    static deleteOverrides(id: string, overridesToDelete: OpportunityManualOverride[]): Promise<{
+        id: string;
+        name: string;
+        type: string;
+        status: import("@db/api").$Enums.Status;
+        tags: string[];
+        identifier: string;
+        action: import("@db/api").$Enums.OpportunityAction;
+        manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
+        chainId: number;
+        depositUrl: string | null;
+        explorerAddress: string | null;
+        mainProtocolId: string | null;
+        tvl: number;
+        apr: number;
+        dailyRewards: number;
+    }>;
     /**
      * create an opportunity without campaigns
      * @param newOpp the new opportunity to create
      * @returns {Promise<Opportunity|undefined>}
      */
-    static create(newOpp: Omit<CreateOpportunityModel, "id">): Promise<{
+    static create(newOpp: CreateOpportunityModel): Promise<{
         id: string;
         name: string;
         type: string;
@@ -19,6 +53,7 @@ export declare abstract class OpportunityService {
         tags: string[];
         identifier: string;
         action: import("@db/api").$Enums.OpportunityAction;
+        manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
         chainId: number;
         depositUrl: string | null;
         explorerAddress: string | null;
@@ -60,26 +95,10 @@ export declare abstract class OpportunityService {
         explorerAddress: string | undefined;
         tags: string[];
     }>;
-    static updateStatus(opportunityId: string, status: Status): Promise<{
-        id: string;
-        name: string;
-        type: string;
-        status: import("@db/api").$Enums.Status;
-        tags: string[];
-        identifier: string;
-        action: import("@db/api").$Enums.OpportunityAction;
-        chainId: number;
-        depositUrl: string | null;
-        explorerAddress: string | null;
-        mainProtocolId: string | null;
-        tvl: number;
-        apr: number;
-        dailyRewards: number;
-    }>;
     /**
      * deletes and recreates an opportunity with fresh data
      */
-    static recreate(opportunityId: string | OpportunityUnique, campaignId?: string): Promise<{
+    static recreate(opportunityId: string, campaignId?: string): Promise<{
         id: string;
         chainId: number;
         type: string;
@@ -107,7 +126,6 @@ export declare abstract class OpportunityService {
         explorerAddress: string | undefined;
         tags: string[];
     }>;
-    static updateMetadata(chain: ChainId): Promise<void>;
     /**
      * Finds opportunities based on filters of its campaigns
      * @notice campaigns are filtered as well
@@ -498,6 +516,7 @@ export declare abstract class OpportunityService {
                 tags: string[];
                 identifier: string;
                 action: import("@db/api").$Enums.OpportunityAction;
+                manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
                 chainId: number;
                 depositUrl: string | null;
                 explorerAddress: string | null;
@@ -668,6 +687,7 @@ export declare abstract class OpportunityService {
                 tags: string[];
                 identifier: string;
                 action: import("@db/api").$Enums.OpportunityAction;
+                manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
                 chainId: number;
                 depositUrl: string | null;
                 explorerAddress: string | null;
@@ -727,9 +747,6 @@ export declare abstract class OpportunityService {
         tvl: number;
         dailyRewards: number;
     }[]>;
-    static getAllIds(): Promise<{
-        id: string;
-    }[]>;
     static formatResponse(opportunity: Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>): {
         apr: number;
         aprRecord: {
@@ -834,6 +851,7 @@ export declare abstract class OpportunityService {
                 tags: string[];
                 identifier: string;
                 action: import("@db/api").$Enums.OpportunityAction;
+                manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
                 chainId: number;
                 depositUrl: string | null;
                 explorerAddress: string | null;
@@ -953,6 +971,7 @@ export declare abstract class OpportunityService {
         tags: string[];
         identifier: string;
         action: import("@db/api").$Enums.OpportunityAction;
+        manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
         chainId: number;
         depositUrl: string | null;
         explorerAddress: string | null;