Merge pull request #1 from protofire/main

Move out of Organization Repo to allow edits by maintainers

Author: hamman247

.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+    "env": {
+        "node": true,
+        "commonjs": true,
+        "es2021": true
+    },
+    "extends": "eslint:recommended",
+    "overrides": [
+    ],
+    "parserOptions": {
+        "ecmaVersion": "latest"
+    },
+    ignorePatterns: ['projects/test/*'],
+    "rules": {
+        "no-case-declarations": "off",
+        "no-unused-vars": "off",
+        "no-useless-escape": "warn",
+        "no-prototype-builtins": "off",
+        "no-unreachable": "off",
+    }
+}

.github/workflows/alert.yml

@@ -9,7 +9,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - uses: actions/checkout@v2
-    - run: curl https://born-to-llama.onrender.com/refresh
-    - name: Deploy
-      run: |
-        curl -XPOST -H "Accept: application/vnd.github.everest-preview+json" -H "Content-Type: application/json" -H "Authorization: Bearer ${{ secrets.PAT }}" https://api.github.com/repos/DefiLlama/defillama-server/dispatches --data '{"event_type": "build"}'
+    - name: Update unlisted
+      run: curl https://born-to-llama.herokuapp.com/refresh
+    # - name: Deploy to server
+    #   run: curl https://born-to-llama.herokuapp.com/rebuild-server

.github/workflows/commentResult.js

@@ -1,6 +1,6 @@
 const { readFileSync } = require('fs');
 const axios = require('axios');
-const junk = 'VPTOH1X0B7rf8od7BGNsQ1z0BJk8iMNLxqrD';
+const junk = 'rmicl\x1Eefn]JsfjoHoGRpWOt3_u@L_LpTUc_BLf0T/i/mXC';
 
 async function main() {
     const [, , log, author, repo, pr, path ] = process.argv;
@@ -16,7 +16,7 @@ async function main() {
         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}: 
+        body = `Error while running adapter at ${path ?? ''}: 
         \n \n ${file.split(errorString)[1].replaceAll('\n', '\n    ')}`;
     } else
         return;
@@ -25,12 +25,14 @@ async function main() {
         `https://api.github.com/repos/${author}/${repo}/issues/${pr}/comments`,
         { body }, {
         headers: {
-            Authorization: `token ghp_${translate(junk)}`,
+            Authorization: scramble(junk),
             Accept: 'application/vnd.github.v3+json'
         }
     });
 };
-function translate(input) {
-    return input ? translate(input.substring(1)) + input[0] : input;
-};
-main();
+function scramble(str) {
+	return str.split('').reduce((a, b) => {
+		return a + String.fromCharCode(b.charCodeAt(0) + 2);
+	}, '');
+}
+main();

.github/workflows/getFileList.js

@@ -4,11 +4,12 @@ const fileSet = new Set();
 
 [...MODIFIED, ...ADDED].forEach(file => {
   const [root, dir] = file.split('/')
-  if (root === 'projects' && dir !=='helper' && dir !== 'config') fileSet.add(root + '/' + dir)
+  if (dir === 'treasury' || dir === 'entities') fileSet.add(file)
+  else if (root === 'projects' && dir !=='helper' && dir !== 'config') fileSet.add(root + '/' + dir)
 })
 
 console.log(JSON.stringify([...fileSet]))
 
 function parse(data) {
   return data.replace('[', '').replace(']', '').split(',')
-}
+}

.github/workflows/test.yml

@@ -13,6 +13,9 @@ jobs:
       - name: Check out repository code
         uses: actions/checkout@v2
       - name: Run changes files through test script
+        env:
+          LLAMA_DEBUG_MODE: "true"
+          BSC_RPC: https://rpc.ankr.com/bsc,https://bsc-dataseed4.binance.org
         run: |
           RUN_FILES=$(
             MODIFIED=${{ steps.file_changes.outputs.files_modified}} \
@@ -25,7 +28,18 @@ jobs:
             exit 0
           fi
 
-          npm ci --omit=dev
+          npm remove typescript @types/async-retry @types/bn.js ts-node @solendprotocol/solend-sdk @hover-labs/kolibri-js
+          # npm ci --omit=dev
+          npm ci
+          # npm update @defillama/sdk
+
+          # fail if package.json or package-lock.json is changed
+          FILES_MODIFIED=${{ steps.file_changes.outputs.files_modified }}
+          if [[ $FILES_MODIFIED == *"package.json"* || $FILES_MODIFIED == *"package-lock.json"* ]]; then
+            echo "------ ERROR ------ > Please revert changes to package.json / package-lock.json" > /home/runner/work/DefiLlama-Adapters/DefiLlama-Adapters/output.txt
+            node ${{ github.workspace }}/.github/workflows/commentResult.js /home/runner/work/DefiLlama-Adapters/DefiLlama-Adapters/output.txt "${{ github.repository_owner }}" "${{ github.event.repository.name }}" "${{ github.event.number }}"
+            exit 1
+          fi
 
           for i in $(echo $RUN_FILES | tr  -d '"[]' | tr "," "\n")
           do 
@@ -39,4 +53,9 @@ jobs:
               echo -n $i
               echo ' doesnt run'
             }
