@merkl/api 0.10.129 → 0.10.130

package/dist/src/constants.js

@@ -0,0 +1,119 @@
+import Big from "big.js";
+export const zeroBN = new Big(0);
+export const baseTestAnalyticsGraphUrl = "https://api.thegraph.com/subgraphs/name/angleprotocol/test-analytics-";
+export const baseAnalyticsGraphUrl = "https://api.thegraph.com/subgraphs/name/angleprotocol/test-analytics-";
+export const EXPORTER_URL = "https://exporter.angle.money";
+export const DEFAULT_LOCAL_TTL = 120;
+export const subgraphSuffixMapping = {
+    [ChainId.ARBITRUM]: "arb",
+    [ChainId.MAINNET]: "eth",
+    [ChainId.OPTIMISM]: "opt",
+    [ChainId.POLYGON]: "pol",
+    [ChainId.BASE]: "bas",
+    [ChainId.POLYGONZKEVM]: "zke",
+};
+export const MAX_NUM_SUBCALLS = 100;
+export const MERKL_TREE_OPTIONS = { hashLeaves: true, sortLeaves: true, sortPairs: true };
+export const MERKL_USER_POSITION_FETCHING_TIMEOUT = 8000;
+export const MERKL_USER_POSITION_FETCHING_GLOBAL_TIMEOUT = 10000;
+export const MERKL_USER_CLAIMED_TOKENS_TIMEOUT = 10000;
+export const MERKL_ALM_FETCHING_TIMEOUT = 10000;
+export const MERKL_ALM_POSITION_FETCHING_TIMEOUT = 100000;
+export const MERKL_USER_REWARDS_FETCHING_TIMEOUT = 10000;
+export const GITHUB_MERKL_REWARDS_URL = "https://raw.githubusercontent.com/AngleProtocol/merkl-rewards/main/";
+export const GCLOUD_STORAGE_MERKL_PUBLIC_URL = "https://storage.googleapis.com/merkl-production-rewards/";
+export const MERKL_BLACKLIST = [
+    "0xa6161c3e1bc3c743819f0be91322e108946c1a0e7666ae2885ce03c2068cbef7", // ETH - stETH fucked up by gauntlet
+];
+export const EBTC_ADDRESS = "0x661c70333AA1850CcDBAe82776Bb436A0fCfeEfB";
+export const CDPMANAGER_ADDRESS = "0xc4cbaE499bb4Ca41E78f52F07f5d98c375711774";
+export const SORTEDCDPS_ADDRESS = "0x591AcB5AE192c147948c12651a0a5f24f0529BE3";
+export const RFX_DATASTORE = "0x895124783008C6c68eFcccac24c482Fdf30439B2";
+export const DOPEX_OPTION_MARKET = {
+    // UniswapV3 pools
+    ["0xC6962004f452bE9203591991D15f6b388e09E8D0".toLowerCase()]: "0x501B03BdB431154b8Df17BF1c00756E3a8F21744",
+    ["0x0E4831319A50228B9e450861297aB92dee15B44F".toLowerCase()]: "0x550e7E236912DaA302F7d5D0d6e5D7b6EF191f04", // wBTC / USDC
+    ["0xb0f6cA40411360c03d41C5fFc5F179b8403CdcF8".toLowerCase()]: "0x4eed3A2b797Bf5630517EcCe2e31C1438A76bb92",
+    ["0xC31E54c7a869B9FcBEcc14363CF510d1c41fa443".toLowerCase()]: "0x764fA09d0B3de61EeD242099BD9352C1C61D3d27",
+    ["0xac70bD92F89e6739B3a08Db9B6081a923912f73D".toLowerCase()]: "0x3808E8C983023a125fFE2714E2A703A3BF02bE0d",
+    ["0xcDa53B1F66614552F834cEeF361A8D12a0B8DaD8".toLowerCase()]: "0x77b6f45a3Dcf0493f1B9Ac9874e5982AB526AA9e",
+    // PCS pools
+    ["0x843aC8dc6D34AEB07a56812b8b36429eE46BDd07".toLowerCase()]: "0x550e7E236912DaA302F7d5D0d6e5D7b6EF191f04", // wBTC / USDC
+    ["0xd9e2a1a61b6e61b275cec326465d417e52c1b95c".toLowerCase()]: "0x501B03BdB431154b8Df17BF1c00756E3a8F21744", // wETH / USDC
+    ["0x9fFCA51D23Ac7F7df82da414865Ef1055E5aFCc3".toLowerCase()]: "0x4eed3A2b797Bf5630517EcCe2e31C1438A76bb92", // ARB / USDC
+};
+import { ChainId } from "@sdk";
+const COMMON_PREFIX_STAKE = "https://lockers.stakedao.org/api/strategies/cache/curve";
+const COMMON_PREFIX_CONVEX = "https://www.convexfinance.com/api/curve-apys";
+export const constantChain = {
+    [ChainId.MAINNET]: {
+        apw: "0x4104b135dbc9609fc1a9490e61369036497660c8",
+        convexEndpoint: COMMON_PREFIX_CONVEX,
+        crv: "0xD533a949740bb3306d119CC777fa900bA034cd52",
+        crv3: "0x6c3F90f043a72FA612cbac8115EE7e52BDe6E490",
+        crvANGLESDANGLE: "0x96AAE323E111A19b1E0e26F55e8De21F1dD01f26",
+        crvEURAEUROC: "0xBa3436Fd341F2C8A928452Db3C5A3670d1d5Cc73",
+        crvEURAEURe: "0x413928a25D6ea1A26F2625d633207755f67Bf97c",
+        crvEuropool: "0xe7A3b38c39F97E977723bd1239C3470702568e7B",
+        crvFRAX: "0x3175Df0976dFA876431C2E9eE6Bc45b65d3473CC",
+        crvFRAXEURA: "0x22e859Ee894c2068920858A60b51DC03ac5581c1",
+        crvLUSD3CRV: "0xEd279fDD11cA84bEef15AF5D39BB4d4bEE23F0cA",
+        cvx: "0x4e3FBD56CD56c3e72c1403e103b45Db9da5B9D2B",
+        dai: "0x6B175474E89094C44Da98b954EedeAC495271d0F",
+        frax: "0x853d955aCEf822Db058eb8505911ED77F175b99e",
+        fxs: "0x3432B6A60D23Ca0dFCa7761B7ab56459D9C964D0",
+        morpho: "0x9994E35Db50125E0DF82e4c2dde62496CE330999",
+        rKP3R: "0x1ceb5cb57c4d4e2b2433641b95dd330a33185a44",
+        sdt: "0x73968b9a57c6e53d41345fd57a6e6ae27d6cdb2f",
+        stakeEndpoint: COMMON_PREFIX_STAKE,
+        sushi: "0x6b3595068778dd592e39a122f4f5a5cf09c90fe2",
+        usdc: "0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48",
+        weth: "0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2",
+        wstETH: "0x7f39C581F595B53c5cb19bD0b3f8dA6c935E2Ca0",
+    },
+    [ChainId.ARBITRUM]: {
+        arb: "0x912ce59144191c1204e64559fe8253a0e49e6548",
+        chr: "0x15b2fb8f08E4Ac1Ce019EADAe02eE92AeDF06851",
+        convexProxy: "0x989AEb4d175e16225E39E87d0D97A3360524AD80",
+        crv: "0x11cdb42b0eb46d95f990bedd4695a6e3fa034978",
+        crv2Pool: "0x7f90122BF0700F9E7e1F688fe926940E8839F353",
+        cvx: "0xb952A807345991BD529FDded05009F5e80Fe8F45",
+        frax: "0x17FC002b466eEc40DaE837Fc4bE5c67993ddBd6F",
+        jeur: "0xAD435674417520aeeED6b504bBe654d4f556182F",
+        ram: "0xAAA6C1E32C55A7Bfa8066A6FAE9b42650F262418",
+        sdt: "0x7ba4a00d54a07461d9db2aef539e91409943adc9",
+        sliz: "0x463913D3a3D3D291667D53B8325c598Eb88D3B0e",
+        stakeEndpoint: `${COMMON_PREFIX_STAKE}-arbitrum`,
+        usdc: "0xFF970A61A04b1cA14834A43f5dE4533eBDDB5CC8",
+    },
+    [ChainId.OPTIMISM]: {
+        jeur: "0x79AF5dd14e855823FA3E9ECAcdF001D99647d043",
+        mai: "0xdFA46478F9e5EA86d57387849598dbFB2e964b02",
+        op: "0x4200000000000000000000000000000000000042",
+        usdc: "0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85",
+        usdce: "0x7F5c764cBc14f9669B88837ca1490cCa17c31607",
+        velo: "0x3c8b650257cfb5f272f799f5e2b4e65093a11a05",
+        veloV2: "0x9560e827aF36c94D2Ac33a39bCE1Fe78631088Db",
+    },
+    [ChainId.BASE]: {
+        aero: "0x940181a94A35A4569E4529A3CDfB74e38FD98631",
+        usdc: "0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913",
+    },
+    [ChainId.POLYGON]: {
+        am3CRV: "0xE7a24EF0C5e95Ffb0f6684b813A78F2a3AD7D171",
+        amDAI: "0x27F8D03b3a2196956ED754baDc28D73be8830A6e",
+        amUSDC: "0x1a13F4Ca1d028320A707D99520AbFefca3998b7F",
+        amUSDT: "0x60D55F02A771d515e077c9C2403a1ef324885CeC",
+        jeur: "0x4e3Decbb3645551B8A19f0eA1678079FCB33fB4c",
+        jrt: "0x596ebe76e2db4470966ea395b0d063ac6197a8c5",
+        oretro: "0x3A29CAb2E124919d14a6F735b6033a3AaD2B260F",
+        usdc: "0x2791Bca1f2de4661ED88A30C99A7a9449Aa84174",
+    },
+    [ChainId.AVALANCHE]: {
+        glcr: "0x3712871408a829C5cd4e86DA1f4CE727eFCD28F6",
+        usdc: "0xB97EF9Ef8734C71904D8002F8b6Bc66Dd9c48a6E",
+    },
+    [ChainId.BSC]: {
+        cake: "0x0E09FaBB73Bd3Ade0a17ECC321fD13a19e81cE82",
+    },
+};

