@merkl/api 1.0.78 → 1.0.80

package/dist/src/cache/declaration.d.ts

@@ -0,0 +1,133 @@
+import { TTLType } from "./redis";
+export declare const CacheDeclaration: {
+    Updates: {
+        compressed: false;
+        redisTTL: TTLType.Minutes2;
+        localCache: false;
+    };
+    Delays: {
+        compressed: false;
+        redisTTL: TTLType.Minutes2;
+        localCache: false;
+    };
+    TwtParticipants: {
+        compressed: false;
+        redisTTL: TTLType.Minutes5;
+        localCache: false;
+    };
+    LastBlockBefore: {
+        compressed: false;
+        redisTTL: TTLType.Hours12;
+        localCache: false;
+    };
+    LostYield: {
+        compressed: false;
+        redisTTL: TTLType.Hours3;
+        localCache: false;
+    };
+    DolomiteMarkets: {
+        compressed: false;
+        redisTTL: TTLType.Minutes30;
+        localCache: false;
+    };
+    EulerV2Vaults: {
+        compressed: false;
+        redisTTL: TTLType.Day;
+        localCache: false;
+    };
+    CompoundV2ForksVaults: {
+        compressed: false;
+        redisTTL: TTLType.Week;
+        localCache: false;
+    };
+    RadiantMarkets: {
+        compressed: false;
+        redisTTL: TTLType.Minutes30;
+        localCache: false;
+    };
+    SiloMarkets: {
+        compressed: false;
+        redisTTL: TTLType.Minutes30;
+        localCache: false;
+    };
+    MorphoMarkets: {
+        compressed: false;
+        redisTTL: TTLType.Minutes30;
+        localCache: false;
+    };
+    Prices: {
+        compressed: true;
+        redisTTL: TTLType.Minutes30;
+        localCache: false;
+    };
+    MerklChainData: {
+        compressed: false;
+        redisTTL: TTLType.Minutes30;
+        localCache: false;
+    };
+    Opportunities: {
+        compressed: true;
+        redisTTL: TTLType.Hours12;
+        localCache: false;
+    };
+    OpportunitiesWithTest: {
+        compressed: true;
+        redisTTL: TTLType.Hours12;
+        localCache: false;
+    };
+    Campaigns: {
+        compressed: true;
+        redisTTL: TTLType.Hours12;
+        localCache: false;
+    };
+    LiveCampaigns: {
+        compressed: true;
+        redisTTL: TTLType.Hours12;
+        localCache: false;
+    };
+    CampaignsOldFormat: {
+        compressed: true;
+        redisTTL: TTLType.Hours12;
+        localCache: false;
+    };
+    LiveCampaignsOldFormat: {
+        compressed: true;
+        redisTTL: TTLType.Hours12;
+        localCache: false;
+    };
+    StaticCampaigns: {
+        compressed: true;
+        redisTTL: TTLType.Hours12;
+        localCache: false;
+    };
+    Blacklist: {
+        compressed: true;
+        redisTTL: TTLType.Minutes10;
+        localCache: false;
+    };
+    TokenList: {
+        compressed: false;
+        redisTTL: TTLType.Minutes30;
+        localCache: false;
+    };
+    CurrentRoot: {
+        compressed: false;
+        redisTTL: TTLType.Seconds30;
+        localCache: true;
+    };
+    Chains: {
+        compressed: false;
+        redisTTL: TTLType.Hours3;
+        localCache: true;
+    };
+    RootsWithRewardOnChain: {
+        compressed: false;
+        redisTTL: TTLType.Minutes2;
+        localCache: true;
+    };
+    UniswapV4Pools: {
+        compressed: false;
+        redisTTL: TTLType.Day;
+        localCache: false;
+    };
+};

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

@@ -0,0 +1,61 @@
+import NodeCache from "node-cache";
+import type { CacheKeys } from "./keys";
+export type CacheArg = {
+    [Key in keyof CacheKeys]: CacheKeys[Key]["arg"] extends null ? `${Key}` : `${Key}_${CacheKeys[Key]["arg"]}`;
+};
+export type CacheKey<Key extends keyof CacheKeys = keyof CacheKeys> = Key;
+export type AnyKey<BaseKey extends CacheKey, ActualKey extends BaseKey | NonNullable<CacheArg[BaseKey]>> = ActualKey extends CacheKey ? BaseKey : NonNullable<CacheArg[BaseKey]>;
+export type Getter = <K extends string | string[]>(key: K) => Promise<K extends string[] ? string[] : string>;
+export declare class Cache {
+    static decoder: TextDecoder;
+    static encoder: TextEncoder;
+    localCache: NodeCache;
+    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"];
+    /** @notice Compress (if enabled), stringify and encoded data to be stored in the cache */
+    static compress<T extends CacheKey, Key extends T | NonNullable<CacheArg[T]>>(key: Key, value: CacheKeys[T]["returns"]): string;
+    private getRaw;
+    private getManyRaw;
+    private setRaw;
+    /** @notice Set value for a given key for both local and raw cache */
+    private set;
+    /**
+     * @deprecated Local cache is not used anymore
+     */
+    private isLocallyCached;
+    /**
+     * @deprecated Local cache is not used anymore
+     */
+    private setLocally;
+    /**
+     * @deprecated Local cache is not used anymore
+     */
+    private getLocally;
+    /**
+     * @returns the uncompressed (if enabled), parsed and typed data from the cache
+     */
+    get<Key extends CacheKey, Args extends CacheKeys[Key]["arg"]>(key: Key, args?: Args): Promise<CacheKeys[Key]["returns"]>;
+    /**
+     * Get many data from cache
+     * @param key cache key
+     * @returns the uncompressed (if enabled), parsed and typed data from the cache for all keys
+     */
+    findMany<T extends CacheKey, Key extends T | NonNullable<CacheArg[T]>>(keys: Key[]): Promise<CacheKeys[T]["returns"][]>;
+    /**
+     * Get many data from cache with argument
+     * @param key cache key
+     * @param args arguments to append to cache keys
+     * @returns the uncompressed (if enabled), parsed and typed data from the cache for all keys
+     */
+    getManyWithArgs<Key extends CacheKey, Args extends CacheKeys[Key]["arg"]>(key: CacheKeys[Key]["arg"] extends null ? never : Key, args: Args[]): Promise<CacheKeys[Key]["returns"][]>;
+    /**
+     * Get data from cache or set it using the callback
+     * @param key cache key
+     * @returns the uncompressed (if enabled), parsed and typed data from the cache
+     */
+    getOrSet<T extends CacheKey, Key extends T | NonNullable<CacheArg[T]>, Args extends any[]>(key: AnyKey<T, Key>, callback: (...args: Args) => Promise<CacheKeys[T]["returns"]>, ...args: Args): Promise<CacheKeys[T]["returns"]>;
+    /** @notice Set with retrials */
+    safeSet<T extends CacheKey, Key extends T | NonNullable<CacheArg[T]>>(key: Key, value: CacheKeys[T]["returns"]): Promise<void>;
+}
+export declare const Redis: Cache;

