🧮 Quadratic Funding Calculator

📋 Overview

This project is a Streamlit-based web application that calculates and visualizes matching results for Quadratic Funding (QF) rounds. It compares standard Quadratic Funding with Connection-Oriented Cluster Matching (COCM) to provide insights into fund distribution.

✨ Features

• Load and process round data from various blockchain networks
• Apply Sybil defense mechanisms using Passport scores
• Calculate and compare matching results using QF and COCM algorithms
• Visualize crowdfunding statistics and donation distributions
• Generate downloadable matching distributions and round summaries
• Filter out specific wallets or projects from calculations

🚀 Installation

1. Clone the repository:

   git clone [repository-url]
   cd [repository-name]
   

2. Install the required packages:

   pip install -r requirements.txt
   

🖥️ Usage

v6 Donation Export (CSV) calculator (recommended)

This is the lightweight, compute-only workflow intended for admins to upload a v6 donation export CSV, run QF or COCM, see visualizations, and download results as CSV for re-upload to v6.

Run:

streamlit run V6_CSV_Calculator.py

How it works:

• Upload: your v6 QF Donation Export CSV
• Map columns: pick which CSV columns correspond to donor address, project name/id, amount, etc.
• Set round params: matching pool size, cap %, minimum donation threshold, and engine (QF/COCM)
• Compute + visualize: matching distributions and top projects
• Download: v6_matching_results.csv

Notes:

• No writes back to v6: this tool is read-only + compute-only.
• No external dependencies required: it does not call indexer APIs, databases, or price feeds. If your donation amounts are not USD, you can provide a token price to convert to USD for calculations/export.

Legacy app (round explorer / Gitcoin-oriented)

Run:

streamlit run Home.py

2. Access the app through your web browser, typically at http://localhost:8501

3. (Optional) Provide the round_id and chain_id as URL parameters:

   http://localhost:8501/?round_id=[ROUND_ID]&chain_id=[CHAIN_ID]
   

⚙️ Configuration

• The app uses environment variables for database connections and API keys. Ensure these are set up in a secrets.toml file or your environment.

📁 Files Description

• Home.py: Main Streamlit application file
• fundingutils.py: Contains functions for QF calculations
• utils.py: Utility functions for data loading and processing
• requirements.txt: List of Python package dependencies
• queries/: SQL query files for data retrieval

📦 Dependencies

• streamlit
• pandas
• numpy
• plotly
• psycopg2-binary

🚀 Deployment with Fly.io

This project is configured for deployment on Fly.io. Here are the steps to deploy:

1. Install the Fly CLI: Follow the instructions at https://fly.io/docs/hands-on/install-flyctl/

2. Login to Fly:

   fly auth login
   

3. Navigate to your project directory and initialize the Fly app:

   fly launch
   

4. Deploy the app:

   fly deploy
   

5. Once deployed, you can access your app at https://qf-calculator.fly.dev

Remember to set up your environment variables and secrets in the Fly.io dashboard or using the Fly CLI before deployment.

For more detailed information on deploying Streamlit apps on Fly.io, refer to their documentation: https://fly.io/docs/app-guides/streamlit/