npm - @merkl/api - Versions diffs - 1.4.85 → 1.4.86 - Mend

@merkl/api 1.4.85 → 1.4.86

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

package/dist/src/cache/index.d.ts CHANGED Viewed

@@ -10,9 +10,6 @@ export declare class Cache {
     static decoder: TextDecoder;
     static encoder: TextEncoder;
     localCache: NodeCache;
-    /*//////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-                                                         UTILS
-    //////////////////////////////////////////////////////////////////////////////////////////////////////////////////*/
     static baseKey<T extends CacheKey, Key extends T | NonNullable<CacheArg[T]>>(key: Key): CacheKey;
     /** @notice Uncompress (if enabled), parsed and typed data from the cache */
     static uncompress<T extends CacheKey, Key extends T | NonNullable<CacheArg[T]>>(key: Key, value: string): CacheKeys[T]["returns"];
@@ -22,9 +19,6 @@ export declare class Cache {
     private getManyRaw;
     private setRaw;
     private set;
-    /*//////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-                                                      LOCAL CACHE
-    //////////////////////////////////////////////////////////////////////////////////////////////////////////////////*/
     /**
      * @deprecated Local cache is not used anymore
      */
@@ -37,9 +31,6 @@ export declare class Cache {
      * @deprecated Local cache is not used anymore
      */
     private getLocally;
-    /*//////////////////////////////////////////////////////////////////////////////////////////////////////////////////
-                                                   PUBLIC OPERATIONS
-    //////////////////////////////////////////////////////////////////////////////////////////////////////////////////*/
     /**
      * @returns the uncompressed (if enabled), parsed and typed data from the cache
      */

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

@@ -8,7 +8,6 @@ export type { InteractionTarget } from "../modules/v4/interaction/interaction.mo
 export type { OpportunityDeleteOverrideModel, OpportunityOverrideModel, } from "../modules/v4/opportunity/opportunity.model";
 export type { BreakdownForCampaignsRaw } from "../modules/v4/reward/reward.model";
 export declare const MerklApi: typeof treaty<App>;
-// Types to export along the Eden type
 declare const eden: {
     get: (options?: {
         fetch?: RequestInit | undefined;
@@ -2206,6 +2205,9 @@ declare const eden: {
                             description: string;
                             url: string;
                             icon: string;
+                            banner: string | null;
+                            opportunityBannerLight: string | null;
+                            opportunityBannerDark: string | null;
                         } | undefined;
                         activePrograms: {
                             icon: string;
@@ -3344,6 +3346,9 @@ declare const eden: {
                                     description: string;
                                     url: string;
                                     icon: string;
+                                    banner: string | null;
+                                    opportunityBannerLight: string | null;
+                                    opportunityBannerDark: string | null;
                                 } | undefined;
                                 activePrograms: {
                                     icon: string;
@@ -3420,6 +3425,9 @@ declare const eden: {
                                 description: string;
                                 url: string;
                                 icon: string;
+                                banner: string | null;
+                                opportunityBannerLight: string | null;
+                                opportunityBannerDark: string | null;
                             }[];
                             Tokens: {
                                 id: string;
@@ -3522,6 +3530,9 @@ declare const eden: {
                                     description: string;
                                     url: string;
                                     icon: string;
+                                    banner: string | null;
+                                    opportunityBannerLight: string | null;
+                                    opportunityBannerDark: string | null;
                                 }[];
                                 Tokens: {
                                     id: string;
@@ -3624,6 +3635,9 @@ declare const eden: {
                                     description: string;
                                     url: string;
                                     icon: string;
+                                    banner: string | null;
+                                    opportunityBannerLight: string | null;
+                                    opportunityBannerDark: string | null;
                                 }[];
                                 Tokens: {
                                     id: string;
@@ -4280,6 +4294,9 @@ declare const eden: {
                                 description: string;
                                 url: string;
                                 icon: string;
+                                banner: string | null;
+                                opportunityBannerLight: string | null;
+                                opportunityBannerDark: string | null;
                             } | undefined;
                             activePrograms: {
                                 icon: string;
@@ -4936,6 +4953,9 @@ declare const eden: {
                                 description: string;
                                 url: string;
                                 icon: string;
+                                banner: string | null;
+                                opportunityBannerLight: string | null;
+                                opportunityBannerDark: string | null;
                             } | null;
                             Protocols: {
                                 id: string;
@@ -4944,6 +4964,9 @@ declare const eden: {
                                 description: string;
                                 url: string;
                                 icon: string;
+                                banner: string | null;
+                                opportunityBannerLight: string | null;
+                                opportunityBannerDark: string | null;
                             }[];
                             Tokens: {
                                 id: string;
@@ -5028,6 +5051,9 @@ declare const eden: {
                             description: string;
                             url: string;
                             icon: string;
+                            banner: string | null;
+                            opportunityBannerLight: string | null;
+                            opportunityBannerDark: string | null;
                         } | null;
                     } & {
                         id: string;
@@ -5210,6 +5236,9 @@ declare const eden: {
                             description: string;
                             url: string;
                             icon: string;
+                            banner: string | null;
+                            opportunityBannerLight: string | null;
+                            opportunityBannerDark: string | null;
                         } | null;
                         Protocols: {
                             id: string;
@@ -5218,6 +5247,9 @@ declare const eden: {
                             description: string;
                             url: string;
                             icon: string;
+                            banner: string | null;
+                            opportunityBannerLight: string | null;
+                            opportunityBannerDark: string | null;
                         }[];
                         Tokens: {
                             id: string;
@@ -5302,6 +5334,9 @@ declare const eden: {
                         description: string;
                         url: string;
                         icon: string;
+                        banner: string | null;
+                        opportunityBannerLight: string | null;
+                        opportunityBannerDark: string | null;
                     } | null;
                 } & {
                     id: string;
@@ -5922,6 +5957,9 @@ declare const eden: {
                             description: string;
                             url: string;
                             icon: string;
+                            banner: string | null;
+                            opportunityBannerLight: string | null;
+                            opportunityBannerDark: string | null;
                         }[];
                         Tokens: {
                             id: string;
@@ -6656,10 +6694,13 @@ declare const eden: {
                     };
                 }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
                     200: ({
+                        banner: string | null;
                         description: string;
                         icon: string;
                         id: string;
                         name: string;
+                        opportunityBannerDark: string | null;
+                        opportunityBannerLight: string | null;
                         tags: string[];
                         url: string;
                     } & {
@@ -7210,6 +7251,9 @@ declare const eden: {
                         description: string;
                         url: string;
                         icon: string;
+                        banner: string | null;
+                        opportunityBannerLight: string | null;
+                        opportunityBannerDark: string | null;
                     }[];
                     Tokens: {
                         id: string;
@@ -7656,6 +7700,9 @@ declare const eden: {
                             description: string;
                             url: string;
                             icon: string;
+                            banner: string | null;
+                            opportunityBannerLight: string | null;
+                            opportunityBannerDark: string | null;
                         }[];
                         Tokens: {
                             id: string;
@@ -8809,6 +8856,9 @@ declare const eden: {
                             description: string;
                             url: string;
                             icon: string;
+                            banner: string | null;
+                            opportunityBannerLight: string | null;
+                            opportunityBannerDark: string | null;
                         }[];
                         Tokens: {
                             id: string;
@@ -8960,6 +9010,9 @@ declare const eden: {
                                 description: string;
                                 url: string;
                                 icon: string;
+                                banner: string | null;
+                                opportunityBannerLight: string | null;
+                                opportunityBannerDark: string | null;
                             }[];
                             Tokens: {
                                 id: string;
@@ -9090,6 +9143,9 @@ declare const eden: {
                                 description: string;
                                 url: string;
                                 icon: string;
+                                banner: string | null;
+                                opportunityBannerLight: string | null;
+                                opportunityBannerDark: string | null;
                             }[];
                             Tokens: {
                                 id: string;
@@ -9481,9 +9537,8 @@ declare const eden: {
                         blacklist: string[];
                         endTimestamp: number;
                         url?: string | undefined;
-                        campaignType: CampaignType.AJNA;
-                        poolId: string;
-                        subCampaignType: import("@package/resources/enums").AjnaSubCampaignType;
+                        campaignType: CampaignType.M0;
+                        markets: string[];
                         forwarders: ({
                             priority: number;
                             sender: string;
@@ -9738,59 +9793,8 @@ declare const eden: {
                         blacklist: string[];
                         endTimestamp: number;
                         url?: string | undefined;
-                        campaignType: CampaignType.M0;
-                        markets: string[];
-                        forwarders: ({
-                            priority: number;
-                            sender: string;
-                        } & ({
-                            forwarderType: import("@package/resources/enums").IRONCLAD_RELIQUARY;
-                        } | {
-                            forwarderType: import("@package/resources/enums").ZKSWAP_FARM;
-                        } | {
-                            forwarderType: import("@package/resources/enums").SUPERFORM;
-                        } | {
-                            forwarderType: import("@package/resources/enums").SWAP_X_GAUGE;
-                        } | {
-                            forwarderType: import("@package/resources/enums").CLAMM;
-                            type: string | number;
-                            owner?: string | undefined;
-                            target: string;
-                        } | {
-                            forwarderType: import("@package/resources/enums").ERC20;
-                            token: string;
-                        } | {
-                            forwarderType: import("@package/resources/enums").ERC20PointsDeposits;
-                            token: string;
-                        } | {
-                            forwarderType: import("@package/resources/enums").INCOMING_TRANSFERS;
-                            token: string;
-                            senderType: import("@package/resources/enums").ForwarderStandardType;
-                            owner?: string | undefined;
-                        } | {
-                            forwarderType: import("@package/resources/enums").LLAMALEND;
-                            token: string;
-                            senderType: import("@package/resources/enums").ForwarderStandardType;
-                            owner?: string | undefined;
-                        } | {
-                            forwarderType: import("@package/resources/enums").LOCKER_PUFFER;
-                            nftAddress: string;
-                            owner?: string | undefined;
-                        } | {
-                            forwarderType: import("@package/resources/enums").MASTERCHEF;
-                            poolID: number;
-                        } | {
-                            forwarderType: import("@package/resources/enums").MAVERICK_BOOSTED_POSITIONS;
-                            owner?: string | undefined;
-                        } | {
-                            forwarderType: import("@package/resources/enums").SILO;
-                            type: import("@package/resources/enums").Contango;
-                            target?: string | undefined;
-                        } | {
-                            forwarderType: import("@package/resources/enums").VAULT;
-                            balanceCallType: import("@package/resources/enums").VaultBalanceCallType;
-                            callDataKey?: string | undefined;
-                        }))[];
+                        campaignType: CampaignType.AAVE_SUPPLY;
+                        targetToken: string;
                     } & {
                         rewardToken: string;
                         amount: string;
@@ -9994,7 +9998,7 @@ declare const eden: {
                         blacklist: string[];
                         endTimestamp: number;
                         url?: string | undefined;
-                        campaignType: CampaignType.AAVE_SUPPLY;
+                        campaignType: CampaignType.AAVE_BORROW;
                         targetToken: string;
                     } & {
                         rewardToken: string;
@@ -10195,12 +10199,9 @@ declare const eden: {
                             };
                         } | undefined;
                     }) | ({
-                        whitelist: string[];
-                        blacklist: string[];
-                        endTimestamp: number;
+                        campaignType: CampaignType.JSON_AIRDROP;
+                        jsonUrl: string;
                         url?: string | undefined;
-                        campaignType: CampaignType.AAVE_BORROW;
-                        targetToken: string;
                     } & {
                         rewardToken: string;
                         amount: string;
@@ -10400,9 +10401,64 @@ declare const eden: {
                             };
                         } | undefined;
                     }) | ({
-                        campaignType: CampaignType.JSON_AIRDROP;
-                        jsonUrl: string;
+                        whitelist: string[];
+                        blacklist: string[];
+                        endTimestamp: number;
                         url?: string | undefined;
+                        campaignType: CampaignType.AJNA;
+                        poolId: string;
+                        subCampaignType: import("@package/resources/enums").AjnaSubCampaignType;
+                        forwarders: ({
+                            priority: number;
+                            sender: string;
+                        } & ({
+                            forwarderType: import("@package/resources/enums").IRONCLAD_RELIQUARY;
+                        } | {
+                            forwarderType: import("@package/resources/enums").ZKSWAP_FARM;
+                        } | {
+                            forwarderType: import("@package/resources/enums").SUPERFORM;
+                        } | {
+                            forwarderType: import("@package/resources/enums").SWAP_X_GAUGE;
+                        } | {
+                            forwarderType: import("@package/resources/enums").CLAMM;
+                            type: string | number;
+                            owner?: string | undefined;
+                            target: string;
+                        } | {
+                            forwarderType: import("@package/resources/enums").ERC20;
+                            token: string;
+                        } | {
+                            forwarderType: import("@package/resources/enums").ERC20PointsDeposits;
+                            token: string;
+                        } | {
+                            forwarderType: import("@package/resources/enums").INCOMING_TRANSFERS;
+                            token: string;
+                            senderType: import("@package/resources/enums").ForwarderStandardType;
+                            owner?: string | undefined;
+                        } | {
+                            forwarderType: import("@package/resources/enums").LLAMALEND;
+                            token: string;
+                            senderType: import("@package/resources/enums").ForwarderStandardType;
+                            owner?: string | undefined;
+                        } | {
+                            forwarderType: import("@package/resources/enums").LOCKER_PUFFER;
+                            nftAddress: string;
+                            owner?: string | undefined;
+                        } | {
+                            forwarderType: import("@package/resources/enums").MASTERCHEF;
+                            poolID: number;
+                        } | {
+                            forwarderType: import("@package/resources/enums").MAVERICK_BOOSTED_POSITIONS;
+                            owner?: string | undefined;
+                        } | {
+                            forwarderType: import("@package/resources/enums").SILO;
+                            type: import("@package/resources/enums").Contango;
+                            target?: string | undefined;
+                        } | {
+                            forwarderType: import("@package/resources/enums").VAULT;
+                            balanceCallType: import("@package/resources/enums").VaultBalanceCallType;
+                            callDataKey?: string | undefined;
+                        }))[];
                     } & {
                         rewardToken: string;
                         amount: string;
@@ -31126,10 +31182,13 @@ declare const eden: {
                 query?: Record<string, unknown> | undefined;
             } | undefined) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
                 200: {
+                    banner: string | null;
                     description: string;
                     icon: string;
                     id: string;
                     name: string;
+                    opportunityBannerDark: string | null;
+                    opportunityBannerLight: string | null;
                     tags: string[];
                     url: string;
                 } & {
@@ -31166,6 +31225,9 @@ declare const eden: {
                     description: string;
                     url: string;
                     icon: string;
+                    banner: string | null;
+                    opportunityBannerLight: string | null;
+                    opportunityBannerDark: string | null;
                 };
                 422: {
                     type: "validation";
@@ -31252,6 +31314,9 @@ declare const eden: {
                     description: string;
                     url: string;
                     icon: string;
+                    banner: string | null;
+                    opportunityBannerLight: string | null;
+                    opportunityBannerDark: string | null;
                 };
                 422: {
                     type: "validation";
@@ -31377,6 +31442,9 @@ declare const eden: {
                             description: string;
                             url: string;
                             icon: string;
+                            banner: string | null;
+                            opportunityBannerLight: string | null;
+                            opportunityBannerDark: string | null;
                         };
                         422: {
                             type: "validation";
@@ -31487,53 +31555,6 @@ declare const eden: {
             campaign: ((params: {
                 campaignId: string | number;
             }) => {
-                get: (options: {
-                    fetch?: RequestInit | undefined;
-                    headers?: Record<string, unknown> | undefined;
-                    query: {
-                        page?: number | undefined;
-                        items?: number | undefined;
-                    };
-                }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
-                    200: {
-                        amount: string;
-                        claimed: string;
-                        pending: string;
-                        recipient: string;
-                    }[];
-                    422: {
-                        type: "validation";
-                        on: string;
-                        summary?: string | undefined;
-                        message?: string | undefined;
-                        found?: unknown;
-                        property?: string | undefined;
-                        expected?: string | undefined;
-                    };
-                }>>;
-                count: {
-                    get: (options: {
-                        fetch?: RequestInit | undefined;
-                        headers?: Record<string, unknown> | undefined;
-                        query: {
-                            page?: number | undefined;
-                            items?: number | undefined;
-                        };
-                    }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
-                        200: {
-                            count: number;
-                        };
-                        422: {
-                            type: "validation";
-                            on: string;
-                            summary?: string | undefined;
-                            message?: string | undefined;
-                            found?: unknown;
-                            property?: string | undefined;
-                            expected?: string | undefined;
-                        };
-                    }>>;
-                };
                 list: {
                     get: (options: {
                         fetch?: RequestInit | undefined;
@@ -31558,30 +31579,6 @@ declare const eden: {
                         };
                     }>>;
                 };
-                total: {
-                    get: (options: {
-                        fetch?: RequestInit | undefined;
-                        headers?: Record<string, unknown> | undefined;
-                        query: {
-                            page?: number | undefined;
-                            items?: number | undefined;
-                        };
-                    }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
-                        200: {
-                            rewardTokenId: string;
-                            amount: bigint;
-                        };
-                        422: {
-                            type: "validation";
-                            on: string;
-                            summary?: string | undefined;
-                            message?: string | undefined;
-                            found?: unknown;
-                            property?: string | undefined;
-                            expected?: string | undefined;
-                        };
-                    }>>;
-                };
             }) & {};
             count: {
                 get: (options: {
@@ -31731,7 +31728,6 @@ declare const eden: {
                         chainId: number;
                         address: string;
                         recipient?: string | undefined;
-                        campaignIds?: string[] | undefined;
                         test?: boolean | undefined;
                     };
                 }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
@@ -31761,7 +31757,6 @@ declare const eden: {
                             chainId: number;
                             address: string;
                             recipient?: string | undefined;
-                            campaignIds?: string[] | undefined;
                             test?: boolean | undefined;
                         };
                     }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
@@ -31789,7 +31784,6 @@ declare const eden: {
                             chainId: number;
                             address: string;
                             recipient?: string | undefined;
-                            campaignIds?: string[] | undefined;
                             test?: boolean | undefined;
                         };
                     }) => Promise<import("@elysiajs/eden").Treaty.TreatyResponse<{
@@ -33495,10 +33489,13 @@ declare const eden: {
                                 mainProtocolId?: string | undefined;
                                 liveCampaignsForCreator?: number | undefined;
                                 protocol?: ({
+                                    banner: string | null;
                                     description: string;
                                     icon: string;
                                     id: string;
                                     name: string;
+                                    opportunityBannerDark: string | null;
+                                    opportunityBannerLight: string | null;
                                     tags: string[];
                                     url: string;
                                 } & {
@@ -33793,10 +33790,13 @@ declare const eden: {
                                 mainProtocolId?: string | undefined;
                                 liveCampaignsForCreator?: number | undefined;
                                 protocol?: ({
+                                    banner: string | null;
                                     description: string;
                                     icon: string;
                                     id: string;
                                     name: string;
+                                    opportunityBannerDark: string | null;
+                                    opportunityBannerLight: string | null;
                                     tags: string[];
                                     url: string;
                                 } & {
@@ -34202,6 +34202,9 @@ declare const eden: {
                                             description: string;
                                             url: string;
                                             icon: string;
+                                            banner: string | null;
+                                            opportunityBannerLight: string | null;
+                                            opportunityBannerDark: string | null;
                                         } | null;
                                         Protocols: {
                                             id: string;
@@ -34210,6 +34213,9 @@ declare const eden: {
                                             description: string;
                                             url: string;
                                             icon: string;
+                                            banner: string | null;
+                                            opportunityBannerLight: string | null;
+                                            opportunityBannerDark: string | null;
                                         }[];
                                         Tokens: {
                                             id: string;
@@ -34315,6 +34321,9 @@ declare const eden: {
                                             description: string;
                                             url: string;
                                             icon: string;
+                                            banner: string | null;
+                                            opportunityBannerLight: string | null;
+                                            opportunityBannerDark: string | null;
                                         } | null;
                                         Protocols: {
                                             id: string;
@@ -34323,6 +34332,9 @@ declare const eden: {
                                             description: string;
                                             url: string;
                                             icon: string;
+                                            banner: string | null;
+                                            opportunityBannerLight: string | null;
+                                            opportunityBannerDark: string | null;
                                         }[];
                                         Tokens: {
                                             id: string;
@@ -34425,10 +34437,13 @@ declare const eden: {
                                         mainProtocolId?: string | undefined;
                                         liveCampaignsForCreator?: number | undefined;
                                         protocol?: ({
+                                            banner: string | null;
                                             description: string;
                                             icon: string;
                                             id: string;
                                             name: string;
+                                            opportunityBannerDark: string | null;
+                                            opportunityBannerLight: string | null;
                                             tags: string[];
                                             url: string;
                                         } & {
@@ -35060,7 +35075,6 @@ export type FromPromise<R extends (...args: any) => Promise<{
     data: any;
 }>> = NonNullable<NonNullable<Awaited<ReturnType<R>>["data"]>[number]>;
 type RouteType<V extends ApiModuleVersion, R extends ApiModuleRoute<V>> = Awaited<ReturnType<"get" extends keyof Api[V][R] ? (Api[V][R]["get"] extends (...args: any) => any ? Api[V][R]["get"] : never) : never>>;
-// Exports types shared to the frontend
 export type Opportunity = OpportunityResourceModel;
 export type Protocol = FromPromise<Api["v4"]["protocols"]["get"]>;
 export type Campaign = FromPromise<Api["v4"]["campaigns"]["get"]>;

package/dist/src/engine/deprecated/dynamicData/implementations/Hyperdrive.d.ts CHANGED Viewed

@@ -7,18 +7,3 @@ export declare class HyperdriveDynamicData implements DynamicDataBuilder<campaig
     build(chainId: ChainId, campaigns: EngineCampaign<campaignType>[]): Promise<CampaignDynamicData<campaignType>[]>;
 }
 export {};
-// enum AssetIdPrefix {
-//   LP = 0,
-//   Long = 1,
-//   Short = 2,
-//   WithdrawalShare = 3,
-// }
-// function encodeAssetId(prefix: AssetIdPrefix, timestamp: bigint): bigint {
-//   // Check if the timestamp is within the valid range
-//   const maxTimestamp = BigInt("0xffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff");
-//   if (timestamp > maxTimestamp) {
-//     throw new Error("InvalidTimestamp");
-//   }
-//   // Encode the asset ID
-//   return (BigInt(prefix) << BigInt(248)) | timestamp;
-// }

package/dist/src/engine/deprecated/dynamicData/utils/getContractCreationBlock.d.ts CHANGED Viewed

@@ -1,3 +1,2 @@
 import type { JsonRpcProvider } from "@ethersproject/providers";
-// Function to find the contract creation transaction
 export declare function getContractCreationBlock(contractAddress: string, provider: JsonRpcProvider): Promise<number | undefined>;

package/dist/src/engine/deprecated/dynamicData/utils/getFixedApr.d.ts CHANGED Viewed

@@ -1,7 +1,4 @@
 import type { CampaignType } from "@package/resources/enums";
 import type { EngineCampaign } from "@package/resources/schemas";
 export type FixedAprCampaignType = CampaignType.ERC20_FIX_APR | CampaignType.HYPERDRIVELOGFIXPROCESSOR;
-// TODO: Enhance APR display for non-dollar denominations when front-end is ready.
-// This should handle cases where one or both token price are unavailable, showing the APR as a direct ratio
-// (e.g., X reward tokens per Y target tokens) instead of dollar values.
 export declare function getFixedApr(campaignParameters: EngineCampaign<CampaignType>, priceRewardToken: number, priceTargetToken: number): number;