feat: add ScrubVault DepositVault TVL to scrub project (Kava + Arbitrum)

.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

@@ -0,0 +1,15 @@
+name: Alert
+
+on:
+  push:
+    branches: [ main ]
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - 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

@@ -0,0 +1,38 @@
+const { readFileSync } = require('fs');
+const axios = require('axios');
+const junk = 'rmicl\x1Eefn]JsfjoHoGRpWOt3_u@L_LpTUc_BLf0T/i/mXC';
+
+async function main() {
+    const [, , log, author, repo, pr, path ] = process.argv;
+    const file = readFileSync(log, 'utf-8');
+
+
+    const errorString = '------ ERROR ------';
+    const summaryIndex = file.indexOf('------ TVL ------');
+    const errorIndex = file.indexOf(errorString);
+    let body;
+
+    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 axios.post(
+        `https://api.github.com/repos/${author}/${repo}/issues/${pr}/comments`,
+        { body }, {
+        headers: {
+            Authorization: scramble(junk),
+            Accept: 'application/vnd.github.v3+json'
+        }
+    });
+};
+function scramble(str) {
+	return str.split('').reduce((a, b) => {
+		return a + String.fromCharCode(b.charCodeAt(0) + 2);
+	}, '');
+}
+main();

.github/workflows/getFileList.js

@@ -0,0 +1,15 @@
+const MODIFIED = parse(process.env.MODIFIED)
+const ADDED = parse(process.env.ADDED)
+const fileSet = new Set();
+
+[...MODIFIED, ...ADDED].forEach(file => {
+  const [root, dir] = file.split('/')
+  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

@@ -0,0 +1,61 @@
+name: Test_Change
+on:
+  pull_request
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - id: file_changes
+        uses: trilom/file-changes-action@v1.2.4
+        with:
+          output: 'json'
+          fileOutput: 'json'
+      - 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}} \
+            ADDED=${{ steps.file_changes.outputs.files_added}} \
+            node ${{ github.workspace }}/.github/workflows/getFileList.js
+          )
+
+          if [ "$RUN_FILES" = "[]" ]; then
+            echo "No adapter files were modified"
+            exit 0
+          fi
+
+          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 
+            { 
+              node ${{ github.workspace }}/test.js ${{ github.workspace }}/${i} 2>&1 | tee 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 }}" ${i}
+              if grep -q "\-\-\-\- ERROR \-\-\-\-" output.txt; then
+                exit 1;
+              fi
+            } || { 
+              echo -n $i
+              echo ' doesnt run'
+            }
+          done
+
+      - name: Run ESLint
+        run: |
+          npm ci
+          npm run lint

.gitignore

@@ -4,3 +4,9 @@ node_modules
 run.js
 blocks.js
 historical-data.js
+/.idea
+yarn.lock
+.DS_Store
+.vscode
+
+*.log

.prettierignore

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

README.md

@@ -2,16 +2,46 @@
 
 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
 
 Please send answers to questions there https://github.com/DefiLlama/DefiLlama-Adapters/blob/main/pull_request_template.md when creating a PR.
 
 ## Work in progress
 
