npm - @merkl/api - Versions diffs - 1.0.48 → 1.0.50 - Mend

@merkl/api 1.0.48 → 1.0.50

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 (70) hide show

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

@@ -311,87 +311,7 @@ export declare const CreatorController: Elysia<"/creators", {
                             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;
-                                decimals: number;
-                                address: string;
-                                id: string;
-                                chainId: number;
-                                icon: string;
-                                isNative: boolean;
-                                isPoint: boolean;
-                                isPreTGE: boolean;
-                                isTest: boolean;
-                                verified: boolean;
-                            } & {
-                                price?: number | null | undefined;
-                                isTokenWrapper?: boolean | undefined;
-                                tokenWrapperAddress?: string | undefined;
-                            };
-                            distributionChain: {
-                                name: string;
-                                id: number;
-                                icon: string;
-                            } | undefined;
-                            campaignStatus: {
-                                computedUntil: number;
-                                processingStarted: number;
-                                campaignId: string;
-                                error: string;
-                                status: import("@package/databases").RunStatus;
-                                details: import("@prisma/client/runtime/library").JsonValue;
-                            } | undefined;
-                            creatorAddress: string;
-                            creator: {
-                                address: string;
-                                tags: string[];
-                                creatorId: string | null;
-                            };
-                            createdAt: string;
-                            description: string | undefined;
-                            parentCampaignId: string | undefined;
-                            rootCampaignId: string | undefined;
-                            Opportunity: {
-                                name: string;
-                                apr: number;
-                                tvl: number;
-                                description: string;
-                                id: string;
-                                status: import("@package/databases").Status;
-                                chainId: number;
-                                action: import("@package/databases").OpportunityAction;
-                                type: string;
-                                depositUrl: string | null;
-                                explorerAddress: string | null;
-                                howToSteps: string[];
-                                mainProtocolId: string | null;
-                                manualOverrides: import("@package/databases").OpportunityManualOverride[];
-                                identifier: string;
-                                dailyRewards: number;
-                                tags: string[];
-                                lastCampaignCreatedAt: Date;
-                            };
-                            campaignId: string;
-                            id: string;
-                            amount: string;
-                            type: string;
-                            computeChainId: number;
-                            distributionChainId: number;
-                            opportunityId: string;
-                            distributionType: import("@package/databases").DistributionType;
-                            subType: number | null;
-                            rewardTokenId: string;
-                        })[];
+                        }) | Omit<import("../campaign/campaign.model").CampaignWithParams, "manualOverrides">)[];
                         422: {
                             type: "validation";
                             on: string;
@@ -462,87 +382,7 @@ export declare const CreatorController: Elysia<"/creators", {
                                 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;
-                                    decimals: number;
-                                    address: string;
-                                    id: string;
-                                    chainId: number;
-                                    icon: string;
-                                    isNative: boolean;
-                                    isPoint: boolean;
-                                    isPreTGE: boolean;
-                                    isTest: boolean;
-                                    verified: boolean;
-                                } & {
-                                    price?: number | null | undefined;
-                                    isTokenWrapper?: boolean | undefined;
-                                    tokenWrapperAddress?: string | undefined;
-                                };
-                                distributionChain: {
-                                    name: string;
-                                    id: number;
-                                    icon: string;
-                                } | undefined;
-                                campaignStatus: {
-                                    computedUntil: number;
-                                    processingStarted: number;
-                                    campaignId: string;
-                                    error: string;
-                                    status: import("@package/databases").RunStatus;
-                                    details: import("@prisma/client/runtime/library").JsonValue;
-                                } | undefined;
-                                creatorAddress: string;
-                                creator: {
-                                    address: string;
-                                    tags: string[];
-                                    creatorId: string | null;
-                                };
-                                createdAt: string;
-                                description: string | undefined;
-                                parentCampaignId: string | undefined;
-                                rootCampaignId: string | undefined;
-                                Opportunity: {
-                                    name: string;
-                                    apr: number;
-                                    tvl: number;
-                                    description: string;
-                                    id: string;
-                                    status: import("@package/databases").Status;
-                                    chainId: number;
-                                    action: import("@package/databases").OpportunityAction;
-                                    type: string;
-                                    depositUrl: string | null;
-                                    explorerAddress: string | null;
-                                    howToSteps: string[];
-                                    mainProtocolId: string | null;
-                                    manualOverrides: import("@package/databases").OpportunityManualOverride[];
-                                    identifier: string;
-                                    dailyRewards: number;
-                                    tags: string[];
-                                    lastCampaignCreatedAt: Date;
-                                };
-                                campaignId: string;
-                                id: string;
-                                amount: string;
-                                type: string;
-                                computeChainId: number;
-                                distributionChainId: number;
-                                opportunityId: string;
-                                distributionType: import("@package/databases").DistributionType;
-                                subType: number | null;
-                                rewardTokenId: string;
-                            }[];
+                            })[] | Omit<import("../campaign/campaign.model").CampaignWithParams, "manualOverrides">[];
                             422: {
                                 type: "validation";
                                 on: string;

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

@@ -121,87 +121,7 @@ export declare abstract class CreatorService {
         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;
-            decimals: number;
-            address: string;
-            id: string;
-            chainId: number;
-            icon: string;
-            isNative: boolean;
-            isPoint: boolean;
-            isPreTGE: boolean;
-            isTest: boolean;
-            verified: boolean;
-        } & {
-            price?: number | null | undefined;
-            isTokenWrapper?: boolean | undefined;
-            tokenWrapperAddress?: string | undefined;
-        };
-        distributionChain: {
-            name: string;
-            id: number;
-            icon: string;
-        } | undefined;
-        campaignStatus: {
-            computedUntil: number;
-            processingStarted: number;
-            campaignId: string;
-            error: string;
-            status: import("@package/databases").RunStatus;
-            details: import("@prisma/client/runtime/library").JsonValue;
-        } | undefined;
-        creatorAddress: string;
-        creator: {
-            address: string;
-            tags: string[];
-            creatorId: string | null;
-        };
-        createdAt: string;
-        description: string | undefined;
-        parentCampaignId: string | undefined;
-        rootCampaignId: string | undefined;
-        Opportunity: {
-            name: string;
-            apr: number;
-            tvl: number;
-            description: string;
-            id: string;
-            status: import("@package/databases").Status;
-            chainId: number;
-            action: import("@package/databases").OpportunityAction;
-            type: string;
-            depositUrl: string | null;
-            explorerAddress: string | null;
-            howToSteps: string[];
-            mainProtocolId: string | null;
-            manualOverrides: import("@package/databases").OpportunityManualOverride[];
-            identifier: string;
-            dailyRewards: number;
-            tags: string[];
-            lastCampaignCreatedAt: Date;
-        };
-        campaignId: string;
-        id: string;
-        amount: string;
-        type: string;
-        computeChainId: number;
-        distributionChainId: number;
-        opportunityId: string;
-        distributionType: import("@package/databases").DistributionType;
-        subType: number | null;
-        rewardTokenId: string;
-    })[]>;
+    }) | Omit<import("../campaign/campaign.model").CampaignWithParams, "manualOverrides">)[]>;
     static getCampaignsForAddress(creatorAddress: string, status?: "PAST" | "LIVE" | "FUTURE"): Promise<({
         Opportunity: {
             name: string;
@@ -243,87 +163,7 @@ export declare abstract class CreatorService {
         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;
-            decimals: number;
-            address: string;
-            id: string;
-            chainId: number;
-            icon: string;
-            isNative: boolean;
-            isPoint: boolean;
-            isPreTGE: boolean;
-            isTest: boolean;
-            verified: boolean;
-        } & {
-            price?: number | null | undefined;
-            isTokenWrapper?: boolean | undefined;
-            tokenWrapperAddress?: string | undefined;
-        };
-        distributionChain: {
-            name: string;
-            id: number;
-            icon: string;
-        } | undefined;
-        campaignStatus: {
-            computedUntil: number;
-            processingStarted: number;
-            campaignId: string;
-            error: string;
-            status: import("@package/databases").RunStatus;
-            details: import("@prisma/client/runtime/library").JsonValue;
-        } | undefined;
-        creatorAddress: string;
-        creator: {
-            address: string;
-            tags: string[];
-            creatorId: string | null;
-        };
-        createdAt: string;
-        description: string | undefined;
-        parentCampaignId: string | undefined;
-        rootCampaignId: string | undefined;
-        Opportunity: {
-            name: string;
-            apr: number;
-            tvl: number;
-            description: string;
-            id: string;
-            status: import("@package/databases").Status;
-            chainId: number;
-            action: import("@package/databases").OpportunityAction;
-            type: string;
-            depositUrl: string | null;
-            explorerAddress: string | null;
-            howToSteps: string[];
-            mainProtocolId: string | null;
-            manualOverrides: import("@package/databases").OpportunityManualOverride[];
-            identifier: string;
-            dailyRewards: number;
-            tags: string[];
-            lastCampaignCreatedAt: Date;
-        };
-        campaignId: string;
-        id: string;
-        amount: string;
-        type: string;
-        computeChainId: number;
-        distributionChainId: number;
-        opportunityId: string;
-        distributionType: import("@package/databases").DistributionType;
-        subType: number | null;
-        rewardTokenId: string;
-    }[]>;
+    })[] | Omit<import("../campaign/campaign.model").CampaignWithParams, "manualOverrides">[]>;
     static getCampaignMetrics(campaignId: string): Promise<{
         tvlRecords: {
             timestamp: bigint;

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

@@ -144,7 +144,6 @@ export declare const OpportunityController: Elysia<"/opportunities", {
                             campaignStatus?: {
                                 error?: string | undefined;
                                 details?: any;
-                                campaignId: string;
                                 status: string;
                                 computedUntil: string | number;
                                 processingStarted: string | number;
@@ -183,10 +182,8 @@ export declare const OpportunityController: Elysia<"/opportunities", {
                             computeChainId: number;
                             distributionChainId: number;
                             endTimestamp: string | number;
-                            opportunityId: string;
                             creatorAddress: string;
                             subType: number | null;
-                            rewardTokenId: string;
                             createdAt: string;
                             chain: {
                                 explorers?: {
@@ -487,7 +484,6 @@ export declare const OpportunityController: Elysia<"/opportunities", {
                                 campaignStatus?: {
                                     error?: string | undefined;
                                     details?: any;
-                                    campaignId: string;
                                     status: string;
                                     computedUntil: string | number;
                                     processingStarted: string | number;
@@ -526,10 +522,8 @@ export declare const OpportunityController: Elysia<"/opportunities", {
                                 computeChainId: number;
                                 distributionChainId: number;
                                 endTimestamp: string | number;
-                                opportunityId: string;
                                 creatorAddress: string;
                                 subType: number | null;
-                                rewardTokenId: string;
                                 createdAt: string;
                                 chain: {
                                     explorers?: {

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

@@ -1,4 +1,4 @@
-import type { LightOpportunityFromDB } from "./opportunity.model";
+import type { OpportunityWithoutRecords, OpportunityWithoutRecordsAndRelation } from "./opportunity.model";
 import type { OpportunityRepository } from "./opportunity.repository";
 export declare abstract class OpportunityFormatter {
     static format(opportunity: Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>): {
@@ -55,91 +55,7 @@ export declare abstract class OpportunityFormatter {
                 distributionType: import("@package/databases").DistributionType;
             }[];
         };
-        campaigns: {
-            params: any;
-            chain: {
-                name: string;
-                id: number;
-                icon: string;
-            };
-            endTimestamp: number;
-            startTimestamp: number;
-            rewardToken: {
-                symbol: string;
-                name: string | null;
-                decimals: number;
-                address: string;
-                id: string;
-                chainId: number;
-                icon: string;
-                isNative: boolean;
-                isPoint: boolean;
-                isPreTGE: boolean;
-                isTest: boolean;
-                verified: boolean;
-            } & {
-                price?: number | null | undefined;
-                isTokenWrapper?: boolean | undefined;
-                tokenWrapperAddress?: string | undefined;
-            };
-            distributionChain: {
-                name: string;
-                id: number;
-                icon: string;
-            } | undefined;
-            campaignStatus: {
-                computedUntil: number;
-                processingStarted: number;
-                campaignId: string;
-                error: string;
-                status: import("@package/databases").RunStatus;
-                details: import("@prisma/client/runtime/library").JsonValue;
-            } | undefined;
-            creatorAddress: string;
-            creator: {
-                address: string;
-                tags: string[];
-                creatorId: string | null;
-            };
-            createdAt: string;
-            description: string | undefined;
-            parentCampaignId: string | undefined;
-            rootCampaignId: string | undefined;
-            Opportunity: {
-                name: string;
-                apr: number;
-                tvl: number;
-                description: string;
-                id: string;
-                status: import("@package/databases").Status;
-                chainId: number;
-                action: import("@package/databases").OpportunityAction;
-                type: string;
-                depositUrl: string | null;
-                explorerAddress: string | null;
-                howToSteps: string[];
-                mainProtocolId: string | null;
-                manualOverrides: import("@package/databases").OpportunityManualOverride[];
-                identifier: string;
-                dailyRewards: number;
-                tags: string[];
-                lastCampaignCreatedAt: Date;
-            };
-            campaignId: string;
-            id: string;
-            amount: string;
-            type: string;
-            computeChainId: number;
-            distributionChainId: number;
-            opportunityId: string;
-            distributionType: import("@package/databases").DistributionType;
-            subType: number | null;
-            rewardTokenId: string;
-        }[] | undefined;
-        id: string;
-        depositUrl: string | undefined;
-        explorerAddress: string | undefined;
-        lastCampaignCreatedAt: string;
+        campaigns: Omit<import("../campaign/campaign.model").CampaignWithParams, "manualOverrides">[] | undefined;
         tokens: ({
             symbol: string;
             name: string | null;
@@ -171,6 +87,10 @@ export declare abstract class OpportunityFormatter {
             icon: string;
             tags: string[];
         } | undefined;
+        id: string;
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        lastCampaignCreatedAt: string;
         name: string;
         apr: number;
         tvl: number;
@@ -184,11 +104,7 @@ export declare abstract class OpportunityFormatter {
         dailyRewards: number;
         tags: string[];
     };
-    static formatWithoutRecords(opportunity: LightOpportunityFromDB): {
-        id: string;
-        depositUrl: string | undefined;
-        explorerAddress: string | undefined;
-        lastCampaignCreatedAt: string;
+    static formatWithoutRecords(opportunity: OpportunityWithoutRecords): {
         tokens: ({
             symbol: string;
             name: string | null;
@@ -220,6 +136,28 @@ export declare abstract class OpportunityFormatter {
             icon: string;
             tags: string[];
         } | undefined;
+        id: string;
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        lastCampaignCreatedAt: string;
+        name: string;
+        apr: number;
+        tvl: number;
+        description: string;
+        status: import("@package/databases").Status;
+        chainId: number;
+        action: import("@package/databases").OpportunityAction;
+        type: string;
+        howToSteps: string[];
+        identifier: string;
+        dailyRewards: number;
+        tags: string[];
+    };
+    static formatWithoutRecordsAndRelations(opportunity: OpportunityWithoutRecordsAndRelation): {
+        id: string;
+        depositUrl: string | undefined;
+        explorerAddress: string | undefined;
+        lastCampaignCreatedAt: string;
         name: string;
         apr: number;
         tvl: number;

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

@@ -13,9 +13,21 @@ import type { OpportunityRepository } from "./opportunity.repository";
  * @description Target description of rewards campaigns
  * @see {@link Resource}
  */
-export type Opportunity = Resource<"Opportunity", "mainProtocolId" | "manualOverrides", {
+export type OpportunityLight = Resource<"Opportunity", "manualOverrides" | "mainProtocolId", {
     depositUrl?: string;
     explorerAddress?: string;
+    lastCampaignCreatedAt: string;
+    mainProtocolId?: string;
+}>;
+/**
+ * Opportunity
+ * @description Target description of rewards campaigns
+ * @see {@link Resource}
+ */
+export type Opportunity = Resource<"Opportunity", "manualOverrides" | "mainProtocolId", {
+    depositUrl?: string;
+    explorerAddress?: string;
+    mainProtocolId?: string;
     chain: Chain["model"];
     tokens: Token["model"][];
     lastCampaignCreatedAt: string;
@@ -25,7 +37,8 @@ export type Opportunity = Resource<"Opportunity", "mainProtocolId" | "manualOver
     rewardsRecord?: DailyRewardsRecord["model"];
     campaigns?: Omit<Campaign["model"], "manualOverrides">[];
 }>;
-export type LightOpportunityFromDB = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns">;
+export type OpportunityWithoutRecords = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns">;
+export type OpportunityWithoutRecordsAndRelation = Omit<Awaited<ReturnType<typeof OpportunityRepository.findUniqueOrThrow>>, "AprRecords" | "TvlRecords" | "DailyRewardsRecords" | "Campaigns" | "Chain" | "Tokens" | "Protocols" | "MainProtocol">;
 export type OpportunityUnique = {
     chainId: ChainId;
     type: string;
@@ -291,9 +304,7 @@ export declare const OpportunityWithCampaignsResourceDto: import("@sinclair/type
         campaignId: import("@sinclair/typebox").TString;
         type: import("@sinclair/typebox").TString;
         subType: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TNumber, import("@sinclair/typebox").TNull]>;
-        rewardTokenId: import("@sinclair/typebox").TString;
         amount: import("@sinclair/typebox").TString;
-        opportunityId: import("@sinclair/typebox").TString;
         startTimestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
         endTimestamp: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
         creatorAddress: import("@sinclair/typebox").TString;
@@ -353,7 +364,6 @@ export declare const OpportunityWithCampaignsResourceDto: import("@sinclair/type
             readonly FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT: "FIX_REWARD_AMOUNT_PER_LIQUIDITY_AMOUNT";
         }>>;
         campaignStatus: import("@sinclair/typebox").TOptional<import("@sinclair/typebox").TObject<{
-            campaignId: import("@sinclair/typebox").TString;
             computedUntil: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
             processingStarted: import("@sinclair/typebox").TUnion<[import("@sinclair/typebox").TString, import("@sinclair/typebox").TNumber]>;
             status: import("@sinclair/typebox").TString;