@merkl/api 0.10.78

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

@@ -0,0 +1,158 @@
+import type { Resource } from "../prisma";
+import type { Token } from "../token";
+/**
+ * Rewards Record
+ * @description Describes one rewards value snapshot for an opportunity
+ * @see {@link Resource}
+ */
+export type Reward = Resource<"Reward", "rewardTokenId" | "id", {
+    breakdowns: RewardBreakdown["model"][];
+    token: Token["model"];
+    pending: bigint;
+    claimed: bigint;
+    amount: bigint;
+}>;
+/**
+ * Rewards Breakdown
+ * @description Describes one reward amount for one token and campaign
+ * @see {@link Resource}
+ */
+export type RewardBreakdown = Resource<"RewardBreakdown", "id" | "rewardId" | "protocolId">;
+/**
+ * Daily Rewards
+ * @description Describes rewards breakdown from the opportunity view
+ * @see {@link Resource}
+ */
+export type DailyRewardsRecord = Resource<"DailyRewardsRecord", "opportunityId" | "id", {
+    breakdowns: DailyRewardsBreakdown["model"][];
+}>;
+/**
+ * Daily Rewards Breakdown
+ * @description Describes one rewards value of a campaign
+ * @see {@link Resource}
+ */
+export type DailyRewardsBreakdown = Resource<"DailyRewardsBreakdown", "id" | "dailyRewardsRecordId">;
+export declare const CreateManyBreakdownDto: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    rewardToken: import("@sinclair/typebox").TString;
+    campaignId: import("@sinclair/typebox").TString;
+    root: import("@sinclair/typebox").TString;
+    breakdowns: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        recipient: import("@sinclair/typebox").TString;
+        protocolId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        reason: import("@sinclair/typebox").TString;
+        amount: import("@sinclair/typebox").TString;
+        claimed: import("@sinclair/typebox").TString;
+        pending: import("@sinclair/typebox").TString;
+        auxiliaryData1: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        auxiliaryData2: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>>;
+}>>;
+declare const RewardDto: import("@sinclair/typebox").TObject<{
+    root: import("@sinclair/typebox").TString;
+    recipient: import("@sinclair/typebox").TString;
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    rewardToken: import("@sinclair/typebox").TString;
+    proofs: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+}>;
+export declare const CreateManyRewardDto: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+    root: import("@sinclair/typebox").TString;
+    recipient: import("@sinclair/typebox").TString;
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    rewardToken: import("@sinclair/typebox").TString;
+    proofs: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+}>>;
+declare const PendingDto: import("@sinclair/typebox").TObject<{
+    recipient: import("@sinclair/typebox").TString;
+    reason: import("@sinclair/typebox").TString;
+    pending: import("@sinclair/typebox").TString;
+    auxiliaryData1: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    auxiliaryData2: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+}>;
+export declare const UpdatePendingDto: import("@sinclair/typebox").TObject<{
+    distributionChainId: import("@sinclair/typebox").TNumber;
+    rewardToken: import("@sinclair/typebox").TString;
+    campaignId: import("@sinclair/typebox").TString;
+    root: import("@sinclair/typebox").TString;
+    toUpdate: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        recipient: import("@sinclair/typebox").TString;
+        reason: import("@sinclair/typebox").TString;
+        pending: import("@sinclair/typebox").TString;
+        auxiliaryData1: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        auxiliaryData2: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>>;
+    toCreate: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{
+        recipient: import("@sinclair/typebox").TString;
+        reason: import("@sinclair/typebox").TString;
+        pending: import("@sinclair/typebox").TString;
+        auxiliaryData1: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        auxiliaryData2: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>>;
+}>;
+export declare const RewardsByUser: import("@sinclair/typebox").TObject<{
+    address: import("@sinclair/typebox").TString;
+}>;
+export declare const RewardsByUserAndChain: import("@sinclair/typebox").TObject<{
+    address: import("@sinclair/typebox").TString;
+    chainId: import("@sinclair/typebox").TNumber;
+}>;
+export declare const UserRewardQueryDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    mainParameter: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    proof: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    rewardToken: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    user: import("@sinclair/typebox").TString;
+}>;
+export declare const RewardsPerChainDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+}>;
+export declare const CampaignIdListDto: import("@sinclair/typebox").TObject<{
+    chainId: import("@sinclair/typebox").TNumber;
+    campaignIdentifiers: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>]>;
+    page: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    items: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+}>;
+export declare const UserRewardV3Dto: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
+    symbol: import("@sinclair/typebox").TString;
+    decimals: import("@sinclair/typebox").TNumber;
+    accumulated: import("@sinclair/typebox").TString;
+    unclaimed: import("@sinclair/typebox").TString;
+    pending: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    reasons: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
+        accumulated: import("@sinclair/typebox").TString;
+        unclaimed: import("@sinclair/typebox").TString;
+        pending: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    }>>;
+    proof: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+}>>;
+export declare const RewardV3Dto: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
+    campaignData: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
+        accumulated: import("@sinclair/typebox").TString;
+        unclaimed: import("@sinclair/typebox").TString;
+        pending: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        auxiliaryData1: import("@sinclair/typebox").TString;
+        auxiliaryData2: import("@sinclair/typebox").TString;
+        decimals: import("@sinclair/typebox").TNumber;
+        mainParameter: import("@sinclair/typebox").TString;
+        symbol: import("@sinclair/typebox").TString;
+        token: import("@sinclair/typebox").TString;
+    }>>>;
+    tokenData: import("@sinclair/typebox").TRecord<import("@sinclair/typebox").TString, import("@sinclair/typebox").TObject<{
+        accumulated: import("@sinclair/typebox").TString;
+        unclaimed: import("@sinclair/typebox").TString;
+        pending: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+        decimals: import("@sinclair/typebox").TNumber;
+        proof: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>;
+        symbol: import("@sinclair/typebox").TString;
+    }>>;
+}>>;
+export type CreateManyRewardModel = typeof CreateManyRewardDto.static;
+export type CreateManyBreakdownModel = typeof CreateManyBreakdownDto.static;
+export type RewardEntity = typeof RewardDto.static;
+export type RewardPerChainModel = typeof RewardsPerChainDto.static;
+export type UpdatePendingModel = typeof UpdatePendingDto.static;
+export type PendingEntity = typeof PendingDto.static;
+export type CampaignIdListModel = typeof CampaignIdListDto.static;
+export type UserRewardV3Model = typeof UserRewardV3Dto.static;
+export type RewardV3Model = typeof RewardV3Dto.static;
+export {};

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

