https://github.com/samparsky/aaveinterest
Simple API for Aave interest rates
https://github.com/samparsky/aaveinterest
Last synced: 3 months ago
JSON representation
Simple API for Aave interest rates
- Host: GitHub
- URL: https://github.com/samparsky/aaveinterest
- Owner: samparsky
- Created: 2020-02-05T03:28:25.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T23:35:10.000Z (over 2 years ago)
- Last Synced: 2023-10-26T11:51:40.451Z (over 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 648 KB
- Stars: 0
- Watchers: 2
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aaveinterest
A simple http api to get Aave interest rates from the blockchain.
## Dependencies
- Node >= v12
- Mongodb >= 4.2
## Run Application
There are two services:
- API
- Worker (listens to the ethereum network for events)
The worker uses an in memory queue and a configurable number of workers (default is 10 for testnet and 3 for mainnet)
to process the events in the queue. The configuration of the number of workers
should be based on number of requests your Ethereum node is able to process (Infura was ~1-2 while testing)
else you would have request timeouts
**Manual**
**Start Http Server**
It can connect to either the `mainnet` or `ropsten` ethereum network
```sh
$ npm run build
$ npm start -- --network=mainnet
```
**Start Worker Service**
It listens to the ethereum network for `ReserveUpdated` Aave events and stores in the database
It can listen to either the `mainnet` or `ropsten` ethereum network
```sh
$ npm run build
$ npm run start-worker -- --network=mainnet
```
**Docker**
This automatically startups both the Http and Worker service
```sh
$ docker-compose up
```
## Run Tests
For the tests to pass you **MUST** seed the database
```sh
$ npm run seed-database
```
**Run tests**
```sh
$ npm test
```
## Routes
### Get Reserves List
The reserves list is updated every hour from the blockchain, this is to prevent having
to make a expensive blockchain network call on every request.
#### *URL*
/
#### *Response*
```js
{
data: ["0x6B175474E89094C44Da98b954EedeAC495271d0F"],
updatedAt: "2020-02-06T06:48:53.037Z"
}
```
### Get Deposit Rates
Returns the rates for the last 24 hours by default
#### *URL*
/deposit/:reserve/:mode?
#### *Route Params*
reserve: Reserve address (e.g. 0x6B175474E89094C44Da98b954EedeAC495271d0F)
mode (optional): Get weighted average rate for the options ['week', 'month', 'all-time']
#### *Response*
```js
{
data: [
{
liquidityRate: 0.0000005,
time: "2020-02-06T06:48:53.037Z"
}
]
}
```
### Get Borrow Rates
Returns the rates for the last 24 hours by default
#### *URL*
/borrow/:reserve/:mode?
#### *Route Params*
reserve: Reserve address (e.g. 0x6B175474E89094C44Da98b954EedeAC495271d0F)
mode (optional): Get weighted average rate for the options ['week', 'month', 'all-time']
#### *Query Params*
borrowRate: ['stable', 'variable']
#### *Response*
```js
{
data: [
{
stableBorrowRate: 0.0000005,
time: "2020-02-06T06:48:53.037Z"
}
]
}
```
# Running locally
### Sample data
There is a sample Mongodb dump data in the `./data` directory. It can be imported to the
local mongodb server
```sh
$ cd ./data
$ mongorestore
```
There is should now be a collection of sample 208 documents in your local database that you can
test against
# LICENSE
MIT