kylefang/DefiLlama-yield-server
1
0
Fork 0
mirror of https://github.com/uniwhale-io/DefiLlama-yield-server.git synced 2026-01-12 17:12:21 +08:00
Code Issues Packages Projects Releases Wiki Activity

update readme

Browse Source
This commit is contained in:
slasher125
2022-09-27 13:58:45 +02:00
parent 95f45b4de3
commit 2b8e555ccc
1 changed files with 5 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@@ -9,6 +9,10 @@
5. Test your adaptor by running `npm run test --adapter=YOUR_ADAPTER` (remember to install dependencies with `npm i` first!)
6. 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).
### Adaptors
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):
@@ -96,7 +100,7 @@ const poolsFunction = async () => {
module.exports = {
timetravel: false,
apy: poolsFunction,
url: 'https://app.anchorprotocol.com/#/earn'
url: 'https://app.anchorprotocol.com/#/earn',
};
```