Skip to content

MVoucher Profit Tracker is a Python (Flask) powered web dashboard that calculates the profit margin when exercising an $MVOUCHER call option into a $MILK token within the Cardano blockchain.

License

Notifications You must be signed in to change notification settings

brandontownes/MVoucher-Profit-Tracker

Repository files navigation

MVOUCHER Profit Tracker

Description and Usage

MVoucher Profit Tracker is a Python (Flask) powered web dashboard that calculates the profit margin when exercising an $MVOUCHER call option into a $MILK token within the MuesliSwap protocol/Cardano blockchain.

System Requirements

You will need the following services to utilize MVoucher Profit Tracker:

Blockfrost Account

A Blockfrost API key is required to retrieve data from the Cardano blockain. and can be obtained after registration via the following link:

Coingecko API

MVoucher Profit Tracker uses the (free) public Coingecko API for aggregate price info:

Dependencies

To install the necessary dependencies, you can use the included requirements.txt file:

pip install -r requirements.txt
Flask==2.1.1
Flask-Cors==3.0.10
python-dotenv==0.20.0
requests==2.27.1

Instructions

  1. Ensure Python3 is installed. You can download it from python.org.
  2. Open a new Terminal/Command Prompt window, clone project repo:
git clone https://github.com/brandontownes/MVOUCHER-Profit-Tracker
  1. Replace environment variables in '.env_template' with the your own Blockfrost API key and ADA wallet address, then Save the new file as '.env' in the project directory (may need to enable 'view hidden files' first):
BLOCKFROST_PROJECT_ID=[BLOCKFROST_PROJECT_ID]
ADA_WALLET_ADDRESS=[ADA_WALLET_ADDRESS] # should contain at least 1 MVOUCHER token
  1. Start the web server:
cd </projcet_directory>
python3 main.py
 * Serving Flask app 'app'
 * Debug mode: off
WARNING: This is a development server. Do not use it in a production deployment. Use a production WSGI server instead.
 * Running on all addresses (0.0.0.0)
 * Running on http://127.0.0.1:8080
Press CTRL+C to quit
  1. Load one of the local addresses into a web browser to start the dashbaord.

About

MVoucher Profit Tracker is a Python (Flask) powered web dashboard that calculates the profit margin when exercising an $MVOUCHER call option into a $MILK token within the Cardano blockchain.

Topics

Resources

License

Stars

Watchers

Forks