@merkl/api 0.20.32 → 0.20.34

package/dist/src/index.d.ts

@@ -1892,6 +1892,7 @@ declare const app: Elysia<"", false, {
                         items?: number | undefined;
                         tags?: string[] | undefined;
                         page?: number | undefined;
+                        test?: boolean | undefined;
                         ids?: string[] | undefined;
                         opportunityTag?: string | undefined;
                     };
@@ -1919,7 +1920,16 @@ declare const app: Elysia<"", false, {
                 get: {
                     body: unknown;
                     params: {};
-                    query: unknown;
+                    query: {
+                        id?: string | undefined;
+                        name?: string | undefined;
+                        items?: number | undefined;
+                        tags?: string[] | undefined;
+                        page?: number | undefined;
+                        test?: boolean | undefined;
+                        ids?: string[] | undefined;
+                        opportunityTag?: string | undefined;
+                    };
                     headers: unknown;
                     response: {
                         200: number;
@@ -2847,6 +2857,7 @@ declare const app: Elysia<"", false, {
                     params: {};
                     query: {
                         name?: string | undefined;
+                        test?: boolean | undefined;
                     };
                     headers: unknown;
                     response: {
@@ -2873,6 +2884,7 @@ declare const app: Elysia<"", false, {
                     params: {};
                     query: {
                         name?: string | undefined;
+                        test?: boolean | undefined;
                     };
                     headers: unknown;
                     response: {

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

@@ -63,7 +63,7 @@ export const CampaignController = new Elysia({ prefix: "/campaigns", detail: { t
         throw new NotFoundError();
     const campaign = await CampaignService.findUniqueOrThrow(id, true);
     const campaignV3 = OpportunityConvertorService.convertV4CampaignToV3(Campaign[campaign.type], CampaignService.format(campaign), campaign.Opportunity.identifier);
-    return await DynamicDataService.updateForCampaigns([campaignV3], true);
+    return await DynamicDataService.updateForCampaignType([campaignV3], campaignV3.campaignType, true);
 }, { beforeHandle: BackOfficeGuard, headers: AuthorizationHeadersDto, detail: { hide: true } })
     // ─── Test Dynamic data computation with a list of campaignId ───────────────────────
     .post("/dynamic-data", async ({ body }) => {

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

@@ -45,6 +45,7 @@ export declare const ChainController: Elysia<"/chains", false, {
                 params: {};
                 query: {
                     name?: string | undefined;
+                    test?: boolean | undefined;
                 };
                 headers: unknown;
                 response: {
@@ -71,6 +72,7 @@ export declare const ChainController: Elysia<"/chains", false, {
                 params: {};
                 query: {
                     name?: string | undefined;
+                    test?: boolean | undefined;
                 };
                 headers: unknown;
                 response: {

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

@@ -12,6 +12,7 @@ export declare const ChainResourceDto: import("@sinclair/typebox").TObject<{
 }>;
 export declare const GetChainQueryDto: import("@sinclair/typebox").TObject<{
     name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    test: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
 }>;
 export declare const ChainUniqueDto: import("@sinclair/typebox").TObject<{
     chainId: import("@sinclair/typebox").TNumber;

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

@@ -8,6 +8,7 @@ export const ChainResourceDto = t.Object({
 });
 export const GetChainQueryDto = t.Object({
     name: t.Optional(t.String({ description: "Search by blockchain name" })),
+    test: t.Optional(t.Boolean({ description: "Includes chains that have only test opportunities.", default: false })),
 });
 export const ChainUniqueDto = t.Object({
     chainId: t.Numeric(),

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

@@ -22,6 +22,17 @@ export declare class ChainRepository {
                 contains: string;
                 mode: "insensitive";
             } | undefined;
+            Opportunity: {
+                some: {
+                    Campaigns: {
+                        some: {
+                            RewardToken: {
+                                isTest: false;
+                            };
+                        };
+                    };
+                };
+            } | undefined;
         };
     };
     /** Returns many chains based on query

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

@@ -11,7 +11,10 @@ export class ChainRepository {
     }
     static transformQueryToPrismaFilters(query) {
         return {
-            where: { name: query.name ? { contains: query.name, mode: "insensitive" } : undefined },
+            where: {
+                name: query.name ? { contains: query.name, mode: "insensitive" } : undefined,
+                Opportunity: query.test ? undefined : { some: { Campaigns: { some: { RewardToken: { isTest: false } } } } },
+            },
         };
     }
     /** Returns many chains based on query

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

@@ -8,7 +8,7 @@ export class ChainService {
     }
     //TODO: determine find vs get nomenclature and cache handling
     static async findMany(query) {
-        return await CacheService.wrap(TTLPresets.HOUR_4, ChainRepository.findMany, query);
+        return await CacheService.wrap(TTLPresets.MIN_10, ChainRepository.findMany, query);
     }
     static async countMany(query) {
         return await ChainRepository.countMany(query);

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

@@ -722,7 +722,7 @@ const EtherlinkInterfaceCampaigns = {
         campaignType: Campaign.EVENT_BASED,
         contract: "0xd0bc067cf877f7b76ceb331891331d9e6acda1a7",
         eventID: id("OrderPlaced(address,uint64,bool,uint128,uint72,uint128,uint128,uint128,uint128,uint128,bool,bool)"),
-        topicToData: [{ topicIndex: 1, decodeKeyTopic: "address", dataIndex: 6, multiplier: (3n * 10n ** 19n).toString() }],
+        topicToData: [{ topicIndex: 1, decodeKeyTopic: "address", dataIndex: 6, multiplier: (3n * 10n ** 20n).toString() }],
         computeScoreParameters: {
             computeMethod: ComputeScoreMethod.cappedScorePercentageHistorical,
             computeSettings: {
@@ -752,7 +752,7 @@ const EtherlinkInterfaceCampaigns = {
         campaignType: Campaign.EVENT_BASED,
         contract: "0x65ea4dd7f789c71c0f57ed84b3bdc3062898d3cb",
         eventID: id("OrderPlaced(address,uint64,bool,uint128,uint72,uint128,uint128,uint128,uint128,uint128,bool,bool)"),
-        topicToData: [{ topicIndex: 1, decodeKeyTopic: "address", dataIndex: 6, multiplier: (3n * 10n ** 19n).toString() }],
+        topicToData: [{ topicIndex: 1, decodeKeyTopic: "address", dataIndex: 6, multiplier: (3n * 10n ** 20n).toString() }],
         computeScoreParameters: {
             computeMethod: ComputeScoreMethod.cappedScorePercentageHistorical,
             computeSettings: {
@@ -782,7 +782,7 @@ const EtherlinkInterfaceCampaigns = {
         campaignType: Campaign.EVENT_BASED,
         contract: "0xbb6b01d94e3f6ebae8647cb56d544f57928ab758",
         eventID: id("OrderPlaced(address,uint64,bool,uint128,uint72,uint128,uint128,uint128,uint128,uint128,bool,bool)"),
-        topicToData: [{ topicIndex: 1, decodeKeyTopic: "address", dataIndex: 6, multiplier: (3n * 10n ** 19n).toString() }],
+        topicToData: [{ topicIndex: 1, decodeKeyTopic: "address", dataIndex: 6, multiplier: (3n * 10n ** 20n).toString() }],
         computeScoreParameters: {
             computeMethod: ComputeScoreMethod.cappedScorePercentageHistorical,
             computeSettings: {

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

@@ -23,6 +23,7 @@ export declare const ProtocolController: Elysia<"/protocols", false, {
                     items?: number | undefined;
                     tags?: string[] | undefined;
                     page?: number | undefined;
+                    test?: boolean | undefined;
                     ids?: string[] | undefined;
                     opportunityTag?: string | undefined;
                 };
@@ -50,7 +51,16 @@ export declare const ProtocolController: Elysia<"/protocols", false, {
             get: {
                 body: unknown;
                 params: {};
-                query: unknown;
+                query: {
+                    id?: string | undefined;
+                    name?: string | undefined;
+                    items?: number | undefined;
+                    tags?: string[] | undefined;
+                    page?: number | undefined;
+                    test?: boolean | undefined;
+                    ids?: string[] | undefined;
+                    opportunityTag?: string | undefined;
+                };
                 headers: unknown;
                 response: {
                     200: number;

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

@@ -12,7 +12,8 @@ export const ProtocolController = new Elysia({ prefix: "/protocols", detail: { t
 })
     // ─── Count Protocols ─────────────────────────────────────────────────
     .get("/count", async ({ query }) => await ProtocolService.countMany(query), {
-    detail: { description: "Get the number of protocols correspoinding to the query." },
+    query: GetProtocolsQueryDto,
+    detail: { description: "Get the number of protocols corresponding to the query." },
 })
     // ─── Get A Protocol By Its Id Or Name ────────────────────────────────
     .get("/:id", async ({ params }) => {

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

@@ -21,6 +21,7 @@ export declare const ProtocolResourceDto: import("@sinclair/typebox").TObject<{
 }>;
 export declare const GetProtocolsQueryDto: import("@sinclair/typebox").TObject<{
     id: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
+    test: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
     ids: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
     name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;

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

@@ -128,6 +128,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" })),
+    test: t.Optional(t.Boolean({ description: "Includes protocols that have only test opportunities", default: false })),
     ids: t.Optional(t.Array(t.String())),
     name: t.Optional(t.String({ description: "Search protocols by name" })),
     tags: t.Optional(t.Array(t.String())),

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

@@ -2,6 +2,39 @@ import { log } from "@/utils/logger";
 import { apiDbClient } from "@db";
 // ─── Protocols Repository ────────────────────────────────────────────────────
 export class ProtocolRepository {
+    static #transformQueryToPrismaFilters(query) {
+        return {
+            where: {
+                id: query.id
+                    ? { contains: query.id, mode: "insensitive" }
+                    : query.ids
+                        ? { in: query.ids, mode: "insensitive" }
+                        : undefined,
+                tags: query.tags ? { hasEvery: query.tags } : undefined,
+                name: query.name ? { contains: query.name, mode: "insensitive" } : undefined,
+                OR: query.opportunityTag // The opportunity tag specified can be either at the protocol level or the opportunity level
+                    ? [
+                        {
+                            MainOpportunities: {
+                                some: {
+                                    tags: {
+                                        has: query.opportunityTag,
+                                    },
+                                },
+                            },
+                        },
+                        { tags: { has: query.opportunityTag } },
+                    ]
+                    : !query.test
+                        ? [
+                            { MainOpportunities: { some: { Campaigns: { some: { RewardToken: { isTest: false } } } } } },
+                            { Opportunities: { some: { Campaigns: { some: { RewardToken: { isTest: false } } } } } },
+                        ]
+                        : undefined,
+                // id: typeof query.id === "string" ? query.id : !!query.id ? { in: query.id } : undefined,
+            },
+        };
+    }
     static async create(data) {
         return await apiDbClient.protocol.create({
             data: {
@@ -91,34 +124,6 @@ export class ProtocolRepository {
     static async findManyByName(name) {
         return await apiDbClient.protocol.findMany({ where: { name: { equals: name } } });
     }
-    static #transformQueryToPrismaFilters(query) {
-        return {
-            where: {
-                id: query.id
-                    ? { contains: query.id, mode: "insensitive" }
-                    : query.ids
-                        ? { in: query.ids, mode: "insensitive" }
-                        : undefined,
-                tags: query.tags ? { hasEvery: query.tags } : undefined,
-                name: query.name ? { contains: query.name, mode: "insensitive" } : undefined,
-                OR: query.opportunityTag // The opportunity tag specified can be either at the protocol level or the opportunity level
-                    ? [
-                        {
-                            MainOpportunities: {
-                                some: {
-                                    tags: {
-                                        has: query.opportunityTag,
-                                    },
-                                },
-                            },
-                        },
-                        { tags: { has: query.opportunityTag } },
-                    ]
-                    : undefined,
-                // id: typeof query.id === "string" ? query.id : !!query.id ? { in: query.id } : undefined,
-            },
-        };
-    }
     static async findMany(query) {
         const { page: _page, items: _items } = query;
         const page = _page ? _page : 0;

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

@@ -1,18 +1,22 @@
 import { ChainService } from "@/modules/v4/chain/chain.service";
 import { TokenService } from "@/modules/v4/token/token.service";
 import { log } from "@/utils/logger";
+import { CacheService } from "../cache";
+import { TTLPresets } from "../cache/cache.model";
 import { ProtocolRepository } from "./protocol.repository";
 // ─── Protocols Services ──────────────────────────────────────────────────────
 export class ProtocolService {
     static async findMany(query) {
-        const protocols = await ProtocolRepository.findMany(query);
-        const enrichedProtocols = protocols.map(({ MainOpportunities, ...protocol }) => ({
-            ...protocol,
-            dailyRewards: MainOpportunities.reduce((sum, opportunity) => sum + opportunity.dailyRewards, 0),
-            numberOfLiveCampaigns: MainOpportunities.reduce((sum, opportunity) => sum + opportunity.Campaigns.length, 0),
-            opportunityLiveTags: [...new Set(MainOpportunities.flatMap(opportunity => opportunity.action))], // ensure uniqness of tags
-        }));
-        return enrichedProtocols;
+        return await CacheService.wrap(TTLPresets.MIN_10, async (query) => {
+            const protocols = await ProtocolRepository.findMany(query);
+            const enrichedProtocols = protocols.map(({ MainOpportunities, ...protocol }) => ({
+                ...protocol,
+                dailyRewards: MainOpportunities.reduce((sum, opportunity) => sum + opportunity.dailyRewards, 0),
+                numberOfLiveCampaigns: MainOpportunities.reduce((sum, opportunity) => sum + opportunity.Campaigns.length, 0),
+                opportunityLiveTags: [...new Set(MainOpportunities.flatMap(opportunity => opportunity.action))], // ensure uniqness of tags
+            }));
+            return enrichedProtocols;
+        }, query);
     }
     static async countMany(query) {
         return ProtocolRepository.countMany(query);

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

@@ -1762,6 +1762,7 @@ export declare const v4: Elysia<"/v4", false, {
                         items?: number | undefined;
                         tags?: string[] | undefined;
                         page?: number | undefined;
+                        test?: boolean | undefined;
                         ids?: string[] | undefined;
                         opportunityTag?: string | undefined;
                     };
@@ -1789,7 +1790,16 @@ export declare const v4: Elysia<"/v4", false, {
                 get: {
                     body: unknown;
                     params: {};
-                    query: unknown;
+                    query: {
+                        id?: string | undefined;
+                        name?: string | undefined;
+                        items?: number | undefined;
+                        tags?: string[] | undefined;
+                        page?: number | undefined;
+                        test?: boolean | undefined;
+                        ids?: string[] | undefined;
+                        opportunityTag?: string | undefined;
+                    };
                     headers: unknown;
                     response: {
                         200: number;
@@ -2717,6 +2727,7 @@ export declare const v4: Elysia<"/v4", false, {
                     params: {};
                     query: {
                         name?: string | undefined;
+                        test?: boolean | undefined;
                     };
                     headers: unknown;
                     response: {
@@ -2743,6 +2754,7 @@ export declare const v4: Elysia<"/v4", false, {
                     params: {};
                     query: {
                         name?: string | undefined;
+                        test?: boolean | undefined;
                     };
                     headers: unknown;
                     response: {

package/dist/src/utils/generateCardName.d.ts

@@ -1,5 +1,5 @@
 import { tokenType } from "@/engine/erc20SubTypeProcessors/helpers/tokenType";
-import { type Campaign, type CampaignParameters } from "@sdk";
+import type { Campaign, CampaignParameters } from "@sdk";
 export declare const stakingContractToStakingSymbol: {
     [key: string]: string;
 };

package/dist/src/utils/generateCardName.js

@@ -1,5 +1,4 @@
 import { tokenType } from "@/engine/erc20SubTypeProcessors/helpers/tokenType";
-import { ChainId } from "@sdk";
 import { capitalize } from "lodash";
 export const stakingContractToStakingSymbol = {
     "0x18eeD20f71BEf84B605253C89A7576E3634134C0": "CyberStaking",
@@ -51,19 +50,9 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
         case tokenType.beratrax_vault:
             return `Deposit ${symbols.join("-")} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.balancerPool: {
-            if (campaign.computeChainId === ChainId.SONIC) {
-                typeInfo.protocol = "Beets";
-            }
-            let cardName = `Provide liquidity to ${capitalize(typeInfo.protocol)} ${symbols.join("-")}`;
-            if (typeInfo.vault === "0xFB43069f6d0473B85686a85F4Ce4Fc1FD8F00875") {
-                cardName = `Provide liquidity to Jellyverse Pool ${symbols.join("-")}`;
-            }
-            return cardName;
+            return `Provide liquidity to ${capitalize(typeInfo.protocol)} ${symbols.join("-")}`;
         }
         case tokenType.balancerV3: {
-            if (campaign.computeChainId === ChainId.SONIC) {
-                typeInfo.protocol = "Beets";
-            }
             return `Provide liquidity to ${capitalize(typeInfo.protocol)} Boosted ${symbols.join("-")}`;
         }
         case tokenType.aura:
@@ -110,7 +99,8 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
         case tokenType.venus:
         case tokenType.reactor_fusion:
         case tokenType.euler_lend:
-            return `Supply ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
+        case tokenType.fluid:
+            return `Lend ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.metamorpho:
             return `Supply to ${typeInfo.name} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.sturdy_aggregator:
@@ -120,8 +110,6 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
         case tokenType.curve:
         case tokenType.curve_2:
             return `Provide liquidity to ${capitalize(typeInfo.protocol)} ${Object.values(typeInfo.poolTokens).join("-")}`;
-        case tokenType.fluid:
-            return `Lend ${typeInfo.symbolUnderlyingToken} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.enzyme:
             return `Supply to the ${typeInfo.name} on ${capitalize(typeInfo.protocol)}`;
         case tokenType.filament:

package/dist/src/utils/sanitizeChain.d.ts

@@ -0,0 +1,2 @@
+import { ChainId } from "@sdk";
+export declare const sanitizeChainName: (computeChainId: ChainId) => any;

package/dist/src/utils/sanitizeChain.js

@@ -0,0 +1,6 @@
+import { ChainId, NETWORK_LABELS } from "@sdk";
+export const sanitizeChainName = (computeChainId) => {
+    return computeChainId === ChainId.MAINNET
+        ? "ethereum"
+        : NETWORK_LABELS[computeChainId]?.toLowerCase().replaceAll(" ", "");
+};