@merkl/api 0.9.15

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

@@ -0,0 +1,728 @@
+import type { CampaignUnique, CampaignWithParams, CreateCampaignModel, GetCampaignQueryModel, UpdateCampaignCreatorModel, UpdateCampaignModel, UpdateMetaDataCampaignModel } from "@/modules/v4/campaign";
+import type { CampaignManualOverride } from "@db/api";
+import { Campaign as CampaignEnum, type CampaignParameters, type ChainId } from "@sdk";
+import { CampaignRepository } from "./campaign.repository";
+export declare abstract class CampaignService {
+    static hashId(campaign: CampaignUnique): string;
+    static splitIdOrThrow(chainAndCampaignId: `${number}-${string}` | string): CampaignUnique;
+    static getPastCampaigns(query?: {
+        computeChainId?: number;
+        type?: string;
+    }): Promise<({
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+    } & {
+        id: string;
+        type: string;
+        params: import("database/api/.generated/runtime/library").JsonValue;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        startTimestamp: bigint;
+        endTimestamp: bigint;
+        creatorAddress: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    })[]>;
+    static getFutureCampaigns(query?: {
+        computeChainId?: number;
+        type?: string;
+    }): Promise<({
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+    } & {
+        id: string;
+        type: string;
+        params: import("database/api/.generated/runtime/library").JsonValue;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        startTimestamp: bigint;
+        endTimestamp: bigint;
+        creatorAddress: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    })[]>;
+    static getLiveCampaigns(query?: {
+        distributionChainId?: number;
+        computeChainId?: number;
+        type?: string;
+    }): Promise<({
+        RewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            displaySymbol: string;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+            price: number | null;
+        };
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+    } & {
+        id: string;
+        type: string;
+        params: import("database/api/.generated/runtime/library").JsonValue;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        startTimestamp: bigint;
+        endTimestamp: bigint;
+        creatorAddress: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    })[]>;
+    static countLives(query?: {
+        distributionChainId?: number;
+        computeChainId?: number;
+        type?: string;
+    }): Promise<number>;
+    static create(campaign: Omit<CreateCampaignModel, "id">): Promise<{
+        id: string;
+        type: string;
+        params: import("database/api/.generated/runtime/library").JsonValue;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        startTimestamp: bigint;
+        endTimestamp: bigint;
+        creatorAddress: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    } | undefined>;
+    /**
+     * @dev back-office function
+     * @dev deprecated should be replaced with a manual override
+     */
+    static updateMetaData(campaign: Omit<UpdateMetaDataCampaignModel, "id">): Promise<{
+        id: string;
+        type: string;
+        params: import("database/api/.generated/runtime/library").JsonValue;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        startTimestamp: bigint;
+        endTimestamp: bigint;
+        creatorAddress: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    }>;
+    /**
+     * @dev back-office function for manual overrides
+     */
+    static updateCreator(campaign: UpdateCampaignCreatorModel): Promise<void>;
+    /**
+     * @dev back-office function
+     */
+    static moveToOpportunity(campaign: 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: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+        } & {
+            price?: number | null | undefined;
+        };
+        distributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        createdAt: string;
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        id: string;
+        type: string;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+    }[]>;
+    static findAndGroupByChains(query: GetCampaignQueryModel): Promise<Map<number, {
+        params: any;
+        chain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+        } & {
+            price?: number | null | undefined;
+        };
+        distributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        createdAt: string;
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        id: string;
+        type: string;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+    }[]>>;
+    static countByChains(query: GetCampaignQueryModel): Promise<Record<string, number>>;
+    static findAndGroupByType(query: GetCampaignQueryModel): Promise<Map<string, {
+        params: any;
+        chain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+        } & {
+            price?: number | null | undefined;
+        };
+        distributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        createdAt: string;
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        id: string;
+        type: string;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+    }[]>>;
+    static countByType(query: GetCampaignQueryModel): Promise<Record<string, number>>;
+    static findAndGroupByProtocol(query: GetCampaignQueryModel): Promise<Map<string | null, {
+        params: any;
+        chain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+        } & {
+            price?: number | null | undefined;
+        };
+        distributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        createdAt: string;
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        id: string;
+        type: string;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+    }[]>>;
+    static countByProtocol(query: GetCampaignQueryModel): 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: GetCampaignQueryModel): Promise<number>;
+    static checkIfExist(campaign: CampaignUnique | string): Promise<boolean>;
+    static findUnique(campaign: CampaignUnique | string): Promise<({
+        ComputeChain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        DistributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        RewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            displaySymbol: string;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+            price: number | null;
+        };
+        Creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        CampaignStatus: {
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+            computedUntil: bigint;
+            processingStarted: bigint;
+        }[];
+    } & {
+        id: string;
+        type: string;
+        params: import("database/api/.generated/runtime/library").JsonValue;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        startTimestamp: bigint;
+        endTimestamp: bigint;
+        creatorAddress: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    }) | null>;
+    static findUniqueOrThrow(campaign: CampaignUnique | string, withOpportunity?: boolean): Promise<{
+        ComputeChain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        DistributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        RewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            displaySymbol: string;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+            price: number | null;
+        };
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        Creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        CampaignStatus: {
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+            computedUntil: bigint;
+            processingStarted: bigint;
+        }[];
+    } & {
+        id: string;
+        type: string;
+        params: import("database/api/.generated/runtime/library").JsonValue;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        startTimestamp: bigint;
+        endTimestamp: bigint;
+        creatorAddress: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    }>;
+    static removeManualOverride(campaign: CampaignUnique | string, field: CampaignManualOverride): Promise<void>;
+    static findCampaignsToProcess(distributionChainId: ChainId): Promise<{
+        campaignId: string;
+        endTimestamp: bigint;
+        CampaignStatus: {
+            status: import("@db/api").$Enums.RunStatus;
+            computedUntil: bigint;
+            processingStarted: bigint;
+        }[];
+    }[]>;
+    static findNextCampaignToProcess(chainId: ChainId): Promise<{
+        campaignId: string;
+    }>;
+    static pickCampaignToProcess(chainId: ChainId): Promise<{
+        campaignId: string;
+    }>;
+    static fill(campaigns: CampaignUnique[]): Promise<{
+        success: number;
+        fail: number;
+    }>;
+    static findChains(): Promise<Record<string, ChainId>>;
+    /**
+     * Returns the campaign data
+     * @param type index of Campaign enum from sdk
+     * @returns a string
+     */
+    static getTypeFromV3(type: CampaignEnum): string;
+    /**
+     * Split a campaigns array into three array for each status
+     * @param campaigns
+     * @param timestamp to compare to campaigns timestamps
+     * @returns a status => campaigns map
+     */
+    static splitOnStatus<C extends {
+        startTimestamp: bigint | number;
+        endTimestamp: bigint | number;
+    }>(campaigns: C[], timestamp?: number): {
+        past: C[];
+        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: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+        } & {
+            price?: number | null | undefined;
+        };
+        distributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        createdAt: string;
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        id: string;
+        type: string;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+    };
+    static formatAsCampaignParameters<C extends CampaignEnum>(campaign: CampaignWithParams): CampaignParameters<C>;
+    /**
+     * Shortcut to get daily amount from total
+     * @param start timestamp
+     * @param end timestamp
+     * @param amount
+     * @returns daily token amount
+     */
+    static getDailyAmount<T extends bigint | number>(start: T, end: T, amount: bigint): bigint;
+}