@merkl/api 0.0.22

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

@@ -0,0 +1,1316 @@
+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 { Protocol } from "../protocol/protocol.model";
+import type { Token } from "../token/token.model";
+import type { CreateOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, Opportunity, OpportunityOverrideModel, OpportunityResourceModel, OpportunityUnique } from "./opportunity.model";
+import { OpportunityRepository } from "./opportunity.repository";
+export declare abstract class OpportunityService {
+    #private;
+    static hashId(opportunity: OpportunityUnique): string;
+    static getAprBins(query: GetOpportunitiesQueryModel): Promise<{
+        min: number;
+        max: number;
+        overThreshold: number;
+        binWidth: number;
+        bins: any[];
+    }>;
+    static getTvlBins(query: GetOpportunitiesQueryModel): Promise<{
+        min: number;
+        max: number;
+        binWidth: number;
+        bins: any[];
+    }>;
+    static override(id: string, data: OpportunityOverrideModel): Promise<{
+        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;
+    }>;
+    static deleteOverrides(id: string, overridesToDelete: OpportunityManualOverride[]): Promise<{
+        id: string;
+        chainId: number;
+        type: string;
+        identifier: string;
+        name: string;
+        status: "PAST" | "LIVE" | "SOON";
+        action: OpportunityAction;
+        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;
+        })[];
+        mainProtocol: "splice" | "curve" | "morpho" | "compound" | "reserve" | "gamma" | "vest" | "zero" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "quickswap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "pinto" | "mimswap" | "ichi" | "radiant" | "aave" | "fraxlend" | "ironclad" | "euler" | "gearbox" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "zerolend" | "lnd" | "dlend" | "hyperdrive" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "stability" | "hypurrfi" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "termmax" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "punchswap" | "satlayer" | "puffer" | undefined;
+        description: string;
+        howToSteps: string[];
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        tags: string[];
+    } | ({
+        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;
+    })>;
+    /**
+     * 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<{
+        id: string;
+        chainId: number;
+        type: string;
+        identifier: string;
+        name: string;
+        status: "PAST" | "LIVE" | "SOON";
+        action: OpportunityAction;
+        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;
+        })[];
+        mainProtocol: "splice" | "curve" | "morpho" | "compound" | "reserve" | "gamma" | "vest" | "zero" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "quickswap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "pinto" | "mimswap" | "ichi" | "radiant" | "aave" | "fraxlend" | "ironclad" | "euler" | "gearbox" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "zerolend" | "lnd" | "dlend" | "hyperdrive" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "stability" | "hypurrfi" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "termmax" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "punchswap" | "satlayer" | "puffer" | undefined;
+        description: string;
+        howToSteps: string[];
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        tags: string[];
+    } | ({
+        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;
+    })>;
+    /**
+     * deletes and recreates an opportunity with fresh data
+     */
+    static recreate(opportunityId: string, campaignId?: string): Promise<{
+        id: string;
+        chainId: number;
+        type: string;
+        identifier: string;
+        name: string;
+        status: "PAST" | "LIVE" | "SOON";
+        action: OpportunityAction;
+        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;
+        })[];
+        mainProtocol: "splice" | "curve" | "morpho" | "compound" | "reserve" | "gamma" | "vest" | "zero" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "quickswap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "pinto" | "mimswap" | "ichi" | "radiant" | "aave" | "fraxlend" | "ironclad" | "euler" | "gearbox" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "zerolend" | "lnd" | "dlend" | "hyperdrive" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "stability" | "hypurrfi" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "termmax" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "punchswap" | "satlayer" | "puffer" | undefined;
+        description: string;
+        howToSteps: string[];
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        tags: string[];
+    } | ({
+        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;
+    })>;
+    /**
+     * Finds opportunities based on filters of its campaigns
+     * @notice campaigns are filtered as well
+     * @param where
+     * @returns opportunities
+     */
+    static findManyByCampaigns(query: GetCampaignQueryModel): Promise<{
+        depositUrl?: string | undefined;
+        protocol?: {
+            dailyRewards?: number | undefined;
+            numberOfLiveCampaigns?: number | undefined;
+            opportunityLiveTags?: string[] | undefined;
+            name: string;
+            description: string;
+            id: string;
+            url: string;
+            icon: string;
+            tags: string[];
+        } | null | undefined;
+        explorerAddress?: string | undefined;
+        distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
+        aprRecord?: {
+            timestamp: string | bigint;
+            cumulated: number;
+            breakdowns: {
+                distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
+                value: number;
+                type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
+                identifier: string;
+            }[];
+        } | undefined;
+        tvlRecord?: {
+            timestamp: string | bigint;
+            total: number;
+            breakdowns: {
+                value: number;
+                type: "TOKEN" | "PROTOCOL";
+                identifier: string;
+            }[];
+        } | undefined;
+        rewardsRecord?: {
+            timestamp: string | bigint;
+            total: number;
+            breakdowns: {
+                distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
+                token: {
+                    price?: number | null | undefined;
+                    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;
+                };
+                campaignId: string;
+                value: number;
+                amount: string | bigint;
+            }[];
+        } | undefined;
+        name: string;
+        apr: number;
+        tokens: {
+            price?: number | null | undefined;
+            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;
+        }[];
+        tvl: number;
+        description: string;
+        id: string;
+        status: string;
+        chainId: number;
+        campaigns: {
+            description?: string | undefined;
+            creator?: {
+                tags?: string[] | undefined;
+                creatorId?: string | null | undefined;
+                address: string;
+            } | undefined;
+            distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
+            rootCampaignId?: string | undefined;
+            parentCampaignId?: string | undefined;
+            campaignStatus?: {
+                error?: string | undefined;
+                details?: any;
+                campaignId: string;
+                status: string;
+                computedUntil: string | number;
+                processingStarted: string | number;
+            } | undefined;
+            distributionChain?: {
+                explorers?: {
+                    chainId: number;
+                    type: "ETHERSCAN" | "BLOCKSCOUT";
+                    url: string;
+                }[] | undefined;
+                name: string;
+                id: number;
+                icon: string;
+            } | undefined;
+            rewardToken: {
+                price?: number | null | undefined;
+                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;
+            };
+            campaignId: string;
+            id: string;
+            params: any;
+            amount: string;
+            startTimestamp: string | number;
+            type: string;
+            computeChainId: number;
+            distributionChainId: number;
+            endTimestamp: string | number;
+            opportunityId: string;
+            creatorAddress: string;
+            subType: number | null;
+            rewardTokenId: string;
+            createdAt: string;
+            chain: {
+                explorers?: {
+                    chainId: number;
+                    type: "ETHERSCAN" | "BLOCKSCOUT";
+                    url: string;
+                }[] | undefined;
+                name: string;
+                id: number;
+                icon: string;
+            };
+        }[];
+        action: string;
+        type: string;
+        howToSteps: string[];
+        identifier: string;
+        dailyRewards: number;
+        tags: string[];
+        lastCampaignCreatedAt: string;
+        chain: {
+            explorers?: {
+                chainId: number;
+                type: "ETHERSCAN" | "BLOCKSCOUT";
+                url: string;
+            }[] | undefined;
+            name: string;
+            id: number;
+            icon: string;
+        };
+    }[]>;
+    static getUniqueWithCampaignsOrThrow(opportunityId: string | OpportunityUnique, withTest?: boolean, withPoints?: boolean): Promise<{
+        depositUrl?: string | undefined;
+        protocol?: {
+            dailyRewards?: number | undefined;
+            numberOfLiveCampaigns?: number | undefined;
+            opportunityLiveTags?: string[] | undefined;
+            name: string;
+            description: string;
+            id: string;
+            url: string;
+            icon: string;
+            tags: string[];
+        } | null | undefined;
+        explorerAddress?: string | undefined;
+        distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
+        aprRecord?: {
+            timestamp: string | bigint;
+            cumulated: number;
+            breakdowns: {
+                distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
+                value: number;
+                type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
+                identifier: string;
+            }[];
+        } | undefined;
+        tvlRecord?: {
+            timestamp: string | bigint;
+            total: number;
+            breakdowns: {
+                value: number;
+                type: "TOKEN" | "PROTOCOL";
+                identifier: string;
+            }[];
+        } | undefined;
+        rewardsRecord?: {
+            timestamp: string | bigint;
+            total: number;
+            breakdowns: {
+                distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
+                token: {
+                    price?: number | null | undefined;
+                    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;
+                };
+                campaignId: string;
+                value: number;
+                amount: string | bigint;
+            }[];
+        } | undefined;
+        name: string;
+        apr: number;
+        tokens: {
+            price?: number | null | undefined;
+            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;
+        }[];
+        tvl: number;
+        description: string;
+        id: string;
+        status: string;
+        chainId: number;
+        campaigns: {
+            description?: string | undefined;
+            creator?: {
+                tags?: string[] | undefined;
+                creatorId?: string | null | undefined;
+                address: string;
+            } | undefined;
+            distributionType?: "DUTCH_AUCTION" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | undefined;
+            rootCampaignId?: string | undefined;
+            parentCampaignId?: string | undefined;
+            campaignStatus?: {
+                error?: string | undefined;
+                details?: any;
+                campaignId: string;
+                status: string;
+                computedUntil: string | number;
+                processingStarted: string | number;
+            } | undefined;
+            distributionChain?: {
+                explorers?: {
+                    chainId: number;
+                    type: "ETHERSCAN" | "BLOCKSCOUT";
+                    url: string;
+                }[] | undefined;
+                name: string;
+                id: number;
+                icon: string;
+            } | undefined;
+            rewardToken: {
+                price?: number | null | undefined;
+                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;
+            };
+            campaignId: string;
+            id: string;
+            params: any;
+            amount: string;
+            startTimestamp: string | number;
+            type: string;
+            computeChainId: number;
+            distributionChainId: number;
+            endTimestamp: string | number;
+            opportunityId: string;
+            creatorAddress: string;
+            subType: number | null;
+            rewardTokenId: string;
+            createdAt: string;
+            chain: {
+                explorers?: {
+                    chainId: number;
+                    type: "ETHERSCAN" | "BLOCKSCOUT";
+                    url: string;
+                }[] | undefined;
+                name: string;
+                id: number;
+                icon: string;
+            };
+        }[];
+        action: string;
+        type: string;
+        howToSteps: string[];
+        identifier: string;
+        dailyRewards: number;
+        tags: string[];
+        lastCampaignCreatedAt: string;
+        chain: {
+            explorers?: {
+                chainId: number;
+                type: "ETHERSCAN" | "BLOCKSCOUT";
+                url: string;
+            }[] | undefined;
+            name: string;
+            id: number;
+            icon: string;
+        };
+    }>;
+    static findUniqueOrThrow(opportunityId: string | OpportunityUnique, withCampaigns?: boolean, withTest?: boolean, withPoints?: boolean): Promise<OpportunityResourceModel>;
+    /**
+     * Get the list of opportunities satisfying the query
+     * @param query
+     * @returns A list of opportunities
+     */
+    static findMany(query: GetOpportunitiesQueryModel): 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[];
+    }[]>;
+    /**
+     * Counts the number of opportunities that complies to query
+     * @description used for pagination purposes
+     * @param query
+     * @returns the number of opportunities
+     */
+    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;
+            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 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;
+        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 aggregate(query: GetOpportunitiesQueryModel, field: keyof Prisma.OpportunitySumAggregateInputType): Promise<{
+        sum: string;
+    }>;
+    static aggregateMin(query: GetOpportunitiesQueryModel, field: keyof Prisma.OpportunityMinAggregateInputType): Promise<{
+        min: string;
+    }>;
+    static aggregateMax(query: GetOpportunitiesQueryModel, field: keyof Prisma.OpportunityMaxAggregateInputType): Promise<{
+        max: string;
+    }>;
+    static update(id: string, data: Partial<Opportunity["raw"]>): Promise<{
+        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;
+    }>;
+    static updateMany(ids: string[], data: Partial<Opportunity["raw"]>): Promise<Prisma.BatchPayload>;
+    static description(action: OpportunityAction, tokens: Token["model"][], protocol: Protocol["model"], chainId: number): Promise<string>;
+    static howToSteps(action: OpportunityAction, tokens: Token["model"][], protocol: Protocol["model"]): string[];
+}