gcarq / cdpnotify

MakerDAO CDP Collateralization Notification Bot for Telegram

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

cdpnotify

MakerDAO CDP Collateralization Notification Bot for Telegram.

Commands

/watch <cdp_id> [<ratio>]: Add a CDP with the given ID to your watchlist.
The bot will send you a private notification if the collateralization is below the given ratio (default=200%)

/unwatch <cdp_id>: Remove CDP from your watchlist

/status: Show your current watchlist

/help: Show this message

Using the already deployed instance

A instance of this bot is already deployed under @cdpnotifybot. NOTE: This instance is hosted by me and it will save your Telegram Id associated with the CDP Ids you are watching (this data will be deleted once you issue /unwatch). Also I cannot guarantee a 24/7 uptime, so dont rely solely on this bot!

Installation

The following steps are made for Linux/MacOS environment

1. Clone repo

git clone https://github.com/gcarq/cdpnotify.git
cd cdpnotify

2. Create config file

cp config.json.example config.json
vi config.json

3. Install dependencies

python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -e .

Docker

touch cdps.sqlite
docker build -t cdpnotify .
docker run --rm \
    -v /etc/localtime:/etc/localtime:ro \
    -v `pwd`/config.json:/cdpnotify/config.json \
    -v `pwd`/cdps.sqlite:/cdpnotify/cdps.sqlite \
    -it cdpnotify

Software requirements

Please consider making a small donation if you find this bot useful:

ETH: 0x7f07523856BEf9c0a6153A703dE613D6F19e82e4

About

MakerDAO CDP Collateralization Notification Bot for Telegram

License:GNU General Public License v3.0


Languages

Language:Python 100.0%