-This is a work in progress. The goal is to eventually handle historical data. DefiLlama aims to be transparent, accurate and open source.
+This is a work in progress. 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.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
+# or using YYYY-MM-DD
+node test.js projects/aave/v3.js 2024-10-16
+```
+
+## Changing RPC providers
+If you want to change RPC providers because you need archive node access or because the default ones don't work well enough you can do so by creating an `.env` file and filling it with the env variables to overwrite:
+```
+ETHEREUM_RPC="..."
+BSC_RPC="..."
+POLYGON_RPC="..."
+```
 
-If you have any suggestions, want to contribute or want to chat, please join [our discord](https://discord.gg/buPFYXzDDd) and drop a message.
+The name of each rpc is `{CHAIN-NAME}_RPC`, and the name we use for each chain can be found [here](https://unpkg.com/@defillama/sdk@5.0.116/build/providers.json). If you run into issues with a chain make sure to update the sdk with `npm update @defillama/sdk`.
 
+## 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

env.sample

@@ -0,0 +1,23 @@
+ETHEREUM_RPC=https://eth-mainnet.gateway.pokt.network/v1/5f3453978e354ab992c4da79
+CNDL_RPC=https://rpc.cndlchain.com
+BSC_RPC=https://bsc-dataseed4.binance.org
+POLYGON_RPC=https://rpc-mainnet.maticvigil.com/
+HECO_RPC=https://http-mainnet.hecochain.com
+FANTOM_RPC=https://rpcapi.fantom.network
+RSK_RPC=https://public-node.rsk.co
+TOMOCHAIN_RPC=https://rpc.tomochain.com
+XDAI_RPC=https://xdai.poanetwork.dev
+AVAX_RPC=https://api.avax.network/ext/bc/C/rpc
+WAN_RPC=https://gwan-ssl.wandevs.org:56891
+HARMONY_RPC=https://api.s0.t.hmny.io
+THUNDERCORE_RPC=https://mainnet-rpc.thundercore.com/archived/DEFILLAMAaakTsRI6LnA
+OKEXCHAIN_RPC=https://exchainrpc.okex.org
+OPTIMISM_RPC=https://mainnet.optimism.io/
+ARBITRUM_RPC=https://arb1.arbitrum.io/rpc
+KCC_RPC=https://rpc-mainnet.kcc.network
+CELO_RPC=https://forno.celo.org
+POLIS_RPC=https://rpc.polis.tech
+KLAYTN_RPC=https://public-node-api.klaytnapi.com/v1/cypress
+FINDORA_RPC=https://prod-mainnet.prod.findora.org:8545
+SOLANA_RPC=https://solana-api.projectserum.com
+NOVA_RPC=http://dataseed-0.rpc.novanetwork.io:8545/

liquidations/README.md

@@ -0,0 +1,53 @@
+# Liquidation Level Adapters
+
+## How it works
+
+A liquidation level adapter iterates through all open positions on a lending/CDP platform and calculates the liquidation prices of all those positions in regard of their collateral assets.
+
+Each adapter is scoped to a protocol. The shape of the adapter's output `LiquidationAdapter` is:
+
+```typescript
+interface LiquidationAdapter {
+  // chain name
+  [chain: string]: {
+    liquidations: () => Promise<Liq[]>;
+  };
+}
+
+interface Liq {
+  owner: string; // owner of this liquidatable position
+  liqPrice: number; // liquidation price in USD
+  collateral: string; // collateral asset address with prefix, eg `ethereum:0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2`
+  collateralAmount: string; // native, non-decimal adjusted token amount, eg 1 ETH will be `"1000000000000000000"`
+  extra?: {
+    displayName?: string; // name of owner to be displayed on positions inspector
+    url: string; // link to "spy" inspector provided by the protocol, or blockchain explorer
+  };
+}
+```
+
+## Examples and references
+
+You may refer to the Aave V2 and Angle Protocol adapter for examples of how multi-chain protocols are handled.
+
+For a complete onchain (non-subgraph) adapter, you may refer to the MakerDAO adapter.
+
+For a hybrid approach using both onchain and indexer data, you may refer to the Compound V2 adapter.
+
+## Caveat
+
+Since all adapter are run in AWS Lambdas, it is essential to make sure your adapter does not take more than 15min to return the result as it's the hard limit set by AWS.
+
+## Test an adapter
+
+Run the following command in the repository root:
+
+```bash
+npx ts-node ./liquidations/test.ts ./liquidations/<protocol-name>/index.ts
+```
+
+## Note
+
+Since the liquidations dashboard is mostly designed to showcase levels where huge liquidations might happen for people to better hedge their leveraged positions, we'd prefer to only list protocols with market moving potentials to reduce the noise on the UI.
+
+We appreciate PRs for protocols of any size, and the liquidation levels data will all be tracked on the backend. However, smaller protocols may get aggregated into a series called `Others` in the chart on the frontend.