- Overview
- Core Features Implemented
- Technologies
- Repo Setup
- Requirements
- Setup the Project
- Create the SmartContract
- Setup the Frontend
- Testing the Smartcontract
- ZuriSchool Contract Address
- Live Link
- Contributors
- Contributing to the project
Zuri as an organization needs to setup an election for leadership position in its school. The major stakeholders here are the school board of directors, the teachers and the students.
Deployment on a faster network
- Deployment on polygon for speed, gas fees & optimization.
Upload Stakeholders & mint
- Batch upload stakeholder addresses and assign each address with a role on upload.
- A certain amount of tokens are minted during upload depending on the role of the stakeholder.
- Ability to restrict the voting power of stakeholders to only those who have a token.
- The tokens represent the voting weight with the chairman having the highest voting weight of 4 and the student having the least voting weight of 1.
Setup elections and compile votes
- Restrict the power to set up and compile votes to only the chairman and teachers.
- Ability to set up multiple elections at the same time.
- Restrict the ability for anyone who isn't a stakeholder to vote.
- Ability for eligible stakeholders to vote for candidates in different election categories simultaneously.
- Ability to limit stakeholders from voting in specific elections, for example students can't vote in an election for board of directors.
- Ability to register candidates to contest for specific roles.
- Restrict stakeholders from voting multiple times for different candidates in the same category.
- Check to prevent users from voting for a candidate that doesn't exist for that category.
- Ability for stakeholders to view history of past elections.
- Ability for the chairman to view the election queue.
- Restrict the start and end of a voting session to only the chairman.
- Ability to compile votes for different election categories.
- Ability for the chairman, teachers and directors to make the election results public.
- Restrict the ability of the students to view the election results until it is made public.
Remove Chairman
- Ability to change the current chairman based on a consensus of above 75% vote from the board of directors.
Security
- Ability for the chairman to pause and unpause the contract for security reasons.
- If there's a vulnerability or a security breach, the contract functionality can be paused so the vulnerability can't be abused until the problem has been resolved.
Test Coverage
- Unit testing ensures that all the codes meet the quality standards and the functions return the expected output.
- Test coverage shows us the extent of how much of our codes are covered by tests. We ideally aim for 100% coverage.
Natspec commenting
- This documentation provides information about the codebase and their implementation for both technical and non technical people.
| Stack | Usage |
|---|---|
Solidity |
Smart contract |
React JS |
Frontend |
To setup the repo, first fork the TeamB ZuriSchool repo, then clone the forked repository to create a copy on the local machine.
$ git clone https://github.com/pauline-banye/ZuriSchool.git
Change directory to the cloned repo and set the original ZuriSchool repository as the "upstream" and your forked repository as the "origin" using gitbash.
$ git remote add upstream https://github.com/Blockgames-TeamB/ZuriSchool.git
- Hardhat
- Alchemy key
- Metamask key
- Polygonscan.com API Url
- Node JS
*Note:
This project was setup on a windows 10 system using the gitbash terminal. Some of the commands used may not work with the VScode terminal, command prompt or powershell.
The steps involved are outlined below:-
The first step involves cloning and installing hardhat.
$ cd ZuriSchool
$ npm i -D hardhat
$ npm install
$ npm install --save-dev "@nomiclabs/hardhat-waffle" "ethereum-waffle" "chai" "@nomiclabs/hardhat-ethers" "ethers" "web3" "@nomiclabs/hardhat-web3" "@nomiclabs/hardhat-etherscan" "@openzeppelin/contracts" "dotenv" "@tenderly/hardhat-tenderly" "hardhat-gas-reporter" "hardhat-deploy"Next create a .env file by using the sample.env. Retrieve your information from the relevant sites and input the information where needed in the .env file.
To retrieve your metamask private key.
- Open your account details by clicking on the three dots on the metamask extension on your chrome browser
- Click on export private key
- Verify your password
- Copy your private key and place it in the .env file
To retrieve your alchemy key.
- Login to your account on alchemy
- Once you're redirected to your dashboard, click on create app.
- Fill in the relevant details especially the chain and network
- Once the app has been created, click on view key.
- Copy the HTTP and place it in the .env file.
To retrieve your polygonscan key.
- Login to polygonscan and hover over the dropdown arrow for your profile on the navbar.
- Click on API keys and add to create a new project (optional step).
- Once the project has been created, click on the copy button to copy the API key.
- Paste it in the .env file
Below is the setup for the hardhat.config.json
- First write the Smartcontract codes within the contracts folder.
- The next step involves the compilation, deployment and verification of the contract on the testnet.
- To compile the smartcontract before deployment:
$ npx hardhat compile
- To deploy the smartcontract:
$ npx hardhat run scripts/deploy.js --network mumbai
- To verify the smartcontract:
$ npx hardhat verify 0xD6c7Bc7089DBe4DC6D493E35eaC3dAf5b18FC04d 0xC291B856723080177f983CB32C275D1e56f91841 --network mumbai
- Note for verificition, the first address is the ZuriSchoolToken address, while the second is the ZuriSchool address.
- First run the frontend on your local server to ensure it's fully functional before building for production.
- Setup and install dependencies
$ cd frontend
$ npm install
$ npm run dev-
Create an account on vercel and authorize your GitHub account.
-
Once you're redirected to the Dashboard, click on the drop down menu and select
Add GitHub Org or Account. -
In the pop-up window, select the install option.
-
Once installation is completed, return to the dashboard and click
new project. -
Select the TeamB organization and select the zurischool repo to import the project.
-
Enter the relevant details and click
Deploy.
- Coverage is used to view the percentage of the code required by tests and unittests were implemented to ensure that the code functions as expected
Coverage Test
-
To test the smartcontract, first open a terminal and run the following command:
-
First install Solidity Coverage
$ npm i solidity-coverage
-
Add
require('solidity-coverage')to hardhat.config.json -
Install Ganache
$ npm i ganache-cli
- Run coverage
$ npx hardhat coverage --network localhost
# if you get errors and you want to trace the error in the terminal
$ npx hardhat coverage --network localhost --show-stack-traces
This Project was created by the members of TeamB during the Blockgames Internship.
If you find something worth contributing, please fork the repo, make a pull request and add valid and well-reasoned explanations about your changes or comments.
Before adding a pull request, please note:
- This is an open source project.
- Your contributions should be inviting and clear.
- Any additions should be relevant.
- New features should be easy to contribute to.
All suggestions are welcome!