@merkl/api 1.19.2 → 1.19.27

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

@@ -2,7 +2,6 @@ import type { TokenType } from "@package/resources/enums";
 import { CampaignType, ChainId } from "@package/resources/enums";
 import type { Opportunity } from "@package/resources/schemas";
 import type { CampaignDynamicData } from "@package/sdk/types/campaigns/deprecated/campaignDynamicData";
-import { MerklRootService } from "../../../modules/v4/merklRoot/merklRoot.service";
 import type { AuthenticationOptions } from "../authentication/authentication.model";
 import type { CampaignStatus } from "../campaignStatus/campaignStatus.model";
 import { LeafService } from "../leaf/leaf.service";
@@ -133,6 +132,8 @@ export declare abstract class RewardService {
                 price: number | null;
                 updatedAt: number | null;
                 priceSource: string | null;
+                priceAlertDismissedAt: number | null;
+                priceAlertCount: number;
             }[];
         } & {
             id: string;
@@ -193,6 +194,8 @@ export declare abstract class RewardService {
             priceSource?: string | null | undefined;
             displaySymbol?: string | undefined;
             underlyingTokenId?: string | undefined;
+            priceAlertDismissedAt?: number | undefined;
+            priceAlertCount?: number | undefined;
         };
         breakdowns: {
             root: string;
@@ -268,6 +271,8 @@ export declare abstract class RewardService {
                     price: number | null;
                     updatedAt: number | null;
                     priceSource: string | null;
+                    priceAlertDismissedAt: number | null;
+                    priceAlertCount: number;
                 }[];
             } & {
                 id: string;
@@ -303,299 +308,6 @@ export declare abstract class RewardService {
         amount: bigint;
         pending: bigint;
     }[]>;
-    static getByRecipient(recipient: string, roots: Awaited<ReturnType<typeof MerklRootService.fetchAll>>, tags: string[], options?: {
-        items?: number;
-        page?: number;
-        withToken?: boolean;
-        withTestTokens?: boolean;
-        breakdownPage?: number;
-        chainFilter?: ChainId[] | null;
-        reasonFilter?: string;
-        type?: TokenType;
-    }): Promise<{
-        id: string;
-        root: string;
-        distributionChainId: number;
-        rewardTokenId: string;
-        recipient: string;
-        amount: string;
-        claimed: string;
-        pending: string;
-        proofs: string[] | never[];
-        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;
-        };
-        Breakdown: {
-            id: string;
-            rewardId: string;
-            root: string;
-            distributionChainId: number;
-            reason: string;
-            amount: string;
-            claimed: string;
-            pending: string;
-            campaignId: string;
-            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;
-                }[];
-                Opportunity: {
-                    ActivePrograms: {
-                        id: string;
-                        slug: string | null;
-                        name: string;
-                        description: string;
-                        icon: string;
-                    }[];
-                    Chain: {
-                        id: number;
-                        name: string;
-                        icon: string;
-                        liveCampaigns: number;
-                        endOfDisputePeriod: number;
-                        lastClaimsOnchainFetchTimestamp: string | null;
-                    };
-                    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;
-                    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;
-                    }[];
-                } & {
-                    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;
-                };
-            } & {
-                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;
-            };
-            subCampaignId: string | null;
-            SubCampaign: ({
-                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;
-                }[];
-                Opportunity: {
-                    ActivePrograms: {
-                        id: string;
-                        slug: string | null;
-                        name: string;
-                        description: string;
-                        icon: string;
-                    }[];
-                    Chain: {
-                        id: number;
-                        name: string;
-                        icon: string;
-                        liveCampaigns: number;
-                        endOfDisputePeriod: number;
-                        lastClaimsOnchainFetchTimestamp: string | null;
-                    };
-                    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;
-                    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;
-                    }[];
-                } & {
-                    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;
-                };
-            } & {
-                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;
-            }) | null;
-            protocolId: null;
-        }[];
-    }[]>;
     /**
      * Groups a breakdown array by their corresponding opportunities
      * @param breakdowns with campaignIds
@@ -649,6 +361,8 @@ export declare abstract class RewardService {
                 priceSource?: string | null | undefined;
                 displaySymbol?: string | undefined;
                 underlyingTokenId?: string | undefined;
+                priceAlertDismissedAt?: number | undefined;
+                priceAlertCount?: number | undefined;
             };
             breakdowns: {
                 root: string;
@@ -724,6 +438,8 @@ export declare abstract class RewardService {
                         price: number | null;
                         updatedAt: number | null;
                         priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
                     }[];
                 } & {
                     id: string;
@@ -782,6 +498,8 @@ export declare abstract class RewardService {
                 priceSource?: string | null | undefined;
                 displaySymbol?: string | undefined;
                 underlyingTokenId?: string | undefined;
+                priceAlertDismissedAt?: number | undefined;
+                priceAlertCount?: number | undefined;
             };
             breakdowns: {
                 root: string;
@@ -857,6 +575,8 @@ export declare abstract class RewardService {
                         price: number | null;
                         updatedAt: number | null;
                         priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
                     }[];
                 } & {
                     id: string;
@@ -949,6 +669,8 @@ export declare abstract class RewardService {
                         priceSource?: string | null | undefined;
                         displaySymbol?: string | undefined;
                         underlyingTokenId?: string | undefined;
+                        priceAlertDismissedAt?: number | undefined;
+                        priceAlertCount?: number | undefined;
                     }[];
                     chain: {
                         id: number;
@@ -1018,6 +740,8 @@ export declare abstract class RewardService {
                             priceSource?: string | null | undefined;
                             displaySymbol?: string | undefined;
                             underlyingTokenId?: string | undefined;
+                            priceAlertDismissedAt?: number | undefined;
+                            priceAlertCount?: number | undefined;
                         } | undefined;
                     } | undefined;
                     tvlRecord?: {
@@ -1035,6 +759,7 @@ export declare abstract class RewardService {
                         breakdowns: {
                             campaignId: string;
                             value: number;
+                            maxValue?: number | undefined;
                             timestamp: string | bigint;
                             token: {
                                 id: string;
@@ -1053,6 +778,8 @@ export declare abstract class RewardService {
                                 priceSource?: string | null | undefined;
                                 displaySymbol?: string | undefined;
                                 underlyingTokenId?: string | undefined;
+                                priceAlertDismissedAt?: number | undefined;
+                                priceAlertCount?: number | undefined;
                             };
                             amount: string | bigint;
                             distributionType?: "AAVE_NET_APR" | "AAVE_V4_NET_APR" | "DUTCH_AUCTION" | "ERC4626_APR" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "FIX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "FIX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_AMOUNT_PER_LIQUIDITY_VALUE" | "MAX_REWARD_VALUE_PER_LIQUIDITY_AMOUNT" | "MAX_REWARD_VALUE_PER_LIQUIDITY_VALUE" | undefined;
@@ -1115,6 +842,8 @@ export declare abstract class RewardService {
                 priceSource?: string | null | undefined;
                 displaySymbol?: string | undefined;
                 underlyingTokenId?: string | undefined;
+                priceAlertDismissedAt?: number | undefined;
+                priceAlertCount?: number | undefined;
             };
             breakdowns: {
                 root: string;
@@ -1190,6 +919,8 @@ export declare abstract class RewardService {
                         price: number | null;
                         updatedAt: number | null;
                         priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
                     }[];
                 } & {
                     id: string;
@@ -1248,6 +979,8 @@ export declare abstract class RewardService {
                 priceSource?: string | null | undefined;
                 displaySymbol?: string | undefined;
                 underlyingTokenId?: string | undefined;
+                priceAlertDismissedAt?: number | undefined;
+                priceAlertCount?: number | undefined;
             };
             breakdowns: {
                 root: string;
@@ -1323,6 +1056,8 @@ export declare abstract class RewardService {
                         price: number | null;
                         updatedAt: number | null;
                         priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
                     }[];
                 } & {
                     id: string;
@@ -1383,7 +1118,7 @@ export declare abstract class RewardService {
         })[];
     })[];
     static findLatestRootsOnChain(chainId: ChainId): Promise<string[]>;
-    static checkLastClaim(chainId: number, recipient: string, rewards: Awaited<ReturnType<(typeof RewardService)["getByRecipient"]>>): Promise<{
+    static checkLastClaim(chainId: number, recipient: string, rewards: Awaited<ReturnType<typeof LeafService.getByRecipient>>): Promise<{
         id: string;
         root: string;
         distributionChainId: number;
@@ -1410,6 +1145,8 @@ export declare abstract class RewardService {
             price: number | null;
             updatedAt: number | null;
             priceSource: string | null;
+            priceAlertDismissedAt: number | null;
+            priceAlertCount: number;
         };
         Breakdown: {
             id: string;
@@ -1485,6 +1222,8 @@ export declare abstract class RewardService {
                         price: number | null;
                         updatedAt: number | null;
                         priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
                     }[];
                 } & {
                     id: string;
@@ -1607,6 +1346,8 @@ export declare abstract class RewardService {
                         price: number | null;
                         updatedAt: number | null;
                         priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
                     }[];
                 } & {
                     id: string;
@@ -1703,6 +1444,8 @@ export declare abstract class RewardService {
                 priceSource?: string | null | undefined;
                 displaySymbol?: string | undefined;
                 underlyingTokenId?: string | undefined;
+                priceAlertDismissedAt?: number | undefined;
+                priceAlertCount?: number | undefined;
             };
             breakdowns: {
                 root: string;
@@ -1778,6 +1521,8 @@ export declare abstract class RewardService {
                         price: number | null;
                         updatedAt: number | null;
                         priceSource: string | null;
+                        priceAlertDismissedAt: number | null;
+                        priceAlertCount: number;
                     }[];
                 } & {
                     id: string;
@@ -1853,103 +1598,4 @@ export declare abstract class RewardService {
      * @deprecated
      */
     static extractDailyRewardsRecordFromDynamicData<C extends CampaignType>(type: C, dynamicData: CampaignDynamicData<C>[], timestamp?: bigint): Promise<DailyRewardsRecord["model"]>;
-    static getUserRewards(chainIdRootPairs: Array<{
-        chainId: number;
-        root: string;
-    }>, address: string): Promise<{
-        id: string;
-        distributionChainId: number;
-        root: string;
-        recipient: string;
-        rewardTokenId: string;
-        amount: string | undefined;
-        claimed: string;
-        pending: string;
-        proofs: string[];
-        RewardToken: {
-            id: string;
-            address: string;
-            chainId: number;
-            decimals: number;
-            price: number | null;
-            symbol: string;
-            type: import("@package/databases").TokenType;
-        };
-        Breakdown: {
-            id: string;
-            distributionChainId: number;
-            root: string;
-            reason: string;
-            campaignId: string;
-            rewardId: string;
-            amount: string;
-            claimed: string;
-            pending: string;
-            Campaign: {
-                Opportunity: {
-                    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;
-                };
-            } & {
-                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;
-            };
-        }[];
-    }[]>;
-    /** @dev Doesn't account for pending */
-    static getMultipleUserRewardsForToken(chainId: number, root: string, addresses: string[], tokenAddress: string): Promise<{
-        distributionChainId: number;
-        recipient: string;
-        amount: string;
-        claimed: string;
-        proofs: string[];
-    }[]>;
 }