@merkl/api 1.0.46 → 1.0.48

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

@@ -1,16 +1,12 @@
 import { type CampaignParameters, Campaign as CampaignType, type ChainId } from "@angleprotocol/sdk/ts";
 import type { CampaignManualOverride } from "@package/databases/api";
-import type { CampaignConfigMinimalModel, CampaignUnique, CampaignWithParams, CreateCampaignModel, GetCampaignQueryModel, TransactionModel, UpdateCampaignCreatorModel, UpdateCampaignModel, UpdateMetaDataCampaignModel } from "../../../modules/v4/campaign/campaign.model";
+import type { CampaignConfigMinimalModel, CampaignUnique, CreateCampaignModel, FindCampaignModel, TransactionModel, UpdateCampaignCreatorModel, UpdateCampaignModel, UpdateMetaDataCampaignModel, findCampaignWithStatusModel } from "../../../modules/v4/campaign/campaign.model";
 import type { GetCampaignComputedValueModel } from "../computedValue/computedValue.model";
-import { CampaignRepository } from "./campaign.repository";
-export declare abstract class CampaignService {
+import { CampaignFormatter } from "./campaign.formatter";
+export declare abstract class CampaignService extends CampaignFormatter {
     static hashId(campaign: CampaignUnique): string;
     static splitIdOrThrow(chainAndCampaignId: `${number}-${string}` | string): CampaignUnique;
-    static getPastCampaigns(query?: {
-        computeChainId?: number;
-        type?: string;
-        creatorAddress?: string;
-    }): Promise<({
+    static getPastCampaigns(query?: findCampaignWithStatusModel): Promise<({
         Opportunity: {
             name: string;
             apr: number;
@@ -52,11 +48,7 @@ export declare abstract class CampaignService {
         rootCampaignId: string | null;
         parentCampaignId: string | null;
     })[]>;
-    static getFutureCampaigns(query?: {
-        computeChainId?: number;
-        type?: string;
-        creatorAddress?: string;
-    }): Promise<({
+    static getFutureCampaigns(query?: findCampaignWithStatusModel): Promise<({
         Opportunity: {
             name: string;
             apr: number;
@@ -98,12 +90,7 @@ export declare abstract class CampaignService {
         rootCampaignId: string | null;
         parentCampaignId: string | null;
     })[]>;
-    static getLiveCampaigns(query?: {
-        distributionChainId?: number;
-        computeChainId?: number;
-        type?: string;
-        creatorAddress?: string;
-    }): Promise<({
+    static getLiveCampaigns(query?: findCampaignWithStatusModel): Promise<({
         RewardToken: {
             symbol: string;
             name: string | null;
@@ -183,11 +170,7 @@ export declare abstract class CampaignService {
         rootCampaignId: string | null;
         parentCampaignId: string | null;
     })[]>;
-    static countLives(query?: {
-        distributionChainId?: number;
-        computeChainId?: number;
-        type?: string;
-    }): Promise<number>;
+    static countLives(query?: findCampaignWithStatusModel): Promise<number>;
     static create(body: Omit<CreateCampaignModel, "id">, dryRun?: boolean): Promise<{
         campaignId: string;
         description: string | null;
@@ -324,7 +307,7 @@ export declare abstract class CampaignService {
      * @param query
      * @returns A list of campaigns
      */
-    static findMany(query: GetCampaignQueryModel): Promise<{
+    static findMany(query: FindCampaignModel): Promise<{
         params: any;
         chain: {
             name: string;
@@ -405,7 +388,7 @@ export declare abstract class CampaignService {
         subType: number | null;
         rewardTokenId: string;
     }[]>;
-    static findFirst(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<{
+    static findFirst(query: Omit<FindCampaignModel, "page" | "items">): Promise<{
         params: any;
         chain: {
             name: string;
@@ -486,7 +469,7 @@ export declare abstract class CampaignService {
         subType: number | null;
         rewardTokenId: string;
     } | null>;
-    static findAndGroupByChains(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Map<number, {
+    static findAndGroupByChains(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<number, {
         params: any;
         chain: {
             name: string;
@@ -567,8 +550,8 @@ export declare abstract class CampaignService {
         subType: number | null;
         rewardTokenId: string;
     }[]>>;
-    static countByChains(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Record<string, number>>;
-    static findAndGroupByTypes(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Map<string, {
+    static countByChains(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
+    static findAndGroupByTypes(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<string, {
         params: any;
         chain: {
             name: string;
@@ -649,8 +632,8 @@ export declare abstract class CampaignService {
         subType: number | null;
         rewardTokenId: string;
     }[]>>;
-    static countByTypes(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Record<string, number>>;
-    static findAndGroupByProtocols(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Map<string | null, {
+    static countByTypes(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
+    static findAndGroupByProtocols(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<string | null, {
         params: any;
         chain: {
             name: string;
@@ -731,7 +714,7 @@ export declare abstract class CampaignService {
         subType: number | null;
         rewardTokenId: string;
     }[]>>;
-    static countByProtocols(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Record<string, number>>;
+    static countByProtocols(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
     static countBy<T>(campaignsMap: Map<T, ReturnType<(typeof CampaignService)["format"]>[]>): Record<string, number>;
     /**
      * Counts the number of campaigns that complies to query
@@ -739,7 +722,7 @@ export declare abstract class CampaignService {
      * @param query
      * @returns the number of campaigns
      */
-    static countMany(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<number>;
+    static countMany(query: Omit<FindCampaignModel, "page" | "items">): Promise<number>;
     static checkIfExist(campaign: CampaignUnique | string): Promise<boolean>;
     static findUnique(campaign: CampaignUnique | string): Promise<({
         ComputeChain: {
@@ -948,97 +931,6 @@ export declare abstract class CampaignService {
         live: C[];
         soon: C[];
     };
-    /**
-     * Convert raw
-     * @param query
-     * @returns A list of opportunities
-     * TODO: remove CampaignService function in favor of prisma client extensions
-     */
-    static format(campaign: NonNullable<Awaited<ReturnType<(typeof CampaignRepository)["findMany"]>>>[number]): {
-        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;
-    };
-    /**
-     * @deprecated Used only in tentative position fetcher
-     */
-    static formatAsCampaignParameters<C extends CampaignType>(campaign: CampaignWithParams): CampaignParameters<C>;
     /**
      * Shortcut to get daily amount from total
      * @param start timestamp

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

@@ -1059,90 +1059,6 @@ export declare const OpportunityController: Elysia<"/opportunities", {
             };
         };
     };
-} & {
-    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/modules/v4/opportunity/opportunity.converter.d.ts

@@ -1,10 +1,6 @@
-import { type CampaignParameters, Campaign as CampaignType, type Opportunity as OpportunityV3 } from "@angleprotocol/sdk/ts";
-import type { CampaignWithParams } from "../../../modules/v4/campaign/campaign.model";
-import { OpportunityService } from "../../../modules/v4/opportunity/opportunity.service";
-export declare abstract class OpportunityConvertorService {
+import { type Opportunity as OpportunityV3 } from "@angleprotocol/sdk/ts";
+export declare abstract class OpportunityConvertor {
     #private;
-    static convertV4CampaignToV3<C extends CampaignType>(campaignType: C, campaign: Exclude<Awaited<ReturnType<(typeof OpportunityService)["findMany"]>>[number]["campaigns"], undefined>[number] | Omit<CampaignWithParams<C>, "manualOverrides">, opportunityIdentifier: string): CampaignParameters<C>;
-    static convertV4toV3(opportunity: Awaited<ReturnType<(typeof OpportunityService)["findMany"]>>[number], withCampaigns?: boolean): OpportunityV3;
     static setV3Opportunities(showCampaigns: boolean, test: boolean | undefined, identifier: string | undefined, chainId: string | undefined): Promise<{
         [id: `0_${string}`]: OpportunityV3;
         [id: `1_${string}`]: OpportunityV3;

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

@@ -0,0 +1,236 @@
+import type { LightOpportunityFromDB } from "./opportunity.model";
+import type { OpportunityRepository } from "./opportunity.repository";
+export declare abstract class OpportunityFormatter {
+    static format(opportunity: Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>): {
+        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;
+        apr: number;
+        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 formatWithoutRecords(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;
+        description: string;
+        status: import("@package/databases").Status;
+        chainId: number;
+        action: import("@package/databases").OpportunityAction;
+        type: string;
+        howToSteps: string[];
+        identifier: string;
+        dailyRewards: number;
+        tags: string[];
+    };
+}

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