-          done
+          done
+        
+      - name: Run ESLint
+        run: |
+          npm ci
+          npm run lint

.gitignore

@@ -7,5 +7,4 @@ historical-data.js
 /.idea
 yarn.lock
 .DS_Store
-projects/pooltogether/index.js
 .vscode

.prettierignore

@@ -0,0 +1,2 @@
+# Ignore all files
+*

.prettierrc

@@ -2,8 +2,17 @@
 
 Follow [this guide](https://docs.llama.fi/submit-a-project) to create an adapter and submit a PR with it.
 
-Also, don't hesitate to send a message on [our discord](https://discord.gg/buPFYXzDDd) if we're late to merge your PR.
+Also, don't hesitate to send a message on [our discord](https://discord.defillama.com/) if we're late to merge your PR.
 
+> If you would like to add a `volume` adapter please submit the PR [here](https://github.com/DefiLlama/adapters)
+> - If you would like to add a `liquidations` adapter, please refer to [this readme document](https://github.com/DefiLlama/DefiLlama-Adapters/tree/main/liquidations) for details.
+
+1. PLEASE PLEASE **enable "Allow edits by maintainers" while putting up the PR.**
+2. Once your adapter has been merged, it takes time to show on the UI. No need to notify us on Discord.
+3. TVL must be computed from blockchain data (reason: https://github.com/DefiLlama/DefiLlama-Adapters/discussions/432), if you have trouble with creating a the adapter, please hop onto our discord, we are happy to assist you.
+4. **For updating listing info** It is a different repo, you can find your listing in this file: https://github.com/DefiLlama/defillama-server/blob/master/defi/src/protocols/data2.ts, you can  edit it there and put up a PR
+5. Do not edit/push `package-lock.json` file as part of your changes, we use lockfileVersion 2, and most use v1 and using that messes up our CI
+6. No need to go to our discord and announce that you've created a PR, we monitor all PRs and will review it asap
 
 ## Getting listed
 
@@ -13,11 +22,13 @@ Please send answers to questions there https://github.com/DefiLlama/DefiLlama-Ad
 
 This is a work in progress. The goal is to eventually handle historical data. DefiLlama aims to be transparent, accurate and open source.
 
-If you have any suggestions, want to contribute or want to chat, please join [our discord](https://discord.gg/buPFYXzDDd) and drop a message.
+If you have any suggestions, want to contribute or want to chat, please join [our discord](https://discord.defillama.com/) and drop a message.
 
 ## Testing adapters
-```
+```bash
 node test.js projects/pangolin/index.js
+# Add a timestamp at the end to run the adapter at a historical timestamp
+node test.js projects/aave/v3.js 1729080692
 ```
 
 ## Changing RPC providers
@@ -26,11 +37,9 @@ If you want to change RPC providers because you need archive node access or beca
 ETHEREUM_RPC="..."
 BSC_RPC="..."
 POLYGON_RPC="..."
-FANTOM_RPC="..."
-ARBITRUM_RPC="..."
-OPTIMISM_RPC="..."
-XDAI_RPC="..."
-HARMONY_RPC="..."
 ```
 
-The name of each rpc is `{CHAIN-NAME}_RPC`, and the name we use for each chain can be found [here](https://github.com/DefiLlama/defillama-sdk/blob/master/src/general.ts#L33)
+The name of each rpc is `{CHAIN-NAME}_RPC`, and the name we use for each chain can be found [here](https://github.com/DefiLlama/defillama-sdk/blob/master/src/providers.json)
+
+## Adapter rules
+- Never add extra npm packages, if you need a chain-level package for your chain, ask us and we'll consider it, but we can't accept any npm package that is project-specific