@merkl/api 1.20.0 → 1.20.21

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

@@ -728,6 +728,96 @@ export declare abstract class OpportunityRepository {
         latestCampaignEnd: bigint | null;
         hidden: boolean;
     }>;
+    /**
+     * Fetches opportunities by id. When {@link liveOnly} is `true` (default), only
+     * LIVE opportunities are returned; set to `false` for reward breakdowns where
+     * ended opportunities must still be shown.
+     */
+    static findByIds(ids: string[], withTestTokens?: boolean, liveOnly?: boolean): Promise<{
+        chainId: number;
+        type: string;
+        identifier: string;
+        name: string;
+        description: string;
+        howToSteps: string[];
+        status: import("@package/databases").Status;
+        action: import("@package/databases").OpportunityAction;
+        tvl: number;
+        apr: number;
+        maxApr: number | null;
+        dailyRewards: number;
+        maxDailyRewards: number;
+        tags: string[];
+        liveCampaigns: number;
+        tokens: {
+            id: string;
+            name: string | null;
+            chainId: number;
+            address: string;
+            decimals: number;
+            symbol: string;
+            icon: string;
+            verified: boolean;
+            isNative: boolean;
+            isTest: boolean;
+            type: "POINT" | "PRETGE" | "TOKEN";
+            price?: number | null | undefined;
+            updatedAt?: number | null | undefined;
+            priceSource?: string | null | undefined;
+            displaySymbol?: string | undefined;
+            underlyingTokenId?: string | undefined;
+            priceAlertDismissedAt?: number | undefined;
+            priceAlertCount?: number | undefined;
+        }[];
+        chain: {
+            id: number;
+            name: string;
+            icon: string;
+            liveCampaigns: number;
+            endOfDisputePeriod: number;
+            explorers?: {
+                type: "BLOCKSCOUT" | "ETHERSCAN" | "SOLSCAN";
+                url: string;
+                chainId: number;
+            }[] | undefined;
+            lastClaimsOnchainFetchTimestamp: string | null;
+        };
+        protocol: {
+            id: string;
+            tags: string[];
+            name: string;
+            description: string;
+            url: string;
+            icon: string;
+            banner: string | null;
+            opportunityBannerLight: string | null;
+            opportunityBannerDark: string | null;
+        } | undefined;
+        activePrograms: {
+            icon: string;
+            id: string;
+            name: string;
+            slug: string | null;
+        }[];
+        depositUrls: {
+            id: string;
+            title: string;
+            url: string;
+            subtitle?: string | undefined;
+            icon?: string | undefined;
+            priority: number;
+        }[] | undefined;
+        id: string;
+        hidden: true | undefined;
+        nativeApr: number | undefined;
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        lastCampaignCreatedAt: number;
+        earliestCampaignStart: bigint | undefined;
+        latestCampaignStart: bigint | undefined;
+        earliestCampaignEnd: bigint | undefined;
+        latestCampaignEnd: bigint | undefined;
+    }[]>;
     /**
      * Gets opportunities and campaigns based on a campaign filter
      */
@@ -1336,6 +1426,486 @@ export declare abstract class OpportunityRepository {
         latestCampaignEnd: bigint | null;
         hidden: boolean;
     }[]>;
