@merkl/api 0.21.4 → 0.21.5

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

@@ -457,7 +457,7 @@ export declare const CampaignController: Elysia<"/campaigns", false, {
         };
     } & {
         ":id": {
-            timeseries: {
+            metrics: {
                 get: {
                     body: unknown;
                     params: {
@@ -473,8 +473,17 @@ export declare const CampaignController: Elysia<"/campaigns", false, {
                             }[];
                             aprRecords: {
                                 timestamp: bigint;
-                                cumulated: number;
+                                apr: number;
                             }[];
+                            dailyRewardsRecords: {
+                                total: number;
+                                timestamp: bigint;
+                            }[];
+                            walletCount: {
+                                timestamp: bigint;
+                                walletCount: number;
+                            }[];
+                            tvlInflowPerDollar: bigint;
                         };
                     };
                 };

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

@@ -100,11 +100,11 @@ export const CampaignController = new Elysia({ prefix: "/campaigns", detail: { t
       <p>This endpoint enables you to retrieve a campaign by providing its unique identifier.</p>`,
     },
 })
-    .get("/:id/timeseries", async ({ params }) => {
+    .get("/:id/metrics", async ({ params }) => {
     if (!params.id.includes("-"))
-        return await CampaignService.getTimeSeries(params.id);
+        return await CampaignService.getMetrics(params.id);
     const [distributionChain, campaignId] = params.id.split("-");
-    return await CampaignService.getTimeSeries({ distributionChain: +distributionChain, campaignId });
+    return await CampaignService.getMetrics({ distributionChain: +distributionChain, campaignId });
 })
     .group("/campaigns-to-process", app => {
     return (app

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

@@ -1,4 +1,4 @@
-import type { CampaignUnique, CampaignWithParams, GetCampaignQueryModel } from "@/modules/v4/campaign/campaign.model";
+import type { Campaign, CampaignUnique, CampaignWithParams, GetCampaignQueryModel } from "@/modules/v4/campaign/campaign.model";
 import { type CampaignManualOverride, Prisma } from "@db/api";
 import { type ChainId } from "@sdk";
 export declare abstract class CampaignRepository {
@@ -333,6 +333,8 @@ export declare abstract class CampaignRepository {
     static getPastCampaigns(query?: {
         computeChainId?: number;
         type?: string;
+        creatorId?: string;
+        creatorAddress?: string;
     }): Promise<({
         Opportunity: {
             status: import("@db/api").$Enums.Status;
@@ -386,6 +388,8 @@ export declare abstract class CampaignRepository {
     static getFutureCampaigns(query?: {
         computeChainId?: number;
         type?: string;
+        creatorId?: string;
+        creatorAddress?: string;
     }): Promise<({
         Opportunity: {
             status: import("@db/api").$Enums.Status;
@@ -440,6 +444,8 @@ export declare abstract class CampaignRepository {
         distributionChainId?: number;
         computeChainId?: number;
         type?: string;
+        creatorId?: string;
+        creatorAddress?: string;
     }): Promise<({
         RewardToken: {
             symbol: string;
@@ -477,6 +483,28 @@ export declare abstract class CampaignRepository {
             dailyRewards: number;
             lastCampaignCreatedAt: Date;
         };
+        RewardBreakdown: ({
+            Reward: {
+                pending: string;
+                id: string;
+                rewardTokenId: string;
+                amount: string;
+                root: string;
+                recipient: string;
+                claimed: string;
+                proofs: string[];
+            };
+        } & {
+            reason: string;
+            pending: string;
+            id: string;
+            campaignId: string;
+            amount: string;
+            claimed: string;
+            protocolId: string | null;
+            rewardId: string;
+            subCampaignId: string | null;
+        })[];
     } & {
         type: string;
         description: string | null;
@@ -831,12 +859,25 @@ export declare abstract class CampaignRepository {
         total: number;
         timestamp: bigint;
     }[]>;
-    static getAprRecords(campaign: {
+    static getAprRecords(campaign: Campaign["raw"]): Promise<{
+        timestamp: bigint;
+        apr: number;
+    }[]>;
+    static getDailyRewardsRecords(campaign: {
+        opportunityId: string;
+        startTimestamp: bigint;
+        endTimestamp: bigint;
+    }): Promise<{
+        total: number;
+        timestamp: bigint;
+    }[]>;
+    static getWalletCountOverTime(campaign: {
+        id: string;
         opportunityId: string;
         startTimestamp: bigint;
         endTimestamp: bigint;
     }): Promise<{
         timestamp: bigint;
-        cumulated: number;
+        walletCount: number;
     }[]>;
 }

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

@@ -148,6 +148,7 @@ export class CampaignRepository {
             include: {
                 Opportunity: true,
                 RewardToken: true,
+                RewardBreakdown: { include: { Reward: true } },
             },
         });
     }
@@ -466,12 +467,55 @@ export class CampaignRepository {
         });
     }
     static async getAprRecords(campaign) {
-        return await apiDbClient.aprRecord.findMany({
+        return (await apiDbClient.aprRecord.findMany({
             where: {
                 opportunityId: campaign.opportunityId,
                 timestamp: { gte: campaign.startTimestamp, lte: campaign.endTimestamp },
             },
-            select: { timestamp: true, cumulated: true },
+            select: {
+                timestamp: true,
+                AprBreakdown: {
+                    select: {
+                        value: true,
+                    },
+                    where: { type: "CAMPAIGN", identifier: campaign.campaignId },
+                },
+            },
+        })).map(record => ({
+            timestamp: record.timestamp,
+            apr: record.AprBreakdown[0]?.value,
+        }));
+    }
+    static async getDailyRewardsRecords(campaign) {
+        return await apiDbClient.dailyRewardsRecord.findMany({
+            where: {
+                opportunityId: campaign.opportunityId,
+                timestamp: { gte: campaign.startTimestamp, lte: campaign.endTimestamp },
+            },
+            select: { timestamp: true, total: true },
         });
     }
+    static async getWalletCountOverTime(campaign) {
+        const rewardBreakdowns = await apiDbClient.rewardBreakdown.findMany({
+            where: {
+                campaignId: campaign.id,
+                Reward: {
+                    MerklRoot: { timestamp: { gte: campaign.startTimestamp, lte: campaign.endTimestamp } },
+                },
+            },
+            select: { Reward: { select: { recipient: true, MerklRoot: { select: { timestamp: true } } } } },
+        });
+        const walletCounts = {};
+        for (const { Reward } of rewardBreakdowns) {
+            const timestampKey = Reward.MerklRoot.timestamp.toString();
+            if (!walletCounts[timestampKey]) {
+                walletCounts[timestampKey] = new Set();
+            }
+            walletCounts[timestampKey].add(Reward.recipient);
+        }
+        return Object.entries(walletCounts).map(([timestampKey, recipients]) => ({
+            timestamp: BigInt(timestampKey),
+            walletCount: recipients.size,
+        }));
+    }
 }

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

@@ -9,6 +9,7 @@ export declare abstract class CampaignService {
     static getPastCampaigns(query?: {
         computeChainId?: number;
         type?: string;
+        creatorAddress?: string;
     }): Promise<({
         Opportunity: {
             status: import("@db/api").$Enums.Status;
@@ -54,6 +55,7 @@ export declare abstract class CampaignService {
     static getFutureCampaigns(query?: {
         computeChainId?: number;
         type?: string;
+        creatorAddress?: string;
     }): Promise<({
         Opportunity: {
             status: import("@db/api").$Enums.Status;
@@ -100,6 +102,7 @@ export declare abstract class CampaignService {
         distributionChainId?: number;
         computeChainId?: number;
         type?: string;
+        creatorAddress?: string;
     }): Promise<({
         RewardToken: {
             symbol: string;
@@ -137,6 +140,28 @@ export declare abstract class CampaignService {
             dailyRewards: number;
             lastCampaignCreatedAt: Date;
         };
+        RewardBreakdown: ({
+            Reward: {
+                pending: string;
+                id: string;
+                rewardTokenId: string;
+                amount: string;
+                root: string;
+                recipient: string;
+                claimed: string;
+                proofs: string[];
+            };
+        } & {
+            reason: string;
+            pending: string;
+            id: string;
+            campaignId: string;
+            amount: string;
+            claimed: string;
+            protocolId: string | null;
+            rewardId: string;
+            subCampaignId: string | null;
+        })[];
     } & {
         type: string;
         description: string | null;
@@ -938,14 +963,23 @@ export declare abstract class CampaignService {
         endTimestamp: any;
         params: string;
     };
-    static getTimeSeries(campaignId: CampaignUnique | string): Promise<{
+    static getMetrics(campaignId: CampaignUnique | string): Promise<{
         tvlRecords: {
             total: number;
             timestamp: bigint;
         }[];
         aprRecords: {
             timestamp: bigint;
-            cumulated: number;
+            apr: number;
+        }[];
+        dailyRewardsRecords: {
+            total: number;
+            timestamp: bigint;
+        }[];
+        walletCount: {
+            timestamp: bigint;
+            walletCount: number;
         }[];
+        tvlInflowPerDollar: bigint;
     }>;
 }

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

@@ -40,9 +40,8 @@ export class CampaignService {
         const [rewardToken] = await TokenService.findManyOrCreate([
             { chainId: body.chainId, address: body.rewardTokenAddress },
         ]);
-        if (!rewardToken) {
+        if (!rewardToken)
             throw new Error(`unable to fetch data for token ${body.rewardTokenAddress}`);
-        }
         const chain = await ChainService.findUniqueOrThrow(body.chainId);
         const params = JSON.parse(body.params);
         const campaign = {
@@ -73,8 +72,7 @@ export class CampaignService {
             if (dryRun)
                 return opportunity;
         }
-        catch (e) {
-            console.error(e);
+        catch (_err) {
             throw new CannotParseOpportunity(campaign.campaignId, campaign.distributionChainId, campaign.type);
         }
         return await CampaignRepository.upsert(campaign, body.opportunityIdentifier);
@@ -388,11 +386,25 @@ export class CampaignService {
             params: JSON.stringify(fakeCampaign.campaignParameters),
         };
     }
-    static async getTimeSeries(campaignId) {
+    static async getMetrics(campaignId) {
         const id = typeof campaignId === "string" ? campaignId : CampaignService.hashId(campaignId);
         const campaign = await CampaignRepository.findUniqueOrThrow(id, false);
-        const tvlRecords = await CampaignRepository.getTvlRecords(campaign);
-        const aprRecords = await CampaignRepository.getAprRecords(campaign);
-        return { tvlRecords, aprRecords };
+        const [tvlRecords, aprRecords, dailyRewardsRecords, walletCount] = await Promise.all([
+            CampaignRepository.getTvlRecords(campaign),
+            CampaignRepository.getAprRecords(campaign),
+            CampaignRepository.getDailyRewardsRecords(campaign),
+            CampaignRepository.getWalletCountOverTime(campaign),
+        ]);
+        return {
+            tvlRecords,
+            aprRecords,
+            dailyRewardsRecords,
+            walletCount,
+            tvlInflowPerDollar: tvlRecords.length > 1
+                ? (BigInt(tvlRecords[tvlRecords.length - 1].total) - BigInt(tvlRecords[0].total)) /
+                    ((BigInt(campaign.amount) / BigInt(10 ** campaign.RewardToken.decimals)) *
+                        BigInt(campaign.RewardToken.price ?? 1))
+                : 0n,
+        };
     }
 }

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

@@ -12,12 +12,39 @@ export declare const CreatorController: Elysia<"/creators", false, {
     macro: {};
     macroFn: {};
 }, {
+    creators: {
+        index: {
+            post: {
+                body: {
+                    icon?: string | undefined;
+                    name: string;
+                    id: string;
+                    addresses: string[];
+                };
+                params: {};
+                query: unknown;
+                headers: {
+                    authorization: string;
+                };
+                response: {
+                    200: {
+                        name: string;
+                        id: string;
+                        icon: string | null;
+                        rebateFee: number;
+                    };
+                };
+            };
+        };
+    };
+} & {
     creators: {
         index: {
             get: {
                 body: unknown;
                 params: {};
                 query: {
+                    id?: string | undefined;
                     items?: number | undefined;
                     page?: number | undefined;
                     address?: string | undefined;
@@ -25,12 +52,14 @@ export declare const CreatorController: Elysia<"/creators", false, {
                 headers: unknown;
                 response: {
                     200: ({
+                        Users: {
+                            address: string;
+                        }[];
+                    } & {
                         name: string;
                         id: string;
-                        addresses: string[];
-                    } & {
-                        icon?: string | undefined;
-                        rebateFee?: number | undefined;
+                        icon: string | null;
+                        rebateFee: number;
                     })[];
                 };
             };
@@ -38,21 +67,25 @@ export declare const CreatorController: Elysia<"/creators", false, {
     };
 } & {
     creators: {
-        ":id": {
+        ":address": {
             get: {
                 body: unknown;
                 params: {
-                    id: string;
+                    address: string;
                 };
                 query: unknown;
                 headers: unknown;
                 response: {
                     200: {
+                        Users: {
+                            tags: string[];
+                            address: string;
+                            creatorId: string | null;
+                        }[];
                         name: string;
                         id: string;
-                        addresses: string[];
-                        icon?: string | undefined;
-                        rebateFee?: number | undefined;
+                        icon: string | null;
+                        rebateFee: number;
                     };
                 };
             };
@@ -60,16 +93,16 @@ export declare const CreatorController: Elysia<"/creators", false, {
     };
 } & {
     creators: {
-        index: {
-            post: {
+        ":address": {
+            patch: {
                 body: {
                     icon?: string | undefined;
-                    rebateFee?: number | undefined;
                     name: string;
-                    id: string;
                     addresses: string[];
                 };
-                params: {};
+                params: {
+                    address: string;
+                };
                 query: unknown;
                 headers: {
                     authorization: string;
@@ -87,15 +120,11 @@ export declare const CreatorController: Elysia<"/creators", false, {
     };
 } & {
     creators: {
-        ":id": {
-            patch: {
-                body: {
-                    icon?: string | undefined;
-                    name: string;
-                    addresses: string[];
-                };
+        ":address": {
+            delete: {
+                body: unknown;
                 params: {
-                    id: string;
+                    address: string;
                 };
                 query: unknown;
                 headers: {
@@ -114,25 +143,198 @@ export declare const CreatorController: Elysia<"/creators", false, {
     };
 } & {
     creators: {
-        ":id": {
-            rebate: {
-                patch: {
-                    body: {
-                        rebate: number;
+        ":address": {
+            dashboard: {
+                get: {
+                    body: unknown;
+                    params: {
+                        address: string;
                     };
+                    query: unknown;
+                    headers: unknown;
+                    response: {
+                        200: {
+                            pastCampaigns: number;
+                            liveCampaigns: number;
+                            futureCampaigns: number;
+                            incentivizedTvl: number;
+                            totalCampaigns: number;
+                            creatorId: string | null;
+                        };
+                    };
+                };
+            };
+        };
+    };
+} & {
+    creators: {
+        ":address": {
+            campaigns: {
+                get: {
+                    body: unknown;
+                    params: {
+                        address: string;
+                    };
+                    query: {
+                        status?: "PAST" | "LIVE" | "FUTURE" | undefined;
+                    };
+                    headers: unknown;
+                    response: {
+                        200: ({
+                            Opportunity: {
+                                status: import("@db/api").$Enums.Status;
+                                type: string;
+                                name: string;
+                                description: string;
+                                id: string;
+                                tags: string[];
+                                identifier: string;
+                                action: import("@db/api").$Enums.OpportunityAction;
+                                manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
+                                chainId: number;
+                                howToSteps: string[];
+                                depositUrl: string | null;
+                                explorerAddress: string | null;
+                                mainProtocolId: string | null;
+                                tvl: number;
+                                apr: number;
+                                dailyRewards: number;
+                                lastCampaignCreatedAt: Date;
+                            };
+                        } & {
+                            type: string;
+                            description: string | null;
+                            id: string;
+                            params: import("database/api/.generated/runtime/library").JsonValue;
+                            subType: number | null;
+                            computeChainId: number;
+                            distributionChainId: number;
+                            campaignId: string;
+                            distributionType: import("@db/api").$Enums.DistributionType;
+                            rewardTokenId: string;
+                            amount: string;
+                            opportunityId: string;
+                            startTimestamp: bigint;
+                            endTimestamp: bigint;
+                            creatorAddress: string;
+                            manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+                            createdAt: Date;
+                            rootCampaignId: string | null;
+                            parentCampaignId: string | null;
+                        })[] | {
+                            params: any;
+                            chain: {
+                                name: string;
+                                id: number;
+                                icon: string;
+                            };
+                            endTimestamp: number;
+                            startTimestamp: number;
+                            rewardToken: {
+                                symbol: string;
+                                name: string | null;
+                                id: string;
+                                icon: string;
+                                address: string;
+                                chainId: number;
+                                decimals: number;
+                                verified: boolean;
+                                isTest: boolean;
+                                isPoint: boolean;
+                                isPreTGE: boolean;
+                                isNative: boolean;
+                            } & {
+                                price?: number | null | undefined;
+                            };
+                            distributionChain: {
+                                name: string;
+                                id: number;
+                                icon: string;
+                            } | undefined;
+                            campaignStatus: {
+                                computedUntil: number;
+                                processingStarted: number;
+                                status: import("@db/api").$Enums.RunStatus;
+                                error: string;
+                                details: import("database/api/.generated/runtime/library").JsonValue;
+                                campaignId: string;
+                            } | undefined;
+                            creatorAddress: string;
+                            creator: {
+                                tags: string[];
+                                address: string;
+                                creatorId: string | null;
+                            };
+                            createdAt: string;
+                            description: string | undefined;
+                            parentCampaignId: string | undefined;
+                            rootCampaignId: string | undefined;
+                            Opportunity: {
+                                status: import("@db/api").$Enums.Status;
+                                type: string;
+                                name: string;
+                                description: string;
+                                id: string;
+                                tags: string[];
+                                identifier: string;
+                                action: import("@db/api").$Enums.OpportunityAction;
+                                manualOverrides: import("@db/api").$Enums.OpportunityManualOverride[];
+                                chainId: number;
+                                howToSteps: string[];
+                                depositUrl: string | null;
+                                explorerAddress: string | null;
+                                mainProtocolId: string | null;
+                                tvl: number;
+                                apr: number;
+                                dailyRewards: number;
+                                lastCampaignCreatedAt: Date;
+                            };
+                            type: string;
+                            id: string;
+                            subType: number | null;
+                            computeChainId: number;
+                            distributionChainId: number;
+                            campaignId: string;
+                            distributionType: import("@db/api").$Enums.DistributionType;
+                            rewardTokenId: string;
+                            amount: string;
+                            opportunityId: string;
+                        }[];
+                    };
+                };
+            };
+        };
+    };
+} & {
+    creators: {
+        campaigns: {
+            ":id": {
+                get: {
+                    body: unknown;
                     params: {
                         id: string;
                     };
                     query: unknown;
-                    headers: {
-                        authorization: string;
-                    };
+                    headers: unknown;
                     response: {
                         200: {
-                            name: string;
-                            id: string;
-                            icon: string | null;
-                            rebateFee: number;
+                            tvlRecords: {
+                                total: number;
+                                timestamp: bigint;
+                            }[];
+                            aprRecords: {
+                                timestamp: bigint;
+                                apr: number;
+                            }[];
+                            dailyRewardsRecords: {
+                                total: number;
+                                timestamp: bigint;
+                            }[];
+                            walletCount: {
+                                timestamp: bigint;
+                                walletCount: number;
+                            }[];
+                            tvlInflowPerDollar: bigint;
                         };
                     };
                 };