@merkl/api 0.16.46 → 0.17.0

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

@@ -386,6 +386,7 @@ declare const eden: {
             };
             patch: (body: {
                 name?: string | undefined;
+                status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
                 tags?: string[] | undefined;
             }, options: {
                 headers: {
@@ -3668,6 +3669,7 @@ declare const eden: {
             };
             patch: (body: {
                 name?: string | undefined;
+                status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
                 tags?: string[] | undefined;
             }, options: {
                 headers: {
@@ -8242,6 +8244,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
                 patch: {
                     body: {
                         name?: string | undefined;
+                        status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
                         tags?: string[] | undefined;
                     };
                     params: {
@@ -12514,6 +12517,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
             };
             patch: (body: {
                 name?: string | undefined;
+                status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
                 tags?: string[] | undefined;
             }, options: {
                 headers: {
@@ -15796,6 +15800,7 @@ export declare const MerklApi: (domain: string | import("elysia").default<"", fa
             };
             patch: (body: {
                 name?: string | undefined;
+                status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
                 tags?: string[] | undefined;
             }, options: {
                 headers: {

package/dist/src/index.d.ts

@@ -1009,6 +1009,7 @@ declare const app: Elysia<"", false, {
                 patch: {
                     body: {
                         name?: string | undefined;
+                        status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
                         tags?: string[] | undefined;
                     };
                     params: {

package/dist/src/jobs/etl/update-dynamic-data.js

@@ -6,22 +6,60 @@ import { OpportunityRepository } from "../../modules/v4/opportunity/opportunity.
 import { RewardService } from "../../modules/v4/reward";
 import { TvlService } from "../../modules/v4/tvl";
 import { executeSimple } from "../../utils/execute";
-import { Campaign } from "@sdk";
+import { Campaign as CampaignTypesEnum } from "@sdk";
+import moment from "moment";
+// ─── Required Env Variables ──────────────────────────────────────────────────
 const chainId = Number(process.env.CHAIN_ID);
 if (!chainId)
     throw new Error("Environment variable CHAIN_ID is required.");
-const campaignType = process.env.CAMPAIGN_TYPE;
-if (!campaignType)
-    throw new Error("Environment variable CAMPAIGN_TYPE is required.");
-async function updateDynamicData() {
-    const liveCampaigns = (await CampaignService.getLiveCampaigns({ computeChainId: chainId, type: campaignType })).map(c => {
+// ─── Update Dynamic Data (APR / TVL / Daily Rewards) ─────────────────────────
+async function updateDynamicData(liveCampaigns, campaignType) {
+    try {
+        const dynamicData = await executeSimple(chainId, campaignsDynamicData(chainId, liveCampaigns, campaignType));
+        const oppMap = {};
+        for (const data of dynamicData) {
+            if (!!data) {
+                // Main Parameter OVERRIDING
+                if (data.campaignType === CampaignTypesEnum.SILO && data.campaignParameters.whitelist?.length === 1)
+                    data.mainParameter = `${data.mainParameter}-${data.campaignParameters.whitelist[0]}`;
+                if (!oppMap[`${data.campaignType}_${data.mainParameter}`])
+                    oppMap[`${data.campaignType}_${data.mainParameter}`] = {};
+                oppMap[`${data.campaignType}_${data.mainParameter}`][data.campaignId] = data;
+            }
+        }
+        for (const entry of Object.entries(oppMap)) {
+            const [type, mainParameter] = entry[0].split("_");
+            try {
+                const apr = AprService.extractFromDynamicData(+type, Object.values(entry[1]));
+                const tvl = TvlService.extractFromDynamicData(+type, Object.values(entry[1]));
+                const dailyRewards = await RewardService.extractDailyRewardsRecordFromDynamicData(+type, Object.values(entry[1]));
+                const opportunityId = OpportunityService.hashId({
+                    chainId,
+                    identifier: mainParameter,
+                    type: type,
+                });
+                await OpportunityRepository.updateRecords(opportunityId, apr, tvl, dailyRewards);
+            }
+            catch (err) {
+                console.log(mainParameter);
+                console.error(err);
+            }
+        }
+    }
+    catch (err) {
+        console.error(err);
+    }
+}
+// ─── Get And Transform Live Campaigns Into A Map ─────────────────────────────
+const getLiveCampaignsByType = async (chainId) => {
+    const liveCampaigns = (await CampaignService.getLiveCampaigns({ computeChainId: chainId })).map(c => {
         return {
             amount: c.amount,
             campaignId: c.campaignId,
             mainParameter: c.Opportunity.identifier,
             campaignParameters: c.params,
             campaignSubType: c.subType,
-            campaignType,
+            campaignType: c.type,
             chainId: c.distributionChainId,
             computeChainId: c.computeChainId,
             creator: c.creatorAddress,
@@ -30,42 +68,59 @@ async function updateDynamicData() {
             startTimestamp: c.startTimestamp,
         };
     });
-    const dynamicData = await executeSimple(chainId, campaignsDynamicData(chainId, liveCampaigns, campaignType));
-    const oppMap = {};
-    for (const data of dynamicData) {
-        if (!!data) {
-            // Main Parameter OVERRIDING
-            if (data.campaignType === Campaign.SILO && data.campaignParameters.whitelist?.length === 1)
-                data.mainParameter = `${data.mainParameter}-${data.campaignParameters.whitelist[0]}`;
-            if (!oppMap[`${data.campaignType}_${data.mainParameter}`])
-                oppMap[`${data.campaignType}_${data.mainParameter}`] = {};
-            oppMap[`${data.campaignType}_${data.mainParameter}`][data.campaignId] = data;
-        }
+    const campaignTypeToCampaigns = new Map();
+    for (const campaign of liveCampaigns) {
+        const type = campaign.campaignType;
+        let campaigns = campaignTypeToCampaigns.get(campaign.campaignType);
+        if (!campaigns)
+            campaigns = [campaign];
+        else
+            campaigns.push(campaign);
+        campaignTypeToCampaigns.set(type, campaigns);
     }
-    for (const entry of Object.entries(oppMap)) {
-        const [type, mainParameter] = entry[0].split("_");
-        try {
-            const apr = AprService.extractFromDynamicData(+type, Object.values(entry[1]));
-            const tvl = TvlService.extractFromDynamicData(+type, Object.values(entry[1]));
-            const dailyRewards = await RewardService.extractDailyRewardsRecordFromDynamicData(+type, Object.values(entry[1]));
-            const opportunityId = OpportunityService.hashId({
-                chainId,
-                identifier: mainParameter,
-                type: type,
-            });
-            await OpportunityRepository.updateRecords(opportunityId, apr, tvl, dailyRewards);
+    return campaignTypeToCampaigns;
+};
+// ─── Main function / entry point ─────────────────────────────────────────────
+const main = async () => {
+    try {
+        // 1. Get a map of campaigns by campaign type
+        const liveCampaigns = await getLiveCampaignsByType(chainId);
+        // 2. Call updateDynamicData with each entries of the map (process by campaign type)
+        for (const [type, campaigns] of liveCampaigns.entries())
+            await updateDynamicData(campaigns, type);
+        // 3. Update status of opportunities
+        // 3.1 Get current live opportunities
+        const liveOpportunities = await OpportunityService.findLiveWithCampaigns(chainId);
+        // 3.2 For each currently live opportunities, infer its updated status by looping through its campaigns
+        const now = moment().unix();
+        for (const opportunity of liveOpportunities) {
+            let status = "NONE";
+            const campaigns = opportunity.campaigns;
+            for (const campaign of campaigns) {
+                if (status !== "LIVE" && campaign.endTimestamp < now)
+                    status = "PAST";
+                else if (campaign.startTimestamp < now && campaign.endTimestamp > now)
+                    status = "LIVE";
+                else if (status !== "LIVE" && campaign.startTimestamp > now)
+                    status = "SOON";
+            }
+            await OpportunityService.updateStatus(opportunity.id, status);
         }
-        catch (err) {
-            console.log(mainParameter);
-            console.error(err);
+        // 4. Compute the opportunity ids of the liveCampaigns
+        const opportunities = new Set();
+        for (const [type, campaigns] of liveCampaigns.entries()) {
+            for (const campaign of campaigns) {
+                const opportunityId = OpportunityService.hashId({ chainId, identifier: campaign.mainParameter, type });
+                opportunities.add(opportunityId);
+            }
         }
+        // 5. Update the status of the liveCampaigns opportunities
+        await OpportunityService.updateMany(Array.from(opportunities), { status: "LIVE" });
+        process.exit(0);
     }
-}
-try {
-    await updateDynamicData();
-    process.exit(0);
-}
-catch (err) {
-    console.error(err);
-    process.exit(1);
-}
+    catch (err) {
+        console.error(err);
+        process.exit(1);
+    }
+};
+await main();

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

@@ -17,7 +17,7 @@ export class LiquidityService {
         [Campaign.DOLOMITE]: new DolomitePositionFetcher(),
     };
     static async fetchPositions(query) {
-        const opportunities = await OpportunityService.findLiveWithFirstCampaign(query.chainId);
+        const opportunities = await OpportunityService.findLiveWithCampaigns(query.chainId, 1);
         const promises = [];
         for (const campaignType of Object.keys(Campaign)) {
             const fetcher = LiquidityService.#fetchers[Number.parseInt(campaignType)];

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

@@ -864,6 +864,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
             patch: {
                 body: {
                     name?: string | undefined;
+                    status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
                     tags?: string[] | undefined;
                 };
                 params: {

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

@@ -340,6 +340,12 @@ export declare const OpportunityIdDto: import("@sinclair/typebox").TObject<{
 export declare const UpdateOpportunityDto: import("@sinclair/typebox").TObject<{
     name: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TString>;
     tags: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TArray<import("@sinclair/typebox").TString>>;
+    status: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TEnum<{
+        NONE: "NONE";
+        PAST: "PAST";
+        LIVE: "LIVE";
+        SOON: "SOON";
+    }>>;
 }>;
 export type GetOpportunitiesQueryModel = typeof GetOpportunitiesQueryDto.static;
 export type GetOpportunityQueryModel = typeof GetOpportunityQueryDto.static;

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

@@ -103,4 +103,5 @@ export const OpportunityIdDto = t.Object({ id: t.String() });
 export const UpdateOpportunityDto = t.Object({
     name: t.Optional(t.String()),
     tags: t.Optional(t.Array(t.String())),
+    status: t.Optional(t.Enum(Status)),
 });

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

@@ -628,7 +628,7 @@ export declare abstract class OpportunityRepository {
         apr: number;
         dailyRewards: number;
     })[]>;
-    static findLiveWithFirstCampaign(chainId: MerklChainId): Promise<({
+    static findLiveWithCampaigns(chainId: MerklChainId, take?: number): Promise<({
         Chain: {
             name: string;
             id: number;
@@ -936,4 +936,5 @@ export declare abstract class OpportunityRepository {
         apr: number;
         dailyRewards: number;
     }>;
+    static updateMany(ids: string[], data: UpdateOpportunityModel): Promise<import("database/api/.generated/runtime/library").GetBatchResult>;
 }

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

@@ -257,7 +257,7 @@ export class OpportunityRepository {
             ...args,
         });
     }
-    static async findLiveWithFirstCampaign(chainId) {
+    static async findLiveWithCampaigns(chainId, take) {
         const now = moment().unix();
         return await apiDbClient.opportunity.findMany({
             include: {
@@ -274,7 +274,7 @@ export class OpportunityRepository {
                         CampaignStatus: true,
                         Creator: true,
                     },
-                    take: 1,
+                    take: take ? take : undefined,
                     orderBy: { endTimestamp: "desc" },
                 },
                 MainProtocol: true,
@@ -406,4 +406,7 @@ export class OpportunityRepository {
     static async update(id, data) {
         return await apiDbClient.opportunity.update({ where: { id }, data });
     }
+    static async updateMany(ids, data) {
+        return await apiDbClient.opportunity.updateMany({ where: { id: { in: ids } }, data });
+    }
 }

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

@@ -1,5 +1,5 @@
 import { type CreateCampaignModel, type GetCampaignQueryModel } from "../campaign";
-import { Prisma } from "../../../../database/api/.generated";
+import { Prisma, Status } from "../../../../database/api/.generated";
 import { type ChainId, type MerklChainId } from "@sdk";
 import type { CreateOpportunityModel, GetOpportunitiesQueryModel, LightOpportunityFromDB, OpportunityResourceModel, OpportunityUnique, UpdateOpportunityModel } from "./opportunity.model";
 import { OpportunityRepository } from "./opportunity.repository";
@@ -63,6 +63,21 @@ export declare abstract class OpportunityService {
         depositUrl: any;
         tags: string[];
     }>;
+    static updateStatus(opportunityId: string, status: Status): Promise<{
+        name: string;
+        type: string;
+        id: string;
+        status: import("../../../../database/api/.generated").$Enums.Status;
+        tags: string[];
+        identifier: string;
+        chainId: number;
+        action: import("../../../../database/api/.generated").$Enums.OpportunityAction;
+        depositUrl: string | null;
+        mainProtocolId: string | null;
+        tvl: number;
+        apr: number;
+        dailyRewards: number;
+    }>;
     static updateStatusFromCampaign(campaign: Omit<CreateCampaignModel, "id">, upsert?: boolean): Promise<{
         id: string;
         chainId: number;
@@ -535,7 +550,7 @@ export declare abstract class OpportunityService {
      * @returns the number of opportunities
      */
     static countMany(query: GetOpportunitiesQueryModel): Promise<number>;
-    static findLiveWithFirstCampaign(chainId: MerklChainId): Promise<{
+    static findLiveWithCampaigns(chainId: MerklChainId, take?: number): Promise<{
         apr: number;
         aprRecord: {
             cumulated: number;
@@ -882,4 +897,5 @@ export declare abstract class OpportunityService {
         apr: number;
         dailyRewards: number;
     }>;
+    static updateMany(ids: string[], data: UpdateOpportunityModel): Promise<import("database/api/.generated/runtime/library").GetBatchResult>;
 }

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

@@ -28,7 +28,7 @@ import { getMorphoMetadata } from "./subservices/getMorphoMetadata.service";
 import { getRadiantMetadata } from "./subservices/getRadiantMetadata.service";
 import { getSiloMetadata } from "./subservices/getSiloMetadata.service";
 import { getUniswapV4Metadata } from "./subservices/getUniswapV4Metadata.service";
-import { getVestMetadata } from "./subservices/getVestMetadata.service";
+import { getVestMetadata } from "./subservices/getVestMetaData.service";
 export class OpportunityService {
     static hashId(opportunity) {
         return Bun.hash(`${opportunity.chainId}${opportunity.type}${opportunity.identifier}`).toString();
@@ -165,6 +165,9 @@ export class OpportunityService {
         await OpportunityRepository.create(opportunity, upsert);
         return opportunity;
     }
+    static async updateStatus(opportunityId, status) {
+        return await OpportunityRepository.update(opportunityId, { status });
+    }
     static async updateStatusFromCampaign(campaign, upsert = true) {
         const campaignType = CampaignService.getTypeFromV3(campaign.type);
         const metadata = await OpportunityService.#getMetadata(campaign);
@@ -283,10 +286,10 @@ export class OpportunityService {
     static async countMany(query) {
         return await OpportunityRepository.countMany(query);
     }
-    static async findLiveWithFirstCampaign(chainId) {
+    static async findLiveWithCampaigns(chainId, take) {
         return record("data-layer.access", async () => {
             return await CacheService.wrap(TTLPresets.MIN_10, async (chainId) => {
-                const opportunities = await OpportunityRepository.findLiveWithFirstCampaign(chainId);
+                const opportunities = await OpportunityRepository.findLiveWithCampaigns(chainId, take);
                 return opportunities.map(o => {
                     return OpportunityService.formatResponse(o);
                 });
@@ -365,4 +368,7 @@ export class OpportunityService {
     static async update(id, data) {
         return await OpportunityRepository.update(id, data);
     }
+    static async updateMany(ids, data) {
+        return await OpportunityRepository.updateMany(ids, data);
+    }
 }

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

@@ -879,6 +879,7 @@ export declare const v4: Elysia<"/v4", false, {
                 patch: {
                     body: {
                         name?: string | undefined;
+                        status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
                         tags?: string[] | undefined;
                     };
                     params: {

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

@@ -7,7 +7,7 @@ import { ChainDto } from "../accounting";
 import { CreateTokenDto, FindUniqueTokenAllowanceDto, FindUniqueTokenDto, GetTokenBalanceDto, GetTokenQueryDto, NotionWebhookDto, TokenIdDto, UpdateTokenDto, } from "./token.model";
 import { TokenService } from "./token.service";
 // ─── Tokens Controller ───────────────────────────────────────────────────────
-export const TokenController = new Elysia({ prefix: "/tokens", detail: { tags: ["Tokens"], hide: true } })
+export const TokenController = new Elysia({ prefix: "/tokens", detail: { tags: ["Tokens"] } })
     // ─── Get A Token By Id ───────────────────────────────────────────────
     .get("/:id", async ({ params }) => {
     try {
@@ -18,7 +18,12 @@ export const TokenController = new Elysia({ prefix: "/tokens", detail: { tags: [
         if (err.code && err.code === "P2025")
             throw new NotFoundError();
     }
-}, { params: FindUniqueTokenDto })
+}, {
+    params: FindUniqueTokenDto,
+    detail: {
+        hide: true,
+    },
+})
     .get("/:id/allowance/:owner/:spender", async ({ params: { id, owner, spender } }) => {
     try {
         const [chainId, address] = id.split("-");
@@ -30,11 +35,19 @@ export const TokenController = new Elysia({ prefix: "/tokens", detail: { tags: [
         if (err.code && err.code === "P2025")
             throw new NotFoundError();
     }
-}, { params: FindUniqueTokenAllowanceDto })
+}, {
+    params: FindUniqueTokenAllowanceDto,
+    detail: {
+        hide: true,
+    },
+})
     // ─── Get Valid Reward Token ───────────────────────────────────────────
     .get("/reward/:chainId", async ({ params }) => TokenService.getValidRewardTokens(params.chainId), {
     params: ChainDto,
     beforeHandle: ({ params }) => throwOnUnsupportedChainId(params.chainId),
+    detail: {
+        description: "Get the list of tokens that are accept as reward tokens on a given chain",
+    },
 })
     // ─── Get Tokens With Balances ────────────────────────────────────────
     .get("/balances", async ({ query: { chainId, userAddress, tokenAddress, additionalTokenAddresses } }) => {
@@ -43,11 +56,24 @@ export const TokenController = new Elysia({ prefix: "/tokens", detail: { tags: [
     return await TokenService.fetchVerifiedBalances(chainId, userAddress, additionalTokenAddresses);
 }, {
     query: GetTokenBalanceDto,
+    detail: {
+        hide: true,
+    },
 })
     // ─── Get Many Tokens ─────────────────────────────────────────────────
-    .get("/", async ({ query }) => await TokenService.findMany(query), { query: GetTokenQueryDto })
+    .get("/", async ({ query }) => await TokenService.findMany(query), {
+    query: GetTokenQueryDto,
+    detail: {
+        hide: true,
+    },
+})
     // ─── Count Tokens ────────────────────────────────────────────────────
-    .get("/count", async ({ query }) => await TokenService.countMany(query), { query: GetTokenQueryDto })
+    .get("/count", async ({ query }) => await TokenService.countMany(query), {
+    query: GetTokenQueryDto,
+    detail: {
+        hide: true,
+    },
+})
     // ─── Update IsTest Status ────────────────────────────────────────────
     .post("/", async ({ body }) => await TokenService.fillAndCreate(body), {
     body: CreateTokenDto,