@merkl/api 1.0.47 → 1.0.49

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, CampaignWithParams, CreateCampaignModel, FindCampaignModel, TransactionModel, UpdateCampaignCreatorModel, UpdateCampaignModel, findCampaignWithStatusModel } from "../../../modules/v4/campaign/campaign.model";
 import type { GetCampaignComputedValueModel } from "../computedValue/computedValue.model";
-import { CampaignRepository } from "./campaign.repository";
+import { CampaignFormatter } from "./campaign.formatter";
 export declare abstract class CampaignService {
     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;
@@ -286,31 +269,6 @@ export declare abstract class CampaignService {
         lastCampaignCreatedAt: Date;
     }) | undefined>;
     static getCampaignIdsFromCreationTxHash(query: TransactionModel): Promise<string[]>;
-    /**
-     * @dev back-office function
-     * @dev deprecated should be replaced with a manual override
-     */
-    static updateMetaData(campaign: Omit<UpdateMetaDataCampaignModel, "id">): Promise<{
-        campaignId: string;
-        description: string | null;
-        id: string;
-        params: import("@prisma/client/runtime/library").JsonValue;
-        amount: string;
-        startTimestamp: bigint;
-        type: string;
-        computeChainId: number;
-        distributionChainId: number;
-        endTimestamp: bigint;
-        opportunityId: string;
-        creatorAddress: string;
-        distributionType: import("@package/databases").DistributionType;
-        subType: number | null;
-        rewardTokenId: string;
-        manualOverrides: import("@package/databases").CampaignManualOverride[];
-        createdAt: Date;
-        rootCampaignId: string | null;
-        parentCampaignId: string | null;
-    }>;
     /**
      * @dev back-office function for manual overrides
      */
@@ -319,570 +277,19 @@ export declare abstract class CampaignService {
      * @dev back-office function
      */
     static moveToOpportunity(data: Omit<UpdateCampaignModel, "id">, upsert?: boolean): Promise<string>;
-    /**
-     * Get the list of campaigns satisfying the query
-     * @param query
-     * @returns A list of campaigns
-     */
-    static findMany(query: GetCampaignQueryModel): Promise<{
-        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;
-    }[]>;
-    static findFirst(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<{
-        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;
-    } | null>;
-    static findAndGroupByChains(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Map<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;
-    }[]>>;
-    static countByChains(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Record<string, number>>;
-    static findAndGroupByTypes(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Map<string, {
-        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;
-    }[]>>;
-    static countByTypes(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Record<string, number>>;
-    static findAndGroupByProtocols(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<Map<string | null, {
-        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;
-    }[]>>;
-    static countByProtocols(query: Omit<GetCampaignQueryModel, "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
-     * @description used for pagination purposes
-     * @param query
-     * @returns the number of campaigns
-     */
-    static countMany(query: Omit<GetCampaignQueryModel, "page" | "items">): Promise<number>;
+    static findMany(query: FindCampaignModel): Promise<Omit<CampaignWithParams, "manualOverrides">[]>;
+    static countMany(query: Omit<FindCampaignModel, "page" | "items">): Promise<number>;
+    static findFirst(query: Omit<FindCampaignModel, "page" | "items">): Promise<Omit<CampaignWithParams, "manualOverrides"> | null>;
+    static findAndGroupByChains(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<number, Omit<CampaignWithParams, "manualOverrides">[]>>;
+    static countByChains(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
+    static findAndGroupByTypes(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<string, Omit<CampaignWithParams, "manualOverrides">[]>>;
+    static countByTypes(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
+    static findAndGroupByProtocols(query: Omit<FindCampaignModel, "page" | "items">): Promise<Map<string | undefined, Omit<CampaignWithParams, "manualOverrides">[]>>;
+    static countByProtocols(query: Omit<FindCampaignModel, "page" | "items">): Promise<Record<string, number>>;
+    static countBy<T>(campaignsMap: Map<T, ReturnType<(typeof CampaignFormatter)["format"]>[]>): Record<string, number>;
     static checkIfExist(campaign: CampaignUnique | string): Promise<boolean>;
-    static findUnique(campaign: CampaignUnique | string): Promise<({
-        ComputeChain: {
-            name: string;
-            id: number;
-            icon: string;
-        };
-        DistributionChain: {
-            name: string;
-            id: number;
-            icon: string;
-        };
-        RewardToken: {
-            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;
-        };
-        Creator: {
-            address: string;
-            tags: string[];
-            creatorId: string | null;
-        };
-        CampaignStatus: {
-            campaignId: string;
-            error: string;
-            status: import("@package/databases").RunStatus;
-            details: import("@prisma/client/runtime/library").JsonValue;
-            computedUntil: bigint;
-            processingStarted: bigint;
-        }[];
-    } & {
-        campaignId: string;
-        description: string | null;
-        id: string;
-        params: import("@prisma/client/runtime/library").JsonValue;
-        amount: string;
-        startTimestamp: bigint;
-        type: string;
-        computeChainId: number;
-        distributionChainId: number;
-        endTimestamp: bigint;
-        opportunityId: string;
-        creatorAddress: string;
-        distributionType: import("@package/databases").DistributionType;
-        subType: number | null;
-        rewardTokenId: string;
-        manualOverrides: import("@package/databases").CampaignManualOverride[];
-        createdAt: Date;
-        rootCampaignId: string | null;
-        parentCampaignId: string | null;
-    }) | null>;
-    static findUniqueOrThrow(campaign: CampaignUnique | string, withOpportunity?: boolean): Promise<{
-        ComputeChain: {
-            name: string;
-            id: number;
-            icon: string;
-        };
-        DistributionChain: {
-            name: string;
-            id: number;
-            icon: string;
-        };
-        RewardToken: {
-            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;
-        };
-        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;
-        };
-        Creator: {
-            address: string;
-            tags: string[];
-            creatorId: string | null;
-        };
-        CampaignStatus: {
-            campaignId: string;
-            error: string;
-            status: import("@package/databases").RunStatus;
-            details: import("@prisma/client/runtime/library").JsonValue;
-            computedUntil: bigint;
-            processingStarted: bigint;
-        }[];
-    } & {
-        campaignId: string;
-        description: string | null;
-        id: string;
-        params: import("@prisma/client/runtime/library").JsonValue;
-        amount: string;
-        startTimestamp: bigint;
-        type: string;
-        computeChainId: number;
-        distributionChainId: number;
-        endTimestamp: bigint;
-        opportunityId: string;
-        creatorAddress: string;
-        distributionType: import("@package/databases").DistributionType;
-        subType: number | null;
-        rewardTokenId: string;
-        manualOverrides: import("@package/databases").CampaignManualOverride[];
-        createdAt: Date;
-        rootCampaignId: string | null;
-        parentCampaignId: string | null;
-    }>;
+    static findUnique(campaign: CampaignUnique | string): Promise<Omit<CampaignWithParams, "manualOverrides"> | null>;
+    static findUniqueOrThrow(campaign: CampaignUnique | string, withOpportunity?: boolean): Promise<Omit<CampaignWithParams, "manualOverrides">>;
     static findCampaignValue(params: GetCampaignComputedValueModel): Promise<{
         apr: number | null;
         tvl: number | null;
@@ -948,97 +355,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