package/dist/src/entities/campaign.js

@@ -0,0 +1,134 @@
+import { Redis } from "../cache";
+import { Campaign, Int256 } from "@sdk";
+import moment from "moment";
+export const activeCampaign = (v) => v.startTimestamp < moment().unix() && v.endTimestamp > moment().unix();
+export const inactiveCampaign = (v) => v.startTimestamp > moment().unix() || v.endTimestamp < moment().unix();
+export const removeTestTokens = (v) => !["aglamerkl", "test"].includes(v.campaignParameters.symbolRewardToken?.toLowerCase());
+export async function getCampaignsFor(chainIds, filters = { onlyLive: false }) {
+    const cachePrefix = filters?.onlyLive ? "LiveCampaigns" : "Campaigns";
+    const cacheKeys = chainIds.map(chain => `${cachePrefix}_${chain}`);
+    return (await Redis.getMany(cacheKeys)).reduce((prev, allData, index) => {
+        if (!!allData) {
+            const chain = chainIds[index];
+            prev[chain] = Object.keys(allData).reduce((acc, curr) => {
+                const [type, mainParameter] = curr.split("_");
+                const campaignType = Number.parseInt(type);
+                if (!filters?.types?.length || filters?.types?.includes(campaignType))
+                    acc[`${campaignType}_${mainParameter}`] = allData[curr];
+                return acc;
+            }, {});
+        }
+        return prev;
+    }, {});
+}
+/**
+ * @returns all opportunityIds in the campaign data
+ */
+export function extractIds(campaigns) {
+    const chains = Object.keys(campaigns).map(n => Number.parseInt(n));
+    return chains.flatMap(chainId => Object.keys(campaigns[chainId] ?? {})?.map(opportunityId => `${chainId}_${opportunityId}`));
+}
+/**
+ * @returns the daily price of all rewards from the campaign array
+ */
+export function getDailyRewards(campaigns, prices) {
+    const rewardPrices = campaigns
+        .map(({ campaignParameters: c, amount, endTimestamp, startTimestamp, campaignType }) => {
+        const isSporadic = [Campaign.ERC20_SNAPSHOT, Campaign.JSON_AIRDROP].includes(campaignType);
+        const timespan = Math.abs(endTimestamp - startTimestamp);
+        let dayspan = isSporadic ? 1 : Math.floor(timespan / (60 * 60 * 24));
+        if (dayspan === 0)
+            dayspan = 1; // If distribution periode < 1 day -> avoid division by 0
+        return [c.symbolRewardToken, Int256.from(amount, c.decimalsRewardToken).div(dayspan)];
+    })
+        .map(([symbol, amount]) => {
+        return Math.max(prices?.[symbol] ?? 0, 0) * (amount?.toNumber() ?? 0);
+    });
+    return rewardPrices?.length > 0 ? rewardPrices.reduce((a, b) => a + b) : 0;
+}
+/**
+ * @returns the status of an opportunity based on its campaigns
+ */
+export function getStatus(campaigns) {
+    const active = campaigns?.filter(activeCampaign);
+    const inactive = campaigns?.filter(inactiveCampaign);
+    if (active?.length)
+        return "live";
+    if (inactive?.some(v => v.startTimestamp > moment().unix()))
+        return "soon";
+    return "past";
+}
+/**
+ * @returns the sum of the APRs from a campaigns array
+ */
+export function getApr(campaigns) {
+    return campaigns.reduce((res, campaign) => res + (campaign.apr ?? 0), 0);
+}
+/**
+ * @returns the sum of the all tags
+ */
+export function getTags(campaigns) {
+    const tags = Array.from(campaigns.reduce((res, campaign) => {
+        campaign.tags?.forEach(tag => {
+            res.add(tag);
+        });
+        return res;
+    }, new Set()));
+    return tags.length === 0 ? undefined : tags;
+}
+/**
+ * @returns all the reward token symbols from a compaign array
+ */
+export function getRewardTokenIcons(campaigns) {
+    const rewardTokens = new Set();
+    campaigns.forEach(({ rewardToken }) => rewardTokens.add(rewardToken));
+    return Array.from(rewardTokens);
+}
+/**
+ * @returns the daily reward token symbols from a compaign array
+ */
+export function getRewardTokens(campaigns) {
+    const rewardTokens = {};
+    campaigns.forEach(({ amount, rewardToken, campaignParameters: { symbolRewardToken: symbol }, ...c }) => {
+        const timespan = Math.abs(c.endTimestamp - c.startTimestamp);
+        const dayspan = Math.max(Math.floor(timespan / (60 * 60 * 24)), 1);
+        const dailyAmount = BigInt(amount) / BigInt(dayspan);
+        if (!rewardTokens[symbol])
+            rewardTokens[symbol] = { amount: dailyAmount, address: rewardToken };
+        else
+            rewardTokens[symbol].amount += dailyAmount;
+    });
+    return Object.entries(rewardTokens).map(([symbol, { amount, address }]) => ({
+        symbol,
+        address,
+        amount: amount.toString(),
+    }));
+}
+/**
+ * @returns campaigns that match the opportunityIds
+ */
+export function splitCampaigns(campaigns, ids, showTest) {
+    if (!campaigns || !ids?.length)
+        return [];
+    const campaignAt = (id) => {
+        const [chainId, type, mainParameter] = id.split("_");
+        return (campaigns?.[chainId]?.[`${type}_${mainParameter}`] ??
+            Object.entries(campaigns[chainId] ?? {}).find(([t_m]) => t_m?.toLowerCase() === id?.toLowerCase())?.[1]);
+    };
+    return ids
+        .filter(id => campaignAt(id) !== undefined)
+        .map(id => {
+        let all = Object.values(campaignAt(id) ?? {});
+        if (!showTest)
+            all = all.filter(removeTestTokens);
+        const active = all?.filter(activeCampaign);
+        const inactive = all?.filter(inactiveCampaign);
+        return {
+            id,
+            all,
+            active,
+            inactive,
+        };
+    })
+        .filter(opportunity => opportunity?.all?.length);
+}