@merkl/api 0.21.28 → 0.21.30

package/dist/src/engine/deprecated/erc20SubTypeProcessors/helpers/factoryFinder.js

@@ -31,6 +31,7 @@ const factoryAddresses = {
     "0xB255D6A720BB7c39fee173cE22113397119cB930": Erc20SubType.katana, // Katana Ronin
     "0x29372c22459a4e373851798bFd6808e71EA34A71": Erc20SubType.punchswap, // Punchswap Flow EVM
     "0x724412C00059bf7d6ee7d4a1d0D5cd4de3ea1C48": Erc20SubType.hyperswap, // Hyperswap Factory HyperEVM
+    "0x8909Dc15e40173Ff4699343b6eB8132c65e18eC6": Erc20SubType.uniswapv2, // Uniswap Factory Base
 };
 export function getTypeFromFactoryAddress(address) {
     if (factoryAddresses[address]) {

package/dist/src/engine/deprecated/erc20SubTypeProcessors/subtypesRound1.js

@@ -118,7 +118,7 @@ function satisfiesNameConditions(name, type) {
         case Erc20SubType.lnd_lending:
             return lowerCaseName.includes("lnd");
         case Erc20SubType.dlend_lending:
-            return lowerCaseName.includes("dlend");
+            return lowerCaseName.startsWith("dlend") && !lowerCaseName.includes("debt");
         case Erc20SubType.compound:
             return lowerCaseName.includes("compound");
         case Erc20SubType.ironcladStaking:

package/dist/src/engine/implementations/Erc20/subTypes/factories.js

@@ -1,14 +1,12 @@
 import { Erc20SubType } from ".";
-import { DlendMetadata } from "./implementations/dlend/metadata";
-import { DlendTVLBuilder } from "./implementations/dlend/tvl";
+import { AaveMetadata } from "./implementations/aave/metadata";
+import { AaveTVLBuilder } from "./implementations/aave/tvl";
 import { EulerMetadata } from "./implementations/euler/metadata";
 import { EulerTVLBuilder } from "./implementations/euler/tvl";
 import { GearboxMetadata } from "./implementations/gearbox/metadata";
 import { GearboxTVLBuilder } from "./implementations/gearbox/tvl";
 import { LendleMetadata } from "./implementations/lendleVaults/metadata";
 import { LendleTVLBuilder } from "./implementations/lendleVaults/tvl";
-import { SuperlendMetadata } from "./implementations/superlend/metadata";
-import { SuperlendTVLBuilder } from "./implementations/superlend/tvl";
 import { TermMaxMetadata } from "./implementations/termmax/metadata";
 import { TermMaxTVLBuilder } from "./implementations/termmax/tvl";
 /**
@@ -19,14 +17,14 @@ import { TermMaxTVLBuilder } from "./implementations/termmax/tvl";
  */
 const tvlMap = {
     [Erc20SubType.gearbox]: new GearboxTVLBuilder(),
-    [Erc20SubType.superlend_borrowing]: new SuperlendTVLBuilder(),
-    [Erc20SubType.superlend_lending]: new SuperlendTVLBuilder(),
+    [Erc20SubType.superlend_borrowing]: new AaveTVLBuilder(),
+    [Erc20SubType.superlend_lending]: new AaveTVLBuilder(),
     [Erc20SubType.euler_borrow]: new EulerTVLBuilder(),
     [Erc20SubType.euler_lend]: new EulerTVLBuilder(),
     [Erc20SubType.lendle_vaults]: new LendleTVLBuilder(),
     [Erc20SubType.termmax]: new TermMaxTVLBuilder(),
-    [Erc20SubType.dlend_lending]: new DlendTVLBuilder(),
-    [Erc20SubType.dlend_borrowing]: new DlendTVLBuilder(),
+    [Erc20SubType.dlend_lending]: new AaveTVLBuilder(),
+    [Erc20SubType.dlend_borrowing]: new AaveTVLBuilder(),
 };
 export const erc20SubTypeTVLBuilderFactory = (erc20Subtype) => {
     if (!tvlMap[erc20Subtype]) {
@@ -42,14 +40,14 @@ export const erc20SubTypeTVLBuilderFactory = (erc20Subtype) => {
  */
 const metadataMap = {
     [Erc20SubType.gearbox]: new GearboxMetadata(),
-    [Erc20SubType.superlend_borrowing]: new SuperlendMetadata(),
-    [Erc20SubType.superlend_lending]: new SuperlendMetadata(),
+    [Erc20SubType.superlend_borrowing]: new AaveMetadata("superlend", "Superlend", (underlyingToken) => `https://markets.superlend.xyz/reserve-overview/?underlyingAsset=${underlyingToken}`),
+    [Erc20SubType.superlend_lending]: new AaveMetadata("superlend", "Superlend", (underlyingToken) => `https://markets.superlend.xyz/reserve-overview/?underlyingAsset=${underlyingToken}`),
     [Erc20SubType.euler_borrow]: new EulerMetadata(),
     [Erc20SubType.euler_lend]: new EulerMetadata(),
     [Erc20SubType.lendle_vaults]: new LendleMetadata(),
     [Erc20SubType.termmax]: new TermMaxMetadata(),
-    [Erc20SubType.dlend_lending]: new DlendMetadata(),
-    [Erc20SubType.dlend_borrowing]: new DlendMetadata(),
+    [Erc20SubType.dlend_lending]: new AaveMetadata("dlend", "dTrinity dLend", (underlyingToken) => `https://app.dtrinity.org/dlend/reserve-overview/?underlyingAsset=${underlyingToken}`),
+    [Erc20SubType.dlend_borrowing]: new AaveMetadata("dlend", "dTrinity dLend", (underlyingToken) => `https://app.dtrinity.org/dlend/reserve-overview/?underlyingAsset=${underlyingToken}`),
 };
 export const erc20SubTypeMetadataBuilderFactory = (erc20Subtype) => {
     if (!metadataMap[erc20Subtype]) {

package/dist/src/engine/implementations/Erc20/subTypes/implementations/aave/metadata.d.ts

@@ -0,0 +1,30 @@
+import type { MetadataBuilder } from "@/engine/metadata/interface";
+import type { CampaignWithParams } from "@/modules/v4/campaign/campaign.model";
+import type { ProtocolId } from "@/modules/v4/protocol/protocol.model";
+import type { Erc20LikeCampaignEnum } from "../..";
+export declare class AaveMetadata implements MetadataBuilder<Erc20LikeCampaignEnum> {
+    /**
+     *  @notice Protocol entity ID - must be defined in the corresponding file and created in DB
+     */
+    mainProtocol: ProtocolId;
+    /**
+     *  @notice Protocol name - used to create the opportunity name
+     */
+    protocolName: string;
+    /**
+     *  @notice Function to generate the deposit URL for the opportunity
+     */
+    depositUrl: (underlyingToken: string) => string;
+    constructor(mainProtocol: ProtocolId, protocolName: string, depositUrl: (underlyingToken: string) => string);
+    build(campaign: Omit<CampaignWithParams<Erc20LikeCampaignEnum>, "manualOverrides">, _opportunityIdentifier: string): Promise<{
+        action: "LEND" | "BORROW";
+        mainProtocol: "splice" | "reserve" | "morpho" | "quickswap" | "euler" | "uniswap" | "ambient" | "arthswap" | "base-swap" | "camelot" | "crust" | "fenix" | "horiza" | "izumi" | "kim" | "pancake-swap" | "ramses" | "retro" | "stryke" | "sushi-swap" | "swapr" | "thruster" | "voltage" | "zero" | "koi" | "supswap" | "zk-swap" | "thirdtrade" | "swap-x" | "velodrome" | "aerodrome" | "balancer" | "curve" | "cross_curve" | "curveNPool" | "aura" | "akron" | "beefy" | "dragonswap" | "poolside" | "syncswap" | "neptune" | "zkSwapThreePool" | "rfx" | "ra" | "maverick" | "trader-joe" | "hanji" | "radiant" | "aave" | "fraxlend" | "ironclad" | "gearbox" | "compound" | "sturdy" | "frax" | "ionic" | "moonwell" | "fluid" | "silo" | "dolomite" | "badger" | "ajna" | "layerbank" | "ion" | "venus" | "woofi" | "reactor_fusion" | "eigenlayer" | "vest" | "zerolend" | "lnd" | "dlend" | "hyperdrive" | "gamma" | "oku" | "hourglass" | "veda" | "kyo" | "sonex" | "lendle" | "tako-tako" | "equalizer" | "spectra" | "beraborrow" | "superlend" | "avalon" | "iguana" | "xlend" | "sake" | "sonicmarket" | "stability" | "angles" | "enzyme" | "toros" | "vicuna" | "bunni" | "beratrax" | "concrete" | "cian" | "pendle" | "yei" | "termmax" | "filament" | "gammaswap" | "maha" | "tempest" | "uranium" | "holdstation" | "katana" | "punchswap" | "satlayer" | "puffer";
+        name: string;
+        tokens: {
+            chainId: number;
+            address: any;
+        }[];
+        depositUrl: string;
+        explorerAddress: any;
+    }>;
+}

package/dist/src/engine/implementations/Erc20/subTypes/implementations/{superlend → aave}/metadata.js

@@ -1,7 +1,24 @@
 import { TokenService } from "@/modules/v4/token/token.service";
 import { OpportunityAction } from "@db/api";
 import { Aave__factory, ChainInteractionService, TokenInteractionService } from "@sdk";
-export class SuperlendMetadata {
+export class AaveMetadata {
+    /**
+     *  @notice Protocol entity ID - must be defined in the corresponding file and created in DB
+     */
+    mainProtocol;
+    /**
+     *  @notice Protocol name - used to create the opportunity name
+     */
+    protocolName;
+    /**
+     *  @notice Function to generate the deposit URL for the opportunity
+     */
+    depositUrl;
+    constructor(mainProtocol, protocolName, depositUrl) {
+        this.mainProtocol = mainProtocol;
+        this.protocolName = protocolName;
+        this.depositUrl = depositUrl;
+    }
     async build(campaign, _opportunityIdentifier) {
         const { params, computeChainId } = campaign;
         const { targetToken } = params;
@@ -16,13 +33,13 @@ export class SuperlendMetadata {
             : OpportunityAction.LEND;
         return {
             action,
-            mainProtocol: "superlend",
-            name: `${action === OpportunityAction.BORROW ? "Borrow" : "Supply"} ${underlyingTokenSymbol} on Superlend`,
+            mainProtocol: this.mainProtocol,
+            name: `${action === OpportunityAction.BORROW ? "Borrow" : "Supply"} ${underlyingTokenSymbol} on ${this.protocolName}`,
             tokens: [
                 { chainId: computeChainId, address: targetToken },
                 { chainId: computeChainId, address: underlyingToken },
             ],
-            depositUrl: `https://markets.superlend.xyz/reserve-overview/?underlyingAsset=${underlyingToken}`,
+            depositUrl: this.depositUrl(underlyingToken),
             explorerAddress: params.targetToken,
         };
     }

package/dist/src/engine/implementations/Erc20/subTypes/implementations/{dlend → aave}/tvl.d.ts

@@ -1,6 +1,6 @@
 import type { Erc20LikeCampaignEnum } from "@/engine/implementations/Erc20/subTypes";
 import type { TVLBuilder, TVLData } from "@/engine/tvl/interface";
 import { type CampaignParameters, type MerklChainId } from "@sdk";
-export declare class DlendTVLBuilder implements TVLBuilder<Erc20LikeCampaignEnum> {
+export declare class AaveTVLBuilder implements TVLBuilder<Erc20LikeCampaignEnum> {
     build(computeChainId: MerklChainId, campaigns: CampaignParameters<Erc20LikeCampaignEnum>[]): Promise<TVLData<any>>;
 }

package/dist/src/engine/implementations/Erc20/subTypes/implementations/{dlend → aave}/tvl.js

@@ -1,7 +1,7 @@
 import { TokenService } from "@/modules/v4/token/token.service";
 import { TvlType } from "@db/api";
 import { AaveInterface, ChainInteractionService, ERC20Interface, bigIntToNumber, } from "@sdk";
-export class DlendTVLBuilder {
+export class AaveTVLBuilder {
     async build(computeChainId, campaigns) {
         const tvls = [];
         const firstRound = await ChainInteractionService(computeChainId).fetchAndDecodeObject(campaigns.flatMap(campaign => {

package/dist/src/engine/implementations/UniswapV4/tvl.js

@@ -3,20 +3,20 @@ import { TokenService } from "@/modules/v4/token/token.service";
 import { log } from "@/utils/logger";
 import { engineDbClient } from "@db";
 import { TvlType } from "@db/api";
-import { BN2Number, ChainInteractionService, NETWORK_LABELS, } from "@sdk";
+import { BN2Number, ChainInteractionService, NETWORK_LABELS, UniswapV4Addresses, UniswapV4StateViewInterface, getRawPriceFromSqrtRatioX96, getSqrtRatioAtTick, } from "@sdk";
 /**
  * Compute TVL
  * @dev important: using the most recent state save with current prices
  *      it's only an estimate
  */
-async function computeUniV4PoolTVLFromMostRecentStateSave(computeChainId, poolID) {
+async function computeUniV4PoolTVLFromMostRecentStateSave(computeChainId, poolID, campaign) {
     let stateSave;
     let blockNumber;
     let states = {};
     // TEMPORARY: handle Gamma TVL
     const nodesTVL = {};
+    const currentBlock = await ChainInteractionService(computeChainId).getBlockNumber();
     try {
-        const currentBlock = await ChainInteractionService(computeChainId).getBlockNumber();
         const mostRecentStateSave = await engineDbClient.stateSave.findFirst({
             where: {
                 id: `UniswapV4_${computeChainId}_${poolID}`,
@@ -37,25 +37,57 @@ async function computeUniV4PoolTVLFromMostRecentStateSave(computeChainId, poolID
         return { amount0: 0n, amount1: 0n, blockNumber: blockNumber ?? 0, nodesTVL };
     }
     const { fileName } = states;
-    // Get nodes
+    // Root campaign info
+    const hasRulesOnPrice = !!campaign?.campaignParameters.lowerPriceBond || !!campaign?.campaignParameters.upperPriceBond;
+    let priceAtTick = 0n; // price in base 4
+    if (hasRulesOnPrice) {
+        const res = await ChainInteractionService(computeChainId).fetchArchiveState([
+            {
+                allowFailure: true,
+                callData: UniswapV4StateViewInterface.encodeFunctionData("getSlot0", [campaign.campaignParameters.poolId]),
+                target: UniswapV4Addresses[computeChainId].StateView,
+            },
+        ], blockNumber ?? currentBlock);
+        const poolData = UniswapV4StateViewInterface.decodeFunctionResult("getSlot0", res[0].returnData);
+        const tick = poolData.tick;
+        const sqrtRatioAtTick = BigInt(getSqrtRatioAtTick(tick).toString());
+        priceAtTick = getRawPriceFromSqrtRatioX96(1, sqrtRatioAtTick, campaign.campaignParameters.decimalsCurrency0, campaign.campaignParameters.decimalsCurrency1);
+    }
+    // SubCampaigns info
     const nodes = await engineDbClient.nodes.findMany({
         where: { chainId: computeChainId, nodeType: "GammaUniV4" },
         select: { nodeType: true, recipient: true },
     });
-    // Bucket service
     let amount0 = 0n;
     let amount1 = 0n;
     try {
+        // Bucket service
         const bucket = new BucketService("merkl-production-states", "merkl-production");
         const storedStates = JSON.parse(await bucket.pull(fileName));
-        for (const [_, { value, params: _params }] of Object.entries(storedStates)) {
-            amount0 += BigInt(value.amount0);
-            amount1 += BigInt(value.amount1);
-            // TEMPORARY: handle Gamma TVL
-            if (nodes.map(node => node.recipient).includes(_params.recipient)) {
-                const node = nodes.find(node => node.recipient === _params.recipient);
+        for (const [_, { value, params }] of Object.entries(storedStates)) {
+            // _ Handle rules
+            if (!!hasRulesOnPrice && priceAtTick > 0n) {
+                if (!!campaign.campaignParameters.lowerPriceBond) {
+                    const lowerPriceBond = BigInt(campaign.campaignParameters.lowerPriceBond);
+                    const sqrtRatioAtLowerTick = BigInt(getSqrtRatioAtTick(params.additional.tickLower).toString());
+                    const priceAtLowerTick = getRawPriceFromSqrtRatioX96(1, sqrtRatioAtLowerTick, campaign.campaignParameters.decimalsCurrency0, campaign.campaignParameters.decimalsCurrency1);
+                    if (priceAtLowerTick < lowerPriceBond)
+                        continue;
+                }
+                if (!!campaign.campaignParameters.upperPriceBond) {
+                    const upperPriceBond = BigInt(campaign.campaignParameters.upperPriceBond);
+                    const sqrtRatioAtUpperTick = BigInt(getSqrtRatioAtTick(params.additional.tickUpper).toString());
+                    const priceAtUpperTick = getRawPriceFromSqrtRatioX96(1, sqrtRatioAtUpperTick, campaign.campaignParameters.decimalsCurrency0, campaign.campaignParameters.decimalsCurrency1);
+                    if (priceAtUpperTick > upperPriceBond)
+                        continue;
+                }
+            }
+            // _ Handle subcampaigns TVL
+            // ----------------- TEMPORARY: handle Gamma TVL
+            if (nodes.map(node => node.recipient).includes(params.recipient)) {
+                const node = nodes.find(node => node.recipient === params.recipient);
                 if (!node) {
-                    log.warn(`merklDynamic data - failed to find node ${_params.recipient} for pool ${poolID}`);
+                    log.warn(`merklDynamic data - failed to find node ${params.recipient} for pool ${poolID}`);
                     continue;
                 }
                 if (!nodesTVL[node.nodeType]) {
@@ -63,7 +95,11 @@ async function computeUniV4PoolTVLFromMostRecentStateSave(computeChainId, poolID
                 }
                 nodesTVL[node.nodeType].amount0 += BigInt(value.amount0);
                 nodesTVL[node.nodeType].amount1 += BigInt(value.amount1);
+                // -----------------
             }
+            // _ Add amounts for TVL
+            amount0 += BigInt(value.amount0);
+            amount1 += BigInt(value.amount1);
         }
     }
     catch {
@@ -75,7 +111,7 @@ export class UniswapV4TVLBuilder {
     async build(computeChainId, campaigns) {
         const tvls = [];
         for (const campaign of campaigns) {
-            const { amount0: poolBalanceToken0, amount1: poolBalanceToken1, nodesTVL, } = await computeUniV4PoolTVLFromMostRecentStateSave(computeChainId, campaign.campaignParameters.poolId);
+            const { amount0: poolBalanceToken0, amount1: poolBalanceToken1, nodesTVL, } = await computeUniV4PoolTVLFromMostRecentStateSave(computeChainId, campaign.campaignParameters.poolId, campaign);
             const token0Id = TokenService.hashId({
                 chainId: computeChainId,
                 address: campaign.campaignParameters.currency0,

package/dist/src/utils/generateCardName.js

@@ -40,8 +40,9 @@ export function generateCardName(type, typeInfo, campaign, symbols = [""], displ
         case Erc20SubType.traderJoe:
         case Erc20SubType.katana:
         case Erc20SubType.punchswap:
-        case Erc20SubType.hyperswap:
             return `Provide liquidity to ${capitalize(typeInfo.protocol)} ${typeInfo.symbolToken0}-${typeInfo.symbolToken1}`;
+        case Erc20SubType.hyperswap:
+            return `Provide liquidity to HyperSwap Standard AMM ${typeInfo.symbolToken0}-${typeInfo.symbolToken1}`;
         case Erc20SubType.pendleYT:
             return `Hold ${capitalize(typeInfo.protocol)} ${typeInfo.name}`;
         case Erc20SubType.pendle: