@merkl/api 0.10.247 → 0.10.249

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

@@ -1436,6 +1436,7 @@ declare const eden: {
                     get: (options: {
                         headers?: Record<string, unknown> | undefined;
                         query: {
+                            test?: boolean | undefined;
                             chainIds?: number[] | undefined;
                             reloadChainId?: number | undefined;
                         };
@@ -1541,6 +1542,7 @@ declare const eden: {
                 get: (options: {
                     headers?: Record<string, unknown> | undefined;
                     query: {
+                        test?: boolean | undefined;
                         reloadChainId?: number | undefined;
                         chainId: number[];
                     };
@@ -4564,6 +4566,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
                                 address: string;
                             };
                             query: {
+                                test?: boolean | undefined;
                                 chainIds?: number[] | undefined;
                                 reloadChainId?: number | undefined;
                             };
@@ -4680,6 +4683,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
                             address: string;
                         };
                         query: {
+                            test?: boolean | undefined;
                             reloadChainId?: number | undefined;
                             chainId: number[];
                         };
@@ -7624,6 +7628,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
                     get: (options: {
                         headers?: Record<string, unknown> | undefined;
                         query: {
+                            test?: boolean | undefined;
                             chainIds?: number[] | undefined;
                             reloadChainId?: number | undefined;
                         };
@@ -7729,6 +7734,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
                 get: (options: {
                     headers?: Record<string, unknown> | undefined;
                     query: {
+                        test?: boolean | undefined;
                         reloadChainId?: number | undefined;
                         chainId: number[];
                     };

package/dist/src/entities/opportunity.js

@@ -217,6 +217,7 @@ export const extractOpportunities = {
                     "maverickBoostedPosition",
                     "zkSwapThreePool",
                     "syncswap",
+                    "rfx",
                 ],
                 borrow: ["radiant_borrow", "aave_borrowing", "euler_borrow", "zerolend_borrowing"],
                 lend: [
@@ -247,6 +248,12 @@ export const extractOpportunities = {
                             .filter(tkn => tkn);
                     if (["curve"].includes(campaign.type ?? ""))
                         return Object.values(typeInfo.poolTokens ?? {}).filter(tkn => tkn);
+                    if (["rfx"].includes(campaign.type ?? "")) {
+                        return [typeInfo.symbolShortToken, typeInfo.symbolLongToken];
+                    }
+                    if (["maverickBoostedPosition"].includes(campaign.type ?? "")) {
+                        return [typeInfo.symbolTokenA, typeInfo.symbolTokenB];
+                    }
                     return [typeInfo.symbolToken0, typeInfo.symbolToken1];
                 },
                 lend: () => (campaign.type === "compound" ? [typeInfo.symbolBaseToken] : [typeInfo.symbolUnderlyingToken]),

package/dist/src/index.d.ts

@@ -1824,6 +1824,7 @@ declare const app: Elysia<"", false, {
                                 address: string;
                             };
                             query: {
+                                test?: boolean | undefined;
                                 chainIds?: number[] | undefined;
                                 reloadChainId?: number | undefined;
                             };
@@ -1940,6 +1941,7 @@ declare const app: Elysia<"", false, {
                             address: string;
                         };
                         query: {
+                            test?: boolean | undefined;
                             reloadChainId?: number | undefined;
                             chainId: number[];
                         };

package/dist/src/libs/campaigns/campaignTypes/ERC20DynamicData.js

@@ -147,7 +147,7 @@ export async function ERC20DynamicData(chainId, campaigns) {
                             campaign.campaignParameters.duration /
                             (whitelistedSupplyTargetToken * priceTargetToken),
                         totalSupplyTargetToken,
-                        tvl: getTVL(tokenTypesByCampaign[campaign.campaignId].typeInfo.type, totalSupplyTargetToken, whitelistedSupplyTargetToken, priceTargetToken),
+                        tvl: getTVL(tokenTypesByCampaign[campaign.campaignId].typeInfo.type, tokenTypesByCampaign[campaign.campaignId].typeInfo.totalSupply, whitelistedSupplyTargetToken, priceTargetToken),
                         type: tokenTypesByCampaign[campaign.campaignId].type,
                         typeInfo: tokenTypesByCampaign[campaign.campaignId].typeInfo,
                         priceRewardToken: priceRewardToken,

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/RfxProcessor.d.ts

@@ -23,7 +23,10 @@ type callKeysRfx = mandatoryCallKeys & {
     metaDataLong: string;
 };
 type dataRawTemplate = callKeysRfx & {};
-type dataTypeRfx = dataType & {};
+type dataTypeRfx = dataType & {
+    symbolShortToken: string;
+    symbolLongToken: string;
+};
 export declare class RfxProcessor extends GenericProcessor<callKeysRfx, dataRawTemplate, dataTypeRfx> {
     rounds: {
         round1: callType[];

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/RfxProcessor.js

@@ -59,6 +59,8 @@ export class RfxProcessor extends GenericProcessor {
             cardName: generateCardName(type, typeInfo, campaign),
             priceTargetToken: priceTargetToken, // Add the appropriate value here
             tvl,
+            symbolShortToken: typeInfo.symbolShortToken,
+            symbolLongToken: typeInfo.symbolLongToken,
         };
     }
 }

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/WoofiProcessor.d.ts

@@ -13,7 +13,7 @@ type callKeysBeefy = mandatoryCallKeys & {
     underlying: string;
     pricePerShare: string;
     totalSupplyUnderlying: string;
-    symbolUnderlying: string;
+    symbolUnderlyingToken: string;
 };
 type dataRawBeefy = callKeysBeefy & {};
 type dataTypeBeefy = dataType & {

package/dist/src/libs/campaigns/campaignTypes/ERC20SubTypes/processor/WoofiProcessor.js

@@ -8,7 +8,7 @@ export class WoofiProcessor extends GenericProcessor {
             { key: "underlying", call: "want", target: "tokenAddress" },
         ],
         round2: [
-            { key: "symbolUnderlying", call: "symbol", target: "underlying" },
+            { key: "symbolUnderlyingToken", call: "symbol", target: "underlying" },
             { key: "totalSupply", call: "totalSupply", target: "tokenAddress" },
             { key: "decimalsToken", call: "decimals", target: "underlying" },
         ],
@@ -18,7 +18,7 @@ export class WoofiProcessor extends GenericProcessor {
     // override computeRound1(): void {}
     async processingRound5(index, type, typeInfo, calls, campaign, pricer) {
         const { whitelistedSupplyTargetToken, totalSupply, blacklistedSupply } = this.handleWhiteListBlacklistRound5(typeInfo, campaign);
-        const priceToken = (await pricer.get({ symbol: typeInfo.symbolUnderlying })) ?? 0;
+        const priceToken = (await pricer.get({ symbol: typeInfo.symbolUnderlyingToken })) ?? 0;
         let normalizedFactor = 1;
         if (Number(typeInfo.decimalsToken) < campaign.campaignParameters.decimalsTargetToken) {
             normalizedFactor = 10 ** (campaign.campaignParameters.decimalsTargetToken - Number(typeInfo.decimalsToken));

package/dist/src/modules/v4/opportunity/subservices/getErc20Metadata.service.js

@@ -35,6 +35,7 @@ export const getErc20Metadata = async (chainId, campaignId, rewardToken, amount,
                     "maverickBoostedPosition",
                     "zkSwapThreePool",
                     "syncswap",
+                    "rfx",
                 ],
                 BORROW: ["radiant_borrow", "aave_borrowing", "euler_borrow", "zerolend_borrowing"],
                 LEND: [

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", "syncswap-v3", "neptune", "zkSwapThreePool", "syncswap", "radiant", "aave", "euler", "gearbox", "compound", "sturdy", "frax", "ionic", "moonwell", "fluid", "silo", "morpho", "coumpound", "dolomite", "badger", "ajna", "layerbank", "ion", "venus", "woofi", "reactor_fusion", "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", "syncswap-v3", "neptune", "zkSwapThreePool", "syncswap", "rfx", "radiant", "aave", "euler", "gearbox", "compound", "sturdy", "frax", "ionic", "moonwell", "fluid", "silo", "morpho", "coumpound", "dolomite", "badger", "ajna", "layerbank", "ion", "venus", "woofi", "reactor_fusion", "eigenlayer"];
 export type ProtocolId = (typeof protocolTypes)[number];
 export declare const ProtocolResourceDto: import("@sinclair/typebox").TObject<{
     id: import("@sinclair/typebox").TString;

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

@@ -43,6 +43,7 @@ const protocolTypes = [
     "neptune",
     "zkSwapThreePool",
     "syncswap",
+    "rfx",
     // ─── LP Lending ──────────────────────────────────────────────────────
     "radiant",
     "aave",

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

@@ -4,7 +4,7 @@ import type { BreakdownForCampaignsRaw, CampaignIdModel, CampaignIdWithoutPageMo
 export declare abstract class RewardRepository {
     static createManyReward(rewards: CreateManyRewardModel): Promise<Prisma.BatchPayload>;
     static createManyBreakdown(data: CreateManyBreakdownModel): Promise<Prisma.BatchPayload>;
-    static getByRecipient(recipient: string, roots: string[], withToken: boolean, chainFilter?: ChainId[]): Promise<({
+    static getByRecipient(recipient: string, roots: string[], withToken: boolean, withTestTokens: boolean, chainFilter?: ChainId[]): Promise<({
         RewardToken: {
             symbol: string;
             name: string | null;

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

@@ -52,14 +52,19 @@ export class RewardRepository {
             data: breakdownsToCreate,
         });
     }
-    static async getByRecipient(recipient, roots, withToken, chainFilter) {
+    static async getByRecipient(recipient, roots, withToken, withTestTokens, chainFilter) {
         return await apiDbClient.reward.findMany({
             where: {
                 root: {
                     in: roots,
                 },
                 recipient,
-                ...(!!chainFilter?.length ? { RewardToken: { chainId: { in: chainFilter } } } : undefined),
+                RewardToken: !!chainFilter?.length || !withTestTokens
+                    ? {
+                        chainId: !!chainFilter?.length ? { in: chainFilter } : undefined,
+                        isTest: withTestTokens ? undefined : false,
+                    }
+                    : undefined,
             },
             include: {
                 Breakdown: {

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

@@ -158,7 +158,7 @@ export declare abstract class RewardService {
         proofs: string[];
     }[];
     static createManyBreakdown(data: CreateManyBreakdownModel): Promise<import("../../../../database/api/.generated").Prisma.BatchPayload | undefined>;
-    static getByRecipient(recipient: string, roots: string[], withToken?: boolean, chainFilter?: ChainId[]): Promise<({
+    static getByRecipient(recipient: string, roots: string[], withToken?: boolean, withTestTokens?: boolean, chainFilter?: ChainId[]): Promise<({
         RewardToken: {
             symbol: string;
             name: string | null;
@@ -543,7 +543,7 @@ export declare abstract class RewardService {
         root: string;
         proofs: string[];
     })[]>;
-    static getUserRewardsByChain(user: string, withToken: boolean, chainFilter?: ChainId[], connectedChainId?: MerklChainId | null): Promise<{
+    static getUserRewardsByChain(user: string, withToken: boolean, chainFilter?: ChainId[], connectedChainId?: MerklChainId | null, withTestTokens?: boolean): Promise<{
         chain: Chain;
         rewards: Awaited<ReturnType<(typeof RewardService)["format"]>>;
     }[]>;

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

@@ -83,8 +83,8 @@ export class RewardService {
             log.error(`createManyBreakdown - error creating many breakdowns for campaigns ${foundCampaigns.join(", ")}`, e);
         }
     }
-    static async getByRecipient(recipient, roots, withToken = false, chainFilter) {
-        return RewardRepository.getByRecipient(recipient, roots, withToken, chainFilter);
+    static async getByRecipient(recipient, roots, withToken = false, withTestTokens = false, chainFilter) {
+        return RewardRepository.getByRecipient(recipient, roots, withToken, withTestTokens, chainFilter);
     }
     /**
      * Groups a breakdown array by their corresponding opportunities
@@ -172,7 +172,7 @@ export class RewardService {
         }
         return rewards;
     }
-    static async getUserRewardsByChain(user, withToken, chainFilter = [], connectedChainId = null) {
+    static async getUserRewardsByChain(user, withToken, chainFilter = [], connectedChainId = null, withTestTokens = false) {
         const chains = await ChainService.findMany();
         let chainIds = !chainFilter || !chainFilter.length
             ? chains.map(({ id }) => id)
@@ -190,7 +190,7 @@ export class RewardService {
             .filter(({ status }) => status === "fulfilled")
             .map(x => x.value);
         /** Load rewards from api DB */
-        const rewards = (await RewardService.getByRecipient(user, merkleRoots.map(({ live }) => live), withToken)).filter(reward => chainIds.includes(reward.RewardToken.chainId));
+        const rewards = (await RewardService.getByRecipient(user, merkleRoots.map(({ live }) => live), withToken, withTestTokens)).filter(reward => chainIds.includes(reward.RewardToken.chainId));
         const promises = [];
         for (const [index, chainId] of chainIds.entries()) {
             const chain = chains.find(chain => chain.id === chainId);

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

@@ -1702,6 +1702,7 @@ export declare const v4: Elysia<"/v4", false, {
                                 address: string;
                             };
                             query: {
+                                test?: boolean | undefined;
                                 chainIds?: number[] | undefined;
                                 reloadChainId?: number | undefined;
                             };
@@ -1818,6 +1819,7 @@ export declare const v4: Elysia<"/v4", false, {
                             address: string;
                         };
                         query: {
+                            test?: boolean | undefined;
                             reloadChainId?: number | undefined;
                             chainId: number[];
                         };

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

@@ -83,6 +83,7 @@ export declare const UserController: Elysia<"/users", false, {
                             address: string;
                         };
                         query: {
+                            test?: boolean | undefined;
                             chainIds?: number[] | undefined;
                             reloadChainId?: number | undefined;
                         };
@@ -199,6 +200,7 @@ export declare const UserController: Elysia<"/users", false, {
                         address: string;
                     };
                     query: {
+                        test?: boolean | undefined;
                         reloadChainId?: number | undefined;
                         chainId: number[];
                     };

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

@@ -18,7 +18,7 @@ export const UserController = new Elysia({ prefix: "/users", detail: { tags: ["U
 })
     // ─── Get User's Rewards With Breakdown And Details for our FE ────────
     .get("/:address/rewards/breakdowns", async ({ params, query }) => {
-    const rewardsByChain = await RewardService.getUserRewardsByChain(params.address, true, query?.chainIds, query.reloadChainId ?? null);
+    const rewardsByChain = await RewardService.getUserRewardsByChain(params.address, true, query?.chainIds, query.reloadChainId ?? null, !!query.test ? query.test : false);
     return RewardService.splitRewardsBreakdownByOpportunity(rewardsByChain);
 }, {
     params: UserUniqueDto,
@@ -35,7 +35,7 @@ export const UserController = new Elysia({ prefix: "/users", detail: { tags: ["U
 })
     // ─── Get User's Rewards With Breakdown ──────────────────────────────
     .get("/:address/rewards", async ({ params, query }) => {
-    const rewardsByChain = await RewardService.getUserRewardsByChain(params.address, false, typeof query.chainId === "number" ? [query.chainId] : query.chainId, !!query.reloadChainId ? query.reloadChainId : null);
+    const rewardsByChain = await RewardService.getUserRewardsByChain(params.address, false, typeof query.chainId === "number" ? [query.chainId] : query.chainId, !!query.reloadChainId ? query.reloadChainId : null, !!query.test ? query.test : false);
     return RewardService.removeOpportunityFromRewardBreakdown(rewardsByChain);
 }, {
     params: UserUniqueDto,

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

@@ -8,6 +8,7 @@ export type User = Resource<"User">;
 export declare const UserRewardRouteDto: import("@sinclair/typebox").TObject<{
     chainId: import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>]>, number[]>;
     reloadChainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    test: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
 }>;
 export declare const UserRewardsResourceDto: import("@sinclair/typebox").TObject<{
     chain: import("@sinclair/typebox").TObject<{
@@ -45,6 +46,7 @@ export declare const UserUniqueDto: import("@sinclair/typebox").TObject<{
 export declare const OptionalChainIdDto: import("@sinclair/typebox").TObject<{
     chainIds: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TTransform<import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TArray<import("@sinclair/typebox").TNumber>]>, number[]>>;
     reloadChainId: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TNumber>;
+    test: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TBoolean>;
 }>;
 export declare const UserDto: import("@sinclair/typebox").TObject<{
     address: import("@sinclair/typebox").TString;

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

@@ -9,6 +9,7 @@ export const UserRewardRouteDto = t.Object({
     reloadChainId: t.Optional(t.Numeric({
         description: "An optional chainId to bypass the cache and check if there was very recently a claim on this chain",
     })),
+    test: t.Optional(t.Boolean({ description: "Include test token rewards" })),
 }, {
     description: "A required comma separated list of chain ids.<br>You can get the list of all supported chains by calling [GET /v4/chains](#tag/chains/GET/v4/chains/)",
 });
@@ -47,6 +48,7 @@ export const OptionalChainIdDto = t.Object({
         .Decode(value => (typeof value === "string" ? value.split(",").map(v => Number.parseInt(v)) : value))
         .Encode(value => [...value])),
     reloadChainId: t.Optional(t.Numeric()),
+    test: t.Optional(t.Boolean({ description: "Include test token rewards" })),
 });
 export const UserDto = t.Object({
     address: t.String(),

package/dist/src/utils/generateCardName.js

@@ -42,7 +42,7 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""]) {
             return `Lend ${cardToken} on ${typeInfo.protocol}`;
         }
         case tokenType.rfx:
-            return `Supply ${typeInfo.symbolShortToken}/${typeInfo.symbolLongToken} on ${typeInfo.protocol}`;
+            return `${typeInfo.protocol} ${typeInfo.symbolShortToken}/${typeInfo.symbolLongToken}`;
         case tokenType.radiant_borrow:
         case tokenType.aave_borrowing:
         case tokenType.yei_borrowing:
@@ -87,7 +87,7 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""]) {
         case tokenType.ironcladStaking:
             return `Stake ${campaign.campaignParameters.symbolTargetToken} on ${typeInfo.protocol}`;
         case tokenType.woofi:
-            return `Supercharge ${typeInfo.symbolUnderlying} on ${typeInfo.protocol}`;
+            return `Supercharge ${typeInfo.symbolUnderlyingToken} on ${typeInfo.protocol}`;
         case tokenType.maverickBoostedPosition:
             return `Maverick Boosted Position ${campaign.campaignParameters.symbolTargetToken}`;
         case tokenType.zkSwapThreePool: