add Merkl rewards to existing pools

Author: mastilver

src/adaptors/euler-v2/index.js

@@ -5,6 +5,7 @@ const lensAbi = require('./lens.abi.json');
 const factoryAbi = require('./factory.abi.json');
 const axios = require('axios');
 const { url } = require('inspector');
+const { addMerklRewardApy } = require('../merkl/merkl-additional-reward');
 
 const chains = {
   ethereum: {
@@ -131,7 +132,7 @@ const getApys = async () => {
       }
     }
   }
-  return result;
+  return addMerklRewardApy(result, 'euler');
 };
 
 module.exports = {

src/adaptors/gamma/index.js

@@ -3,6 +3,7 @@ const { request, gql } = require('graphql-request');
 const sdk = require('@defillama/sdk');
 const utils = require('../utils');
 const { print } = require('graphql');
+const { addMerklRewardApy } = require('../merkl/merkl-additional-reward');
 
 const EXCHANGES_API = {
   uniswapv3: '',
@@ -388,11 +389,13 @@ const getApy = async () => {
     '0x431f6e577a431d9ee87a535fde2db830e352e33c',
     '0xed17209ab7f9224e29cc9894fa14a011f37b6115',
   ];
-  return pools.flat().map((i) => ({
+  const data = pools.flat().map((i) => ({
     ...i,
     apyReward: x.includes(i.pool) || i.chain === 'Manta' ? null : i.apyReward,
     rewardTokens: x.includes(i.pool) || i.chain === 'Manta' ? null : i.rewardTokens,
   })).filter(p => p.chain != 'Binance');
+
+  return addMerklRewardApy(data, 'gamma', (p) => p.pool.split('-')[0]);
 };
 
 module.exports = {

src/adaptors/merkl/config.js

@@ -0,0 +1,23 @@
+exports.networks = {
+  1: 'ethereum',
+  137: 'polygon',
+  10: 'optimism',
+  42161: 'arbitrum',
+  1101: 'polygon_zkevm',
+  8453: 'base',
+  60808: 'bob',
+  146: 'sonic',
+  43114: 'avax',
+  80094: 'berachain',
+  56: 'bsc',
+};
+
+// Protocols that should not be listed under Merkl
+// as they already have their own adapters.
+exports.protocolsBlacklist = [
+  'euler',
+  'crosscurve',
+  'aerodrome',
+  'gamma',
+  'uniswap',
+];

src/adaptors/merkl/index.js

@@ -1,24 +1,6 @@
 const sdk = require('@defillama/sdk');
 const utils = require('../utils');
-
-const networks = {
-  1: 'ethereum',
-  137: 'polygon',
-  10: 'optimism',
-  42161: 'arbitrum',
-  1101: 'polygon_zkevm',
-  8453: 'base',
-  60808: 'bob',
-};
-
-// Protocols that should not be listed under Merkl
-// as they already have their own adapters.
-const protocolsBlacklist = [
-  'euler',
-  'crosscurve',
-  'aerodrome',
-  'gamma',
-];
+const { networks } = require('./config');
 
 // Allow specific pools from blacklisted protocols
 const poolsWhitelist = [
@@ -50,6 +32,7 @@ const main = async () => {
         data = await utils.getData(`https://api.merkl.xyz/v4/opportunities?chainId=${chainId}&status=LIVE&items=100&page=${pageI}`);
       } catch (err) {
         console.log('failed to fetch Merkl data on chain ' + chain);
+        break;
       }
 
       if (data.length === 0) {

src/adaptors/merkl/merkl-additional-reward.js

@@ -0,0 +1,68 @@
+const { networks } = require('../../constants');
+const { getData } = require('../utils');
+
+exports.addMerklRewardApy = async (
+  pools,
+  protocolId,
+  poolAddressGetter,
+) => {
+  try {
+    let merklPools = [];
+    let pageI = 0;
+
+    while(true) {
+      let data;
+      try {
+        data = await getData(`https://api.merkl.xyz/v4/opportunities?mainProtocolId=${protocolId}&status=LIVE&items=100&page=${pageI}`);
+      } catch (err) {
+        console.log(`failed to fetch Merkl data for ${protocolId}: ${err}`);
+        break;
+      }
+
+      if (data.length === 0) {
+        break;
+      }
+
+      merklPools.push(...data);
+      pageI++;
+    }
+
+
+    const merklPoolsMap = Object.fromEntries(Object.keys(networks).map(id => [networks[id], {}]));
+    merklPools.forEach(pool => {
+      if (!networks[pool.chainId]) {
+        return;
+      }
+
+      merklPoolsMap[networks[pool.chainId]][pool.identifier.toLowerCase()] = {
+        apyReward: pool.apr,
+        rewardTokens: [...new Set(pool.rewardsRecord?.breakdowns.map(x => x.token.address) || [])]
+      }
+    });
+
+    return pools.map(pool => {
+      const poolAddress = poolAddressGetter ? poolAddressGetter(pool) : pool.pool;
+      const merklRewards = merklPoolsMap[pool.chain.toLowerCase()][poolAddress.toLowerCase()];
+
+      if (!merklRewards) {
+        return pool;
+      }
+
+      // if the data is already present, don't overwrite it
+      if (pool.apyReward || (pool.rewardTokens && pool.rewardTokens.length !== 0)) {
+        console.log('pool already has apyReward or rewardTokens', pool.pool);
+        return pool;
+      }
+
+      return {
+        ...pool,
+        ...merklRewards,
+      }
+    });
+  } catch (err) {
+    console.log(`Failed to add Merkl reward apy to ${protocolId}: ${err}`);
+
+    // If we fail to fetch Merkl data, just return the original pools
+    return pools;
+  }
+};

src/adaptors/uniswap-v2/index.js

@@ -2,6 +2,7 @@ const sdk = require('@defillama/sdk');
 const { request, gql } = require('graphql-request');
 
 const utils = require('../utils');
+const { addMerklRewardApy } = require('../merkl/merkl-additional-reward');
 
 const chains = {
   ethereum: sdk.graph.modifyEndpoint(
@@ -126,7 +127,10 @@ const main = async (timestamp = null) => {
     }
   }
 
-  return data.filter((p) => utils.keepFinite(p));
+  return addMerklRewardApy(
+    data.filter((p) => utils.keepFinite(p)),
+    'uniswap'
+  );
 };
 
 module.exports = {

src/adaptors/uniswap-v3/index.js

@@ -7,6 +7,7 @@ const { EstimatedFees } = require('./estimateFee.ts');
 const { checkStablecoin } = require('../../handlers/triggerEnrichment');
 const { boundaries } = require('../../utils/exclude');
 const getOnchainPools = require('./onchain');
+const { addMerklRewardApy } = require('../merkl/merkl-additional-reward');
 
 const chains = {
   ethereum: sdk.graph.modifyEndpoint(
@@ -352,7 +353,8 @@ const main = async (timestamp = null) => {
     );
   }
   data.push(...(await getOnchainPools()))
-  return data
+  return addMerklRewardApy(
+    data
     .flat()
     .filter(
       (p) =>
@@ -361,7 +363,9 @@ const main = async (timestamp = null) => {
           '0x0c6d9d0f82ed2e0b86c4d3e9a9febf95415d1b76',
           '0xc809d13e9ea08f296d3b32d4c69d46ff90f73fd8',
         ].includes(p.pool)
-    );
+    ),
+    'uniswap'
+  );
 };
 
 module.exports = {