+    /**
+     * Fetches opportunities using a pre-built Prisma where clause and orderBy.
+     * Used by GraphQL endpoint to support arbitrary filter expressions.
+     * Uses split-query pattern to avoid lateral join explosion.
+     */
+    static findManyByWhere(params: {
+        where: Prisma.OpportunityWhereInput;
+        orderBy?: Prisma.OpportunityOrderByWithRelationInput | Prisma.OpportunityOrderByWithRelationInput[];
+        take: number;
+        skip: number;
+        withCampaigns: boolean;
+    }): Promise<({
+        ActivePrograms: {
+            icon: string;
+            id: string;
+            name: string;
+            slug: string | null;
+        }[];
+        AprRecords: ({
+            AprBreakdown: {
+                Campaign: {
+                    distributionType: import("@package/databases").DistributionType;
+                } | null;
+                identifier: string;
+                timestamp: bigint;
+                type: import("@package/databases").AprType;
+                value: number;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            cumulated: number;
+            opportunityId: string;
+        })[];
+        Campaigns: {
+            id: string;
+            computeChainId: number;
+            distributionChainId: number;
+            campaignId: string;
+            type: string;
+            distributionType: import("@package/databases").DistributionType;
+            subType: number | null;
+            rewardTokenId: string;
+            amount: string;
+            opportunityId: string;
+            startTimestamp: bigint;
+            endTimestamp: bigint;
+            params: import("@prisma/client/runtime/client").JsonValue;
+            description: string | null;
+            pauseCompute: string | null;
+            pausePrecompute: string | null;
+            dailyRewards: number;
+            apr: number;
+            creatorAddress: string;
+            manualOverrides: import("@package/databases").CampaignManualOverride[];
+            createdAt: Date;
+            rootCampaignId: string | null;
+            parentCampaignId: string | null;
+            isPrivate: boolean;
+            campaignEncodingHash: string | null;
+        }[];
+        Chain: {
+            Explorer: {
+                id: string;
+                type: import("@package/databases").ExplorerType;
+                url: string;
+                chainId: number;
+            }[];
+        } & {
+            id: number;
+            name: string;
+            icon: string;
+            liveCampaigns: number;
+            endOfDisputePeriod: number;
+            lastClaimsOnchainFetchTimestamp: string | null;
+        };
+        DailyRewardsRecords: ({
+            DailyRewardsBreakdown: ({
+                Campaign: {
+                    CampaignStatus: {
+                        campaignId: string;
+                        computedUntil: bigint;
+                        processingStarted: bigint;
+                        status: import("@package/databases").RunStatus;
+                        preComputeStatus: import("@package/databases").RunStatus;
+                        preComputeProcessingStarted: bigint;
+                        error: string;
+                        details: import("@prisma/client/runtime/client").JsonValue;
+                    }[];
+                    RewardToken: {
+                        id: string;
+                        name: string | null;
+                        chainId: number;
+                        address: string;
+                        decimals: number;
+                        symbol: string;
+                        displaySymbol: string;
+                        icon: string;
+                        verified: boolean;
+                        isTest: boolean;
+                        type: import("@package/databases").TokenType;
+                        isNative: boolean;
+                        underlyingTokenId: string | null;
+                        price: number | null;
+                        updatedAt: number | null;
+                        priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
+                    };
+                    amount: string;
+                    campaignId: string;
+                    distributionType: import("@package/databases").DistributionType;
+                    endTimestamp: bigint;
+                    startTimestamp: bigint;
+                };
+            } & {
+                id: string;
+                value: number;
+                maxValue: number;
+                timestamp: bigint;
+                campaignId: string;
+                dailyRewardsRecordId: string;
+            })[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+        DepositUrls: {
+            id: string;
+            title: string;
+            url: string;
+            subtitle: string | null;
+            icon: string | null;
+            priority: number;
+            opportunityId: string;
+        }[];
+        MainProtocol: {
+            id: string;
+            tags: string[];
+            name: string;
+            description: string;
+            url: string;
+            icon: string;
+            banner: string | null;
+            opportunityBannerLight: string | null;
+            opportunityBannerDark: string | null;
+        } | null;
+        NativeAprRecords: ({
+            RewardToken: {
+                id: string;
+                name: string | null;
+                chainId: number;
+                address: string;
+                decimals: number;
+                symbol: string;
+                displaySymbol: string;
+                icon: string;
+                verified: boolean;
+                isTest: boolean;
+                type: import("@package/databases").TokenType;
+                isNative: boolean;
+                underlyingTokenId: string | null;
+                price: number | null;
+                updatedAt: number | null;
+                priceSource: string | null;
+                priceAlertDismissedAt: number | null;
+                priceAlertCount: number;
+            } | null;
+        } & {
+            id: string;
+            title: string;
+            description: string | null;
+            timestamp: bigint;
+            value: number;
+            amount: bigint | null;
+            rewardTokenId: string | null;
+            opportunityId: string;
+        })[];
+        Tokens: {
+            id: string;
+            name: string | null;
+            chainId: number;
+            address: string;
+            decimals: number;
+            symbol: string;
+            displaySymbol: string;
+            icon: string;
+            verified: boolean;
+            isTest: boolean;
+            type: import("@package/databases").TokenType;
+            isNative: boolean;
+            underlyingTokenId: string | null;
+            price: number | null;
+            updatedAt: number | null;
+            priceSource: string | null;
+            priceAlertDismissedAt: number | null;
+            priceAlertCount: number;
+        }[];
+        TvlRecords: ({
+            TvlBreakdown: {
+                identifier: string;
+                type: import("@package/databases").TvlType;
+                value: number;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+    } & {
+        id: string;
+        chainId: number;
+        type: string;
+        identifier: string;
+        name: string;
+        description: string;
+        howToSteps: string[];
+        depositUrl: string | null;
+        explorerAddress: string | null;
+        status: import("@package/databases").Status;
+        action: import("@package/databases").OpportunityAction;
+        mainProtocolId: string | null;
+        tvl: number;
+        apr: number;
+        nativeApr: number | null;
+        maxApr: number | null;
+        dailyRewards: number;
+        maxDailyRewards: number;
+        tags: string[];
+        lastCampaignCreatedAt: Date;
+        manualOverrides: import("@package/databases").OpportunityManualOverride[];
+        liveCampaigns: number;
+        earliestCampaignStart: bigint | null;
+        latestCampaignStart: bigint | null;
+        earliestCampaignEnd: bigint | null;
+        latestCampaignEnd: bigint | null;
+        hidden: boolean;
+    })[]>;
+    /**
+     * Fetches a single opportunity by ID for GraphQL.
+     * Includes all relations and nested data.
+     */
+    static findUniqueForGraphQL(id: string, withCampaigns: boolean): Promise<({
+        ActivePrograms: {
+            icon: string;
+            id: string;
+            name: string;
+            slug: string | null;
+        }[];
+        AprRecords: ({
+            AprBreakdown: {
+                Campaign: {
+                    distributionType: import("@package/databases").DistributionType;
+                } | null;
+                identifier: string;
+                timestamp: bigint;
+                type: import("@package/databases").AprType;
+                value: number;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            cumulated: number;
+            opportunityId: string;
+        })[];
+        Campaigns: {
+            id: string;
+            computeChainId: number;
+            distributionChainId: number;
+            campaignId: string;
+            type: string;
+            distributionType: import("@package/databases").DistributionType;
+            subType: number | null;
+            rewardTokenId: string;
+            amount: string;
+            opportunityId: string;
+            startTimestamp: bigint;
+            endTimestamp: bigint;
+            params: import("@prisma/client/runtime/client").JsonValue;
+            description: string | null;
+            pauseCompute: string | null;
+            pausePrecompute: string | null;
+            dailyRewards: number;
+            apr: number;
+            creatorAddress: string;
+            manualOverrides: import("@package/databases").CampaignManualOverride[];
+            createdAt: Date;
+            rootCampaignId: string | null;
+            parentCampaignId: string | null;
+            isPrivate: boolean;
+            campaignEncodingHash: string | null;
+        }[];
+        Chain: {
+            Explorer: {
+                id: string;
+                type: import("@package/databases").ExplorerType;
+                url: string;
+                chainId: number;
+            }[];
+        } & {
+            id: number;
+            name: string;
+            icon: string;
+            liveCampaigns: number;
+            endOfDisputePeriod: number;
+            lastClaimsOnchainFetchTimestamp: string | null;
+        };
+        DailyRewardsRecords: ({
+            DailyRewardsBreakdown: ({
+                Campaign: {
+                    CampaignStatus: {
+                        campaignId: string;
+                        computedUntil: bigint;
+                        processingStarted: bigint;
+                        status: import("@package/databases").RunStatus;
+                        preComputeStatus: import("@package/databases").RunStatus;
+                        preComputeProcessingStarted: bigint;
+                        error: string;
+                        details: import("@prisma/client/runtime/client").JsonValue;
+                    }[];
+                    RewardToken: {
+                        id: string;
+                        name: string | null;
+                        chainId: number;
+                        address: string;
+                        decimals: number;
+                        symbol: string;
+                        displaySymbol: string;
+                        icon: string;
+                        verified: boolean;
+                        isTest: boolean;
+                        type: import("@package/databases").TokenType;
+                        isNative: boolean;
+                        underlyingTokenId: string | null;
+                        price: number | null;
+                        updatedAt: number | null;
+                        priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
+                    };
+                    amount: string;
+                    campaignId: string;
+                    distributionType: import("@package/databases").DistributionType;
+                    endTimestamp: bigint;
+                    startTimestamp: bigint;
+                };
+            } & {
+                id: string;
+                value: number;
+                maxValue: number;
+                timestamp: bigint;
+                campaignId: string;
+                dailyRewardsRecordId: string;
+            })[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+        DepositUrls: {
+            id: string;
+            title: string;
+            url: string;
+            subtitle: string | null;
+            icon: string | null;
+            priority: number;
+            opportunityId: string;
+        }[];
+        MainProtocol: {
+            id: string;
+            tags: string[];
+            name: string;
+            description: string;
+            url: string;
+            icon: string;
+            banner: string | null;
+            opportunityBannerLight: string | null;
+            opportunityBannerDark: string | null;
+        } | null;
+        NativeAprRecords: ({
+            RewardToken: {
+                id: string;
+                name: string | null;
+                chainId: number;
+                address: string;
+                decimals: number;
+                symbol: string;
+                displaySymbol: string;
+                icon: string;
+                verified: boolean;
+                isTest: boolean;
+                type: import("@package/databases").TokenType;
+                isNative: boolean;
+                underlyingTokenId: string | null;
+                price: number | null;
+                updatedAt: number | null;
+                priceSource: string | null;
+                priceAlertDismissedAt: number | null;
+                priceAlertCount: number;
+            } | null;
+        } & {
+            id: string;
+            title: string;
+            description: string | null;
+            timestamp: bigint;
+            value: number;
+            amount: bigint | null;
+            rewardTokenId: string | null;
+            opportunityId: string;
+        })[];
+        Tokens: {
+            id: string;
+            name: string | null;
+            chainId: number;
+            address: string;
+            decimals: number;
+            symbol: string;
+            displaySymbol: string;
+            icon: string;
+            verified: boolean;
+            isTest: boolean;
+            type: import("@package/databases").TokenType;
+            isNative: boolean;
+            underlyingTokenId: string | null;
+            price: number | null;
+            updatedAt: number | null;
+            priceSource: string | null;
+            priceAlertDismissedAt: number | null;
+            priceAlertCount: number;
+        }[];
+        TvlRecords: ({
+            TvlBreakdown: {
+                identifier: string;
+                type: import("@package/databases").TvlType;
+                value: number;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+    } & {
+        id: string;
+        chainId: number;
+        type: string;
+        identifier: string;
+        name: string;
+        description: string;
+        howToSteps: string[];
+        depositUrl: string | null;
+        explorerAddress: string | null;
+        status: import("@package/databases").Status;
+        action: import("@package/databases").OpportunityAction;
+        mainProtocolId: string | null;
+        tvl: number;
+        apr: number;
+        nativeApr: number | null;
+        maxApr: number | null;
+        dailyRewards: number;
+        maxDailyRewards: number;
+        tags: string[];
+        lastCampaignCreatedAt: Date;
+        manualOverrides: import("@package/databases").OpportunityManualOverride[];
+        liveCampaigns: number;
+        earliestCampaignStart: bigint | null;
+        latestCampaignStart: bigint | null;
+        earliestCampaignEnd: bigint | null;
+        latestCampaignEnd: bigint | null;
+        hidden: boolean;
+    }) | null>;
+    /**
+     * Counts opportunities matching the given Prisma where clause.
+     * Used by GraphQL endpoint.
+     */
+    static countByWhere(where: Prisma.OpportunityWhereInput): Promise<number>;
     static countMany(query: FindManyOpportunityModel, authOptions?: AuthenticationOptions): Promise<number>;
     /**
      * Finds opportunities that need dynamic data updates for a given chain.
@@ -1765,9 +2335,11 @@ export declare abstract class OpportunityRepository {
     static aggregateMax(field: keyof Prisma.OpportunityMaxAggregateInputType, query: FindManyOpportunityModel, authOptions?: AuthenticationOptions): Promise<{
         max: string;
     }>;
-    static getAprRecords(opportunityId: string, pagination?: {
+    static getAprRecords(opportunityId: string, options?: {
         page?: number;
         items?: number;
+        from?: number;
+        to?: number;
     }): Promise<{
         timestamp: bigint;
         date: string;