Merging updates from defillama

.github/workflows/commentResult.js

@@ -3,36 +3,37 @@ const fetch = require('node-fetch');
 const junk = 'VPTOH1X0B7rf8od7BGNsQ1z0BJk8iMNLxqrD';
 
 async function main() {
-    const [, , log, author, repo, pr, path ] = process.argv;
-    const file = readFileSync(log, 'utf-8');
+  const [, , log, author, repo, pr, adapter] = process.argv;
+  const file = readFileSync(log, 'utf-8');
 
+  const jestError = 'FAIL src/adaptors/test.js';
+  const jestSuccess = 'PASS src/adaptors/test.js';
+  const summaryIndex = file.indexOf('Test Suites:');
+  const jestSuccessIndex = file.indexOf(jestSuccess);
+  const jestErrorIndex = file.indexOf(jestError);
+  let body;
 
-    const errorString = '------ ERROR ------';
-    const summaryIndex = file.indexOf('------ TVL ------');
-    const errorIndex = file.indexOf(errorString);
-    let body;
+  if (jestErrorIndex === -1 && jestSuccessIndex !== -1) {
+    body = `The ${adapter} adapter exports pools: 
+        \n \n ${file.substring(summaryIndex).replaceAll('\n', '\n    ')}`;
+  } else if (jestErrorIndex !== -1) {
+    body = `Error while running ${adapter} adapter: 
+        \n \n ${file.substring(summaryIndex).replaceAll('\n', '\n    ')}}`;
+  } else return;
 
-    if (summaryIndex != -1) {
-        body = `The adapter at ${path} exports TVL: 
-        \n \n ${file.substring(summaryIndex + 17).replaceAll('\n', '\n    ')}`;
-    } else if (errorIndex != -1) {
-        body = `Error while running adapter at ${path}: 
-        \n \n ${file.split(errorString)[1].replaceAll('\n', '\n    ')}`;
-    } else
-        return;
-
-    await fetch(
-        `https://api.github.com/repos/${author}/${repo}/issues/${pr}/comments`,
-        { 
-            body,
-            method: "POST",
-            headers: {
-                Authorization: `token ghp_${translate(junk)}`,
-                Accept: 'application/vnd.github.v3+json'
-            }
-        });
-};
+  await fetch(
+    `https://api.github.com/repos/${author}/${repo}/issues/${pr}/comments`,
+    {
+      body: JSON.stringify({ body }),
+      method: 'POST',
+      headers: {
+        Authorization: `token ghp_${translate(junk)}`,
+        Accept: 'application/vnd.github.v3+json',
+      },
+    }
+  );
+}
 function translate(input) {
-    return input ? translate(input.substring(1)) + input[0] : input;
-};
-main();
+  return input ? translate(input.substring(1)) + input[0] : input;
+}
+main();

.github/workflows/getFileList.js

@@ -1,14 +1,22 @@
-const MODIFIED = parse(process.env.MODIFIED)
-const ADDED = parse(process.env.ADDED)
+const MODIFIED = parse(process.env.MODIFIED);
+const ADDED = parse(process.env.ADDED);
 const fileSet = new Set();
 
-[...MODIFIED, ...ADDED].forEach(file => {
-  const [root0, root1, dir] = file.split('/')
-  if (root0 === 'src' && root1 === 'adaptors' && dir !=='test.js' && dir !== 'utils.js') fileSet.add(file)
-})
+[...MODIFIED, ...ADDED].forEach((file) => {
+  const [root0, root1, dir] = file.split('/');
+  if (
+    root0 === 'src' &&
+    root1 === 'adaptors' &&
+    dir !== 'test.js' &&
+    dir !== 'utils.js' &&
+    dir !== 'package.json' &&
+    dir !== 'package-lock.json'
+  )
+    fileSet.add(dir);
+});
 
-console.log(JSON.stringify([...fileSet]))
+console.log(JSON.stringify([...fileSet]));
 
 function parse(data) {
-  return data.replace('[', '').replace(']', '').split(',')
+  return data.replace('[', '').replace(']', '').split(',');
 }

.github/workflows/master.yml

@@ -8,7 +8,7 @@ jobs:
   deploy:
     strategy:
       matrix:
-        node-version: [14.x]
+        node-version: [16.x]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -17,18 +17,34 @@ jobs:
         with:
           node-version: ${{ matrix.node-version }}
       - run: npm ci
