@merkl/api 0.16.34 → 0.16.35

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

@@ -122,45 +122,41 @@ export declare abstract class OpportunityService {
      * @param where
      * @returns opportunities
      */
-    static getManyByCampaigns(where: GetCampaignQueryModel): Promise<({
-        protocol?: {
-            name: string;
-            url: string;
-            description: string;
-            id: string;
-            tags: string[];
-            icon: string;
-        } | null | undefined;
-        depositUrl?: string | undefined;
-        aprRecord?: {
-            timestamp: string | bigint;
+    static findManyByCampaigns(where: GetCampaignQueryModel): Promise<{
+        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;
@@ -168,45 +164,14 @@ export declare abstract class OpportunityService {
                     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: {
@@ -258,7 +223,44 @@ export declare abstract class OpportunityService {
             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;
+    }[]>;
     static getUniqueWithCampaignsOrThrow(opportunityId: string | OpportunityUnique, withTest?: boolean): Promise<OpportunityWithCampaignsResourceModel>;
     static getUniqueOrThrow(opportunityId: string | OpportunityUnique, withTest?: boolean): Promise<OpportunityResourceModel>;
     /**
@@ -316,6 +318,57 @@ export declare abstract class OpportunityService {
                 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: Prisma.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: ({
@@ -354,6 +407,13 @@ export declare abstract class OpportunityService {
         tvl: number;
         dailyRewards: number;
     }[]>;
+    /**
+     * Counts the number of opportunities that complies to query
+     * @description used for pagination purposes
+     * @param query
+     * @returns the number of opportunities
+     */
+    static countMany(query: GetOpportunitiesQueryModel): Promise<number>;
     static findLiveWithFirstCampaign(chainId: MerklChainId): Promise<({
         apr: number;
         aprRecord: {
@@ -404,6 +464,57 @@ export declare abstract class OpportunityService {
                 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: Prisma.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: ({
@@ -497,13 +608,6 @@ export declare abstract class OpportunityService {
     static getAllIds(): Promise<{
         id: string;
     }[]>;
-    /**
-     * Counts the number of opportunities that complies to query
-     * @description used for pagination purposes
-     * @param query
-     * @returns the number of opportunities
-     */
-    static countMany(query: GetOpportunitiesQueryModel): Promise<number>;
     static formatResponse(opportunity: Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>): {
         apr: number;
         aprRecord: {
@@ -554,6 +658,57 @@ export declare abstract class OpportunityService {
                 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: Prisma.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: ({

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

@@ -221,8 +221,9 @@ export class OpportunityService {
     }
     static async updateMetadata(chain) {
         try {
-            const opportunities = await OpportunityRepository.findManyWithCampaigns({
-                where: { chainId: chain },
+            const opportunities = await OpportunityRepository.findMany({
+                chainId: chain.toString(),
+                campaigns: true,
             });
             // ─── Check And Update Opportunity Status ─────────────
             for (const opp of opportunities) {
@@ -246,20 +247,16 @@ export class OpportunityService {
      * @param where
      * @returns opportunities
      */
-    static async getManyByCampaigns(where) {
+    static async findManyByCampaigns(where) {
         const opportunities = await OpportunityRepository.findManyByCampaigns(CampaignRepository.transformQueryToPrismaFilters(where).where);
-        const formatted = opportunities.map(({ Campaigns, ...o }) => {
-            const opportunity = OpportunityService.formatResponse(o);
-            const campaigns = Campaigns.map(CampaignService.format);
-            return Object.assign(opportunity, { campaigns });
+        return opportunities.map(o => {
+            return OpportunityService.formatResponse(o);
         });
-        return formatted;
     }
     static async getUniqueWithCampaignsOrThrow(opportunityId, withTest = false) {
         const id = typeof opportunityId === "string" ? opportunityId : OpportunityService.hashId(opportunityId);
-        const { Campaigns, ...opportunity } = await OpportunityRepository.findUniqueOrThrowWithCampaigns(id, withTest);
-        const formatted = OpportunityService.formatResponse(opportunity);
-        return Object.assign(formatted, { campaigns: Campaigns.map(CampaignService.format) });
+        const opportunity = await OpportunityRepository.findUniqueOrThrow(id, withTest, true);
+        return OpportunityService.formatResponse(opportunity);
     }
     static async getUniqueOrThrow(opportunityId, withTest = false) {
         const id = typeof opportunityId === "string" ? opportunityId : OpportunityService.hashId(opportunityId);
@@ -277,6 +274,15 @@ export class OpportunityService {
             return opportunities.map(OpportunityService.formatResponse);
         }, query);
     }
+    /**
+     * Counts the number of opportunities that complies to query
+     * @description used for pagination purposes
+     * @param query
+     * @returns the number of opportunities
+     */
+    static async countMany(query) {
+        return await OpportunityRepository.countMany(query);
+    }
     static async findLiveWithFirstCampaign(chainId) {
         return record("data-layer.access", async () => {
             return await CacheService.wrap(TTLPresets.MIN_10, async (chainId) => {
@@ -291,17 +297,8 @@ export class OpportunityService {
     static async getAllIds() {
         return await OpportunityRepository.getAllIdsForDynamicOpp();
     }
-    /**
-     * Counts the number of opportunities that complies to query
-     * @description used for pagination purposes
-     * @param query
-     * @returns the number of opportunities
-     */
-    static async countMany(query) {
-        return await OpportunityRepository.countMany(query);
-    }
     static formatResponse(opportunity) {
-        const { DailyRewardsRecords, AprRecords, TvlRecords, ...opp } = opportunity;
+        const { DailyRewardsRecords, AprRecords, TvlRecords, Campaigns, ...opp } = opportunity;
         return {
             ...OpportunityService.formatResponseBase(opp),
             apr: opp.status === "LIVE" ? opp.apr : 0,
@@ -336,6 +333,7 @@ export class OpportunityService {
                     };
                 }),
             }))?.[0] ?? undefined,
+            campaigns: Campaigns?.map(c => CampaignService.format(c)),
             //TODO: change this to accomodate all return types
         };
     }

package/dist/src/modules/v4/reward/{subservices/converter.d.ts → reward.converter.d.ts}

@@ -1,7 +1,7 @@
 import type { MerklAPIType, MerklChainId } from "@sdk";
-import type { RewardV3Model, UserRewardV3Model } from "../reward.model";
-import { RewardService } from "../reward.service";
-export declare abstract class RewardConvertorService {
+import type { RewardV3Model, UserRewardV3Model } from "./reward.model";
+import { RewardService } from "./reward.service";
+export declare class RewardConvertorService {
     /**
      * Convert the v4 reward data to the v3 model used in the v3/userRewards route
      */

package/dist/src/modules/v4/reward/{subservices/converter.js → reward.converter.js}

@@ -1,4 +1,4 @@
-import { RewardService } from "../reward.service";
+import { RewardService } from "./reward.service";
 export class RewardConvertorService {
     /**
      * Convert the v4 reward data to the v3 model used in the v3/userRewards route