Handraise is an ERC-20 token published on the SepoliaETH testnet. It is designed to be used for tracking class participation points, and the accompanying python scripts can automate issuance and redemption for credit!

View it on GitHub

Handraise

Contract Address: 0xc24a1F9B20518D483784Fb91cc2Df39305A7bca7

Requirements

The python scripts require the following packages:

  • web3
  • pandas
  • dotenv
  • streamlit (only if you’d like to use the web app GUI instead of the CLI)

They can be installed with:

pip install pandas web3 dotenv streamlit

conda install pandas web3 dotenv streamlit

The required NPM packages are:

  • @truffle/hdwallet-provider
  • dotenv

They can be installed with:

npm install @truffle/hdwallet-provider dotenv

All of the code will require a .env file in the root directory, example contents of this file can be found here

GUI Usage

From the directory that dash.py is in run

streamlit run dash.py

The web app should open automatically, if it does not you can access it at addresses output in your terminal. The addresses are typically: Local URL: http://localhost:8501 Network URL: http://192.168.50.14:8501

Upload the students.csv file and select the functions you wish to utilize using the app’s elements.

Web App Example web app example

CLI Usage

From the directory that main.py is in run

python main.py

Then choose the relevant menu options by entering the associated number.

$ python main.py

1. Mint Coins
2. Update Grades
3. Read Events
4. Exit
Enter your choice:

1. Mint Coins Reads the students.csv file and mints coins equal to earned points to each student address in the file.

2. Update Grades Reads token burning events and then updates student grades in canvas according to the tokens burned by each student.

3. Read Events Reads token burning events then prints student a-numbers and tokens burned, primarily for testing.

In order to deploy the smart contract follow the instructions in this file

File Organization

python scripts/

main.py: Contains the CLI menu for functionalities

read_events.py: Reads events emitted by the contract when tokens are sent back to the contract.

canvas_script.py: Updates student grades based on amount of Handraise burned.

mint_coins.py: Tells the smart contract to mint coins and send them to addresses based on the contents of the students.csv file.

students.csv: File that contains student information and grades. The one in this repo is an example. The columns are: [name,a_number,address,points]

Contracts/:
Contains solidity code for smart contract

Migrations/: Contains js script for deploying smart contract

Contracts/Handraise.sol: Creates a smart contract that mints coins to students according to class participation credit. When the tokens are transferred back to the smart contract the tokens are burned and an event is emitted. Any eth that is sent to the contract is stored and an event is emitted. For the longevity of the contract we suggest offering extra credit for extra sepolia eth.

Example .env file

PRIVATE_KEY=your_private_key
SEPOLIA_RPC_URL=https://sepolia.infura.io/v3/your_project_id
PUBLIC_ADDRESS=your_public_addresss
CANVAS_URL=https://yourcanvasinstance.instructure.com/api/v1 CANVAS_ACCESS_TOKEN=your_canvas_access_token
COURSE_ID=1234
ASSIGNMENT_ID=5678
CONTRACT_ADDRESS=your_contract_address