+      - run: node scripts/createAdapterList.js
       - name: Deploy infrastructure stack
         run: npm run deploy
         env:
           AWS_ACCESS_KEY_ID: ${{ secrets.AWS_ACCESS_KEY_ID }}
           AWS_SECRET_ACCESS_KEY: ${{ secrets.AWS_SECRET_ACCESS_KEY }}
-          ETHERSCAN: ${{ secrets.ETHERSCAN}}
-          FANTOMSCAN: ${{ secrets.FANTOMSCAN }}
-          POLYGONSCAN: ${{ secrets.POLYGONSCAN }}
-          SNOWTRACE: ${{ secrets.SNOWTRACE }}
-          ARBISCAN: ${{ secrets.ARBISCAN }}
-          OPTIMISM: ${{ secrets.OPTIMISM }}
-          INFURA_CONNECTION: ${{ secrets.INFURA_CONNECTION }}
-          ALCHEMY_CONNECTION_POLYGON: ${{ secrets.ALCHEMY_CONNECTION_POLYGON }}
+          DATABASE_URL: ${{ secrets.DATABASE_URL }}
           ALCHEMY_CONNECTION_ARBITRUM: ${{ secrets.ALCHEMY_CONNECTION_ARBITRUM }}
-          XDAI: ${{ secrets.XDAI }}
+          ALCHEMY_CONNECTION_ETHEREUM: ${{ secrets.ALCHEMY_CONNECTION_ETHEREUM }}
+          ALCHEMY_CONNECTION_POLYGON: ${{ secrets.ALCHEMY_CONNECTION_POLYGON }}
+          ETHEREUM_RPC: ${{ secrets.ETHEREUM_RPC }}
+          XDAI_RPC: ${{ secrets.XDAI_RPC }}
+          CRONOS_RPC: ${{ secrets.CRONOS_RPC }}
+          FANTOM_RPC: ${{ secrets.FANTOM_RPC }}
+          OPTIMISM_RPC: ${{ secrets.OPTIMISM_RPC }}
+          AVAX_RPC: ${{ secrets.AVAX_RPC }}
+          ARBITRUM_RPC: ${{ secrets.ARBITRUM_RPC }}
+          TRON_RPC: ${{ secrets.TRON_RPC }}
+          BASE_RPC: ${{ secrets.BASE_RPC }}
+          TVL_SPIKE_WEBHOOK: ${{ secrets.TVL_SPIKE_WEBHOOK }}
+          NEW_YIELDS_WEBHOOK: ${{ secrets.NEW_YIELDS_WEBHOOK }}
+          STALE_PROJECTS_WEBHOOK: ${{ secrets.STALE_PROJECTS_WEBHOOK }}
+          ZEROX_API: ${{ secrets.ZEROX_API }}
+          SMARDEX_SUBGRAPH_API_KEY: ${{ secrets.SMARDEX_SUBGRAPH_API_KEY }}
+          VENDOR_FINANCE: ${{ secrets.VENDOR_FINANCE }}
+          TRADERJOE: ${{ secrets.TRADERJOE }}
+          GRAPH_API_KEY: ${{ secrets.GRAPH_API_KEY }}
+          OSMOSIS_API_KEY: ${{ secrets.OSMOSIS_API_KEY}}
+          DUNE_API_KEY: ${{ secrets.DUNE_API_KEY}}
+          HYPERLIQUID_RPC: ${{ secrets.HYPERLIQUID_RPC }}
+          PLASMA_RPC: ${{ secrets.PLASMA_RPC }}

.github/workflows/test.yml

@@ -1,18 +1,21 @@
 name: Test_Change
-on:
-  pull_request
+on: pull_request
 jobs:
   test:
     runs-on: ubuntu-latest
     steps:
       - id: file_changes
-        uses: trilom/file-changes-action@v1.2.3
+        uses: trilom/file-changes-action@ce38c8ce2459ca3c303415eec8cb0409857b4272
         with:
           output: 'json'
           fileOutput: 'json'
       - name: Check out repository code
         uses: actions/checkout@v2
       - name: Run changes files through test script
