@merkl/api 0.10.361 → 0.10.377

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

@@ -29,7 +29,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                     status: "NONE" | "PAST" | "LIVE" | "SOON";
                     identifier: string;
                     chainId: number;
-                    action: "INVALID" | "POOL" | "HOLD" | "DROP" | "LEND" | "BORROW" | "LP" | "LONG" | "SHORT";
+                    action: "INVALID" | "POOL" | "HOLD" | "DROP" | "LEND" | "BORROW" | "LONG" | "SHORT";
                 };
                 params: {};
                 query: unknown;
@@ -354,6 +354,176 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
             };
         };
     };
+} & {
+    opportunities: {
+        campaigns: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    type?: "INVALID" | "ERC20" | "CLAMM" | "ERC20_SNAPSHOT" | "JSON_AIRDROP" | "SILO" | "RADIANT" | "MORPHO" | "DOLOMITE" | "BADGER" | "COMPOUND" | "AJNA" | "EULER" | "UNISWAP_V4" | "ION" | "EIGENLAYER" | "ERC20TRANSFERS" | "ERC20LOGPROCESSOR" | "ERC20REBASELOGPROCESSOR" | "VEST" | "ERC20_FIX_APR" | "HYPERDRIVELOGPROCESSOR" | "HYPERDRIVELOGFIXPROCESSOR" | undefined;
+                    items?: number | undefined;
+                    subType?: number | undefined;
+                    page?: number | undefined;
+                    chainId?: number | undefined;
+                    startTimestamp?: string | undefined;
+                    endTimestamp?: string | undefined;
+                    tokenAddress?: string | undefined;
+                    mainParameter?: string | undefined;
+                    campaignId?: string | undefined;
+                    opportunityId?: string | undefined;
+                    creatorId?: string | undefined;
+                    test?: boolean | undefined;
+                    creatorTag?: string | undefined;
+                    tokenSymbol?: string | undefined;
+                };
+                headers: unknown;
+                response: {
+                    200: ({
+                        protocol?: {
+                            name: string;
+                            url: string;
+                            description: string;
+                            id: string;
+                            tags: string[];
+                            icon: string;
+                        } | null | undefined;
+                        depositUrl?: string | undefined;
+                        aprRecord?: {
+                            timestamp: string | bigint;
+                            cumulated: number;
+                            breakdowns: {
+                                type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
+                                id: number;
+                                identifier: string;
+                                value: number;
+                                aprRecordId: string;
+                            }[];
+                        } | undefined;
+                        tvlRecord?: {
+                            total: number;
+                            timestamp: string | bigint;
+                            breakdowns: {
+                                type: "TOKEN" | "PROTOCOL";
+                                id: number;
+                                identifier: string;
+                                value: number;
+                                tvlRecordId: string;
+                            }[];
+                        } | undefined;
+                        rewardsRecord?: {
+                            total: number;
+                            id: string;
+                            timestamp: string | bigint;
+                            breakdowns: {
+                                token: {
+                                    price?: number | null | undefined;
+                                    symbol: string;
+                                    name: string | null;
+                                    id: string;
+                                    icon: string;
+                                    chainId: number;
+                                    address: string;
+                                    decimals: number;
+                                    verified: boolean;
+                                    isTest: boolean;
+                                };
+                                id: number;
+                                value: number;
+                                campaignId: string;
+                                amount: string | bigint;
+                                dailyRewardsRecordId: string;
+                            }[];
+                        } | undefined;
+                        name: string;
+                        type: string;
+                        tokens: {
+                            price?: number | null | undefined;
+                            symbol: string;
+                            name: string | null;
+                            id: string;
+                            icon: string;
+                            chainId: number;
+                            address: string;
+                            decimals: number;
+                            verified: boolean;
+                            isTest: boolean;
+                        }[];
+                        id: string;
+                        status: string;
+                        tags: string[];
+                        identifier: string;
+                        chain: {
+                            name: string;
+                            id: number;
+                            icon: string;
+                        };
+                        chainId: number;
+                        action: string;
+                        tvl: number;
+                        apr: number;
+                        dailyRewards: number;
+                    } & {
+                        campaigns: {
+                            params: any;
+                            chain: {
+                                name: string;
+                                id: number;
+                                icon: string;
+                            };
+                            rewardToken: {
+                                symbol: string;
+                                name: string | null;
+                                id: string;
+                                icon: string;
+                                chainId: number;
+                                address: string;
+                                decimals: number;
+                                verified: boolean;
+                                isTest: boolean;
+                            } & {
+                                price?: number | null | undefined;
+                            };
+                            distributionChain: {
+                                name: string;
+                                id: number;
+                                icon: string;
+                            } | undefined;
+                            campaignStatus: {
+                                error: string;
+                                details: import("database/api/.generated/runtime/library").JsonValue;
+                                status: import("../../../../database/api/.generated").$Enums.RunStatus;
+                                campaignId: string;
+                                computedUntil: bigint;
+                                processingStarted: bigint;
+                            };
+                            type: import("../../../../database/api/.generated").$Enums.CampaignType;
+                            id: string;
+                            subType: number | null;
+                            startTimestamp: bigint;
+                            endTimestamp: bigint;
+                            computeChainId: number;
+                            distributionChainId: number;
+                            campaignId: string;
+                            rewardTokenId: string;
+                            amount: string;
+                            opportunityId: string;
+                            creatorAddress: string;
+                        }[];
+                    })[];
+                    readonly 404: {
+                        message: string;
+                        name: string;
+                    };
+                    readonly 500: {
+                        code: string;
+                        info: string;
+                        httpCode: number;
+                    };
+                };
+            };
+        };
+    };
 } & {
     opportunities: {
         ":id": {

package/dist/src/modules/v4/opportunity/opportunity.controller.js

@@ -2,6 +2,7 @@ import { HttpErrorDto, NotFoundError, NotFoundErrorDto } from "../../../errors";
 import { BackOfficeGuard } from "../../../guards/BackOffice.guard";
 import { AuthorizationHeadersDto, TokenAuthGuard } from "../../../guards/TokenAuth.guard";
 import Elysia, { t } from "elysia";
+import { GetCampaignQueryDto } from "../campaign";
 import { CreateOpportunityDto, GetOpportunitiesQueryDto, GetOpportunityQueryDto, OpportunityAggregateFieldDto, OpportunityIdDto, OpportunityResourceDto, OpportunityUniqueDto, OpportunityWithCampaignsResourceDto, UpdateOpportunityDto, } from "./opportunity.model";
 import { OpportunityService } from "./opportunity.service";
 import { transformId } from "./transform-id.pipe";
@@ -86,6 +87,19 @@ export const OpportunityController = new Elysia({
         500: HttpErrorDto,
     },
     detail: { description: "Get a unique opportunity." },
+})
+    .get("/campaigns", async ({ query }) => {
+    return await OpportunityService.getManyByCampaigns(query);
+}, {
+    query: GetCampaignQueryDto,
+    response: {
+        200: t.Array(OpportunityWithCampaignsResourceDto),
+        404: NotFoundErrorDto,
+        500: HttpErrorDto,
+    },
+    detail: {
+        description: "Get many opportunities, including related [campaigns](#tag/campaigns/).",
+    },
 })
     // ─── Get An Opportunity By Id With Related Campaigns ─────────────────
     .get("/:id/campaigns", async ({ query, params }) => {

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

@@ -335,7 +335,6 @@ export declare const CreateOpportunityDto: import("@sinclair/typebox").TObject<{
         DROP: "DROP";
         LEND: "LEND";
         BORROW: "BORROW";
-        LP: "LP";
         LONG: "LONG";
         SHORT: "SHORT";
         INVALID: "INVALID";

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

@@ -1,6 +1,7 @@
 import { type Prisma, Status } from "../../../../database/api/.generated";
 import type { MerklChainId } from "@sdk";
 import { type AprRecord } from "../apr";
+import type { Campaign } from "../campaign";
 import { type DailyRewardsRecord } from "../reward";
 import { type TvlRecord } from "../tvl";
 import type { CreateOpportunityModel, GetOpportunitiesQueryModel, UpdateOpportunityModel } from "./opportunity.model";
@@ -465,6 +466,190 @@ export declare abstract class OpportunityRepository {
         apr: number;
         dailyRewards: number;
     }>;
+    /**
+     * Gets opportunities and campaigns for which filtered on campaigns
+     * @param filters
+     * @returns
+     */
+    static findManyByCampaigns(where: Campaign["action"]["findMany"]["args"]["where"]): Promise<({
+        Chain: {
+            Explorer: {
+                type: import("../../../../database/api/.generated").$Enums.ExplorerType;
+                url: string;
+                id: string;
+                chainId: number;
+            }[];
+        } & {
+            name: string;
+            id: number;
+            icon: string;
+        };
+        Campaigns: ({
+            ComputeChain: {
+                name: string;
+                id: number;
+                icon: string;
+            };
+            DistributionChain: {
+                Explorer: {
+                    type: import("../../../../database/api/.generated").$Enums.ExplorerType;
+                    url: string;
+                    id: string;
+                    chainId: number;
+                }[];
+            } & {
+                name: string;
+                id: number;
+                icon: string;
+            };
+            RewardToken: {
+                symbol: string;
+                name: string | null;
+                id: string;
+                icon: string;
+                chainId: number;
+                address: string;
+                decimals: number;
+                displaySymbol: string;
+                verified: boolean;
+                isTest: boolean;
+                price: number | null;
+            };
+            CampaignStatus: {
+                error: string;
+                details: Prisma.JsonValue;
+                status: import("../../../../database/api/.generated").$Enums.RunStatus;
+                campaignId: string;
+                computedUntil: bigint;
+                processingStarted: bigint;
+            }[];
+        } & {
+            type: import("../../../../database/api/.generated").$Enums.CampaignType;
+            id: string;
+            params: Prisma.JsonValue;
+            subType: number | null;
+            startTimestamp: bigint;
+            endTimestamp: bigint;
+            computeChainId: number;
+            distributionChainId: number;
+            campaignId: string;
+            rewardTokenId: string;
+            amount: string;
+            opportunityId: string;
+            creatorAddress: string;
+        })[];
+        Tokens: {
+            symbol: string;
+            name: string | null;
+            id: string;
+            icon: string;
+            chainId: number;
+            address: string;
+            decimals: number;
+            displaySymbol: string;
+            verified: boolean;
+            isTest: boolean;
+            price: number | null;
+        }[];
+        Protocols: {
+            name: string;
+            url: string;
+            description: string;
+            id: string;
+            tags: string[];
+            icon: string;
+        }[];
+        MainProtocol: {
+            name: string;
+            url: string;
+            description: string;
+            id: string;
+            tags: string[];
+            icon: string;
+        } | null;
+        TvlRecords: ({
+            TvlBreakdown: {
+                type: import("../../../../database/api/.generated").$Enums.TvlType;
+                id: number;
+                identifier: string;
+                value: number;
+                tvlRecordId: string;
+            }[];
+        } & {
+            total: number;
+            id: string;
+            timestamp: bigint;
+            opportunityId: string;
+        })[];
+        AprRecords: ({
+            AprBreakdown: {
+                type: import("../../../../database/api/.generated").$Enums.AprType;
+                id: number;
+                identifier: string;
+                value: number;
+                aprRecordId: string;
+            }[];
+        } & {
+            id: string;
+            timestamp: bigint;
+            opportunityId: string;
+            cumulated: number;
+        })[];
+        DailyRewardsRecords: ({
+            DailyRewardsBreakdown: ({
+                Campaign: {
+                    startTimestamp: bigint;
+                    endTimestamp: bigint;
+                    amount: string;
+                    RewardToken: {
+                        symbol: string;
+                        name: string | null;
+                        id: string;
+                        icon: string;
+                        chainId: number;
+                        address: string;
+                        decimals: number;
+                        displaySymbol: string;
+                        verified: boolean;
+                        isTest: boolean;
+                        price: number | null;
+                    };
+                    CampaignStatus: {
+                        error: string;
+                        details: Prisma.JsonValue;
+                        status: import("../../../../database/api/.generated").$Enums.RunStatus;
+                        campaignId: string;
+                        computedUntil: bigint;
+                        processingStarted: bigint;
+                    }[];
+                };
+            } & {
+                id: number;
+                value: number;
+                campaignId: string;
+                dailyRewardsRecordId: string;
+            })[];
+        } & {
+            total: number;
+            id: string;
+            timestamp: bigint;
+            opportunityId: string;
+        })[];
+    } & {
+        name: string;
+        type: import("../../../../database/api/.generated").$Enums.CampaignType;
+        id: string;
+        status: import("../../../../database/api/.generated").$Enums.Status;
+        tags: string[];
+        identifier: string;
+        chainId: number;
+        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+        depositUrl: string | null;
+        mainProtocolId: string | null;
+        tvl: number;
+        apr: number;
+        dailyRewards: number;
+    })[]>;
     static findManyWithCampaigns(filters: Prisma.OpportunityFindManyArgs): Promise<({
         Campaigns: ({
             RewardToken: {

package/dist/src/modules/v4/opportunity/opportunity.repository.js

@@ -178,6 +178,47 @@ export class OpportunityRepository {
         });
         return b;
     }
+    /**
+     * Gets opportunities and campaigns for which filtered on campaigns
+     * @param filters
+     * @returns
+     */
+    static async findManyByCampaigns(where) {
+        return await apiDbClient.opportunity.findMany({
+            where: {
+                Campaigns: {
+                    some: where,
+                },
+            },
+            include: {
+                ...OpportunityRepository.#getRecordInclusion(),
+                Chain: {
+                    include: {
+                        Explorer: true,
+                    },
+                },
+                MainProtocol: true,
+                Protocols: true,
+                Tokens: true,
+                Campaigns: {
+                    where,
+                    include: {
+                        RewardToken: true,
+                        ComputeChain: true,
+                        DistributionChain: {
+                            include: {
+                                Explorer: true,
+                            },
+                        },
+                        CampaignStatus: true, // [][0]
+                    },
+                    orderBy: {
+                        endTimestamp: "desc",
+                    },
+                },
+            },
+        });
+    }
     static async findManyWithCampaigns(filters) {
         return await apiDbClient.opportunity.findMany({
             ...filters,

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

@@ -1,4 +1,4 @@
-import { type CreateCampaignModel } from "../campaign";
+import { type CreateCampaignModel, type GetCampaignQueryModel } from "../campaign";
 import { Prisma } from "../../../../database/api/.generated";
 import type { ChainId, MerklChainId } from "@sdk";
 import type { CreateOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, OpportunityResourceModel, OpportunityUnique, OpportunityWithCampaignsResourceModel, UpdateOpportunityModel } from "./opportunity.model";
@@ -26,6 +26,18 @@ export declare abstract class OpportunityService {
         apr: number;
         dailyRewards: number;
     } | null>;
+    static fakeCreateFromCampaign(campaign: Omit<CreateCampaignModel, "id">): Promise<{
+        id: string;
+        chainId: number;
+        type: import("../../../../database/api/.generated").$Enums.CampaignType;
+        identifier: string;
+        name: string;
+        status: "SOON";
+        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+        mainProtocol: "morpho" | "arthswap" | "baseswap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancakeswap-v3" | "quickswap-algebra" | "quickswap-uni" | "ramses" | "retro" | "stryke" | "stryke-pcs" | "stryke-sushi" | "sushiswap-v3" | "swapr" | "thruster" | "uniswap-v3" | "voltage" | "zero" | "koi" | "supswap-v3" | "zkswap" | "thirdtrade" | "uniswap-v2" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap-v3" | "neptune" | "zkSwapThreePool" | "syncswap" | "rfx" | "radiant" | "aave" | "euler" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "coumpound" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "hyperdrive" | undefined;
+        depositUrl: any;
+        tags: string[];
+    }>;
     static createFromCampaign(campaign: Omit<CreateCampaignModel, "id">, upsert?: boolean): Promise<{
         id: string;
         chainId: number;
@@ -80,6 +92,144 @@ export declare abstract class OpportunityService {
         tags: string[];
     }>;
     static updateMetadata(chain: ChainId): Promise<void>;
+    /**
+     * Finds opportunities based on filters of its campaigns
+     * @notice campaigns are filtered as well
+     * @param where
+     * @returns opportunities
+     */
+    static getManyByCampaigns(where: GetCampaignQueryModel): Promise<({
+        protocol?: {
+            name: string;
+            url: string;
+            description: string;
+            id: string;
+            tags: string[];
+            icon: string;
+        } | null | undefined;
+        depositUrl?: string | undefined;
+        aprRecord?: {
+            timestamp: string | bigint;
+            cumulated: number;
+            breakdowns: {
+                type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
+                id: number;
+                identifier: string;
+                value: number;
+                aprRecordId: string;
+            }[];
+        } | undefined;
+        tvlRecord?: {
+            total: number;
+            timestamp: string | bigint;
+            breakdowns: {
+                type: "TOKEN" | "PROTOCOL";
+                id: number;
+                identifier: string;
+                value: number;
+                tvlRecordId: string;
+            }[];
+        } | undefined;
+        rewardsRecord?: {
+            total: number;
+            id: string;
+            timestamp: string | bigint;
+            breakdowns: {
+                token: {
+                    price?: number | null | undefined;
+                    symbol: string;
+                    name: string | null;
+                    id: string;
+                    icon: string;
+                    chainId: number;
+                    address: string;
+                    decimals: number;
+                    verified: boolean;
+                    isTest: boolean;
+                };
+                id: number;
+                value: number;
+                campaignId: string;
+                amount: string | bigint;
+                dailyRewardsRecordId: string;
+            }[];
+        } | undefined;
+        name: string;
+        type: string;
+        tokens: {
+            price?: number | null | undefined;
+            symbol: string;
+            name: string | null;
+            id: string;
+            icon: string;
+            chainId: number;
+            address: string;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+        }[];
+        id: string;
+        status: string;
+        tags: string[];
+        identifier: string;
+        chain: {
+            name: string;
+            id: number;
+            icon: string;
+        };
+        chainId: number;
+        action: string;
+        tvl: number;
+        apr: number;
+        dailyRewards: number;
+    } & {
+        campaigns: {
+            params: any;
+            chain: {
+                name: string;
+                id: number;
+                icon: string;
+            };
+            rewardToken: {
+                symbol: string;
+                name: string | null;
+                id: string;
+                icon: string;
+                chainId: number;
+                address: string;
+                decimals: number;
+                verified: boolean;
+                isTest: boolean;
+            } & {
+                price?: number | null | undefined;
+            };
+            distributionChain: {
+                name: string;
+                id: number;
+                icon: string;
+            } | undefined;
+            campaignStatus: {
+                error: string;
+                details: Prisma.JsonValue;
+                status: import("../../../../database/api/.generated").$Enums.RunStatus;
+                campaignId: string;
+                computedUntil: bigint;
+                processingStarted: bigint;
+            };
+            type: import("../../../../database/api/.generated").$Enums.CampaignType;
+            id: string;
+            subType: number | null;
+            startTimestamp: bigint;
+            endTimestamp: bigint;
+            computeChainId: number;
+            distributionChainId: number;
+            campaignId: string;
+            rewardTokenId: string;
+            amount: string;
+            opportunityId: string;
+            creatorAddress: string;
+        }[];
+    })[]>;
     static getUniqueWithCampaignsOrThrow(opportunityId: string | OpportunityUnique, withTest?: boolean): Promise<OpportunityWithCampaignsResourceModel>;
     static getUniqueOrThrow(opportunityId: string | OpportunityUnique, withTest?: boolean): Promise<OpportunityResourceModel>;
     /**