@merkl/api 0.10.78

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

@@ -0,0 +1,432 @@
+import type { Prisma, Status } from "../../../../database/api/.generated";
+import { type AprRecord } from "../apr";
+import { type DailyRewardsRecord } from "../reward";
+import { type TvlRecord } from "../tvl";
+import type { CreateOpportunityModel, GetOpportunitiesQueryEntity } from "./opportunity.model";
+export declare abstract class OpportunityRepository {
+    #private;
+    static create(newOpp: CreateOpportunityModel): Promise<void>;
+    static findUniqueOrThrow(id: string): Promise<{
+        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;
+        TvlRecords: ({
+            TvlBreakdown: {
+                id: number;
+                identifier: string;
+                type: import("../../../../database/api/.generated").$Enums.TvlType;
+                value: number;
+                tvlRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+        AprRecords: ({
+            AprBreakdown: {
+                id: number;
+                identifier: string;
+                type: import("../../../../database/api/.generated").$Enums.AprType;
+                value: number;
+                aprRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            cummulated: number;
+            cumulated: number;
+            opportunityId: string;
+        })[];
+        DailyRewardsRecords: ({
+            DailyRewardsBreakdown: {
+                id: number;
+                value: number;
+                campaignId: string;
+                dailyRewardsRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+    } & {
+        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[];
+    }>;
+    static findUniqueOrThrowWithCampaigns(id: string): Promise<{
+        Chain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        Campaigns: ({
+            ComputeChain: {
+                id: number;
+                name: string;
+                icon: string;
+            };
+            DistributionChain: {
+                id: number;
+                name: string;
+                icon: string;
+            };
+            RewardToken: {
+                id: string;
+                name: string | null;
+                chainId: number;
+                address: string;
+                decimals: number;
+                symbol: string;
+                icon: string;
+                verified: boolean;
+                price: number | null;
+            };
+            RewardBreakdown: {
+                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;
+            computeChainId: number;
+            distributionChainId: number;
+            identifier: string;
+            campaignId: string;
+            type: import("../../../../database/api/.generated").$Enums.CampaignType;
+            subType: number | null;
+            rewardTokenId: string;
+            amount: string;
+            opportunityId: string;
+            startTimestamp: bigint;
+            endTimestamp: bigint;
+            params: Prisma.JsonValue;
+            creatorAddress: 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;
+        TvlRecords: ({
+            TvlBreakdown: {
+                id: number;
+                identifier: string;
+                type: import("../../../../database/api/.generated").$Enums.TvlType;
+                value: number;
+                tvlRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+        AprRecords: ({
+            AprBreakdown: {
+                id: number;
+                identifier: string;
+                type: import("../../../../database/api/.generated").$Enums.AprType;
+                value: number;
+                aprRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            cummulated: number;
+            cumulated: number;
+            opportunityId: string;
+        })[];
+        DailyRewardsRecords: ({
+            DailyRewardsBreakdown: {
+                id: number;
+                value: number;
+                campaignId: string;
+                dailyRewardsRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+    } & {
+        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[];
+    }>;
+    static findManyWithCampaigns(filters: Prisma.OpportunityFindManyArgs): Promise<({
+        Campaigns: {
+            id: string;
+            computeChainId: number;
+            distributionChainId: number;
+            identifier: string;
+            campaignId: string;
+            type: import("../../../../database/api/.generated").$Enums.CampaignType;
+            subType: number | null;
+            rewardTokenId: string;
+            amount: string;
+            opportunityId: string;
+            startTimestamp: bigint;
+            endTimestamp: bigint;
+            params: Prisma.JsonValue;
+            creatorAddress: string;
+        }[];
+    } & {
+        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[];
+    })[]>;
+    static findMany(query: GetOpportunitiesQueryEntity): Promise<({
+        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;
+        TvlRecords: ({
+            TvlBreakdown: {
+                id: number;
+                identifier: string;
+                type: import("../../../../database/api/.generated").$Enums.TvlType;
+                value: number;
+                tvlRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+        AprRecords: ({
+            AprBreakdown: {
+                id: number;
+                identifier: string;
+                type: import("../../../../database/api/.generated").$Enums.AprType;
+                value: number;
+                aprRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            cummulated: number;
+            cumulated: number;
+            opportunityId: string;
+        })[];
+        DailyRewardsRecords: ({
+            DailyRewardsBreakdown: {
+                id: number;
+                value: number;
+                campaignId: string;
+                dailyRewardsRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        })[];
+    } & {
+        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[];
+    })[]>;
+    static countMany(query: GetOpportunitiesQueryEntity): Promise<number>;
+    static getAllIdsForDynamicOpp(): Promise<{
+        id: string;
+    }[]>;
+    /**
+     * Updates Apr, Tvl and DailyRewards record
+     * @param opportunityId
+     * @param apr
+     * @param tvl
+     * @returns
+     */
+    static updateRecords(opportunityId: string, apr: AprRecord["model"], tvl: TvlRecord["model"], dailyRewards: DailyRewardsRecord["model"]): Promise<{
+        aprRecord: {
+            id: string;
+            timestamp: bigint;
+            cummulated: number;
+            cumulated: number;
+            opportunityId: string;
+        };
+        tvlRecord: {
+            TvlBreakdown: {
+                id: number;
+                identifier: string;
+                type: import("../../../../database/api/.generated").$Enums.TvlType;
+                value: number;
+                tvlRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        };
+        dailyRewardsRecord: {
+            DailyRewardsBreakdown: {
+                id: number;
+                value: number;
+                campaignId: string;
+                dailyRewardsRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            total: number;
+            opportunityId: string;
+        };
+        opportunity: {
+            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[];
+        };
+    }>;
+    static updateStatus(id: string, status: Status): Promise<{
+        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[];
+    }>;
+}