@merkl/api 0.10.198 → 0.10.200

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

@@ -42,13 +42,25 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
     };
 } & {
     opportunities: {
-        ":id": {
+        index: {
             get: {
                 body: unknown;
-                params: {
-                    id: string;
+                params: {};
+                query: {
+                    sort?: string | undefined;
+                    name?: string | undefined;
+                    tokens?: string | undefined;
+                    status?: string | undefined;
+                    items?: number | undefined;
+                    tags?: string | undefined;
+                    page?: number | undefined;
+                    chainId?: string | undefined;
+                    action?: string | undefined;
+                    mainProtocolId?: string | undefined;
+                    order?: string | undefined;
+                    test?: boolean | undefined;
+                    minimumTvl?: number | undefined;
                 };
-                query: unknown;
                 headers: unknown;
                 response: {
                     200: {
@@ -88,9 +100,9 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                                     symbol: string;
                                     name: string | null;
                                     id: string;
+                                    icon: string;
                                     chainId: number;
                                     address: string;
-                                    icon: string;
                                     decimals: number;
                                     displaySymbol: string;
                                     verified: boolean;
@@ -105,9 +117,9 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                             symbol: string;
                             name: string | null;
                             id: string;
+                            icon: string;
                             chainId: number;
                             address: string;
-                            icon: string;
                             decimals: number;
                             verified: boolean;
                             isTest: boolean;
@@ -137,7 +149,143 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                         tvl: number;
                         apr: number;
                         dailyRewards: number;
-                    } | undefined;
+                    }[];
+                };
+            };
+        };
+    };
+} & {
+    opportunities: {
+        count: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    sort?: string | undefined;
+                    name?: string | undefined;
+                    tokens?: string | undefined;
+                    status?: string | undefined;
+                    items?: number | undefined;
+                    tags?: string | undefined;
+                    page?: number | undefined;
+                    chainId?: string | undefined;
+                    action?: string | undefined;
+                    mainProtocolId?: string | undefined;
+                    order?: string | undefined;
+                    test?: boolean | undefined;
+                    minimumTvl?: number | undefined;
+                };
+                headers: unknown;
+                response: {
+                    200: number;
+                };
+            };
+        };
+    };
+} & {
+    opportunities: {
+        ":id": {
+            get: {
+                body: unknown;
+                params: {
+                    id: string;
+                };
+                query: unknown;
+                headers: unknown;
+                response: {
+                    200: {
+                        protocol?: {
+                            name: string;
+                            url: string;
+                            description: string;
+                            id: string;
+                            tags: ("AMM" | "ALM" | "DEX" | "LENDING")[];
+                            icon: string;
+                        } | null | 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;
+                    };
+                    readonly 404: {
+                        message: string;
+                        name: string;
+                    };
+                    readonly 500: {
+                        code: string;
+                        info: string;
+                        httpCode: number;
+                    };
                 };
             };
         };
@@ -155,129 +303,113 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                     headers: unknown;
                     response: {
                         200: {
-                            aprRecord: {
+                            protocol?: {
+                                name: string;
+                                url: string;
+                                description: string;
+                                id: string;
+                                tags: ("AMM" | "ALM" | "DEX" | "LENDING")[];
+                                icon: string;
+                            } | null | undefined;
+                            aprRecord?: {
+                                timestamp: string | bigint;
                                 cumulated: number;
-                                timestamp: bigint;
                                 breakdowns: {
-                                    type: import("../../../../database/api/.generated").$Enums.AprType;
+                                    type: "CAMPAIGN" | "TOKEN" | "PROTOCOL";
                                     id: number;
                                     identifier: string;
                                     value: number;
                                     aprRecordId: string;
                                 }[];
-                            };
-                            tvlRecord: {
-                                id: string;
+                            } | undefined;
+                            tvlRecord?: {
                                 total: number;
-                                timestamp: bigint;
+                                timestamp: string | bigint;
                                 breakdowns: {
-                                    type: import("../../../../database/api/.generated").$Enums.TvlType;
+                                    type: "TOKEN" | "PROTOCOL";
                                     id: number;
                                     identifier: string;
                                     value: number;
                                     tvlRecordId: string;
                                 }[];
-                            };
-                            rewardsRecord: {
-                                id: string;
+                            } | undefined;
+                            rewardsRecord?: {
                                 total: number;
-                                timestamp: bigint;
+                                id: string;
+                                timestamp: string | bigint;
                                 breakdowns: {
-                                    id: number;
-                                    value: number;
-                                    campaignId: string;
-                                    dailyRewardsRecordId: string;
                                     token: {
+                                        price?: number | null | undefined;
                                         symbol: string;
                                         name: string | null;
                                         id: string;
+                                        icon: string;
                                         chainId: number;
                                         address: string;
-                                        icon: string;
                                         decimals: number;
-                                        displaySymbol: string;
                                         verified: boolean;
                                         isTest: boolean;
-                                        price: number | null;
                                     };
-                                    amount: bigint;
+                                    id: number;
+                                    value: number;
+                                    campaignId: string;
+                                    amount: string | bigint;
+                                    dailyRewardsRecordId: string;
                                 }[];
-                            };
-                            id: string;
-                            tokens: ({
+                            } | undefined;
+                            name: string;
+                            type: string;
+                            tokens: {
+                                price?: number | null | undefined;
                                 symbol: string;
                                 name: string | null;
                                 id: string;
+                                icon: string;
                                 chainId: number;
                                 address: string;
-                                icon: string;
                                 decimals: number;
                                 verified: boolean;
                                 isTest: boolean;
-                            } & {
-                                price?: number | null | undefined;
-                            })[];
+                            }[];
+                            id: string;
+                            status: string;
+                            tags: string[];
+                            identifier: string;
                             chain: {
                                 name: string;
                                 id: number;
                                 icon: string;
                             };
-                            protocol: {
-                                name: string;
-                                url: string;
-                                description: string;
-                                id: string;
-                                tags: import("../../../../database/api/.generated").$Enums.ProtocolTag[];
-                                icon: string;
-                            } | undefined;
-                            name: string;
-                            type: import("../../../../database/api/.generated").$Enums.CampaignType;
-                            status: import("../../../../database/api/.generated").$Enums.Status;
-                            tags: string[];
-                            identifier: string;
                             chainId: number;
-                            action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+                            action: string;
                             tvl: number;
                             apr: number;
                             dailyRewards: number;
                             campaigns: {
-                                params: any;
-                                chain: {
+                                campaignStatus?: {
+                                    error?: string | undefined;
+                                    details?: any;
+                                    status: string;
+                                    campaignId: string;
+                                    computedUntil: string | bigint;
+                                    processingStarted: string | bigint;
+                                } | undefined;
+                                distributionChain?: {
                                     name: string;
                                     id: number;
                                     icon: string;
-                                };
-                                rewardToken: {
-                                    symbol: string;
-                                    name: string | null;
-                                    id: string;
-                                    chainId: number;
-                                    address: string;
-                                    icon: string;
-                                    decimals: number;
-                                    verified: boolean;
-                                    isTest: boolean;
-                                } & {
-                                    price?: number | null | undefined;
-                                };
-                                distributionChain: {
+                                } | undefined;
+                                type: string;
+                                id: string;
+                                params: any;
+                                subType: number | null;
+                                chain: {
                                     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;
+                                startTimestamp: string | bigint;
+                                endTimestamp: string | bigint;
                                 computeChainId: number;
                                 distributionChainId: number;
                                 campaignId: string;
@@ -285,151 +417,30 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                                 amount: string;
                                 opportunityId: string;
                                 creatorAddress: string;
-                            }[];
-                        } | null | undefined;
-                    };
-                };
-            };
-        };
-    };
-} & {
-    opportunities: {
-        index: {
-            get: {
-                body: unknown;
-                params: {};
-                query: {
-                    sort?: "tvl" | "apr" | "rewards" | undefined;
-                    name?: string | undefined;
-                    tokens?: string | undefined;
-                    status?: string | undefined;
-                    items?: number | undefined;
-                    tags?: string | undefined;
-                    chainId?: string | undefined;
-                    page?: number | undefined;
-                    action?: string | undefined;
-                    mainProtocolId?: string | undefined;
-                    order?: "asc" | "desc" | undefined;
-                    test?: boolean | undefined;
-                    minimumTvl?: number | undefined;
-                };
-                headers: unknown;
-                response: {
-                    200: {
-                        aprRecord: {
-                            cumulated: number;
-                            timestamp: bigint;
-                            breakdowns: {
-                                type: import("../../../../database/api/.generated").$Enums.AprType;
-                                id: number;
-                                identifier: string;
-                                value: number;
-                                aprRecordId: string;
-                            }[];
-                        };
-                        tvlRecord: {
-                            id: string;
-                            total: number;
-                            timestamp: bigint;
-                            breakdowns: {
-                                type: import("../../../../database/api/.generated").$Enums.TvlType;
-                                id: number;
-                                identifier: string;
-                                value: number;
-                                tvlRecordId: string;
-                            }[];
-                        };
-                        rewardsRecord: {
-                            id: string;
-                            total: number;
-                            timestamp: bigint;
-                            breakdowns: {
-                                id: number;
-                                value: number;
-                                campaignId: string;
-                                dailyRewardsRecordId: string;
-                                token: {
+                                rewardToken: {
+                                    price?: number | null | undefined;
                                     symbol: string;
                                     name: string | null;
                                     id: string;
+                                    icon: string;
                                     chainId: number;
                                     address: string;
-                                    icon: string;
                                     decimals: number;
-                                    displaySymbol: string;
                                     verified: boolean;
                                     isTest: boolean;
-                                    price: number | null;
                                 };
-                                amount: bigint;
                             }[];
                         };
-                        id: string;
-                        tokens: ({
-                            symbol: string;
-                            name: string | null;
-                            id: string;
-                            chainId: number;
-                            address: string;
-                            icon: string;
-                            decimals: number;
-                            verified: boolean;
-                            isTest: boolean;
-                        } & {
-                            price?: number | null | undefined;
-                        })[];
-                        chain: {
+                        readonly 404: {
+                            message: string;
                             name: string;
-                            id: number;
-                            icon: string;
                         };
-                        protocol: {
-                            name: string;
-                            url: string;
-                            description: string;
-                            id: string;
-                            tags: import("../../../../database/api/.generated").$Enums.ProtocolTag[];
-                            icon: string;
-                        } | undefined;
-                        name: string;
-                        type: import("../../../../database/api/.generated").$Enums.CampaignType;
-                        status: import("../../../../database/api/.generated").$Enums.Status;
-                        tags: string[];
-                        identifier: string;
-                        chainId: number;
-                        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
-                        tvl: number;
-                        apr: number;
-                        dailyRewards: number;
-                    }[];
-                };
-            };
-        };
-    };
-} & {
-    opportunities: {
-        count: {
-            get: {
-                body: unknown;
-                params: {};
-                query: {
-                    sort?: "tvl" | "apr" | "rewards" | undefined;
-                    name?: string | undefined;
-                    tokens?: string | undefined;
-                    status?: string | undefined;
-                    items?: number | undefined;
-                    tags?: string | undefined;
-                    chainId?: string | undefined;
-                    page?: number | undefined;
-                    action?: string | undefined;
-                    mainProtocolId?: string | undefined;
-                    order?: "asc" | "desc" | undefined;
-                    test?: boolean | undefined;
-                    minimumTvl?: number | undefined;
-                };
-                headers: unknown;
-                response: {
-                    200: number;
+                        readonly 500: {
+                            code: string;
+                            info: string;
+                            httpCode: number;
+                        };
+                    };
                 };
             };
         };
@@ -444,17 +455,17 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                         field: never;
                     };
                     query: {
-                        sort?: "tvl" | "apr" | "rewards" | undefined;
+                        sort?: string | undefined;
                         name?: string | undefined;
                         tokens?: string | undefined;
                         status?: string | undefined;
                         items?: number | undefined;
                         tags?: string | undefined;
-                        chainId?: string | undefined;
                         page?: number | undefined;
+                        chainId?: string | undefined;
                         action?: string | undefined;
                         mainProtocolId?: string | undefined;
-                        order?: "asc" | "desc" | undefined;
+                        order?: string | undefined;
                         test?: boolean | undefined;
                         minimumTvl?: number | undefined;
                     };

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

@@ -1,15 +1,17 @@
-import { NotFoundError } from "../../../errors";
+import { HttpErrorDto, NotFoundError, NotFoundErrorDto } from "../../../errors";
 import { BackOfficeGuard } from "../../../guards/BackOffice.guard";
 import { AuthorizationHeadersDto, TokenAuthGuard } from "../../../guards/TokenAuth.guard";
-import Elysia from "elysia";
-import { CreateOpportunityDto, GetOpportunitiesQueryDto, OpportunityAggregateFieldDto, OpportunityIdDto, OpportunityUniqueDto, UpdateOpportunityDto, } from "./opportunity.model";
+import Elysia, { t } from "elysia";
+import { AggregationResourceDto, CreateOpportunityDto, GetOpportunitiesQueryDto, OpportunityAggregateFieldDto, OpportunityIdDto, OpportunityResourceDto, OpportunityUniqueDto, OpportunityWithCampaignsResourceDto, UpdateOpportunityDto, } from "./opportunity.model";
 import { OpportunityService } from "./opportunity.service";
 import { transformId } from "./transform-id.pipe";
 import { validateId } from "./validate-id.pipe";
 // ─── Opportunities Controller ────────────────────────────────────────────────
 export const OpportunityController = new Elysia({
     prefix: "/opportunities",
-    detail: { tags: ["Opportunities"] },
+    detail: {
+        tags: ["Opportunities"],
+    },
 })
     // ─── Create An Opportunity ───────────────────────────────────────────
     .post("/", async ({ body }) => await OpportunityService.create(body), {
@@ -17,6 +19,21 @@ export const OpportunityController = new Elysia({
     headers: AuthorizationHeadersDto,
     body: CreateOpportunityDto,
     detail: { hide: true },
+})
+    // ─── Get All Opportunities ───────────────────────────────────────────
+    .get("/", async ({ query }) => await OpportunityService.getMany(query), {
+    query: GetOpportunitiesQueryDto,
+    detail: {
+        description: `**Retrieve Multiple Opportunities**
+      <p>This endpoint enables you to search for opportunities by providing specific criteria through query parameters.</p>`,
+    },
+    response: t.Array(t.Union([OpportunityResourceDto, t.Null()])),
+})
+    // ─── Get Opportunities Count ─────────────────────────────────────────
+    .get("/count", async ({ query }) => await OpportunityService.countMany(query), {
+    query: GetOpportunitiesQueryDto,
+    detail: { description: "Get the count of opportunities corresponding to the query." },
+    response: { 200: t.Number() },
 })
     // ─── Get An Opportunity By Id ────────────────────────────────────────
     .get("/:id", async ({ params }) => {
@@ -33,11 +50,18 @@ export const OpportunityController = new Elysia({
     catch (err) {
         if (err.code && err.code === "P2025")
             throw new NotFoundError();
+        throw err;
     }
 }, {
     params: OpportunityUniqueDto,
     transform: transformId,
     beforeHandle: validateId,
+    response: {
+        200: OpportunityResourceDto,
+        404: NotFoundErrorDto,
+        500: HttpErrorDto,
+    },
+    detail: { description: "Get a unique opportunity." },
 })
     // ─── Get An Opportunity By Id With Related Campaigns ─────────────────
     .get("/:id/campaigns", async ({ params }) => {
@@ -54,22 +78,27 @@ export const OpportunityController = new Elysia({
     catch (err) {
         if (err.code && err.code === "P2025")
             throw new NotFoundError();
+        throw err;
     }
 }, {
     params: OpportunityUniqueDto,
     transform: transformId,
     beforeHandle: validateId,
+    response: {
+        200: OpportunityWithCampaignsResourceDto,
+        404: NotFoundErrorDto,
+        500: HttpErrorDto,
+    },
+    detail: {
+        description: "Get a unique opportunity, including related [campaigns](#tag/campaigns/).",
+    },
 })
-    // ─── Get All Opportunities ───────────────────────────────────────────
-    .get("/", async ({ query }) => await OpportunityService.getMany(query), {
-    query: GetOpportunitiesQueryDto,
-})
-    // ─── Get Opportunities Count ─────────────────────────────────────────
-    .get("/count", async ({ query }) => await OpportunityService.countMany(query), { query: GetOpportunitiesQueryDto })
     // ─── Get Aggregate Fields ────────────────────────────────────────────
     .get("/aggregate/:field", async ({ query, params }) => await OpportunityService.aggregate(query, params.field), {
     params: OpportunityAggregateFieldDto,
     query: GetOpportunitiesQueryDto,
+    response: AggregationResourceDto,
+    detail: { hide: true },
 })
     // ─── Update An Opportunity ───────────────────────────────────────────
     .patch("/:id", async ({ params, body }) => await OpportunityService.update(params.id, body), {