@merkl/api 1.0.47 → 1.0.48

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

@@ -1,12 +1,12 @@
 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 { OpportunityFormatter } from "./opportunity.formatter";
+import type { FindOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, Opportunity, OpportunityOverrideModel, OpportunityResourceModel, OpportunityUnique } from "./opportunity.model";
 import { OpportunityRepository } from "./opportunity.repository";
-export declare abstract class OpportunityService {
-    #private;
+export declare abstract class OpportunityService extends OpportunityFormatter {
     static hashId(opportunity: OpportunityUnique): string;
     static getAprBins(query: GetOpportunitiesQueryModel): Promise<{
         min: number;
@@ -118,56 +118,6 @@ 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
@@ -251,7 +201,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 +287,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;
@@ -510,7 +461,6 @@ export declare abstract class OpportunityService {
      * @returns A list of opportunities
      */
     static findMany(query: GetOpportunitiesQueryModel): Promise<{
-        apr: number;
         aprRecord: {
             cumulated: number;
             timestamp: bigint;
@@ -681,6 +631,7 @@ export declare abstract class OpportunityService {
             tags: string[];
         } | undefined;
         name: string;
+        apr: number;
         tvl: number;
         description: string;
         status: import("@package/databases").Status;
@@ -700,7 +651,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;
@@ -871,6 +821,7 @@ export declare abstract class OpportunityService {
             tags: string[];
         } | undefined;
         name: string;
+        apr: number;
         tvl: number;
         description: string;
         status: import("@package/databases").Status;
@@ -882,8 +833,7 @@ export declare abstract class OpportunityService {
         dailyRewards: number;
         tags: string[];
     }[]>;
-    static formatResponse(opportunity: Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>): {
-        apr: number;
+    static format(opportunity: Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>): {
         aprRecord: {
             cumulated: number;
             timestamp: bigint;
@@ -1054,6 +1004,7 @@ export declare abstract class OpportunityService {
             tags: string[];
         } | undefined;
         name: string;
+        apr: number;
         tvl: number;
         description: string;
         status: import("@package/databases").Status;
@@ -1065,7 +1016,7 @@ export declare abstract class OpportunityService {
         dailyRewards: number;
         tags: string[];
     };
-    static formatResponseBase(opportunity: LightOpportunityFromDB): {
+    static formatWithoutRecords(opportunity: LightOpportunityFromDB): {
         id: string;
         depositUrl: string | undefined;
         explorerAddress: string | undefined;

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

@@ -9,7 +9,6 @@ export declare abstract class RewardService {
     static hashDailyRewardsRecordId(opportunityId: string, timestamp: bigint): string;
     static createManyReward(rewards: CreateManyRewardModel): Promise<import("@package/databases").BatchPayload>;
     static getTotalDistributedByOpportunities(since: number): Promise<Map<{
-        apr: number;
         aprRecord: {
             cumulated: number;
             timestamp: bigint;
@@ -180,6 +179,7 @@ export declare abstract class RewardService {
             tags: string[];
         } | undefined;
         name: string;
+        apr: number;
         tvl: number;
         description: string;
         status: import("@package/databases").Status;

package/dist/src/modules/v4/router.d.ts

@@ -1068,90 +1068,6 @@ export declare const v4: Elysia<"/v4", {
                 };
             };
         };
-    } & {
-        opportunities: {
-            post: {
-                body: {
-                    name?: string | undefined;
-                    description?: string | undefined;
-                    depositUrl?: string | undefined;
-                    explorerAddress?: string | undefined;
-                    howToSteps?: string[] | undefined;
-                    tags?: string[] | undefined;
-                    protocols?: string[] | undefined;
-                    mainProtocol?: string | undefined;
-                    tokens: {
-                        address: string;
-                        chainId: number;
-                    }[];
-                    status: "NONE" | "PAST" | "LIVE" | "SOON";
-                    chainId: number;
-                    action: "POOL" | "INVALID" | "HOLD" | "DROP" | "LEND" | "BORROW" | "LONG" | "SHORT" | "SWAP";
-                    type: string;
-                    identifier: string;
-                };
-                params: {};
-                query: unknown;
-                headers: {
-                    authorization: string;
-                };
-                response: {
-                    200: {
-                        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;
-                    };
-                    422: {
-                        type: "validation";
-                        on: string;
-                        summary?: string;
-                        message?: string;
-                        found?: unknown;
-                        property?: string;
-                        expected?: string;
-                    };
-                };
-            };
-        };
     } & {
         opportunities: {
             ":id": {

package/dist/src/utils/prices/services/coinGeckoService.d.ts

@@ -8,5 +8,5 @@ export default class CoingeckoService implements PriceFetcher {
     getPrice(tickers: PriceSource[]): Promise<ResponsePriceType[]>;
     private buildUrl;
     private fetchPrices;
-    private formatResponse;
+    private format;
 }

package/dist/src/utils/prices/services/defillamaService.d.ts

@@ -8,5 +8,5 @@ export default class DefillamaService implements PriceFetcher {
     getPrice(sources: PriceSource[]): Promise<ResponsePriceType[]>;
     private buildUrl;
     private fetchPrices;
-    private formatResponse;
+    private format;
 }