npm - @merkl/api - Versions diffs - 0.19.1 → 0.19.3 - Mend

@merkl/api 0.19.1 → 0.19.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (29) hide show

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

@@ -39,6 +39,7 @@ export declare abstract class CampaignService {
         endTimestamp: bigint;
         creatorAddress: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     })[]>;
     static getFutureCampaigns(query?: {
         computeChainId?: number;
@@ -74,6 +75,7 @@ export declare abstract class CampaignService {
         endTimestamp: bigint;
         creatorAddress: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     })[]>;
     static getLiveCampaigns(query?: {
         distributionChainId?: number;
@@ -125,6 +127,7 @@ export declare abstract class CampaignService {
         endTimestamp: bigint;
         creatorAddress: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     })[]>;
     static countLives(query?: {
         distributionChainId?: number;
@@ -146,6 +149,7 @@ export declare abstract class CampaignService {
         endTimestamp: bigint;
         creatorAddress: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     } | undefined>;
     /**
      * @dev back-office function
@@ -166,6 +170,7 @@ export declare abstract class CampaignService {
         endTimestamp: bigint;
         creatorAddress: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     }>;
     /**
      * @dev back-office function for manual overrides
@@ -248,7 +253,222 @@ export declare abstract class CampaignService {
         amount: string;
         opportunityId: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     }[]>;
+    static findAndGroupByChains(query: GetCampaignQueryModel): Promise<Map<number, {
+        params: any;
+        chain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+        } & {
+            price?: number | null | undefined;
+        };
+        distributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        id: string;
+        type: string;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    }[]>>;
+    static countByChains(query: GetCampaignQueryModel): Promise<Record<string, number>>;
+    static findAndGroupByType(query: GetCampaignQueryModel): Promise<Map<string, {
+        params: any;
+        chain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+        } & {
+            price?: number | null | undefined;
+        };
+        distributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        id: string;
+        type: string;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    }[]>>;
+    static countByType(query: GetCampaignQueryModel): Promise<Record<string, number>>;
+    static findAndGroupByProtocol(query: GetCampaignQueryModel): Promise<Map<string | null, {
+        params: any;
+        chain: {
+            id: number;
+            name: string;
+            icon: string;
+        };
+        endTimestamp: number;
+        startTimestamp: number;
+        rewardToken: {
+            symbol: string;
+            id: string;
+            name: string | null;
+            icon: string;
+            address: string;
+            chainId: number;
+            decimals: number;
+            verified: boolean;
+            isTest: boolean;
+            isPoint: boolean;
+            isNative: boolean;
+        } & {
+            price?: number | null | undefined;
+        };
+        distributionChain: {
+            id: number;
+            name: string;
+            icon: string;
+        } | undefined;
+        campaignStatus: {
+            computedUntil: number;
+            processingStarted: number;
+            error: string;
+            status: import("@db/api").$Enums.RunStatus;
+            details: import("database/api/.generated/runtime/library").JsonValue;
+            campaignId: string;
+        } | undefined;
+        creatorAddress: string;
+        creator: {
+            tags: string[];
+            address: string;
+            creatorId: string | null;
+        };
+        Opportunity: {
+            id: string;
+            name: string;
+            type: string;
+            status: import("@db/api").$Enums.Status;
+            tags: string[];
+            identifier: string;
+            action: import("@db/api").$Enums.OpportunityAction;
+            chainId: number;
+            depositUrl: string | null;
+            mainProtocolId: string | null;
+            tvl: number;
+            apr: number;
+            dailyRewards: number;
+        };
+        id: string;
+        type: string;
+        subType: number | null;
+        computeChainId: number;
+        distributionChainId: number;
+        campaignId: string;
+        rewardTokenId: string;
+        amount: string;
+        opportunityId: string;
+        manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
+    }[]>>;
+    static countByProtocol(query: GetCampaignQueryModel): Promise<Record<string, number>>;
+    static countBy<T>(campaignsMap: Map<T, ReturnType<(typeof CampaignService)["format"]>[]>): Record<string, number>;
     /**
      * Counts the number of campaigns that complies to query
      * @description used for pagination purposes
@@ -311,6 +531,7 @@ export declare abstract class CampaignService {
         endTimestamp: bigint;
         creatorAddress: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     }) | null>;
     static findUniqueOrThrow(campaign: CampaignUnique | string, withOpportunity?: boolean): Promise<{
         ComputeChain: {
@@ -381,6 +602,7 @@ export declare abstract class CampaignService {
         endTimestamp: bigint;
         creatorAddress: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     }>;
     static removeManualOverride(campaign: CampaignUnique | string, field: CampaignManualOverride): Promise<void>;
     static findCampaignsToProcess(distributionChainId: ChainId): Promise<{
@@ -497,6 +719,7 @@ export declare abstract class CampaignService {
         amount: string;
         opportunityId: string;
         manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+        createdAt: Date;
     };
     static formatAsCampaignParameters<C extends CampaignEnum>(campaign: CampaignWithParams): CampaignParameters<C>;
     /**

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

@@ -123,12 +123,36 @@ export class CampaignService {
      * @returns A list of campaigns
      */
     static async findMany(query) {
-        if (query.subType && !query.type) {
+        if (query.subType && !query.type)
             throw new HttpError("Bad Request: Cannot specify a subType without a type", 400);
-        }
         const campaigns = await CampaignRepository.findMany(query);
         return campaigns.map(CampaignService.format);
     }
+    static async findAndGroupByChains(query) {
+        return Map.groupBy(await CampaignService.findMany(query), campaign => campaign.chain.id);
+    }
+    static async countByChains(query) {
+        return CampaignService.countBy(await CampaignService.findAndGroupByChains(query));
+    }
+    static async findAndGroupByType(query) {
+        return Map.groupBy(await CampaignService.findMany(query), campaign => campaign.type);
+    }
+    static async countByType(query) {
+        return CampaignService.countBy(await CampaignService.findAndGroupByType({ ...query, items: 0 }));
+    }
+    static async findAndGroupByProtocol(query) {
+        return Map.groupBy(await CampaignService.findMany(query), campaign => campaign.Opportunity.mainProtocolId);
+    }
+    static async countByProtocol(query) {
+        return CampaignService.countBy(await CampaignService.findAndGroupByType({ ...query, items: 0 }));
+    }
+    static countBy(campaignsMap) {
+        const count = {};
+        for (const [key, value] of campaignsMap) {
+            count[key] = value.length;
+        }
+        return count;
+    }
     /**
      * Counts the number of campaigns that complies to query
      * @description used for pagination purposes

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

@@ -28,7 +28,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                         chainId: number;
                     }[];
                     identifier: string;
-                    action: "POOL" | "HOLD" | "DROP" | "LEND" | "BORROW" | "LONG" | "SHORT" | "INVALID";
+                    action: "POOL" | "HOLD" | "DROP" | "LEND" | "BORROW" | "LONG" | "SHORT" | "SWAP" | "INVALID";
                     chainId: number;
                 };
                 params: {};
@@ -249,6 +249,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                             amount: string;
                             opportunityId: string;
                             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+                            createdAt: Date;
                         }[] | undefined;
                         id: string;
                         depositUrl: string | undefined;
@@ -461,6 +462,7 @@ export declare const OpportunityController: Elysia<"/opportunities", false, {
                     mainParameter?: string | undefined;
                     tokenAddress?: string | undefined;
                     test?: boolean | undefined;
+                    createdAfter?: Date | undefined;
                     creatorTag?: string | undefined;
                     distributionChainIds?: number[] | undefined;
                     tokenSymbol?: string | undefined;

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

@@ -315,6 +315,7 @@ export declare const CreateOpportunityDto: import("@sinclair/typebox").TObject<{
         BORROW: "BORROW";
         LONG: "LONG";
         SHORT: "SHORT";
+        SWAP: "SWAP";
         INVALID: "INVALID";
     }>;
     tokens: import("@sinclair/typebox").TArray<import("@sinclair/typebox").TObject<{

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

@@ -59,6 +59,7 @@ export declare abstract class OpportunityRepository {
             endTimestamp: bigint;
             creatorAddress: string;
             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+            createdAt: Date;
         })[];
         Tokens: {
             symbol: string;
@@ -197,6 +198,7 @@ export declare abstract class OpportunityRepository {
             endTimestamp: bigint;
             creatorAddress: string;
             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+            createdAt: Date;
         }[];
         Tokens: {
             symbol: string;
@@ -393,6 +395,7 @@ export declare abstract class OpportunityRepository {
             endTimestamp: bigint;
             creatorAddress: string;
             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+            createdAt: Date;
         })[];
         Tokens: {
             symbol: string;
@@ -538,6 +541,7 @@ export declare abstract class OpportunityRepository {
             endTimestamp: bigint;
             creatorAddress: string;
             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+            createdAt: Date;
         }[];
         Tokens: {
             symbol: string;
@@ -729,6 +733,7 @@ export declare abstract class OpportunityRepository {
             endTimestamp: bigint;
             creatorAddress: string;
             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+            createdAt: Date;
         })[];
         Tokens: {
             symbol: string;

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

@@ -135,7 +135,7 @@ export class OpportunityRepository {
                 newOpp.action = "POOL";
             if (mainProtocol.tags.includes("DEX"))
                 newOpp.action = "POOL";
-            if (mainProtocol.tags.includes("LENDING"))
+            if (mainProtocol.tags.includes("BORROWING"))
                 newOpp.action = "BORROW";
             if (mainProtocol.tags.includes("LENDING") && !!newOpp.name && newOpp.name.includes("Supply"))
                 newOpp.action = "LEND";

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

@@ -537,6 +537,7 @@ export declare abstract class OpportunityService {
             amount: string;
             opportunityId: string;
             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+            createdAt: Date;
         }[] | undefined;
         id: string;
         depositUrl: string | undefined;
@@ -705,6 +706,7 @@ export declare abstract class OpportunityService {
             amount: string;
             opportunityId: string;
             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+            createdAt: Date;
         }[] | undefined;
         id: string;
         depositUrl: string | undefined;
@@ -869,6 +871,7 @@ export declare abstract class OpportunityService {
             amount: string;
             opportunityId: string;
             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+            createdAt: Date;
         }[] | undefined;
         id: string;
         depositUrl: string | undefined;

package/dist/src/modules/v4/protocol/protocol.repository.d.ts CHANGED Viewed

@@ -42,6 +42,7 @@ export declare abstract class ProtocolRepository {
                 endTimestamp: bigint;
                 creatorAddress: string;
                 manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+                createdAt: Date;
             }[];
         } & {
             id: string;

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

@@ -43,7 +43,7 @@ export declare const v4: Elysia<"/v4", false, {
                             chainId: number;
                         }[];
                         identifier: string;
-                        action: "POOL" | "HOLD" | "DROP" | "LEND" | "BORROW" | "LONG" | "SHORT" | "INVALID";
+                        action: "POOL" | "HOLD" | "DROP" | "LEND" | "BORROW" | "LONG" | "SHORT" | "SWAP" | "INVALID";
                         chainId: number;
                     };
                     params: {};
@@ -264,6 +264,7 @@ export declare const v4: Elysia<"/v4", false, {
                                 amount: string;
                                 opportunityId: string;
                                 manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+                                createdAt: Date;
                             }[] | undefined;
                             id: string;
                             depositUrl: string | undefined;
@@ -476,6 +477,7 @@ export declare const v4: Elysia<"/v4", false, {
                         mainParameter?: string | undefined;
                         tokenAddress?: string | undefined;
                         test?: boolean | undefined;
+                        createdAfter?: Date | undefined;
                         creatorTag?: string | undefined;
                         distributionChainIds?: number[] | undefined;
                         tokenSymbol?: string | undefined;
@@ -994,6 +996,7 @@ export declare const v4: Elysia<"/v4", false, {
                             endTimestamp: bigint;
                             creatorAddress: string;
                             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+                            createdAt: Date;
                         } | undefined;
                     };
                 };
@@ -1081,6 +1084,7 @@ export declare const v4: Elysia<"/v4", false, {
                             endTimestamp: bigint;
                             creatorAddress: string;
                             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+                            createdAt: Date;
                         };
                     };
                 };
@@ -1125,6 +1129,7 @@ export declare const v4: Elysia<"/v4", false, {
                         mainParameter?: string | undefined;
                         tokenAddress?: string | undefined;
                         test?: boolean | undefined;
+                        createdAfter?: Date | undefined;
                         creatorTag?: string | undefined;
                         distributionChainIds?: number[] | undefined;
                         tokenSymbol?: string | undefined;
@@ -1200,6 +1205,7 @@ export declare const v4: Elysia<"/v4", false, {
                             amount: string;
                             opportunityId: string;
                             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+                            createdAt: Date;
                         }[];
                     };
                 };
@@ -1282,6 +1288,7 @@ export declare const v4: Elysia<"/v4", false, {
                             amount: string;
                             opportunityId: string;
                             manualOverrides: import("@db/api").$Enums.CampaignManualOverride[];
+                            createdAt: Date;
                         };
                     };
                 };
@@ -1308,6 +1315,7 @@ export declare const v4: Elysia<"/v4", false, {
                         mainParameter?: string | undefined;
                         tokenAddress?: string | undefined;
                         test?: boolean | undefined;
+                        createdAfter?: Date | undefined;
                         creatorTag?: string | undefined;
                         distributionChainIds?: number[] | undefined;
                         tokenSymbol?: string | undefined;
@@ -1319,6 +1327,82 @@ export declare const v4: Elysia<"/v4", false, {
                     };
                 };
             };
+        } & {
+            count: {
+                "by-type": {
+                    get: {
+                        body: unknown;
+                        params: {};
+                        query: {
+                            type?: string | undefined;
+                            status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
+                            items?: number | undefined;
+                            subType?: number | undefined;
+                            page?: number | undefined;
+                            types?: string[] | undefined;
+                            campaignId?: string | undefined;
+                            opportunityId?: string | undefined;
+                            startTimestamp?: string | undefined;
+                            endTimestamp?: string | undefined;
+                            creatorAddress?: string | undefined;
+                            chainId?: number | undefined;
+                            creatorId?: string | undefined;
+                            mainParameter?: string | undefined;
+                            tokenAddress?: string | undefined;
+                            test?: boolean | undefined;
+                            createdAfter?: Date | undefined;
+                            creatorTag?: string | undefined;
+                            distributionChainIds?: number[] | undefined;
+                            tokenSymbol?: string | undefined;
+                            withOpportunity?: boolean | undefined;
+                        };
+                        headers: unknown;
+                        response: {
+                            200: {
+                                [x: string]: number;
+                            };
+                        };
+                    };
+                };
+            };
+        } & {
+            count: {
+                "by-protocol": {
+                    get: {
+                        body: unknown;
+                        params: {};
+                        query: {
+                            type?: string | undefined;
+                            status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
+                            items?: number | undefined;
+                            subType?: number | undefined;
+                            page?: number | undefined;
+                            types?: string[] | undefined;
+                            campaignId?: string | undefined;
+                            opportunityId?: string | undefined;
+                            startTimestamp?: string | undefined;
+                            endTimestamp?: string | undefined;
+                            creatorAddress?: string | undefined;
+                            chainId?: number | undefined;
+                            creatorId?: string | undefined;
+                            mainParameter?: string | undefined;
+                            tokenAddress?: string | undefined;
+                            test?: boolean | undefined;
+                            createdAfter?: Date | undefined;
+                            creatorTag?: string | undefined;
+                            distributionChainIds?: number[] | undefined;
+                            tokenSymbol?: string | undefined;
+                            withOpportunity?: boolean | undefined;
+                        };
+                        headers: unknown;
+                        response: {
+                            200: {
+                                [x: string]: number;
+                            };
+                        };
+                    };
+                };
+            };
         } & {
             "campaigns-to-process": {
                 index: {
@@ -1398,6 +1482,43 @@ export declare const v4: Elysia<"/v4", false, {
                 };
             };
         };
+        campaignscount: {
+            "by-chains": {
+                get: {
+                    body: unknown;
+                    params: {};
+                    query: {
+                        type?: string | undefined;
+                        status?: "NONE" | "PAST" | "LIVE" | "SOON" | undefined;
+                        items?: number | undefined;
+                        subType?: number | undefined;
+                        page?: number | undefined;
+                        types?: string[] | undefined;
+                        campaignId?: string | undefined;
+                        opportunityId?: string | undefined;
+                        startTimestamp?: string | undefined;
+                        endTimestamp?: string | undefined;
+                        creatorAddress?: string | undefined;
+                        chainId?: number | undefined;
+                        creatorId?: string | undefined;
+                        mainParameter?: string | undefined;
+                        tokenAddress?: string | undefined;
+                        test?: boolean | undefined;
+                        createdAfter?: Date | undefined;
+                        creatorTag?: string | undefined;
+                        distributionChainIds?: number[] | undefined;
+                        tokenSymbol?: string | undefined;
+                        withOpportunity?: boolean | undefined;
+                    };
+                    headers: unknown;
+                    response: {
+                        200: {
+                            [x: string]: number;
+                        };
+                    };
+                };
+            };
+        };
     };
 } & {
     v4: {