Merge branch 'DefiLlama:master' into master

Author: Brenzee

adapters/types.ts

@@ -41,6 +41,7 @@ export type FetchOptions = {
   getEndBlock: () => Promise<number>,
   dateString: string,
   preFetchedResults?: any,
+  moduleUID: string,  // randomly generated unique identifier for the module, useful for caching
 }
 
 export type FetchGetLogsOptions = {
@@ -78,9 +79,6 @@ export type BaseAdapterChainConfig = {
     start?: IStartTimestamp | number | string; // date can be in "YYYY-MM-DD" format
     fetch?: Fetch | FetchV2;
     runAtCurrTime?: boolean;
-    meta?: {
-      methodology?: string | IJSON<string>
-    }
   }
 
 export type BaseAdapter = {
@@ -155,6 +153,12 @@ export type FetchResultFees = FetchResultBase & {
   dailyBribesRevenue?: FetchResponseValue;
   dailyTokenTaxes?: FetchResponseValue;
   totalHoldersRevenue?: FetchResponseValue;
+  dailyOtherIncome?: FetchResponseValue;
+  totalOtherIncome?: FetchResponseValue;
+  dailyOperatingIncome?: FetchResponseValue;
+  totalOperatingIncome?: FetchResponseValue;
+  dailyNetIncome?: FetchResponseValue;
+  totalNetIncome?: FetchResponseValue;
 };
 
 // INCENTIVES
@@ -201,11 +205,12 @@ export const whitelistedDimensionKeys = new Set([
   'dailyVolume', 'totalVolume', 'shortOpenInterestAtEnd', 'longOpenInterestAtEnd', 'openInterestAtEnd', 'dailyBridgeVolume', 'totalBridgeVolume',
   'totalFees', 'dailyFees', 'dailyUserFees', 'totalRevenue', 'dailyRevenue', 'dailyProtocolRevenue', 'dailyHoldersRevenue', 'dailySupplySideRevenue', 'totalProtocolRevenue', 'totalSupplySideRevenue', 'totalUserFees', 'dailyBribesRevenue', 'dailyTokenTaxes', 'totalHoldersRevenue',
   'tokenIncentives',
+  'dailyOtherIncome', 'totalOtherIncome', 'dailyOperatingIncome', 'totalOperatingIncome', 'dailyNetIncome', 'totalNetIncome',
   'totalPremiumVolume', 'totalNotionalVolume', 'dailyPremiumVolume', 'dailyNotionalVolume',
 ])
 export const accumulativeKeySet = new Set([
   'totalVolume', 'totalBridgeVolume', 'tokenIncentives', 'totalPremiumVolume', 'totalNotionalVolume',
-  'totalFees', 'totalRevenue', 'totalProtocolRevenue', 'totalSupplySideRevenue', 'totalUserFees', 'totalHoldersRevenue',
+  'totalFees', 'totalRevenue', 'totalProtocolRevenue', 'totalSupplySideRevenue', 'totalUserFees', 'totalHoldersRevenue', 'totalOtherIncome', 'totalOperatingIncome', 'totalNetIncome'
 ])
 
 // End of specific adaptors type

adapters/utils/runAdapter.ts

@@ -4,7 +4,7 @@ import * as _env from '../../helpers/env';
 import { getBlock } from "../../helpers/getBlock";
 import { getUniqStartOfTodayTimestamp } from '../../helpers/getUniSubgraphFees';
 import { getDateString } from '../../helpers/utils';
-import { accumulativeKeySet, BaseAdapter, BaseAdapterChainConfig, ChainBlocks, Fetch, FetchGetLogsOptions, FetchOptions, FetchV2, SimpleAdapter, } from '../types';
+import { accumulativeKeySet, BaseAdapter, BaseAdapterChainConfig, ChainBlocks, Fetch, FetchGetLogsOptions, FetchOptions, FetchResponseValue, FetchResultV2, FetchV2, SimpleAdapter, } from '../types';
 
 // to trigger inclusion of the env.ts file
 const _include_env = _env.getEnv('BITLAYER_RPC')
@@ -111,6 +111,7 @@ async function _runAdapter({
 }: AdapterRunOptions) {
   const cleanCurrentDayTimestamp = endTimestamp
   const adapterVersion = module.version
+  const moduleUID = module._randomUID
 
   const chainBlocks: ChainBlocks = {} // we need it as it is used in the v1 adapters
   const { prefetch, allowNegativeValue = false, } = module
@@ -124,6 +125,15 @@ async function _runAdapter({
   if (chains.some(c => !c) || chains.includes('undefined')) {
     throw new Error(`Invalid chain labels: ${chains.filter(c => !c || c === 'undefined').join(', ')}`)
   }
+
+  const badChainNames = chains.filter(chain => !/^[a-z0-9_]+$/.test(chain));
+  if (badChainNames.length) {
+    throw new Error(`
+    Invalid chain names: ${badChainNames.join(', ')}
+    Chain names should only contain lowercase letters, numbers and underscores
+    `)
+  }
+
   const validStart = {} as {
     [chain: string]: {
       canRun: boolean,
@@ -137,7 +147,7 @@ async function _runAdapter({
   if (typeof prefetch === 'function') {
     const firstChain = chains.find(chain => validStart[chain]?.canRun);
     if (firstChain) {
-      const options = await getOptionsObject(cleanCurrentDayTimestamp, firstChain, chainBlocks);
+      const options = await getOptionsObject({ timestamp: cleanCurrentDayTimestamp, chain: firstChain, chainBlocks, moduleUID });
       preFetchedResults = await prefetch(options);
     }
   }
@@ -185,7 +195,7 @@ async function _runAdapter({
 
     const fetchFunction = adapterObject![chain].fetch
     try {
-      const options = await getOptionsObject(cleanCurrentDayTimestamp, chain, chainBlocks)
+      const options = await getOptionsObject({ timestamp: cleanCurrentDayTimestamp, chain, chainBlocks, moduleUID })
       if (preFetchedResults !== null) {
         options.preFetchedResults = preFetchedResults;
       }
@@ -202,6 +212,12 @@ async function _runAdapter({
       const ignoreKeys = ['timestamp', 'block']
       const improbableValue = 2e11 // 200 billion
 
+      // validate and inject missing record if any
+      validateAdapterResult(result)
+
+      // add missing metrics if need
+      addMissingMetrics(chain, result)
+
       for (const [recordType, value] of Object.entries(result)) {
         if (ignoreKeys.includes(recordType)) continue;
         if (value === undefined || value === null) { // dont store undefined or null values
@@ -269,7 +285,7 @@ async function _runAdapter({
     }
   }
 
-  async function getOptionsObject(timestamp: number, chain: string, chainBlocks: ChainBlocks): Promise<FetchOptions> {
+  async function getOptionsObject({ timestamp, chain, chainBlocks, moduleUID = genUID(10) }: { timestamp: number, chain: string, chainBlocks: ChainBlocks, moduleUID?: string }): Promise<FetchOptions> {
     const withinTwoHours = Math.trunc(Date.now() / 1000) - timestamp < 24 * 60 * 60 // 24 hours
     const createBalances: () => Balances = () => {
       let _chain = chain
@@ -326,6 +342,7 @@ async function _runAdapter({
       getStartBlock,
       getEndBlock,
       dateString: getDateString(startOfDay),
+      moduleUID,
     }
   }
 
@@ -370,3 +387,54 @@ async function _runAdapter({
   }
 
 }
+
+function createBalanceFrom(options: { chain: string, timestamp: number | undefined, amount: FetchResponseValue }): Balances {
+  const { chain, timestamp, amount } = options
+
+  const balance = new Balances({ chain, timestamp })
+  if (amount) {
+    if (typeof amount === 'number' || typeof amount === 'string') {
+      balance.addUSDValue(amount)
+    } else {
+      balance.addBalances(amount)
+    }
+  }
+  return balance;
+}
+
+function subtractBalance(options: { balance: Balances, amount: FetchResponseValue }) {
+  const { balance, amount } = options
+  if (amount) {
+    if (typeof amount === 'number' || typeof amount === 'string') {
+      const otherBalance = createBalanceFrom({ chain: balance.chain, timestamp: balance.timestamp, amount })
+      balance.subtract(otherBalance)
+    } else {
+      balance.subtract(amount)
+    }
+  }
+}
+
+function validateAdapterResult(result: any) {
+  // validate metrics
+  //  this is to ensure that we do this validation only for the new adapters
+  if (result.dailyFees && result.dailyFees instanceof Balances && result.dailyFees.hasBreakdownBalances()) {
+    // should include atleast SupplySideRevenue or ProtocolRevenue or Revenue
+    if (!result.dailySupplySideRevenue && !result.dailyProtocolRevenue && !result.dailyRevenue) {
+      throw Error('found dailyFees record but missing all dailyRevenue, dailySupplySideRevenue, dailyProtocolRevenue records')
+    }
+  }
+}
+
+function addMissingMetrics(chain: string, result: any) {
+  // add missing metrics for Balances which has breakdown labels only
+  //  this is to ensure that we dont change behavior of existing adapters
+  if (result.dailyFees && result.dailyFees instanceof Balances && result.dailyFees.hasBreakdownBalances()) {
+
+    // if we have supplySideRevenue but missing revenue, add revenue = fees - supplySideRevenue
+    if (result.dailySupplySideRevenue && !result.dailyrevenue) {
+      result.dailyRevenue = createBalanceFrom({ chain, timestamp: result.timestamp, amount: result.dailyFees })
+      subtractBalance({ balance: result.dailyRevenue, amount: result.dailySupplySideRevenue })
+    }
+
+  }
+}

aggregator-derivatives/defiapp/index.ts

@@ -3,6 +3,7 @@
 import { FetchResult, SimpleAdapter } from "../../adapters/types";
 import { httpGet } from "../../utils/fetchURL";
 import { CHAIN } from "../../helpers/chains";
+import { getEnv } from "../../helpers/env";
 
 const tsToISO = (ts: number) => new Date(ts * 1e3).toISOString();
 
@@ -14,7 +15,7 @@ const fetch = async (_: any, _b: any, options: any): Promise<FetchResult> => {
   const response = await httpGet(`https://api.defi.app/api/stats/volume-perps/between?startTime=${tsToISO(startDate)}&endTime=${tsToISO(endDate)}`, {
     headers: {
       "Content-Type": "application/json",
-      "X-API-KEY": process.env.DEFIAPP_API_KEY,
+      "X-API-KEY": getEnv('DEFIAPP_API_KEY'),
       User: "defillama",
     },
   });

aggregator-derivatives/flat-money-v1/index.ts

@@ -0,0 +1,51 @@
+import { SimpleAdapter, FetchV2, FetchResultV2 } from "../../adapters/types";
+import { CHAIN } from "../../helpers/chains";
+import {
+  calculateAdjustsVolume, calculateClosesVolume,
+  calculateOpensVolume, CONFIG,
+  fetchVolume,
+  leverageAdjustsQuery,
+  leverageClosesQuery,
+  leverageOpensQuery
+} from "../flat-money/helper";
+
+
+
+
+const fetch: FetchV2 = async ({ startTimestamp, endTimestamp, chain }): Promise<FetchResultV2> => {
+  const config = CONFIG[chain];
+  if (!config) throw new Error(`Unsupported chain: ${chain}`);
+
+  const { decimals, } = config;
+
+  const [
+    dailyOpensData,
+    dailyAdjustsData,
+    dailyClosesData,
+  ] = await Promise.all([
+    fetchVolume(chain as CHAIN, leverageOpensQuery, "leverageOpens", startTimestamp, endTimestamp),
+    fetchVolume(chain as CHAIN, leverageAdjustsQuery, "leverageAdjusts", startTimestamp, endTimestamp),
+    fetchVolume(chain as CHAIN, leverageClosesQuery, "leverageCloses", startTimestamp, endTimestamp),
+  ]);
+
+  return {
+    dailyVolume: calculateOpensVolume(dailyOpensData, decimals.amount)
+        + calculateAdjustsVolume(dailyAdjustsData, decimals.amount)
+        + calculateClosesVolume(dailyClosesData, decimals.amount),
+  };
+};
+
+
+
+const adapter: SimpleAdapter = {
+  adapter: Object.fromEntries(
+    Object.entries(CONFIG).filter(([chain, config]) => chain === CHAIN.BASE).map(([chain, config]) => [
+      chain,
+      { fetch, start: config.startTimestamp }
+    ])
+  ),
+  version: 2
+};
+
+
+export default adapter;

aggregator-derivatives/flat-money-v2/index.ts

@@ -0,0 +1,48 @@
+import { SimpleAdapter, FetchV2, FetchResultV2 } from "../../adapters/types";
+import { CHAIN } from "../../helpers/chains";
+import {
+  calculateAdjustsVolume, calculateClosesVolume,
+  calculateOpensVolume, CONFIG,
+  fetchVolume,
+  leverageAdjustsQuery,
+  leverageClosesQuery,
+  leverageOpensQuery
+} from "../flat-money/helper";
+
+const fetch: FetchV2 = async ({ startTimestamp, endTimestamp, chain }): Promise<FetchResultV2> => {
+  const config = CONFIG[chain];
+  if (!config) throw new Error(`Unsupported chain: ${chain}`);
+
+  const { decimals, } = config;
+
+  const [
+    dailyOpensData,
+    dailyAdjustsData,
+    dailyClosesData,
+  ] = await Promise.all([
+    fetchVolume(chain as CHAIN, leverageOpensQuery, "leverageOpens", startTimestamp, endTimestamp),
+    fetchVolume(chain as CHAIN, leverageAdjustsQuery, "leverageAdjusts", startTimestamp, endTimestamp),
+    fetchVolume(chain as CHAIN, leverageClosesQuery, "leverageCloses", startTimestamp, endTimestamp),
+  ]);
+
+  return {
+    dailyVolume: calculateOpensVolume(dailyOpensData, decimals.amount)
+        + calculateAdjustsVolume(dailyAdjustsData, decimals.amount)
+        + calculateClosesVolume(dailyClosesData, decimals.amount),
+  };
+};
+
+
+
+const adapter: SimpleAdapter = {
+  adapter: Object.fromEntries(
+    Object.entries(CONFIG).filter(([chain, config]) => chain === CHAIN.OPTIMISM || chain === CHAIN.ARBITRUM).map(([chain, config]) => [
+      chain,
+      { fetch, start: config.startTimestamp }
+    ])
+  ),
+  version: 2
+};
+
+
+export default adapter;