@merkl/api 0.10.138 → 0.10.139

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

@@ -1,5 +1,5 @@
 import Elysia from "elysia";
-export declare const DynamicDataController: Elysia<"/dynamicData", false, {
+export declare const DynamicDataController: Elysia<"/dynamic-data", false, {
     decorator: {};
     store: {};
     derive: {};
@@ -12,31 +12,25 @@ export declare const DynamicDataController: Elysia<"/dynamicData", false, {
     macro: {};
     macroFn: {};
 }, {
-    dynamicData: {
-        chainId: {
-            ":chainId": {
-                token: {
-                    ":tokenAddress": {
-                        get: {
-                            body: unknown;
-                            params: {
-                                chainId: number;
-                                tokenAddress: string;
-                            };
-                            query: unknown;
-                            headers: {
-                                authorization: string;
-                            };
-                            response: {
-                                200: {
-                                    tvl: number;
-                                    totalSupply: number;
-                                    cardName: string;
-                                    blacklistedSupply: number;
-                                    priceTargetToken: number;
-                                };
-                            };
-                        };
+    "dynamic-data": {
+        index: {
+            get: {
+                body: unknown;
+                params: {};
+                query: {
+                    chainId: number;
+                    tokenAddress: string;
+                };
+                headers: {
+                    authorization: string;
+                };
+                response: {
+                    200: {
+                        tvl: number;
+                        totalSupply: number;
+                        cardName: string;
+                        blacklistedSupply: number;
+                        priceTargetToken: number;
                     };
                 };
             };

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

@@ -4,13 +4,13 @@ import { throwOnUnsupportedChainId } from "src/utils/throw";
 import { DynamicDataSourceIdentifier } from "./dynamicData.model";
 import { DynamicDataService } from "./dynamicData.service";
 // ─── DynamicDatas Controller ───────────────────────────────────────────────────────
-export const DynamicDataController = new Elysia({ prefix: "/dynamicData", detail: { tags: ["DynamicData"] } })
+export const DynamicDataController = new Elysia({ prefix: "/dynamic-data", detail: { tags: ["DynamicData"] } })
     // ─── Get type Info By Token Address ───────────────────────────────────────
-    .get("/chainId/:chainId/token/:tokenAddress", async ({ params }) => await DynamicDataService.queryERC20DynamicData(params.chainId, params.tokenAddress), {
-    params: DynamicDataSourceIdentifier,
+    .get("/", async ({ query }) => await DynamicDataService.queryERC20DynamicData(query.chainId, query.tokenAddress), {
+    query: DynamicDataSourceIdentifier,
     headers: AuthorizationHeadersDto,
-    beforeHandle: ({ params, headers }) => {
+    beforeHandle: ({ query, headers }) => {
         BackOfficeGuard({ headers });
-        throwOnUnsupportedChainId(params.chainId);
+        throwOnUnsupportedChainId(query.chainId);
     },
 });

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

@@ -1,4 +1,4 @@
-import type { GetParticipateProtocolsQuery } from "../participate/participate.model";
+import type { GetParticipateProtocolsQuery } from "../interaction/interaction.model";
 import { type ProtocolId } from "../protocol";
 import { type EnsoApi, type EnsoSlug } from "./enso.model";
 export declare abstract class EnsoService {

package/dist/src/modules/v4/{participate/participate.controller.d.ts → interaction/interaction.controller.d.ts}

@@ -1,5 +1,5 @@
 import Elysia from "elysia";
-export declare const ParticipateController: Elysia<"/participate", false, {
+export declare const InteractionController: Elysia<"/interaction", false, {
     decorator: {};
     store: {};
     derive: {};
@@ -12,7 +12,7 @@ export declare const ParticipateController: Elysia<"/participate", false, {
     macro: {};
     macroFn: {};
 }, {
-    participate: {
+    interaction: {
         targets: {
             get: {
                 body: unknown;
@@ -24,13 +24,13 @@ export declare const ParticipateController: Elysia<"/participate", false, {
                 };
                 headers: unknown;
                 response: {
-                    200: import("./participate.model").ParticipateTarget[] | undefined;
+                    200: import("./interaction.model").InteractionTarget[] | undefined;
                 };
             };
         };
     };
 } & {
-    participate: {
+    interaction: {
         protocols: {
             get: {
                 body: unknown;
@@ -53,7 +53,7 @@ export declare const ParticipateController: Elysia<"/participate", false, {
         };
     };
 } & {
-    participate: {
+    interaction: {
         quote: {
             get: {
                 body: unknown;
@@ -79,7 +79,7 @@ export declare const ParticipateController: Elysia<"/participate", false, {
         };
     };
 } & {
-    participate: {
+    interaction: {
         transaction: {
             get: {
                 body: unknown;

package/dist/src/modules/v4/{participate/participate.controller.js → interaction/interaction.controller.js}

@@ -1,16 +1,15 @@
 import Elysia from "elysia";
 import { EnsoService } from "../enso/enso.service";
-import { GetParticipateProtocolsQueryDto, GetParticipateQuoteQueryDto, GetParticipateTargetsQueryDto, } from "./participate.model";
-import { ParticipateService } from "./participate.service";
-// ─── Participate Controller ──────────────────────────────────────────────────
-export const ParticipateController = new Elysia({ prefix: "/participate", detail: { tags: ["Participate"] } })
-    // ─── Get All Targets ───────────────────────────────────────────────
+import { GetInteractionProtocolsQueryDto, GetInteractionQuoteQueryDto, GetInteractionTargetsQueryDto, } from "./interaction.model";
+import { InteractionService } from "./interaction.service";
+// ─── Interaction Controller ──────────────────────────────────────────────────
+export const InteractionController = new Elysia({ prefix: "/interaction", detail: { tags: ["Interaction"] } })
     .get("/targets", async ({ query: { protocolId, chainId, identifier } }) => {
     if (identifier)
-        return await ParticipateService.getTarget(chainId, protocolId, identifier);
-    return await ParticipateService.getTargets(chainId, protocolId);
+        return await InteractionService.getTarget(chainId, protocolId, identifier);
+    return await InteractionService.getTargets(chainId, protocolId);
 }, {
-    query: GetParticipateTargetsQueryDto,
+    query: GetInteractionTargetsQueryDto,
     detail: {
         summary: "Available interaction targets for a protocol",
         description: "Retrieves all the pool/token/contract",
@@ -18,7 +17,7 @@ export const ParticipateController = new Elysia({ prefix: "/participate", detail
 })
     // ─── Get All Compatible Protocols ───────────────────────────────────────
     .get("/protocols", async ({ query }) => await EnsoService.getCompatibleProtocols(query), {
-    query: GetParticipateProtocolsQueryDto,
+    query: GetInteractionProtocolsQueryDto,
     detail: {
         summary: "Interactable protocols",
         description: "Retrieves protocols integrated by merkl which supports being interacted with",
@@ -26,7 +25,7 @@ export const ParticipateController = new Elysia({ prefix: "/participate", detail
 })
     // ─── Get Quote ───────────────────────────────────────────────────────
     .get("/quote", async ({ query: { protocolId, chainId, identifier, userAddress, fromAmount, fromTokenAddress } }) => {
-    const [target] = (await ParticipateService.getTarget(chainId, protocolId, identifier)) ?? [];
+    const [target] = (await InteractionService.getTarget(chainId, protocolId, identifier)) ?? [];
     //TODO: throw error
     if (!target)
         return;
@@ -39,7 +38,7 @@ export const ParticipateController = new Elysia({ prefix: "/participate", detail
         chainId,
     });
 }, {
-    query: GetParticipateQuoteQueryDto,
+    query: GetInteractionQuoteQueryDto,
     detail: {
         summary: "Preview participate transaction",
         description: "",
@@ -47,7 +46,7 @@ export const ParticipateController = new Elysia({ prefix: "/participate", detail
 })
     // ─── Get Transaction ─────────────────────────────────────────────────
     .get("/transaction", async ({ query: { protocolId, chainId, identifier, userAddress, fromAmount, fromTokenAddress } }) => {
-    const [target] = (await ParticipateService.getTarget(chainId, protocolId, identifier)) ?? [];
+    const [target] = (await InteractionService.getTarget(chainId, protocolId, identifier)) ?? [];
     //TODO: throw error
     if (!target)
         return;
@@ -60,7 +59,7 @@ export const ParticipateController = new Elysia({ prefix: "/participate", detail
         chainId,
     });
 }, {
-    query: GetParticipateQuoteQueryDto,
+    query: GetInteractionQuoteQueryDto,
     detail: {
         summary: "Get participate transaction",
         description: "",

package/dist/src/modules/v4/{participate/participate.model.d.ts → interaction/interaction.model.d.ts}

@@ -1,7 +1,7 @@
 import type { Token } from "../token";
 export declare const participateInputTypes: readonly ["tokenAmount", "token"];
-export type ParticipateInputType = (typeof participateInputTypes)[number];
-export type ParticipateInput<T extends ParticipateInputType = ParticipateInputType> = {
+export type InteractionInputType = (typeof participateInputTypes)[number];
+export type InteractionInput<T extends InteractionInputType = InteractionInputType> = {
     tokenAmount: {
         chain: number[];
         address: string[];
@@ -12,32 +12,32 @@ export type ParticipateInput<T extends ParticipateInputType = ParticipateInputTy
     };
 }[T];
 export declare const participateTypes: readonly ["link", "deposit", "withdraw"];
-export type ParticipateType = (typeof participateTypes)[number];
-export type ParticipateSchema<T extends ParticipateType> = {
+export type InteractionType = (typeof participateTypes)[number];
+export type InteractionSchema<T extends InteractionType> = {
     link: {
         link: string;
     };
     deposit: {
-        inputs: ParticipateInput[];
+        inputs: InteractionInput[];
     };
     withdraw: {
         d: string;
     };
 }[T];
-export type ParticipateTarget = {
+export type InteractionTarget = {
     identifier: string;
     name: string;
     tokens: Token["model"][];
 };
-export type ParticipateSchemas = {
-    [T in ParticipateType]?: ParticipateSchema<T>;
+export type InteractionSchemas = {
+    [T in InteractionType]?: InteractionSchema<T>;
 };
-export declare const GetParticipateTargetsQueryDto: import("@sinclair/typebox").TObject<{
+export declare const GetInteractionTargetsQueryDto: import("@sinclair/typebox").TObject<{
     chainId: import("@sinclair/typebox").TNumber;
     protocolId: import("@sinclair/typebox").TString;
     identifier: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
 }>;
-export declare const GetParticipateQuoteQueryDto: import("@sinclair/typebox").TObject<{
+export declare const GetInteractionQuoteQueryDto: import("@sinclair/typebox").TObject<{
     chainId: import("@sinclair/typebox").TNumber;
     protocolId: import("@sinclair/typebox").TString;
     identifier: import("@sinclair/typebox").TString;
@@ -45,7 +45,7 @@ export declare const GetParticipateQuoteQueryDto: import("@sinclair/typebox").TO
     fromTokenAddress: import("@sinclair/typebox").TString;
     fromAmount: import("@sinclair/typebox").TString;
 }>;
-export declare const GetParticipateProtocolsQueryDto: import("@sinclair/typebox").TObject<{
+export declare const GetInteractionProtocolsQueryDto: import("@sinclair/typebox").TObject<{
     chainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
 }>;
-export type GetParticipateProtocolsQuery = typeof GetParticipateProtocolsQueryDto.static;
+export type GetInteractionProtocolsQuery = typeof GetInteractionProtocolsQueryDto.static;

package/dist/src/modules/v4/{participate/participate.model.js → interaction/interaction.model.js}

@@ -2,14 +2,14 @@ import protocol from "database/api/seeder/resources/protocol";
 import { t } from "elysia";
 export const participateInputTypes = ["tokenAmount", "token"];
 export const participateTypes = ["link", "deposit", "withdraw"];
-export const GetParticipateTargetsQueryDto = t.Object({
+export const GetInteractionTargetsQueryDto = t.Object({
     chainId: t.Numeric(),
     protocolId: t.String({
         examples: Object.values(protocol).reduce((obj, i) => Object.assign(obj, { [i.name]: { value: i.id } }), {}),
     }),
     identifier: t.Optional(t.String()),
 });
-export const GetParticipateQuoteQueryDto = t.Object({
+export const GetInteractionQuoteQueryDto = t.Object({
     chainId: t.Numeric(),
     protocolId: t.String({
         examples: Object.values(protocol).reduce((obj, i) => Object.assign(obj, { [i.name]: { value: i.id } }), {}),
@@ -19,6 +19,6 @@ export const GetParticipateQuoteQueryDto = t.Object({
     fromTokenAddress: t.String(),
     fromAmount: t.String(),
 });
-export const GetParticipateProtocolsQueryDto = t.Object({
+export const GetInteractionProtocolsQueryDto = t.Object({
     chainId: t.Optional(t.Numeric()),
 });

package/dist/src/modules/v4/{participate/participate.service.d.ts → interaction/interaction.service.d.ts}

@@ -1,8 +1,8 @@
 import { EnsoService } from "../enso/enso.service";
 import type { ProtocolId } from "../protocol";
-import type { ParticipateTarget } from "./participate.model";
-export declare abstract class ParticipateService {
-    static getTarget(chainId: number, protocolId: ProtocolId, identifier: string): Promise<ParticipateTarget[] | undefined>;
-    static getTargetsFromEnsoTokens(tokens: Awaited<ReturnType<typeof EnsoService.getTokens>>): Promise<ParticipateTarget[]>;
-    static getTargets(chainId: number, protocolId: ProtocolId): Promise<ParticipateTarget[] | undefined>;
+import type { InteractionTarget } from "./interaction.model";
+export declare abstract class InteractionService {
+    static getTarget(chainId: number, protocolId: ProtocolId, identifier: string): Promise<InteractionTarget[] | undefined>;
+    static getTargetsFromEnsoTokens(tokens: Awaited<ReturnType<typeof EnsoService.getTokens>>): Promise<InteractionTarget[]>;
+    static getTargets(chainId: number, protocolId: ProtocolId): Promise<InteractionTarget[] | undefined>;
 }

package/dist/src/modules/v4/{participate/participate.service.js → interaction/interaction.service.js}

@@ -1,12 +1,12 @@
 import { EnsoService } from "../enso/enso.service";
 import { TokenService } from "../token";
-export class ParticipateService {
+export class InteractionService {
     static async getTarget(chainId, protocolId, identifier) {
         const slug = EnsoService.getSlug(protocolId);
         if (!slug)
             return;
         const tokens = await EnsoService.getTokens(chainId, slug, identifier);
-        return await ParticipateService.getTargetsFromEnsoTokens(tokens);
+        return await InteractionService.getTargetsFromEnsoTokens(tokens);
     }
     static async getTargetsFromEnsoTokens(tokens) {
         const targets = [];
@@ -28,6 +28,6 @@ export class ParticipateService {
         if (!slug)
             return;
         const tokens = await EnsoService.getTokens(chainId, slug);
-        return await ParticipateService.getTargetsFromEnsoTokens(tokens);
+        return await InteractionService.getTargetsFromEnsoTokens(tokens);
     }
 }

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

@@ -13,7 +13,7 @@ export declare const MerklRootController: Elysia<"/roots", false, {
     macroFn: {};
 }, {
     roots: {
-        timestamps: {
+        index: {
             get: {
                 body: unknown;
                 params: {};
@@ -36,7 +36,7 @@ export declare const MerklRootController: Elysia<"/roots", false, {
     };
 } & {
     roots: {
-        index: {
+        live: {
             get: {
                 body: unknown;
                 params: {};

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

@@ -5,11 +5,11 @@ import { MerklRootService } from "./merklRoot.service";
 // ─── Merkl Roots Controller ──────────────────────────────────────────────────
 export const MerklRootController = new Elysia({ prefix: "/roots", detail: { tags: ["Roots"] } })
     // ─── Get Merkl Root By Timestamp ─────────────────────────────────────
-    .get("/timestamps", async ({ query }) => await MerklRootService.rootForTimestamp(query), {
+    .get("/", async ({ query }) => await MerklRootService.rootForTimestamp(query), {
     query: RootByTimestampsDto,
     beforeHandle: async ({ query }) => {
         throwOnUnsupportedChainId(query.chainId);
     },
 })
     // ─── Get all live Merkl Roots ─────────────────────────────────────────
-    .get("/", async () => await MerklRootService.fetchAll());
+    .get("/live", async () => await MerklRootService.fetchAll());

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

@@ -6,12 +6,16 @@ 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"] } })
+export const OpportunityController = new Elysia({
+    prefix: "/opportunities",
+    detail: { tags: ["Opportunities"] },
+})
     // ─── Create An Opportunity ───────────────────────────────────────────
     .post("/", async ({ body }) => await OpportunityService.create(body), {
     beforeHandle: TokenAuthGuard,
     headers: AuthorizationHeadersDto,
     body: CreateOpportunityDto,
+    detail: { hide: true },
 })
     // ─── Get An Opportunity By Id ────────────────────────────────────────
     .get("/:id", async ({ params }) => {

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

@@ -35,6 +35,7 @@ export const PriceController = new Elysia({ prefix: "/prices", detail: { tags: [
         headers: AuthorizationHeadersDto,
         body: CreatePriceSourceDto,
         beforeHandle: BackOfficeGuard,
+        detail: { hide: true },
     })
         // ─── Update A Price Source ───────────────────
         .patch("/symbol/:symbol", async ({ params, body }) => await PriceService.updatePriceSource(params.symbol, body), {
@@ -42,11 +43,13 @@ export const PriceController = new Elysia({ prefix: "/prices", detail: { tags: [
         params: PriceSourceIdentifier,
         body: UpdatePriceSourceDto,
         beforeHandle: BackOfficeGuard,
+        detail: { hide: true },
     })
         // ─── Delete A Price Source ───────────────────
         .delete("/symbol/:symbol", async ({ params }) => await PriceService.deletePriceSource(params.symbol), {
         headers: AuthorizationHeadersDto,
         params: PriceSourceIdentifier,
         beforeHandle: BackOfficeGuard,
+        detail: { hide: true },
     }));
 });

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

@@ -113,35 +113,37 @@ export declare const RewardController: Elysia<"/rewards", false, {
     };
 } & {
     rewards: {
-        pendings: {
-            post: {
-                body: {
-                    distributionChainId: number;
-                    campaignId: string;
-                    root: string;
-                    rewardToken: string;
-                    toUpdate: {
-                        auxiliaryData1?: string | undefined;
-                        auxiliaryData2?: string | undefined;
-                        reason: string;
-                        pending: string;
-                        recipient: string;
-                    }[];
-                    toCreate: {
-                        auxiliaryData1?: string | undefined;
-                        auxiliaryData2?: string | undefined;
-                        reason: string;
-                        pending: string;
-                        recipient: string;
-                    }[];
-                };
-                params: {};
-                query: unknown;
-                headers: {
-                    authorization: string;
-                };
-                response: {
-                    200: boolean;
+        engine: {
+            pendings: {
+                post: {
+                    body: {
+                        distributionChainId: number;
+                        campaignId: string;
+                        root: string;
+                        rewardToken: string;
+                        toUpdate: {
+                            auxiliaryData1?: string | undefined;
+                            auxiliaryData2?: string | undefined;
+                            reason: string;
+                            pending: string;
+                            recipient: string;
+                        }[];
+                        toCreate: {
+                            auxiliaryData1?: string | undefined;
+                            auxiliaryData2?: string | undefined;
+                            reason: string;
+                            pending: string;
+                            recipient: string;
+                        }[];
+                    };
+                    params: {};
+                    query: unknown;
+                    headers: {
+                        authorization: string;
+                    };
+                    response: {
+                        200: boolean;
+                    };
                 };
             };
         };

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

@@ -33,19 +33,19 @@ export const RewardController = new Elysia({ prefix: "/rewards", detail: { tags:
     beforeHandle: EngineGuard,
 })
     // ─── Create Many Pending Rewards ─────────────────────────────────────
-    .post("/pendings", async ({ body }) => await RewardService.updatePendings(body), {
+    .post("/engine/pendings", async ({ body }) => await RewardService.updatePendings(body), {
     headers: AuthorizationHeadersDto,
     body: UpdatePendingDto,
     beforeHandle: EngineGuard,
 })
-    // ─── Get Reward Count By Chain And Root ───────────────────────────────────────
+    // ─── Get Reward Count By Chain And Root ──────────────────────────────
     .get("/count", async ({ query }) => await RewardService.count(query), {
     query: CampaignIdDto,
     beforeHandle: ({ query }) => {
         throwOnUnsupportedChainId(query.chainId);
     },
 })
-    // ─── Get Reward Count By Chain And Root ───────────────────────────────────────
+    // ─── Get Reward Count By Chain And Root ──────────────────────────────
     .get("/count/chains", async () => await RewardService.countAllchains(), {
     headers: AuthorizationHeadersDto,
     beforeHandle: BackOfficeGuard,

package/dist/src/modules/v4/reward/{rewardConvertor.service.d.ts → subservices/converter.d.ts}

@@ -1,6 +1,6 @@
 import type { MerklAPIType, MerklChainId } from "@sdk";
-import type { RewardV3Model, UserRewardV3Model } from "./reward.model";
-import { RewardService } from "./reward.service";
+import type { RewardV3Model, UserRewardV3Model } from "../reward.model";
+import { RewardService } from "../reward.service";
 export declare abstract class RewardConvertorService {
     /**
      * Convert the v4 reward data to the v3 model used in the v3/userRewards route

package/dist/src/modules/v4/reward/{rewardConvertor.service.js → subservices/converter.js}

@@ -1,4 +1,4 @@
-import { RewardService } from "./reward.service";
+import { RewardService } from "../reward.service";
 export class RewardConvertorService {
     /**
      * Convert the v4 reward data to the v3 model used in the v3/userRewards route