From 56c246da83efbd1f74a9f19734cf9d09500a408d Mon Sep 17 00:00:00 2001 From: Aspirin Date: Thu, 29 Feb 2024 12:48:05 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20add=20features=20=F0=9F=A6=BE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- README.md | 91 +++++++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 89 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 1bfade9..a3c538c 100644 --- a/README.md +++ b/README.md @@ -23,7 +23,7 @@ Architecture • Features • Folder Structure • - Documentation And Testing • + Documentation • Contributing • Team

@@ -32,9 +32,96 @@ Exploring the development of a crowdfunding smart contract on the Solana blockchain, leveraging the Rust programming language and the Anchor framework. Crowdfunding has emerged as a popular method for raising funds for various projects, initiatives, and charitable causes, and blockchain technology introduces new possibilities for enhancing transparency, security, and efficiency in this process. ## 🏛️ Architecture -

+


system design

+```sh +- User Interface + ┌───────────────┐ ┌───────────────┐ ┌───────────────┐ + │ Frontend │ │ Frontend │ │ Frontend │ + └───────┬───────┘ └───────┬───────┘ └───────┬───────┘ + │ │ │ + ▼ ▼ ▼ + ┌───────────────┐ ┌───────────────┐ ┌───────────────┐ + │ User Wallet │ │ User Wallet │ │ User Wallet │ + └───────────────┘ └───────────────┘ └───────────────┘ + │ │ │ + └───────────────┬──────────┼───────────────┬──────────┼───────────────┐ + ▼ │ ▼ │ │ + ┌───────────────┐ │ ┌───────────────┐ │ Smart │ + │ Solana RPC │ │ │ Solana RPC │ │ Contracts │ + └───────────────┘ │ └───────────────┘ │ │ + │ │ │ │ │ + └──────────┼──────────────┼──────────┼───────────────┘ + ▼ ▼ │ + ┌─────────────────────────┐ │ + │ Anchor Lang Program │◀──────┘ + └─────────────────────────┘ + │ │ │ + │ │ │ + ┌────────────┘ │ └────────────┐ + │ │ │ + ┌────────────────┐┌────────────────┐┌────────────────┐ + │ Create ││ Withdraw ││ Donate │ + │ Function ││ Function ││ Function │ + └────────────────┘└────────────────┘└────────────────┘ +``` + +## 🎯 Features +The crowdfunding smart contract implemented using the Anchor framework on the Solana blockchain offers a range of features designed to enhance the fundraising experience while ensuring transparency, security, and efficiency. + +1. Campaign Creation: + +- Project creators can initiate crowdfunding campaigns by providing essential details such as the campaign name, description, target amount, project URL, progress update URL, project image URL, and category. + +```javascript +name : "Campaign Name", +description : "Campaign Description", +amount : "Campaign target amount", +project_url : "Campaign website url", +project_update_url : "Campaign if another website but can be default", +project_image_url : "Campaign logo", +category : "which type of campaign" +``` + +- The smart contract initializes a new campaign account, facilitating the transparent management of funds and project details. + +2. Automated Fund Management: + +- The smart contract automates fund management processes, including the allocation of donations and the disbursement of funds to project creators. +- Through predefined functions, contributors can seamlessly donate to campaigns, while campaign admins can withdraw funds as needed. + +3. Admin Withdrawal Control: + +- Withdrawal functionality is restricted to campaign administrators, ensuring that only authorized individuals can access and manage the raised funds. +- Admins can withdraw funds from the campaign account, subject to sufficient balance and compliance with predefined conditions. + +4. Secure Fund Handling: + +- The smart contract incorporates security measures to safeguard the contributed funds and prevent unauthorized access or misuse. +- Solana's robust consensus mechanism and cryptographic protocols ensure the integrity and security of transactions and data stored on the blockchain. + +5. Transparent Fund Tracking: + +- Contributions, withdrawals, and campaign updates are recorded transparently on the Solana blockchain, providing stakeholders with real-time visibility into the fundraising process. +- Contributors can track the progress of campaigns, view project updates, and verify the utilization of funds, enhancing trust and accountability. + +6. Global Accessibility: + +- The crowdfunding platform built on Solana offers global accessibility, allowing contributors from around the world to participate in fundraising campaigns. +- Blockchain technology eliminates geographical barriers and enables frictionless cross-border transactions, promoting inclusivity and broadening the reach of fundraising initiatives. + +7. Cost-Effective Transactions: + +- Solana's high throughput and low transaction fees make participation in crowdfunding campaigns cost-effective for both contributors and project creators. +- Compared to traditional crowdfunding platforms that may impose significant fees, the blockchain-based solution minimizes transaction costs, maximizing the impact of donations. + +8. Immutable Record Keeping: + +- Transactional data and campaign details recorded on the Solana blockchain are immutable and tamper-proof, providing a permanent and verifiable record of fundraising activities. +Immutable records enhance auditability, mitigating the risk of fraud or data manipulation and fostering trust among stakeholders. + +## \ No newline at end of file