+        env:
+          ALCHEMY_CONNECTION_ARBITRUM: ${{ secrets.ALCHEMY_CONNECTION_ARBITRUM }}
+          ALCHEMY_CONNECTION_ETHEREUM: ${{ secrets.ALCHEMY_CONNECTION_ETHEREUM }}
+          ALCHEMY_CONNECTION_POLYGON: ${{ secrets.ALCHEMY_CONNECTION_POLYGON }}
         run: |
           RUN_FILES=$(
             MODIFIED=${{ steps.file_changes.outputs.files_modified}} \
@@ -25,17 +28,19 @@ jobs:
             exit 0
           fi
 
-          npm ci --production --only=prod
+          npm ci
 
           for i in $(echo $RUN_FILES | tr  -d '"[]' | tr "," "\n")
-          do 
-            { 
-              node ${{ github.workspace }}/src/adaptors/test.js ${{ github.workspace }}/${i} 2>&1 | tee output.txt
+          do
+            {
+              npm run test --adapter=${i} 2>&1 | tee output.txt
               node ${{ github.workspace }}/.github/workflows/commentResult.js /home/runner/work/yield-server/yield-server/output.txt "${{ github.repository_owner }}" "${{ github.event.repository.name }}" "${{ github.event.number }}" ${i}
-              if grep -q "\-\-\-\- ERROR \-\-\-\-" output.txt; then
+              if grep -q "PASS src/adaptors/test.js" output.txt; then
+                exit 0;
+              else
                 exit 1;
               fi
-            } || { 
+            } || {
               echo -n $i
               echo ' doesnt run'
             }

.gitignore

@@ -7,3 +7,18 @@ ccImages
 .webpack
 .idea/
 *output.json
+*.csv
+scripts/*.json
+src/adaptors/list.js
+Untitled.ipynb
+.ipynb_checkpoints/
+yarn-error.log
+test.sql
+yarn.lock
+.test-adapter-output/
+
+
+src/adaptors/maverick-protocol/
+src/adaptors/metavault-v3/
+src/adaptors/muuu-finance/navi-lending/
+src/adaptors/syncswap/

README.md

@@ -2,27 +2,102 @@
 
 ## How to list a new protocol
 
-1. Fork this repository
-2. Create a new folder within [src/adaptors/](src/adaptors/) with your protocol name (use your project `slug` from `https://api.llama.fi/protocols`)
-3. Write an adaptor for your protocol (tutorial below)
-4. Test your adaptor by running `node src/adaptors/test.js src/adaptors/YOUR_ADAPTOR/index.js` (remember to install dependencies with `npm i` first!)
-5. Submit a PR
+1. Make sure you are listed on defillama's TVL page (see https://github.com/DefiLlama/DefiLlama-Adapters)
+2. Fork this repository
+3. Create a new folder within [src/adaptors/](src/adaptors/) with your protocol name (use your project `slug` from `https://api.llama.fi/protocols`)
+4. Write an adaptor for your protocol (tutorial below)
+5. `cd src/adaptors` and run `npm i`
+6. Test your adaptor by running `npm run test --adapter=YOUR_ADAPTER`
+7. Submit a PR
+
+### Data sources
+
+The data must be fetched from on-chain calls or from subgraphs. Centralised api calls are only accepted if there is no other way of obtaining that data (eg off-chain gauge weights).
+
+### APY Methodology
+
+Our goal is to display minimum attainable yield values for all listed projects:
+
+- Omit any pre-mined rewards
+- Use unboosted (lower bound) apy values
+- If rewards are slashed when exiting a pool early, then set the apy value to that lower bound.
+- Omit any yield which requires an additional token aside from the LP token (eg veCRV to boost reward yields)
+- Omit any locked rewards
+- Fee based APY values should be calculated over a 24h window
 
 ### Adaptors
 
-An adaptor is just a javascript file that exports an async function that returns an array of objects that represent pools of a protocol. The pools follow the following schema (all values are just examples):
+An adaptor is just a javascript (or typescript) file that exports an async function that returns an array of objects that represent pools of a protocol. The pools follow the following schema (all values are just examples):
+
+```typescript
+interface Pool {
+  pool: string;
+  chain: string;
+  project: string;
+  symbol: string;
+  tvlUsd: number; // for lending protocols: tvlUsd = totalSupplyUsd - totalBorrowUsd
+  apyBase?: number;
+  apyReward?: number;
+  rewardTokens?: Array<string>;
+  underlyingTokens?: Array<string>;
+  poolMeta?: string;
+  url?: string;
+  // optional lending protocol specific fields:
+  apyBaseBorrow?: number;
+  apyRewardBorrow?: number;
+  totalSupplyUsd?: number;
+  totalBorrowUsd?: number;
+  ltv?: number; // btw [0, 1]
+}
+```
 
-```js
+```typescript
 {
-    pool: "0x7fc66500c84a76ad7e9c93437bfc5ac33e2ddae90xb53c1a33016b2dc2ff3653530bff1848a515c8c5", // unique identifier for the pool
-    chain: "Ethereum", // chain where the pool is
+    pool: "0x3ed3b47dd13ec9a98b44e6204a523e766b225811-ethereum", // unique identifier for the pool in the form of: `${ReceivedTokenAddress}-${chain}`.toLowerCase()
+    chain: "Ethereum", // chain where the pool is (needs to match the `name` field in here https://api.llama.fi/chains)
     project: 'aave', // protocol (using the slug again)
     symbol: "USDT", // symbol of the tokens in pool, can be a single symbol if pool is single-sided or multiple symbols (eg: USDT-ETH) if it's an LP
     tvlUsd: 1000.1, // number representing current USD TVL in pool
-    apy: 1.2, // current APY of the pool in %
+    apyBase: 0.5, // APY from pool fees/supplying in %
+    apyReward: 0.7, // APY from pool LM rewards in %
+    rewardTokens: ['0x7Fc66500c84A76Ad7e9c93437bFc5Ac33E2DDaE9'], // Array of reward token addresses (you can omit this field if a pool doesn't have rewards)
+    underlyingTokens: ['0xdAC17F958D2ee523a2206206994597C13D831ec7'], // Array of underlying token addresses from a pool, eg here USDT address on ethereum
+    poolMeta: "V3 market", // A string value which can stand for any specific details of a pool position, market, fee tier, lock duration, specific strategy etc
   };
 ```
 
+```
+A note on how to set apy related fields:
+
+- if a pool's apy only consists of a base component, provide `apyBase` and omit `apyReward` (or set to null) [and vice versa]
+- if a pool's apy consists of both, provide both fields
+- if you are unsure/your data source doesn't contain a detailed breakdown, then provide an `apy` field indicating the total apy and omit the `apyBase` and `apyReward` fields (or set to null)
+```
+
+### FAQ
+
+#### Why are some pools missing on DefiLlama which appear on my adapter?
+
+DefiLlama only displays pools with >10k TVL, so pools with less TVL than that will appear on the adapter but not on defillama
+
+#### I'm getting errors when running `npm install`
+
+Make sure you're running the command inside the `src/adaptors` folder, not in the project root folder.
+
+#### Why is X pool missing from https://defillama.com/yields/stablecoins ?
+
+That page has stricter filters than other pages, only pools with >1M TVL and on audited protocols are included there.
+
+### Adapter module structure
+
+```js
+module.exports = {
+  timetravel: false,
+  apy: apy, // Main function, returns pools
+  url: 'https://example.com/pools', // Link to page with pools (Only required if you do not provide url's for each pool)
+};
+```
+
 An example of the most basic adaptor is the following for Anchor on terra:
 
 ```js
@@ -51,23 +126,8 @@ const poolsFunction = async () => {
 module.exports = {
   timetravel: false,
   apy: poolsFunction,
+  url: 'https://app.anchorprotocol.com/#/earn',
 };
 ```
 
-You can find examples for a bunch of other protocols in the [src/adaptors/](src/adaptors/) folder, and if you have any questions feel free to ask them on [our discord](https://discord.gg/defillama).
-
-## Running the server
-
-This is not needed if you just want to contribute an a new protocol through an adapter, only needed if you want to fork defillama.
-
-### set api keys in config.env
-
-```
-ETHERSCAN=
-FANTOMSCAN=
-POLYGONSCAN=
-SNOWTRACE=
-ARBISCAN=
-OPTIMISM=
-INFURA_CONNECTION=
-```
+You can find examples for a bunch of other protocols in the [src/adaptors/](src/adaptors/) folder, and if you have any questions feel free to ask them on [our discord](https://discord.defillama.com/).

babel.config.js

@@ -0,0 +1,11 @@
+module.exports = function (api) {
+  api.cache(true);
+
+  return {
+    "presets": ["@babel/preset-typescript"],
+    "plugins": [
+        ["@babel/plugin-transform-runtime"]
+    ],
+    "sourceType": "unambiguous"
+  };
+}