https://donor-chain.vercel.app/
DonorChain is a blockchain-based platform designed to bring transparency and efficiency to the process of donating to charities. By leveraging the power of Ethereum blockchain technology through Solidity and the Hardhat development environment, DonorChain ensures that donations are traceable, secure, and directly reach their intended associations without intermediaries.
These instructions will help you set up the project on your local machine for development and testing purposes.
- Node.js
- Hardhat
- Solidity
- OpenZeppelin Contracts
- NextJS
- React
- Taiwind and Flowbite-react
- Rainbow kit
- ethersJS
- Wagmi
- Transparent Donations: Every transaction is recorded on the blockchain, allowing donors to see exactly where their money is going.
- Direct Funding: Donations go directly to the chosen associations, minimizing overhead costs.
- User-Friendly Interface: A simple and intuitive interface built with Next.js makes it easy for anyone to donate.
- Secure Transactions: Utilizes Ethereum blockchain for secure and immutable transactions.
- Rewarding: Donors receive rewards for their contributions, incentivizing continued support for the causes they care about.
- Admin dashboard: An administrative dashboard allows authorized admin to manage and monitor the platform effectively.
- Association dashboard: An administrative dashboard allows authorized associations to manage the donations its received, they can transfer funds to a professional, check their balance etc.
- Proof SBT for Donor: they got a unique SBT to prove their donation
- Solidity: Smart contract development for handling donations and associations.
- Hardhat: Ethereum development environment for compiling, deploying, testing, and debugging the smart contracts.
- contracts/: Contains all the Solidity smart contracts.
- DonationProofSBT.sol: The main SBT contract.
- DonationBadgeNFT.sol: The NFT contract for badges.
- Donation.sol: The main contract for handling donations.
- scripts/: Contains the deployment scripts.
- test/: Contains the test files written in JavaScript using Chai and Mocha.
- Node.js
- npm or yarn
- MetaMask or any Ethereum wallet for interacting with the dApp
- Next.js: React framework for building the user interface, providing server-side rendering for faster load times and better SEO.
- Vercel: Deployment and hosting platform, offering automatic scaling and a global CDN.
- Contact: Using web3form for contact section.
-
Clone the repository:
git clone <repository-url> cd DonorChain/front npm install
setup your .env with your own keys (check .env.example) Then run
- npm run dev
Open http://localhost:3000 in your browser to view the application.
cd DonorChain/back
npx hardhat compile
npx hardhat node
npx hardhat run scripts/deploy.js --network arbitrumSepolia
// or
npx hardhat run scripts/deploy.js --network localhost
Deploy script was written to deploy and verify 3 contracts
Deploying contracts with the account: 0x8E9B6101776469f4F5e57d509fee35751dBbA54A
DonationProofSBT deployed to: 0x71Ee6bb0b4B51F5c434B1e5522F624AE7B67ba29
DonationBadgeNFT deployed to: 0xD572Cb7DA2778a362C6D9b50c9a73F1E1DCB786e
Donation deployed to: 0x9B7af62F4D0F69A1f6063B99feda48FB3Cd529Fd
Donation contract address set in DonationProofSBT contract
Donation contract address set in DonationBadgeNFT contract
Verifying contracts on Arbiscan...
The contract 0x71Ee6bb0b4B51F5c434B1e5522F624AE7B67ba29 has already been verified on the block explorer. If you're trying to verify a partially verified contract, please use the --force flag.
https://sepolia.arbiscan.io/address/0x71Ee6bb0b4B51F5c434B1e5522F624AE7B67ba29#code
The contract 0xD572Cb7DA2778a362C6D9b50c9a73F1E1DCB786e has already been verified on the block explorer. If you're trying to verify a partially verified contract, please use the --force flag.
https://sepolia.arbiscan.io/address/0xD572Cb7DA2778a362C6D9b50c9a73F1E1DCB786e#code
Successfully submitted source code for contract
contracts/Donation.sol:Donation at 0x9B7af62F4D0F69A1f6063B99feda48FB3Cd529Fd
for verification on the block explorer. Waiting for verification result...
Successfully verified contract Donation on the block explorer.
https://sepolia.arbiscan.io/address/0x9B7af62F4D0F69A1f6063B99feda48FB3Cd529Fd#code
Contracts verified on Arbiscan
Verification:
SBT contract in Donation: 0x71Ee6bb0b4B51F5c434B1e5522F624AE7B67ba29
Badge contract in Donation: 0xD572Cb7DA2778a362C6D9b50c9a73F1E1DCB786e
Donation contract in SBT: 0x9B7af62F4D0F69A1f6063B99feda48FB3Cd529Fd
Donation contract in Badge: 0x9B7af62F4D0F69A1f6063B99feda48FB3Cd529Fd
All addresses are correctly set!
Deployment, verification, and initialization complete!
Check the deployed smart contracts here:
- Donation https://sepolia.arbiscan.io/address/0x9B7af62F4D0F69A1f6063B99feda48FB3Cd529Fd#code
- DonationProofSBT https://sepolia.arbiscan.io/address/0x71Ee6bb0b4B51F5c434B1e5522F624AE7B67ba29#code
- DonationBadgeNFT https://sepolia.arbiscan.io/address/0xD572Cb7DA2778a362C6D9b50c9a73F1E1DCB786e#code
How to running test
cd DonorChain/back
npx hardhat compile
npx hardhat test
npx hardhat coverage
describe("donateToAssociation", function () {
it("should not allow donation to non-whitelisted association", async function () {
const { donation, asso2, donor1 } = await loadFixture(
deployDonationFixture
);
const donationAmount = ethers.parseEther("1");
await expect(
donation
.connect(donor1)
.donateToAssociation(asso2.address, donationAmount, {
value: donationAmount,
})
).to.be.revertedWith("Association is not whitelisted");
});
})
donateToAssociation
✔ should allow a donor to make a donation (210ms)
✔ should not allow donation if sent amount does not match specified amount (38ms)
✔ should not allow donation to non-whitelisted association (40ms)
✔ should not allow association to donate to itself (43ms)
234 passing (21s)
-----------------------|----------|----------|----------|----------|----------------|
| File | % Stmts | % Branch | % Funcs | % Lines | Uncovered Lines |
|---|---|---|---|---|---|
| contracts\ | 100 | 85.88 | 100 | 100 | |
| Donation.sol | 100 | 89 | 100 | 100 | |
| DonationBadgeNFT.sol | 100 | 84.21 | 100 | 100 | |
| DonationProofSBT.sol | 100 | 78.13 | 100 | 100 | |
| ----------------------- | ---------- | ---------- | ---------- | ---------- | ---------------- |
| All files | 100 | 85.88 | 100 | 100 | |
| ----------------------- | ---------- | ---------- | ---------- | ---------- | ---------------- |
To ensure the security of the smart contracts, we use the Slither static analysis tool. Slither helps to identify potential vulnerabilities in the smart contracts.
To run Slither on the DonationBadgeNFT.sol contract, use the following command:
slither contracts/DonationBadgeNFT.sol --json rapportDonationBadgeNFT.json --solc-remaps "@openzeppelin=node_modules/@openzeppelin"
This command will generate a JSON report (reportDonationBadgeNFT.json) with the analysis results.
Importing Reentrancy Guard We use OpenZeppelin's ReentrancyGuard to protect against reentrancy attacks. Ensure that you have imported the guard in your contracts:
import "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
DonorChain is open source and available under the MIT license.
The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.
Check out our Next.js deployment documentation for more details.
This Decentralized Application (DApp) was developed as part of a school project. It is deployed on the Arbitrum Sepolia testnet. The authors are not responsible for any losses or damages resulting from the use of this application.