@merkl/api 1.0.47 → 1.0.49

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

@@ -13,9 +13,21 @@ import type { OpportunityRepository } from "./opportunity.repository";
  * @description Target description of rewards campaigns
  * @see {@link Resource}
  */
-export type Opportunity = Resource<"Opportunity", "mainProtocolId" | "manualOverrides", {
+export type OpportunityLight = Resource<"Opportunity", "manualOverrides" | "mainProtocolId", {
     depositUrl?: string;
     explorerAddress?: string;
+    lastCampaignCreatedAt: string;
+    mainProtocolId?: string;
+}>;
+/**
+ * Opportunity
+ * @description Target description of rewards campaigns
+ * @see {@link Resource}
+ */
+export type Opportunity = Resource<"Opportunity", "manualOverrides" | "mainProtocolId", {
+    depositUrl?: string;
+    explorerAddress?: string;
+    mainProtocolId?: string;
     chain: Chain["model"];
     tokens: Token["model"][];
     lastCampaignCreatedAt: string;
@@ -25,7 +37,8 @@ export type Opportunity = Resource<"Opportunity", "mainProtocolId" | "manualOver
     rewardsRecord?: DailyRewardsRecord["model"];
     campaigns?: Omit<Campaign["model"], "manualOverrides">[];
 }>;
-export type LightOpportunityFromDB = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns">;
+export type OpportunityWithoutRecords = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns">;
+export type OpportunityWithoutRecordsAndRelation = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns" | "Chain" | "Tokens" | "Protocols" | "MainProtocol">;
 export type OpportunityUnique = {
     chainId: ChainId;
     type: string;
@@ -291,9 +304,7 @@ export declare const OpportunityWithCampaignsResourceDto: import("@sinclair/type
         campaignId: import("@sinclair/typebox").TString;
         type: import("@sinclair/typebox").TString;
         subType: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNull]>;
-        rewardTokenId: import("@sinclair/typebox").TString;
         amount: import("@sinclair/typebox").TString;
-        opportunityId: import("@sinclair/typebox").TString;
         startTimestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
         endTimestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
         creatorAddress: import("@sinclair/typebox").TString;
@@ -353,7 +364,6 @@ export declare const OpportunityWithCampaignsResourceDto: import("@sinclair/type
             readonly FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT: "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT";
         }>>;
         campaignStatus: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
-            campaignId: import("@sinclair/typebox").TString;
             computedUntil: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
             processingStarted: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
             status: import("@sinclair/typebox").TString;

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

@@ -368,9 +368,7 @@ export declare abstract class OpportunityRepository {
         lastCampaignCreatedAt: Date;
     }>;
     /**
-     * Gets opportunities and campaigns for which filtered on campaigns
-     * @param filters
-     * @returns
+     * Gets opportunities and campaigns based on a campaign filter
      */
     static findManyByCampaigns(where: Campaign["action"]["findMany"]["args"]["where"]): Promise<({
         Campaigns: ({
@@ -729,6 +727,7 @@ export declare abstract class OpportunityRepository {
         tags: string[];
         lastCampaignCreatedAt: Date;
     })[]>;
+    static countMany(query: GetOpportunitiesQueryModel): Promise<number>;
     /**
      * @dev Live campaigns here can be:
      * 1. Opportunities with status LIVE
@@ -938,7 +937,6 @@ export declare abstract class OpportunityRepository {
         tags: string[];
         lastCampaignCreatedAt: Date;
     })[]>;
-    static countMany(query: GetOpportunitiesQueryModel): Promise<number>;
     /**
      * Updates Apr, Tvl and DailyRewards records
      * @param opportunityId

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

@@ -1,12 +1,10 @@
 import { type MerklChainId } from "@angleprotocol/sdk/ts";
 import { type OpportunityAction, type OpportunityManualOverride, type Prisma } from "@package/databases/api";
-import type { CampaignWithParams, GetCampaignQueryModel } from "../../../modules/v4/campaign/campaign.model";
+import type { CampaignWithParams, FindCampaignModel } from "../../../modules/v4/campaign/campaign.model";
 import type { Protocol } from "../protocol/protocol.model";
 import type { Token } from "../token/token.model";
-import type { CreateOpportunityModel, FindOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, Opportunity, OpportunityOverrideModel, OpportunityResourceModel, OpportunityUnique } from "./opportunity.model";
-import { OpportunityRepository } from "./opportunity.repository";
+import type { FindOpportunityModel, GetOpportunitiesQueryModel, Opportunity, OpportunityOverrideModel, OpportunityResourceModel, OpportunityUnique } from "./opportunity.model";
 export declare abstract class OpportunityService {
-    #private;
     static hashId(opportunity: OpportunityUnique): string;
     static getAprBins(query: GetOpportunitiesQueryModel): Promise<{
         min: number;
@@ -118,62 +116,12 @@ export declare abstract class OpportunityService {
         tags: string[];
         lastCampaignCreatedAt: Date;
     })>;
-    /**
-     * create an opportunity without campaigns
-     * @param newOpp the new opportunity to create
-     * @returns {Promise<Opportunity|undefined>}
-     */
-    static create(newOpp: CreateOpportunityModel): Promise<{
-        Tokens: {
-            symbol: string;
-            name: string | null;
-            decimals: number;
-            price: number | null;
-            address: string;
-            id: string;
-            chainId: number;
-            icon: string;
-            isNative: boolean;
-            isPoint: boolean;
-            isPreTGE: boolean;
-            isTest: boolean;
-            verified: boolean;
-            displaySymbol: string;
-        }[];
-        Protocols: {
-            name: string;
-            description: string;
-            id: string;
-            url: string;
-            icon: string;
-            tags: string[];
-        }[];
-    } & {
-        name: string;
-        apr: number;
-        tvl: number;
-        description: string;
-        id: string;
-        status: import("@package/databases").Status;
-        chainId: number;
-        action: import("@package/databases").OpportunityAction;
-        type: string;
-        depositUrl: string | null;
-        explorerAddress: string | null;
-        howToSteps: string[];
-        mainProtocolId: string | null;
-        manualOverrides: import("@package/databases").OpportunityManualOverride[];
-        identifier: string;
-        dailyRewards: number;
-        tags: string[];
-        lastCampaignCreatedAt: Date;
-    }>;
     /**
      * @param upsert whether to update the opportunity if it already exists in database
      * @param dryRun whether to skip the opportunity table interaction and just return the computed opportunity
      * @returns the opportunity entity computed
      */
-    static createFromCampaign(campaign: Omit<CampaignWithParams, "manualOverrides">, opportunityIdentifier: string, upsert?: boolean, dryRun?: boolean): Promise<{
+    static createFromCampaign(campaign: Omit<CampaignWithParams, "manualOverrides" | "opportunityId">, opportunityIdentifier: string, upsert?: boolean, dryRun?: boolean): Promise<{
         id: string;
         chainId: number;
         type: string;
@@ -251,7 +199,8 @@ export declare abstract class OpportunityService {
         lastCampaignCreatedAt: Date;
     })>;
     /**
-     * deletes and recreates an opportunity with fresh data
+     * @notice Find the first campaign of an opportunity and then upserts the opportunity
+     * based on this
      */
     static recreate(opportunityId: string, campaignId?: string): Promise<{
         id: string;
@@ -336,7 +285,7 @@ export declare abstract class OpportunityService {
      * @param where
      * @returns opportunities
      */
-    static findManyByCampaigns(query: GetCampaignQueryModel): Promise<{
+    static findManyByCampaigns(query: FindCampaignModel): Promise<{
         protocol?: {
             dailyRewards?: number | undefined;
             numberOfLiveCampaigns?: number | undefined;
@@ -430,7 +379,6 @@ export declare abstract class OpportunityService {
             campaignStatus?: {
                 error?: string | undefined;
                 details?: any;
-                campaignId: string;
                 status: string;
                 computedUntil: string | number;
                 processingStarted: string | number;
@@ -469,10 +417,8 @@ export declare abstract class OpportunityService {
             computeChainId: number;
             distributionChainId: number;
             endTimestamp: string | number;
-            opportunityId: string;
             creatorAddress: string;
             subType: number | null;
-            rewardTokenId: string;
             createdAt: string;
             chain: {
                 explorers?: {
@@ -510,7 +456,6 @@ export declare abstract class OpportunityService {
      * @returns A list of opportunities
      */
     static findMany(query: GetOpportunitiesQueryModel): Promise<{
-        apr: number;
         aprRecord: {
             cumulated: number;
             timestamp: bigint;
@@ -564,91 +509,7 @@ export declare abstract class OpportunityService {
                 distributionType: import("@package/databases").DistributionType;
             }[];
         };
-        campaigns: {
-            params: any;
-            chain: {
-                name: string;
-                id: number;
-                icon: string;
-            };
-            endTimestamp: number;
-            startTimestamp: number;
-            rewardToken: {
-                symbol: string;
-                name: string | null;
-                decimals: number;
-                address: string;
-                id: string;
-                chainId: number;
-                icon: string;
-                isNative: boolean;
-                isPoint: boolean;
-                isPreTGE: boolean;
-                isTest: boolean;
-                verified: boolean;
-            } & {
-                price?: number | null | undefined;
-                isTokenWrapper?: boolean | undefined;
-                tokenWrapperAddress?: string | undefined;
-            };
-            distributionChain: {
-                name: string;
-                id: number;
-                icon: string;
-            } | undefined;
-            campaignStatus: {
-                computedUntil: number;
-                processingStarted: number;
-                campaignId: string;
-                error: string;
-                status: import("@package/databases").RunStatus;
-                details: import("@prisma/client/runtime/library").JsonValue;
-            } | undefined;
-            creatorAddress: string;
-            creator: {
-                address: string;
-                tags: string[];
-                creatorId: string | null;
-            };
-            createdAt: string;
-            description: string | undefined;
-            parentCampaignId: string | undefined;
-            rootCampaignId: string | undefined;
-            Opportunity: {
-                name: string;
-                apr: number;
-                tvl: number;
-                description: string;
-                id: string;
-                status: import("@package/databases").Status;
-                chainId: number;
-                action: import("@package/databases").OpportunityAction;
-                type: string;
-                depositUrl: string | null;
-                explorerAddress: string | null;
-                howToSteps: string[];
-                mainProtocolId: string | null;
-                manualOverrides: import("@package/databases").OpportunityManualOverride[];
-                identifier: string;
-                dailyRewards: number;
-                tags: string[];
-                lastCampaignCreatedAt: Date;
-            };
-            campaignId: string;
-            id: string;
-            amount: string;
-            type: string;
-            computeChainId: number;
-            distributionChainId: number;
-            opportunityId: string;
-            distributionType: import("@package/databases").DistributionType;
-            subType: number | null;
-            rewardTokenId: string;
-        }[] | undefined;
-        id: string;
-        depositUrl: string | undefined;
-        explorerAddress: string | undefined;
-        lastCampaignCreatedAt: string;
+        campaigns: Omit<CampaignWithParams, "manualOverrides">[] | undefined;
         tokens: ({
             symbol: string;
             name: string | null;
@@ -680,7 +541,12 @@ export declare abstract class OpportunityService {
             icon: string;
             tags: string[];
         } | undefined;
+        id: string;
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        lastCampaignCreatedAt: string;
         name: string;
+        apr: number;
         tvl: number;
         description: string;
         status: import("@package/databases").Status;
@@ -700,190 +566,6 @@ export declare abstract class OpportunityService {
      */
     static countMany(query: GetOpportunitiesQueryModel): Promise<number>;
     static findLiveWithCampaigns(chainId: MerklChainId, take?: number): Promise<{
-        apr: number;
-        aprRecord: {
-            cumulated: number;
-            timestamp: bigint;
-            breakdowns: ({
-                value: number;
-                distributionType: import("@package/databases").DistributionType;
-                identifier: string;
-                type: "CAMPAIGN";
-            } | {
-                value: number;
-                identifier: string;
-                type: import("@package/databases").AprType;
-            })[];
-        };
-        tvlRecord: {
-            id: string;
-            total: number;
-            timestamp: bigint;
-            breakdowns: {
-                value: number;
-                type: import("@package/databases").TvlType;
-                identifier: string;
-            }[];
-        };
-        rewardsRecord: {
-            id: string;
-            total: number;
-            timestamp: bigint;
-            breakdowns: {
-                campaignId: string;
-                id: string;
-                dailyRewardsRecordId: string;
-                token: {
-                    symbol: string;
-                    name: string | null;
-                    decimals: number;
-                    price: number | null;
-                    address: string;
-                    id: string;
-                    chainId: number;
-                    icon: string;
-                    isNative: boolean;
-                    isPoint: boolean;
-                    isPreTGE: boolean;
-                    isTest: boolean;
-                    verified: boolean;
-                    displaySymbol: string;
-                };
-                amount: bigint;
-                value: number;
-                distributionType: import("@package/databases").DistributionType;
-            }[];
-        };
-        campaigns: {
-            params: any;
-            chain: {
-                name: string;
-                id: number;
-                icon: string;
-            };
-            endTimestamp: number;
-            startTimestamp: number;
-            rewardToken: {
-                symbol: string;
-                name: string | null;
-                decimals: number;
-                address: string;
-                id: string;
-                chainId: number;
-                icon: string;
-                isNative: boolean;
-                isPoint: boolean;
-                isPreTGE: boolean;
-                isTest: boolean;
-                verified: boolean;
-            } & {
-                price?: number | null | undefined;
-                isTokenWrapper?: boolean | undefined;
-                tokenWrapperAddress?: string | undefined;
-            };
-            distributionChain: {
-                name: string;
-                id: number;
-                icon: string;
-            } | undefined;
-            campaignStatus: {
-                computedUntil: number;
-                processingStarted: number;
-                campaignId: string;
-                error: string;
-                status: import("@package/databases").RunStatus;
-                details: import("@prisma/client/runtime/library").JsonValue;
-            } | undefined;
-            creatorAddress: string;
-            creator: {
-                address: string;
-                tags: string[];
-                creatorId: string | null;
-            };
-            createdAt: string;
-            description: string | undefined;
-            parentCampaignId: string | undefined;
-            rootCampaignId: string | undefined;
-            Opportunity: {
-                name: string;
-                apr: number;
-                tvl: number;
-                description: string;
-                id: string;
-                status: import("@package/databases").Status;
-                chainId: number;
-                action: import("@package/databases").OpportunityAction;
-                type: string;
-                depositUrl: string | null;
-                explorerAddress: string | null;
-                howToSteps: string[];
-                mainProtocolId: string | null;
-                manualOverrides: import("@package/databases").OpportunityManualOverride[];
-                identifier: string;
-                dailyRewards: number;
-                tags: string[];
-                lastCampaignCreatedAt: Date;
-            };
-            campaignId: string;
-            id: string;
-            amount: string;
-            type: string;
-            computeChainId: number;
-            distributionChainId: number;
-            opportunityId: string;
-            distributionType: import("@package/databases").DistributionType;
-            subType: number | null;
-            rewardTokenId: string;
-        }[] | undefined;
-        id: string;
-        depositUrl: string | undefined;
-        explorerAddress: string | undefined;
-        lastCampaignCreatedAt: string;
-        tokens: ({
-            symbol: string;
-            name: string | null;
-            decimals: number;
-            address: string;
-            id: string;
-            chainId: number;
-            icon: string;
-            isNative: boolean;
-            isPoint: boolean;
-            isPreTGE: boolean;
-            isTest: boolean;
-            verified: boolean;
-        } & {
-            price?: number | null | undefined;
-            isTokenWrapper?: boolean | undefined;
-            tokenWrapperAddress?: string | undefined;
-        })[];
-        chain: {
-            name: string;
-            id: number;
-            icon: string;
-        };
-        protocol: {
-            name: string;
-            description: string;
-            id: string;
-            url: string;
-            icon: string;
-            tags: string[];
-        } | undefined;
-        name: string;
-        tvl: number;
-        description: string;
-        status: import("@package/databases").Status;
-        chainId: number;
-        action: import("@package/databases").OpportunityAction;
-        type: string;
-        howToSteps: string[];
-        identifier: string;
-        dailyRewards: number;
-        tags: string[];
-    }[]>;
-    static formatResponse(opportunity: Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>): {
-        apr: number;
         aprRecord: {
             cumulated: number;
             timestamp: bigint;
@@ -937,91 +619,7 @@ export declare abstract class OpportunityService {
                 distributionType: import("@package/databases").DistributionType;
             }[];
         };
-        campaigns: {
-            params: any;
-            chain: {
-                name: string;
-                id: number;
-                icon: string;
-            };
-            endTimestamp: number;
-            startTimestamp: number;
-            rewardToken: {
-                symbol: string;
-                name: string | null;
-                decimals: number;
-                address: string;
-                id: string;
-                chainId: number;
-                icon: string;
-                isNative: boolean;
-                isPoint: boolean;
-                isPreTGE: boolean;
-                isTest: boolean;
-                verified: boolean;
-            } & {
-                price?: number | null | undefined;
-                isTokenWrapper?: boolean | undefined;
-                tokenWrapperAddress?: string | undefined;
-            };
-            distributionChain: {
-                name: string;
-                id: number;
-                icon: string;
-            } | undefined;
-            campaignStatus: {
-                computedUntil: number;
-                processingStarted: number;
-                campaignId: string;
-                error: string;
-                status: import("@package/databases").RunStatus;
-                details: import("@prisma/client/runtime/library").JsonValue;
-            } | undefined;
-            creatorAddress: string;
-            creator: {
-                address: string;
-                tags: string[];
-                creatorId: string | null;
-            };
-            createdAt: string;
-            description: string | undefined;
-            parentCampaignId: string | undefined;
-            rootCampaignId: string | undefined;
-            Opportunity: {
-                name: string;
-                apr: number;
-                tvl: number;
-                description: string;
-                id: string;
-                status: import("@package/databases").Status;
-                chainId: number;
-                action: import("@package/databases").OpportunityAction;
-                type: string;
-                depositUrl: string | null;
-                explorerAddress: string | null;
-                howToSteps: string[];
-                mainProtocolId: string | null;
-                manualOverrides: import("@package/databases").OpportunityManualOverride[];
-                identifier: string;
-                dailyRewards: number;
-                tags: string[];
-                lastCampaignCreatedAt: Date;
-            };
-            campaignId: string;
-            id: string;
-            amount: string;
-            type: string;
-            computeChainId: number;
-            distributionChainId: number;
-            opportunityId: string;
-            distributionType: import("@package/databases").DistributionType;
-            subType: number | null;
-            rewardTokenId: string;
-        }[] | undefined;
-        id: string;
-        depositUrl: string | undefined;
-        explorerAddress: string | undefined;
-        lastCampaignCreatedAt: string;
+        campaigns: Omit<CampaignWithParams, "manualOverrides">[] | undefined;
         tokens: ({
             symbol: string;
             name: string | null;
@@ -1053,54 +651,10 @@ export declare abstract class OpportunityService {
             icon: string;
             tags: string[];
         } | undefined;
-        name: string;
-        tvl: number;
-        description: string;
-        status: import("@package/databases").Status;
-        chainId: number;
-        action: import("@package/databases").OpportunityAction;
-        type: string;
-        howToSteps: string[];
-        identifier: string;
-        dailyRewards: number;
-        tags: string[];
-    };
-    static formatResponseBase(opportunity: LightOpportunityFromDB): {
         id: string;
         depositUrl: string | undefined;
         explorerAddress: string | undefined;
         lastCampaignCreatedAt: string;
-        tokens: ({
-            symbol: string;
-            name: string | null;
-            decimals: number;
-            address: string;
-            id: string;
-            chainId: number;
-            icon: string;
-            isNative: boolean;
-            isPoint: boolean;
-            isPreTGE: boolean;
-            isTest: boolean;
-            verified: boolean;
-        } & {
-            price?: number | null | undefined;
-            isTokenWrapper?: boolean | undefined;
-            tokenWrapperAddress?: string | undefined;
-        })[];
-        chain: {
-            name: string;
-            id: number;
-            icon: string;
-        };
-        protocol: {
-            name: string;
-            description: string;
-            id: string;
-            url: string;
-            icon: string;
-            tags: string[];
-        } | undefined;
         name: string;
         apr: number;
         tvl: number;
@@ -1113,7 +667,7 @@ export declare abstract class OpportunityService {
         identifier: string;
         dailyRewards: number;
         tags: string[];
-    };
+    }[]>;
     static aggregate(query: GetOpportunitiesQueryModel, field: keyof Prisma.OpportunitySumAggregateInputType): Promise<{
         sum: string;
     }>;