@merkl/api 1.0.78 → 1.0.80

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

@@ -0,0 +1,753 @@
+import { type CampaignDynamicData, Campaign as CampaignType, ChainId, type MerklChainId } from "@angleprotocol/sdk/ts";
+import type { Chain } from "@package/databases/api";
+import type { Opportunity, OpportunityWithoutRecords } from "../../../modules/v4/opportunity/opportunity.model";
+import type { CampaignIdModel, CampaignIdWithoutPageModel, CreateManyBreakdownModel, CreateManyRewardModel, DailyRewardsRecord, RegisterClaimsModel, RewardBreakdown, TokenIdModel } from "./reward.model";
+import { RewardRepository } from "./reward.repository";
+export declare abstract class RewardService {
+    static hashId(root: string, recipient: string, rewardTokenId: string): string;
+    static hashBreakdownId(rewardId: string, campaignId: string, reason: string): string;
+    static hashDailyRewardsRecordId(opportunityId: string, timestamp: bigint): string;
+    static createManyReward(rewards: CreateManyRewardModel): Promise<import("@package/databases").BatchPayload>;
+    static getTotalDistributedByOpportunities(since: number): Promise<Map<{
+        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: Omit<import("../campaign/campaign.model").CampaignWithParams, "manualOverrides">[] | undefined;
+        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;
+        id: string;
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        lastCampaignCreatedAt: number;
+        name: string;
+        apr: number;
+        tvl: number;
+        description: string;
+        status: import("@package/databases").Status;
+        chainId: number;
+        action: import("@package/databases").OpportunityAction;
+        type: string;
+        identifier: string;
+        howToSteps: string[];
+        dailyRewards: number;
+        tags: string[];
+    }, number>>;
+    static getTotalDistributed(since: number): Promise<number>;
+    static getTotalDistributedByChain(since: number): Promise<any>;
+    static getTotalDistributedByProtocol(since: number): Promise<any>;
+    static getTotalDistributedByType(since: number): Promise<any>;
+    /**
+     * Format the reward breakdown to conform to its resource model declaration
+     * @param breakdown straight from db
+     * @returns a RewardBreakdown model
+     */
+    static formatBreakdown(breakdown: Awaited<ReturnType<(typeof RewardRepository)["getByRecipient"]>>[number]["Breakdown"][number]): {
+        campaignId: string;
+        subCampaignId: string | undefined;
+        opportunity: {
+            Chain: {
+                name: string;
+                id: number;
+                icon: 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[];
+            }[];
+            MainProtocol: {
+                name: string;
+                description: string;
+                id: string;
+                url: string;
+                icon: string;
+                tags: string[];
+            } | null;
+        } & {
+            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;
+            manualOverrides: import("@package/databases").OpportunityManualOverride[];
+            identifier: string;
+            howToSteps: string[];
+            explorerAddress: string | null;
+            mainProtocolId: string | null;
+            dailyRewards: number;
+            tags: string[];
+            lastCampaignCreatedAt: Date;
+        };
+        claimed: string;
+        amount: string;
+        reason: string;
+        pending: string;
+    };
+    /**
+     * Format the reward to conform to its resource model declaration
+     * @param reward straight from db
+     * @returns a Reward model
+     */
+    static format(rewards: Awaited<ReturnType<(typeof RewardRepository)["getByRecipient"]>>): {
+        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;
+        };
+        breakdowns: {
+            campaignId: string;
+            subCampaignId: string | undefined;
+            opportunity: {
+                Chain: {
+                    name: string;
+                    id: number;
+                    icon: 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[];
+                }[];
+                MainProtocol: {
+                    name: string;
+                    description: string;
+                    id: string;
+                    url: string;
+                    icon: string;
+                    tags: string[];
+                } | null;
+            } & {
+                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;
+                manualOverrides: import("@package/databases").OpportunityManualOverride[];
+                identifier: string;
+                howToSteps: string[];
+                explorerAddress: string | null;
+                mainProtocolId: string | null;
+                dailyRewards: number;
+                tags: string[];
+                lastCampaignCreatedAt: Date;
+            };
+            claimed: string;
+            amount: string;
+            reason: string;
+            pending: string;
+        }[];
+        claimed: bigint;
+        amount: bigint;
+        pending: bigint;
+        recipient: string;
+        root: string;
+        proofs: string[];
+    }[];
+    static createManyBreakdown(data: CreateManyBreakdownModel): Promise<import("@package/databases").BatchPayload | undefined>;
+    static getByRecipient(recipient: string, roots: string[], tags: string[], withToken?: boolean, withTestTokens?: boolean, breakdownPage?: number, chainFilter?: ChainId[] | null, reasonFilter?: string): Promise<({
+        RewardToken: {
+            symbol: string;
+            name: string | null;
+            decimals: number;
+            price: number | null;
+            address: string;
+            id: string;
+            chainId: number;
+            icon: string;
+            isNative: boolean;
+            isPoint: boolean;
+            isPreTGE: boolean;
+            isTest: boolean;
+            verified: boolean;
+            displaySymbol: string;
+        };
+        Breakdown: ({
+            Campaign: {
+                campaignId: string;
+                Opportunity: {
+                    Chain: {
+                        name: string;
+                        id: number;
+                        icon: 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[];
+                    }[];
+                    MainProtocol: {
+                        name: string;
+                        description: string;
+                        id: string;
+                        url: string;
+                        icon: string;
+                        tags: string[];
+                    } | null;
+                } & {
+                    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;
+                    manualOverrides: import("@package/databases").OpportunityManualOverride[];
+                    identifier: string;
+                    howToSteps: string[];
+                    explorerAddress: string | null;
+                    mainProtocolId: string | null;
+                    dailyRewards: number;
+                    tags: string[];
+                    lastCampaignCreatedAt: Date;
+                };
+            };
+        } & {
+            protocolId: string | null;
+            campaignId: string;
+            claimed: string;
+            id: string;
+            amount: string;
+            reason: string;
+            rewardId: string;
+            pending: string;
+            subCampaignId: string | null;
+        })[];
+    } & {
+        claimed: string;
+        id: string;
+        recipient: string;
+        amount: string;
+        root: string;
+        proofs: string[];
+        pending: string;
+        rewardTokenId: string;
+    })[]>;
+    /**
+     * Groups a breakdown array by their corresponding opportunities
+     * @param breakdowns with campaignIds
+     * @returns array of breakdown group, including the opportunity they belong to
+     */
+    static splitBreakdownByOpportunity(breakdowns: (RewardBreakdown["model"] & {
+        opportunity: OpportunityWithoutRecords;
+    })[]): {
+        opportunity: Opportunity["model"];
+        claimed: bigint;
+        amount: bigint;
+        pending: bigint;
+    }[];
+    /**
+     * Applies the splitBreakdownByOpportunity function to each rewards in the array
+     * @param rewards return type for most of the rewards functions
+     * @returns rewards with updated breakdowns, including the opportunity they belong to
+     */
+    static splitRewardsBreakdownByOpportunity(rewards: Awaited<ReturnType<(typeof RewardService)["getUserRewardsByChain"]>>): (Omit<{
+        chain: Chain;
+        rewards: Awaited<ReturnType<(typeof RewardService)["format"]>>;
+    }, "rewards"> & {
+        rewards: (Omit<{
+            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;
+            };
+            breakdowns: {
+                campaignId: string;
+                subCampaignId: string | undefined;
+                opportunity: {
+                    Chain: {
+                        name: string;
+                        id: number;
+                        icon: 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[];
+                    }[];
+                    MainProtocol: {
+                        name: string;
+                        description: string;
+                        id: string;
+                        url: string;
+                        icon: string;
+                        tags: string[];
+                    } | null;
+                } & {
+                    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;
+                    manualOverrides: import("@package/databases").OpportunityManualOverride[];
+                    identifier: string;
+                    howToSteps: string[];
+                    explorerAddress: string | null;
+                    mainProtocolId: string | null;
+                    dailyRewards: number;
+                    tags: string[];
+                    lastCampaignCreatedAt: Date;
+                };
+                claimed: string;
+                amount: string;
+                reason: string;
+                pending: string;
+            }[];
+            claimed: bigint;
+            amount: bigint;
+            pending: bigint;
+            recipient: string;
+            root: string;
+            proofs: string[];
+        }, "breakdowns"> & {
+            breakdowns: {
+                opportunity: Opportunity["model"];
+                claimed: bigint;
+                amount: bigint;
+                pending: bigint;
+            }[];
+        })[];
+        distributor: string;
+    })[];
+    static removeOpportunityFromRewardBreakdown(rewards: Awaited<ReturnType<(typeof RewardService)["getUserRewardsByChain"]>>): (Omit<{
+        chain: Chain;
+        rewards: Awaited<ReturnType<(typeof RewardService)["format"]>>;
+    }, "rewards"> & {
+        rewards: (Omit<{
+            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;
+            };
+            breakdowns: {
+                campaignId: string;
+                subCampaignId: string | undefined;
+                opportunity: {
+                    Chain: {
+                        name: string;
+                        id: number;
+                        icon: 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[];
+                    }[];
+                    MainProtocol: {
+                        name: string;
+                        description: string;
+                        id: string;
+                        url: string;
+                        icon: string;
+                        tags: string[];
+                    } | null;
+                } & {
+                    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;
+                    manualOverrides: import("@package/databases").OpportunityManualOverride[];
+                    identifier: string;
+                    howToSteps: string[];
+                    explorerAddress: string | null;
+                    mainProtocolId: string | null;
+                    dailyRewards: number;
+                    tags: string[];
+                    lastCampaignCreatedAt: Date;
+                };
+                claimed: string;
+                amount: string;
+                reason: string;
+                pending: string;
+            }[];
+            claimed: bigint;
+            amount: bigint;
+            pending: bigint;
+            recipient: string;
+            root: string;
+            proofs: string[];
+        }, "breakdowns"> & {
+            breakdowns: {
+                campaignId: string;
+                subCampaignId: string | undefined;
+                claimed: string;
+                amount: string;
+                reason: string;
+                pending: string;
+            }[];
+        })[];
+    })[];
+    static findManyRootsOnChain(chainId: ChainId): Promise<string[]>;
+    static checkLastClaim(chainId: number, user: string, rewards: Awaited<ReturnType<(typeof RewardService)["getByRecipient"]>>): Promise<({
+        RewardToken: {
+            symbol: string;
+            name: string | null;
+            decimals: number;
+            price: number | null;
+            address: string;
+            id: string;
+            chainId: number;
+            icon: string;
+            isNative: boolean;
+            isPoint: boolean;
+            isPreTGE: boolean;
+            isTest: boolean;
+            verified: boolean;
+            displaySymbol: string;
+        };
+        Breakdown: ({
+            Campaign: {
+                campaignId: string;
+                Opportunity: {
+                    Chain: {
+                        name: string;
+                        id: number;
+                        icon: 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[];
+                    }[];
+                    MainProtocol: {
+                        name: string;
+                        description: string;
+                        id: string;
+                        url: string;
+                        icon: string;
+                        tags: string[];
+                    } | null;
+                } & {
+                    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;
+                    manualOverrides: import("@package/databases").OpportunityManualOverride[];
+                    identifier: string;
+                    howToSteps: string[];
+                    explorerAddress: string | null;
+                    mainProtocolId: string | null;
+                    dailyRewards: number;
+                    tags: string[];
+                    lastCampaignCreatedAt: Date;
+                };
+            };
+        } & {
+            protocolId: string | null;
+            campaignId: string;
+            claimed: string;
+            id: string;
+            amount: string;
+            reason: string;
+            rewardId: string;
+            pending: string;
+            subCampaignId: string | null;
+        })[];
+    } & {
+        claimed: string;
+        id: string;
+        recipient: string;
+        amount: string;
+        root: string;
+        proofs: string[];
+        pending: string;
+        rewardTokenId: string;
+    })[]>;
+    static getUserRewardsByChain(user: string, withToken: boolean, breakdownPage?: number, chainFilter?: ChainId[], connectedChainId?: MerklChainId | null, withTestTokens?: boolean, claimableOnly?: boolean, tags?: string[]): Promise<{
+        chain: Chain;
+        rewards: Awaited<ReturnType<(typeof RewardService)["format"]>>;
+    }[]>;
+    static registerClaims(claims: RegisterClaimsModel): Promise<void>;
+    static countOnChain(chainId: number): Promise<{
+        [x: string]: {
+            rewardCount: number;
+            breakdownCount: number;
+        };
+    }>;
+    static breakdownForCampaign(query: CampaignIdModel): Promise<import("./reward.model").BreakdownForCampaignsRaw[]>;
+    static countForCampaign(query: CampaignIdModel): Promise<{
+        count: number;
+    }>;
+    static totalForCampaign(query: CampaignIdModel): Promise<{
+        campaignId: string;
+        amount: bigint;
+    }>;
+    static breakdownForToken(query: TokenIdModel): Promise<{
+        amount: string;
+        claimed: string;
+        pending: string;
+        recipient: string;
+    }[]>;
+    static countForToken(query: TokenIdModel): Promise<{
+        count: number;
+    }>;
+    static totalForToken(query: TokenIdModel): Promise<{
+        tokenId: string;
+        amount: bigint;
+    }>;
+    static getAmountAndClaimedForCampaigns(x: CampaignIdWithoutPageModel): Promise<{
+        campaignId: string;
+        claimed: string;
+        amount: string;
+    }[]>;
+    static getUnclaimed(x: CampaignIdWithoutPageModel): Promise<Record<string, string>>;
+    /**
+     * @deprecated
+     */
+    static extractDailyRewardsRecordFromDynamicData<C extends CampaignType>(type: C, dynamicData: CampaignDynamicData<C>[], timestamp?: bigint): Promise<DailyRewardsRecord["model"]>;
+}