package/dist/src/cache/redis.d.ts

@@ -0,0 +1,23 @@
+import { type RedisClientType } from "redis";
+export declare const REDIS_RETRIES = 0;
+export declare const REDIS_READ_TIMEOUT: number;
+export declare const REDIS_WRITE_TIMEOUT = 4000;
+export declare const REDIS_CRON_READ_TIMEOUT = 5000;
+export declare const REDIS_CRON_WRITE_TIMEOUT = 10000;
+export declare enum TTLType {
+    HalfBlock = 4,
+    Block = 11,
+    Seconds30 = 30,
+    Minutes2 = 120,
+    Minutes3 = 180,
+    Minutes5 = 300,
+    Minutes10 = 600,
+    Minutes25 = 1500,
+    Minutes30 = 1800,
+    Minutes35 = 2100,
+    Hours3 = 10800,
+    Hours12 = 43200,
+    Day = 86400,
+    Week = 604800
+}
+export declare const redisClient: RedisClientType;

package/dist/src/constants.d.ts

@@ -0,0 +1,86 @@
+import { type MerklChainId } from "@angleprotocol/sdk/ts";
+export declare const DEFAULT_LOCAL_TTL = 120;
+export declare const MAX_NUM_SUBCALLS = 100;
+export declare const MERKL_USER_POSITION_FETCHING_TIMEOUT = 8000;
+export declare const MERKL_USER_POSITION_FETCHING_GLOBAL_TIMEOUT = 10000;
+export declare const MERKL_ALM_POSITION_FETCHING_TIMEOUT = 100000;
+export declare const EBTC_ADDRESS = "0x661c70333AA1850CcDBAe82776Bb436A0fCfeEfB";
+export declare const CDPMANAGER_ADDRESS = "0xc4cbaE499bb4Ca41E78f52F07f5d98c375711774";
+export declare const SORTEDCDPS_ADDRESS = "0x591AcB5AE192c147948c12651a0a5f24f0529BE3";
+export declare const RFX_DATASTORE = "0x895124783008C6c68eFcccac24c482Fdf30439B2";
+export declare const constantChain: {
+    1: {
+        apw: string;
+        convexEndpoint: string;
+        crv: string;
+        crv3: string;
+        crvANGLESDANGLE: string;
+        crvEURAEUROC: string;
+        crvEURAEURe: string;
+        crvEuropool: string;
+        crvFRAX: string;
+        crvFRAXEURA: string;
+        crvLUSD3CRV: string;
+        cvx: string;
+        dai: string;
+        frax: string;
+        fxs: string;
+        morpho: string;
+        rKP3R: string;
+        sdt: string;
+        stakeEndpoint: string;
+        sushi: string;
+        usdc: string;
+        weth: string;
+        wstETH: string;
+    };
+    42161: {
+        arb: string;
+        chr: string;
+        convexProxy: string;
+        crv: string;
+        crv2Pool: string;
+        cvx: string;
+        frax: string;
+        jeur: string;
+        ram: string;
+        sdt: string;
+        sliz: string;
+        stakeEndpoint: string;
+        usdc: string;
+    };
+    10: {
+        jeur: string;
+        mai: string;
+        op: string;
+        usdc: string;
+        usdce: string;
+        velo: string;
+        veloV2: string;
+    };
+    8453: {
+        aero: string;
+        usdc: string;
+    };
+    137: {
+        am3CRV: string;
+        amDAI: string;
+        amUSDC: string;
+        amUSDT: string;
+        jeur: string;
+        jrt: string;
+        oretro: string;
+        usdc: string;
+    };
+    43114: {
+        glcr: string;
+        usdc: string;
+    };
+    56: {
+        cake: string;
+    };
+};
+export declare const MAVERICK_ZKSYNC_BP_LENS_ADDRESS = "0xd32CE31CaC98CAC0631764B8286358c0606D87F9";
+export declare const SPECTRA_NETWORK_SLUGS: {
+    [chainId in MerklChainId]?: string;
+};