@merkl/api 0.10.225 → 0.10.227

package/dist/src/eden/index.d.ts

@@ -771,6 +771,7 @@ declare const eden: {
                         items?: number | undefined;
                         tags?: ("AMM" | "ALM" | "DEX" | "LENDING" | "PERPETUAL")[] | undefined;
                         page?: number | undefined;
+                        opportunityTag?: string | undefined;
                     };
                     fetch?: RequestInit | undefined;
                 }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
@@ -3598,6 +3599,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
                         items?: number | undefined;
                         tags?: ("AMM" | "ALM" | "DEX" | "LENDING" | "PERPETUAL")[] | undefined;
                         page?: number | undefined;
+                        opportunityTag?: string | undefined;
                     };
                     headers: unknown;
                     response: {
@@ -6957,6 +6959,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
                         items?: number | undefined;
                         tags?: ("AMM" | "ALM" | "DEX" | "LENDING" | "PERPETUAL")[] | undefined;
                         page?: number | undefined;
+                        opportunityTag?: string | undefined;
                     };
                     fetch?: RequestInit | undefined;
                 }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{

package/dist/src/index.d.ts

@@ -858,6 +858,7 @@ declare const app: Elysia<"", false, {
                         items?: number | undefined;
                         tags?: ("AMM" | "ALM" | "DEX" | "LENDING" | "PERPETUAL")[] | undefined;
                         page?: number | undefined;
+                        opportunityTag?: string | undefined;
                     };
                     headers: unknown;
                     response: {

package/dist/src/index.js

@@ -85,7 +85,11 @@ const app = new Elysia({
     exclude: [/engine\/*/, /v1\/.*/, /v2\/.*/, /v3\/.*/, /swagger\/*/],
 }))
     .use(cors())
-    .get("/", () => "Merkl API: docs available at /docs")
+    .get("/", () => "Merkl API: docs available at /docs", {
+    detail: {
+        hide: true,
+    },
+})
     .use(v1)
     .use(v2)
     .use(v4)

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

@@ -17,13 +17,19 @@ export const CampaignController = new Elysia({ prefix: "/campaigns", detail: { t
     .get("/", async ({ query }) => await CampaignService.findMany(query), {
     query: GetCampaignQueryDto,
     response: t.Array(CampaignResourceDto),
-    detail: `**Retrieve Multiple Campaigns**
-      <p>This endpoint enables you to search for opportunities by providing specific criteria through query parameters.</p>`,
+    detail: {
+        description: `**Retrieve Multiple Campaigns**
+      <p>This endpoint enables you to search for campaigns by providing specific criteria through query parameters.</p>`,
+    },
 })
     // ─── Get Total Campaigns Count ───────────────────────────────────────
     .get("/count", async ({ query }) => await CampaignService.countMany(query), {
     query: GetCampaignQueryDto,
     response: t.Number(),
+    detail: {
+        description: `**Count Campaigns**
+      <p>This endpoint enables you to count campaigns corresponding to filters specified in the query params.</p>`,
+    },
 })
     .group("/campaigns-to-process", app => {
     return (app

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

@@ -22,6 +22,7 @@ export declare const ProtocolController: Elysia<"/protocols", false, {
                     items?: number | undefined;
                     tags?: ("AMM" | "ALM" | "DEX" | "LENDING" | "PERPETUAL")[] | undefined;
                     page?: number | undefined;
+                    opportunityTag?: string | undefined;
                 };
                 headers: unknown;
                 response: {

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

@@ -5,7 +5,7 @@ import type { Resource } from "../prisma";
  * @see {@link Resource}
  */
 export type Protocol = Resource<"Protocol">;
-declare const protocolTypes: readonly ["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", "aura", "akron", "beefy", "dragonswap", "poolside", "koi", "radiant", "aave", "euler", "gearbox", "compound", "sturdy", "frax", "ionic", "moonwell", "fluid", "silo", "morpho", "coumpound", "dolomite", "badger", "ajna", "layerbank", "ion", "eigenlayer"];
+declare const protocolTypes: readonly ["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", "aura", "akron", "beefy", "dragonswap", "poolside", "koi", "radiant", "aave", "euler", "gearbox", "compound", "sturdy", "frax", "ionic", "moonwell", "fluid", "silo", "morpho", "coumpound", "dolomite", "badger", "ajna", "layerbank", "ion", "eigenlayer", "syncswap-v3", "neptune"];
 export type ProtocolId = (typeof protocolTypes)[number];
 export declare const ProtocolResourceDto: import("@sinclair/typebox").TObject<{
     id: import("@sinclair/typebox").TString;
@@ -30,6 +30,7 @@ export declare const GetProtocolsQueryDto: import("@sinclair/typebox").TObject<{
         LENDING: "LENDING";
         PERPETUAL: "PERPETUAL";
     }>>>;
+    opportunityTag: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     page: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
     items: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
 }>;

package/dist/src/modules/v4/protocol/protocol.model.js

@@ -60,6 +60,8 @@ const protocolTypes = [
     "layerbank",
     "ion",
     "eigenlayer",
+    "syncswap-v3",
+    "neptune",
 ];
 // ─── DTOs ────────────────────────────────────────────────────────────────────
 export const ProtocolResourceDto = t.Object({
@@ -73,6 +75,7 @@ export const ProtocolResourceDto = t.Object({
 export const GetProtocolsQueryDto = t.Object({
     id: t.Optional(t.String({ description: "Filter results by name. Useful for searching a protocol to verify its integration" })),
     tags: t.Optional(t.Array(t.Enum(ProtocolTag, { description: "Filter by protocol tag" }))),
+    opportunityTag: t.Optional(t.String({ description: "Filter by underlying opportunities' tag" })),
     page: t.Optional(t.Numeric({ description: "0-indexed page number", default: 0 })),
     items: t.Optional(t.Numeric({ description: "Number of items returned by page", default: 20 })), // items per page
 });

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

@@ -24,6 +24,15 @@ export class ProtocolRepository {
             where: {
                 id: query.id ? { contains: query.id, mode: "insensitive" } : undefined,
                 tags: query.tags ? { hasEvery: query.tags } : undefined,
+                Opportunities: query.opportunityTag
+                    ? {
+                        some: {
+                            tags: {
+                                has: query.opportunityTag,
+                            },
+                        },
+                    }
+                    : undefined,
                 // id: typeof query.id === "string" ? query.id : !!query.id ? { in: query.id } : undefined,
             },
         };

package/dist/src/modules/v4/protocol/protocol.service.js

@@ -34,6 +34,8 @@ export class ProtocolService {
             [AMMV3.AERODROME]: "aerodrome",
             [AMMV3.zkSwap]: "zkswap",
             [AMMV3.ThirdTrade]: "thirdtrade",
+            [AMMV3.SyncswapV3]: "syncswap-v3",
+            [AMMV3.Neptune]: "neptune",
         }[amm];
     }
     static async findMany(query) {

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

@@ -5,13 +5,16 @@ import Elysia from "elysia";
 import { CampaignIdDto, CampaignIdWithoutPageDto, CreateManyBreakdownDto, CreateManyRewardDto, RegisterClaimsDto, UpdatePendingDto, } from "./reward.model";
 import { RewardService } from "./reward.service";
 // ─── Rewards Controller ──────────────────────────────────────────────────────
-export const RewardController = new Elysia({ prefix: "/rewards", detail: { tags: ["Rewards"], hide: true } })
+export const RewardController = new Elysia({ prefix: "/rewards", detail: { tags: ["Rewards"] } })
     // ─── Get Reward Breakdowns For Campaign Ids ──────────────────────────
     .get("/", async ({ query }) => await RewardService.breakdownForCampaign(query), {
     query: CampaignIdDto,
     beforeHandle: ({ query }) => {
         throwOnUnsupportedChainId(query.chainId);
     },
+    detail: {
+        description: "Returns the all the address that received rewards for a given campaign, sorted by descending amounts",
+    },
 })
     // ─── Get Total Amount Rewarded For Campaign Id ──────────────────────
     .get("/total", async ({ query }) => await RewardService.total(query), {
@@ -19,18 +22,21 @@ export const RewardController = new Elysia({ prefix: "/rewards", detail: { tags:
     beforeHandle: ({ query }) => {
         throwOnUnsupportedChainId(query.chainId);
     },
+    detail: { description: "Returns the total amount distributed for a given campaign" },
 })
     // ─── Create Many Rewards ─────────────────────────────────────────────
     .post("/engine", async ({ body }) => await RewardService.createManyReward(body), {
     headers: AuthorizationHeadersDto,
     body: CreateManyRewardDto,
     beforeHandle: EngineGuard,
+    detail: { hide: true },
 })
     // ─── Create Many Reward Breakdowns ───────────────────────────────────
     .post("/engine/breakdowns", async ({ body }) => await RewardService.createManyBreakdown(body), {
     headers: AuthorizationHeadersDto,
     body: CreateManyBreakdownDto,
     beforeHandle: EngineGuard,
+    detail: { hide: true },
 })
     // ─── Register new claims ──────────────────────────────────────────────
     .post("/engine/claims", async ({ body }) => await RewardService.registerClaims(body), {
@@ -44,12 +50,14 @@ export const RewardController = new Elysia({ prefix: "/rewards", detail: { tags:
             claim.recipient = throwOnInvalidRequiredAddress(claim.recipient);
         }
     },
+    detail: { hide: true },
 })
     // ─── Create Many Pending Rewards ─────────────────────────────────────
     .post("/engine/pendings", async ({ body }) => await RewardService.updatePendings(body), {
     headers: AuthorizationHeadersDto,
     body: UpdatePendingDto,
     beforeHandle: EngineGuard,
+    detail: { hide: true },
 })
     // ─── Get Reward Count By Chain And Root ──────────────────────────────
     .get("/count", async ({ query }) => await RewardService.count(query), {
@@ -57,11 +65,13 @@ export const RewardController = new Elysia({ prefix: "/rewards", detail: { tags:
     beforeHandle: ({ query }) => {
         throwOnUnsupportedChainId(query.chainId);
     },
+    detail: { hide: true },
 })
     // ─── Get Reward Count By Chain And Root ──────────────────────────────
     .get("/count/chains", async () => await RewardService.countAllchains(), {
     headers: AuthorizationHeadersDto,
     beforeHandle: BackOfficeGuard,
+    detail: { hide: true },
 })
     // ─── Unclaimed Data routes ───────────────────────────────────────────
     .group("/unclaim", app => {
@@ -70,5 +80,6 @@ export const RewardController = new Elysia({ prefix: "/rewards", detail: { tags:
         beforeHandle: ({ query }) => {
             throwOnUnsupportedChainId(query.chainId);
         },
+        detail: { description: "Returns the total of unclaimed rewards for given campaigns" },
     });
 });

package/dist/src/modules/v4/reward/reward.model.js

@@ -79,9 +79,16 @@ export const RewardsPerChainDto = t.Object({
     chainId: t.Numeric(),
 });
 export const CampaignIdWithoutPageDto = t.Object({
-    chainId: t.Numeric(),
+    chainId: t.Numeric({
+        description: "Chain ID",
+    }),
     campaignIds: t
-        .Transform(t.Union([t.String(), t.Array(t.String())]))
+        .Transform(t.Union([
+        t.String({
+            description: "Comma-separated campaign IDs",
+        }),
+        t.Array(t.String()),
+    ]))
         .Decode(value => {
         return typeof value === "string" ? value.split(",") : value;
     })
@@ -97,10 +104,14 @@ export const CampaignIdListDto = t.Object({
     items: t.Optional(t.Numeric()), // items per page
 });
 export const CampaignIdDto = t.Object({
-    chainId: t.Numeric(),
-    campaignId: t.String(),
-    page: t.Optional(t.Numeric()), // 0-indexed
-    items: t.Optional(t.Numeric()), // items per page
+    chainId: t.Numeric({
+        description: "Chain ID",
+    }),
+    campaignId: t.String({
+        description: "Campaign ID",
+    }),
+    page: t.Optional(t.Numeric({ description: "Page number", default: 0 })), // 0-indexed
+    items: t.Optional(t.Numeric({ description: "Number of returned rows", default: 20 })), // items per page
 });
 export const UserRewardV3Dto = t.Record(t.String({ title: "TokenAddress" }), t.Object({
     symbol: t.String(),

package/dist/src/modules/v4/router.d.ts

@@ -736,6 +736,7 @@ export declare const v4: Elysia<"/v4", false, {
                         items?: number | undefined;
                         tags?: ("AMM" | "ALM" | "DEX" | "LENDING" | "PERPETUAL")[] | undefined;
                         page?: number | undefined;
+                        opportunityTag?: string | undefined;
                     };
                     headers: unknown;
                     response: {