@merkl/api 0.16.33 → 0.16.35

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

@@ -169,182 +169,13 @@ export declare abstract class OpportunityRepository {
         apr: number;
         dailyRewards: number;
     }) | null>;
-    static findUniqueOrThrow(id: string, withTest?: boolean): Promise<{
+    static findUniqueOrThrow(id: string, withTest?: boolean, withCampaigns?: boolean): Promise<{
         Chain: {
             name: string;
             id: number;
             icon: string;
         };
-        Tokens: {
-            symbol: string;
-            name: string | null;
-            id: string;
-            icon: string;
-            chainId: number;
-            address: string;
-            decimals: number;
-            displaySymbol: string;
-            verified: boolean;
-            isTest: boolean;
-            price: number | null;
-        }[];
-        Protocols: {
-            name: string;
-            url: string;
-            description: string;
-            id: string;
-            tags: string[];
-            icon: string;
-        }[];
-        MainProtocol: {
-            name: string;
-            url: string;
-            description: string;
-            id: string;
-            tags: string[];
-            icon: string;
-        } | null;
-        TvlRecords: ({
-            TvlBreakdown: {
-                type: import("../../../../database/api/.generated").$Enums.TvlType;
-                id: number;
-                identifier: string;
-                value: number;
-                tvlRecordId: string;
-            }[];
-        } & {
-            total: number;
-            id: string;
-            timestamp: bigint;
-            opportunityId: string;
-        })[];
-        AprRecords: ({
-            AprBreakdown: {
-                type: import("../../../../database/api/.generated").$Enums.AprType;
-                id: number;
-                identifier: string;
-                value: number;
-                aprRecordId: string;
-            }[];
-        } & {
-            id: string;
-            timestamp: bigint;
-            opportunityId: string;
-            cumulated: number;
-        })[];
-        DailyRewardsRecords: ({
-            DailyRewardsBreakdown: ({
-                Campaign: {
-                    startTimestamp: bigint;
-                    endTimestamp: bigint;
-                    amount: string;
-                    RewardToken: {
-                        symbol: string;
-                        name: string | null;
-                        id: string;
-                        icon: string;
-                        chainId: number;
-                        address: string;
-                        decimals: number;
-                        displaySymbol: string;
-                        verified: boolean;
-                        isTest: boolean;
-                        price: number | null;
-                    };
-                    CampaignStatus: {
-                        error: string;
-                        details: Prisma.JsonValue;
-                        status: import("../../../../database/api/.generated").$Enums.RunStatus;
-                        campaignId: string;
-                        computedUntil: bigint;
-                        processingStarted: bigint;
-                    }[];
-                };
-            } & {
-                id: number;
-                value: number;
-                campaignId: string;
-                dailyRewardsRecordId: string;
-            })[];
-        } & {
-            total: number;
-            id: string;
-            timestamp: bigint;
-            opportunityId: string;
-        })[];
-    } & {
-        name: string;
-        type: string;
-        id: string;
-        status: import("../../../../database/api/.generated").$Enums.Status;
-        tags: string[];
-        identifier: string;
-        chainId: number;
-        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
-        depositUrl: string | null;
-        mainProtocolId: string | null;
-        tvl: number;
-        apr: number;
-        dailyRewards: number;
-    }>;
-    static findUniqueOrThrowWithCampaigns(id: string, withTest: boolean): Promise<{
-        Chain: {
-            Explorer: {
-                type: import("../../../../database/api/.generated").$Enums.ExplorerType;
-                url: string;
-                id: string;
-                chainId: number;
-            }[];
-        } & {
-            name: string;
-            id: number;
-            icon: string;
-        };
-        Campaigns: ({
-            ComputeChain: {
-                name: string;
-                id: number;
-                icon: string;
-            };
-            DistributionChain: {
-                Explorer: {
-                    type: import("../../../../database/api/.generated").$Enums.ExplorerType;
-                    url: string;
-                    id: string;
-                    chainId: number;
-                }[];
-            } & {
-                name: string;
-                id: number;
-                icon: string;
-            };
-            RewardToken: {
-                symbol: string;
-                name: string | null;
-                id: string;
-                icon: string;
-                chainId: number;
-                address: string;
-                decimals: number;
-                displaySymbol: string;
-                verified: boolean;
-                isTest: boolean;
-                price: number | null;
-            };
-            Creator: {
-                tags: string[];
-                address: string;
-                creatorId: string | null;
-            };
-            CampaignStatus: {
-                error: string;
-                details: Prisma.JsonValue;
-                status: import("../../../../database/api/.generated").$Enums.RunStatus;
-                campaignId: string;
-                computedUntil: bigint;
-                processingStarted: bigint;
-            }[];
-        } & {
+        Campaigns: {
             type: string;
             id: string;
             params: Prisma.JsonValue;
@@ -358,7 +189,7 @@ export declare abstract class OpportunityRepository {
             amount: string;
             opportunityId: string;
             creatorAddress: string;
-        })[];
+        }[];
         Tokens: {
             symbol: string;
             name: string | null;
@@ -660,22 +491,13 @@ export declare abstract class OpportunityRepository {
         apr: number;
         dailyRewards: number;
     })[]>;
-    static findManyWithCampaigns(filters: Prisma.OpportunityFindManyArgs): Promise<({
-        Campaigns: ({
-            RewardToken: {
-                symbol: string;
-                name: string | null;
-                id: string;
-                icon: string;
-                chainId: number;
-                address: string;
-                decimals: number;
-                displaySymbol: string;
-                verified: boolean;
-                isTest: boolean;
-                price: number | null;
-            };
-        } & {
+    static findMany(query: GetOpportunitiesQueryModel): Promise<({
+        Chain: {
+            name: string;
+            id: number;
+            icon: string;
+        };
+        Campaigns: {
             type: string;
             id: string;
             params: Prisma.JsonValue;
@@ -689,28 +511,7 @@ export declare abstract class OpportunityRepository {
             amount: string;
             opportunityId: string;
             creatorAddress: string;
-        })[];
-    } & {
-        name: string;
-        type: string;
-        id: string;
-        status: import("../../../../database/api/.generated").$Enums.Status;
-        tags: string[];
-        identifier: string;
-        chainId: number;
-        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
-        depositUrl: string | null;
-        mainProtocolId: string | null;
-        tvl: number;
-        apr: number;
-        dailyRewards: number;
-    })[]>;
-    static findMany(query: GetOpportunitiesQueryModel): Promise<({
-        Chain: {
-            name: string;
-            id: number;
-            icon: string;
-        };
+        }[];
         Tokens: {
             symbol: string;
             name: string | null;
@@ -836,6 +637,13 @@ export declare abstract class OpportunityRepository {
                 icon: string;
             };
             DistributionChain: {
+                Explorer: {
+                    type: import("../../../../database/api/.generated").$Enums.ExplorerType;
+                    url: string;
+                    id: string;
+                    chainId: number;
+                }[];
+            } & {
                 name: string;
                 id: number;
                 icon: string;

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

@@ -6,6 +6,47 @@ import { ProtocolService } from "../protocol";
 import { RewardService } from "../reward";
 import { TvlService } from "../tvl";
 export class OpportunityRepository {
+    static #transformQueryToPrismaFilters(query) {
+        const { page: _page, items: _items, ...filters } = query;
+        //TODO: abstract away query to not be strictly equal to controller
+        const chainIds = query.chainId?.split(",").map(n => Number.parseInt(n));
+        const actions = query.action?.split(",");
+        const status = query.status?.split(",");
+        const tokens = query.tokens?.split(",");
+        const types = query.type?.split(",");
+        const protocols = query.mainProtocolId?.split(",");
+        const sort = (query.sort === "rewards" ? "dailyRewards" : query.sort) ?? "dailyRewards";
+        const order = query.order ?? "desc";
+        const test = query.test ?? false;
+        const creatorAddress = query.creatorAddress ?? null;
+        const identifier = query.identifier ?? null;
+        const orderBy = {
+            [sort]: order,
+        };
+        return {
+            orderBy,
+            where: {
+                tags: !filters.tags ? undefined : { has: filters.tags },
+                type: !filters.type ? undefined : { in: types },
+                tvl: filters.minimumTvl ? { gte: filters.minimumTvl } : undefined,
+                chainId: !chainIds ? undefined : { in: chainIds },
+                name: !filters.name ? undefined : { contains: filters.name, mode: "insensitive" },
+                action: !actions ? undefined : { in: actions },
+                status: !status ? undefined : { in: status },
+                mainProtocolId: !protocols ? undefined : { in: protocols },
+                identifier: !identifier ? undefined : { contains: identifier, mode: "insensitive" },
+                Campaigns: test || !creatorAddress
+                    ? undefined
+                    : {
+                        some: {
+                            RewardToken: !test ? { isTest: false } : undefined,
+                            creatorAddress: creatorAddress ? creatorAddress : undefined,
+                        },
+                    },
+                Tokens: { some: { symbol: { in: tokens } } },
+            },
+        };
+    }
     static #getRecordInclusion(withTest = true) {
         return {
             AprRecords: {
@@ -44,6 +85,31 @@ export class OpportunityRepository {
             },
         };
     }
+    static #getCampaignInclusion(withTest = true) {
+        return {
+            orderBy: {
+                endTimestamp: "desc",
+            },
+            where: withTest
+                ? undefined
+                : {
+                    RewardToken: {
+                        isTest: false,
+                    },
+                },
+            include: {
+                RewardToken: true,
+                ComputeChain: true,
+                DistributionChain: {
+                    include: {
+                        Explorer: true,
+                    },
+                },
+                Creator: true,
+                CampaignStatus: true, // [][0]
+            },
+        };
+    }
     static async create(newOpp, upsert = false) {
         if (!!newOpp.mainProtocol) {
             let mainProtocol = await apiDbClient.protocol.findUnique({ where: { id: newOpp.mainProtocol } });
@@ -125,10 +191,11 @@ export class OpportunityRepository {
             where: { id },
         });
     }
-    static async findUniqueOrThrow(id, withTest = true) {
+    static async findUniqueOrThrow(id, withTest = true, withCampaigns = false) {
         return await apiDbClient.opportunity.findUniqueOrThrow({
             include: {
                 ...OpportunityRepository.#getRecordInclusion(withTest),
+                Campaigns: withCampaigns ? OpportunityRepository.#getCampaignInclusion(withTest) : undefined,
                 Chain: true,
                 MainProtocol: true,
                 Protocols: true,
@@ -139,46 +206,6 @@ export class OpportunityRepository {
             where: { id },
         });
     }
-    static async findUniqueOrThrowWithCampaigns(id, withTest) {
-        const b = await apiDbClient.opportunity.findUniqueOrThrow({
-            include: {
-                ...OpportunityRepository.#getRecordInclusion(withTest),
-                Chain: {
-                    include: {
-                        Explorer: true,
-                    },
-                },
-                Campaigns: {
-                    where: withTest
-                        ? undefined
-                        : {
-                            RewardToken: {
-                                isTest: false,
-                            },
-                        },
-                    include: {
-                        RewardToken: true,
-                        ComputeChain: true,
-                        DistributionChain: {
-                            include: {
-                                Explorer: true,
-                            },
-                        },
-                        Creator: true,
-                        CampaignStatus: true, // [][0]
-                    },
-                    orderBy: {
-                        endTimestamp: "desc",
-                    },
-                },
-                MainProtocol: true,
-                Protocols: true,
-                Tokens: true,
-            },
-            where: { id },
-        });
-        return b;
-    }
     /**
      * Gets opportunities and campaigns for which filtered on campaigns
      * @param filters
@@ -193,6 +220,7 @@ export class OpportunityRepository {
             },
             include: {
                 ...OpportunityRepository.#getRecordInclusion(),
+                Campaigns: OpportunityRepository.#getCampaignInclusion(true),
                 Chain: {
                     include: {
                         Explorer: true,
@@ -201,92 +229,23 @@ export class OpportunityRepository {
                 MainProtocol: true,
                 Protocols: true,
                 Tokens: true,
-                Campaigns: {
-                    where,
-                    include: {
-                        RewardToken: true,
-                        ComputeChain: true,
-                        DistributionChain: {
-                            include: {
-                                Explorer: true,
-                            },
-                        },
-                        Creator: true,
-                        CampaignStatus: true, // [][0]
-                    },
-                    orderBy: {
-                        endTimestamp: "desc",
-                    },
-                },
             },
         });
     }
-    static async findManyWithCampaigns(filters) {
-        return await apiDbClient.opportunity.findMany({
-            ...filters,
-            include: {
-                Campaigns: {
-                    include: {
-                        RewardToken: true,
-                    },
-                    orderBy: {
-                        endTimestamp: "desc",
-                    },
-                },
-            },
-        });
-    }
-    static #transformQueryToPrismaFilters(query) {
-        const { page: _page, items: _items, ...filters } = query;
-        //TODO: abstract away query to not be strictly equal to controller
-        const chainIds = query.chainId?.split(",").map(n => Number.parseInt(n));
-        const actions = query.action?.split(",");
-        const status = query.status?.split(",");
-        const tokens = query.tokens?.split(",");
-        const types = query.type?.split(",");
-        const protocols = query.mainProtocolId?.split(",");
-        const sort = (query.sort === "rewards" ? "dailyRewards" : query.sort) ?? "dailyRewards";
-        const order = query.order ?? "desc";
-        const test = query.test ?? false;
-        const creatorAddress = query.creatorAddress ?? null;
-        const orderBy = {
-            [sort]: order,
-        };
-        return {
-            orderBy,
-            where: {
-                tags: !filters.tags ? undefined : { has: filters.tags },
-                type: !filters.type ? undefined : { in: types },
-                tvl: filters.minimumTvl ? { gte: filters.minimumTvl } : undefined,
-                chainId: !chainIds ? undefined : { in: chainIds },
-                name: !filters.name ? undefined : { contains: filters.name, mode: "insensitive" },
-                action: !actions ? undefined : { in: actions },
-                status: !status ? undefined : { in: status },
-                mainProtocolId: !protocols ? undefined : { in: protocols },
-                Campaigns: test || !creatorAddress
-                    ? undefined
-                    : {
-                        some: {
-                            RewardToken: !test ? { isTest: false } : undefined,
-                            creatorAddress: creatorAddress ? creatorAddress : undefined,
-                        },
-                    },
-                Tokens: { some: { symbol: { in: tokens } } },
-            },
-        };
-    }
     static async findMany(query) {
         // pagination by offset; might have to change to cursor based for performance
         const { page: _page, items: _items } = query;
         const page = _page ? _page : 0;
         const items = _items ? _items : 20;
         const withTest = query.test ?? false;
+        const withCampaigns = query.campaigns ?? false;
         const args = OpportunityRepository.#transformQueryToPrismaFilters(query);
         return await apiDbClient.opportunity.findMany({
             take: items,
             skip: page * items,
             include: {
                 ...OpportunityRepository.#getRecordInclusion(withTest),
+                Campaigns: withCampaigns ? OpportunityRepository.#getCampaignInclusion(withTest) : undefined,
                 MainProtocol: true,
                 Chain: true,
                 Protocols: true,
@@ -306,7 +265,11 @@ export class OpportunityRepository {
                     include: {
                         RewardToken: true,
                         ComputeChain: true,
-                        DistributionChain: true,
+                        DistributionChain: {
+                            include: {
+                                Explorer: true,
+                            },
+                        },
                         CampaignStatus: true,
                         Creator: true,
                     },