This tool generates stats on Collaterized Debt Positions (CDP) using Bitcoin (BTC) as collateral. The tool will obtain historic BTCUSD data information from Quandl and Bitfinex to calculate a Collateralization Ratio and use Bank Of Canada data (CADUSD exchange rate) to calculate BTC prices in CAD.
- Clone this repository and install
requirements.txt.
To use your own data, create /cdp-stats/data/loans.csv, a file that will contain the following information for every movement in each CDP.
num,type,wallet_address,coll_amount,start_date,debt_cad,date_update,admin_fee
| CSV column | Description |
|---|---|
| num | (int) Consecutive counter used as entry ID |
| type | (int) type of CDP movement, |
0 new new loan |
|
1 collateral increase |
|
2 collateral decrease |
|
3 debt (borrowed CAD) increased |
|
4 closed loan |
|
| wallet_address | (str) Bitcoin address used to deposit collateral |
| coll_amount | (float) Amount of BTC increased/decreased by type movement |
| start_date | (str) Format:YYYY-MM-DD; Date loan became active |
| debt_cad | (float) Amount of CAD increased by type movement |
| date_update | (str) Format:YYYY-MM-DD; Date loan reflected type movement |
| admin_fee | (int) Fee charged at the start of loan |
- Loan sample file provided at (
/cdp-stats/data/loan-sample.csv).
To run the application (by default, uses for /data/loans.csv file),
$ cd [HOME]/cdp-stats/src/
$ ./app.py
To run the application using a different input file data, run the application with --f [input_file.csv].
To use the sample file provided,
$ ./app.py --f ../data/loans-sample.csv
Open http://127.0.0.1:8050/ in your web browser.
To run the entire test suite,
$ cd [HOME]/cdp-stats/tests
$ ./runner.py all
To test specific modules,
$ ./runner.py loan
$ ./runner.py debt
$ ./runner.py tools
Daniel Olaya