@@ -0,0 +1,158 @@
+import type { Prisma } from "../../../../database/api/.generated";
+import type { CampaignIdListModel, CreateManyBreakdownModel, CreateManyRewardModel, PendingEntity } from "./reward.model";
+export declare abstract class RewardRepository {
+    static createManyReward(rewards: CreateManyRewardModel): Promise<Prisma.BatchPayload>;
+    static createManyBreakdown(data: CreateManyBreakdownModel): Promise<Prisma.BatchPayload>;
+    static getByRecipient(recipient: string, roots: string[], withToken: boolean): Promise<({
+        RewardToken: {
+            id: string;
+            name: string | null;
+            chainId: number;
+            address: string;
+            decimals: number;
+            symbol: string;
+            icon: string;
+            verified: boolean;
+            price: number | null;
+        };
+        Breakdown: ({
+            Campaign: {
+                identifier: string;
+                campaignId: string;
+                Opportunity: {
+                    Chain: {
+                        id: number;
+                        name: string;
+                        icon: string;
+                    };
+                    Tokens: {
+                        id: string;
+                        name: string | null;
+                        chainId: number;
+                        address: string;
+                        decimals: number;
+                        symbol: string;
+                        icon: string;
+                        verified: boolean;
+                        price: number | null;
+                    }[];
+                    Protocols: {
+                        id: string;
+                        tags: import("../../../../database/api/.generated").$Enums.ProtocolTag[];
+                        name: string;
+                        description: string;
+                        url: string;
+                        icon: string;
+                    }[];
+                    MainProtocol: {
+                        id: string;
+                        tags: import("../../../../database/api/.generated").$Enums.ProtocolTag[];
+                        name: string;
+                        description: string;
+                        url: string;
+                        icon: string;
+                    } | null;
+                } & {
+                    id: string;
+                    chainId: number;
+                    type: import("../../../../database/api/.generated").$Enums.CampaignType;
+                    identifier: string;
+                    name: string;
+                    status: import("../../../../database/api/.generated").$Enums.Status;
+                    action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+                    mainProtocolId: string | null;
+                    tvl: number;
+                    apr: number;
+                    dailyRewards: number;
+                    tags: string[];
+                };
+            };
+        } & {
+            id: number;
+            protocolId: string | null;
+            reason: string;
+            amount: string;
+            claimed: string;
+            pending: string;
+            auxiliaryData1: string | null;
+            auxiliaryData2: string | null;
+            rewardId: string;
+            campaignId: string;
+        })[];
+    } & {
+        id: string;
+        root: string;
+        recipient: string;
+        rewardTokenId: string;
+        proofs: string[];
+    })[]>;
+    static getByChainRecipientToken(recipient: string, root: string, tokenId: string): Promise<({
+        Breakdown: ({
+            Campaign: {
+                identifier: string;
+                campaignId: string;
+            };
+        } & {
+            id: number;
+            protocolId: string | null;
+            reason: string;
+            amount: string;
+            claimed: string;
+            pending: string;
+            auxiliaryData1: string | null;
+            auxiliaryData2: string | null;
+            rewardId: string;
+            campaignId: string;
+        })[];
+    } & {
+        id: string;
+        root: string;
+        recipient: string;
+        rewardTokenId: string;
+        proofs: string[];
+    }) | null>;
+    static countRewardPerRewardTokenIdAndRoot(): Promise<(Prisma.PickEnumerable<Prisma.RewardGroupByOutputType, ("rewardTokenId" | "root")[]> & {
+        _count: {
+            _all: number;
+        };
+    })[]>;
+    static countRewardBreakdownPerCampaignId(): Promise<(Prisma.PickEnumerable<Prisma.RewardBreakdownGroupByOutputType, "campaignId"[]> & {
+        _count: {
+            _all: number;
+        };
+    })[]>;
+    static updatePendings(rewardTokenId: string, root: string, campaignId: string, toUpdate: PendingEntity[]): Promise<{
+        id: number;
+        protocolId: string | null;
+        reason: string;
+        amount: string;
+        claimed: string;
+        pending: string;
+        auxiliaryData1: string | null;
+        auxiliaryData2: string | null;
+        rewardId: string;
+        campaignId: string;
+    }[]>;
+    static createPendings(rewardTokenId: string, root: string, campaignId: string, toCreate: PendingEntity[]): Promise<{
+        id: number;
+        protocolId: string | null;
+        reason: string;
+        amount: string;
+        claimed: string;
+        pending: string;
+        auxiliaryData1: string | null;
+        auxiliaryData2: string | null;
+        rewardId: string;
+        campaignId: string;
+    }[]>;
+    static breakdownForCampaigns(root: string, campaignIds: string[], query: CampaignIdListModel): Promise<{
+        Campaign: {
+            identifier: string;
+            campaignId: string;
+        };
+        amount: string;
+        Reward: {
+            recipient: string;
+        };
+    }[]>;
+}