diff --git a/README.md b/README.md index 1e07f8b..47ab781 100644 --- a/README.md +++ b/README.md @@ -1,21 +1,23 @@
+SecureFlow + # SecureFlow ### Trustless Freelancer Escrow on Stellar -[![Stellar Scaffold Hackathon Winner](https://img.shields.io/badge/๐Ÿ†_Stellar_Scaffold_Hackathon-Winner-FFD700?style=for-the-badge)](https://stellar.org) +[![Global Hackathon Winner](https://img.shields.io/badge/๐Ÿ†_Global_Stellar_Hackathon-Winner-FFD700?style=for-the-badge)](https://stellar.org) [![Built on Stellar](https://img.shields.io/badge/Built_on-Stellar_Soroban-7D00FF?style=for-the-badge&logo=stellar)](https://stellar.org) -[![License: MIT](https://img.shields.io/badge/License-MIT-green?style=for-the-badge)](LICENSE) +[![License: Apache 2.0](https://img.shields.io/badge/License-Apache_2.0-blue?style=for-the-badge)](LICENSE) [![TypeScript](https://img.shields.io/badge/TypeScript-007ACC?style=flat-square&logo=typescript&logoColor=white)](https://www.typescriptlang.org/) [![React](https://img.shields.io/badge/React_19-20232A?style=flat-square&logo=react&logoColor=61DAFB)](https://reactjs.org/) [![Rust](https://img.shields.io/badge/Rust-000000?style=flat-square&logo=rust&logoColor=white)](https://www.rust-lang.org/) -[![CI](https://img.shields.io/github/actions/workflow/status/HyperSafeD/SecureFlow-scaffold/node.yml?label=CI&style=flat-square)](https://github.com/HyperSafeD/SecureFlow-scaffold/actions) +[![CI](https://img.shields.io/github/actions/workflow/status/Secureflow-protocol/secureflow/node.yml?label=CI&style=flat-square)](https://github.com/Secureflow-protocol/secureflow/actions) -**A decentralized freelancer marketplace built on Stellar (Soroban) that provides secure, trustless escrow services for freelance work agreements.** +**SecureFlow is a decentralized freelancer marketplace on Stellar (Soroban) providing secure, trustless, milestone-based escrow for freelance work โ€” and a ๐Ÿ† winner of a global Stellar hackathon.** -[Live Demo](https://secure-flow-scaffold.vercel.app) ยท [Documentation](#getting-started) ยท [Contributing](#contributing) ยท [Open Issues](https://github.com/HyperSafeD/SecureFlow-scaffold/issues) +[Live Demo](https://secure-flow-scaffold.vercel.app) ยท [Roadmap](#-roadmap--vision) ยท [Documentation](#getting-started) ยท [Contributing](#contributing) ยท [Open Issues](https://github.com/Secureflow-protocol/secureflow/issues)
@@ -23,7 +25,7 @@ ## ๐Ÿ† Hackathon Recognition -SecureFlow was built for and **won the [Stellar Scaffold Hackathon](https://stellar.org)** โ€” a global competition challenging builders to ship production-grade dApps using the Stellar Scaffold CLI toolchain on Soroban. +SecureFlow was built for and **won the [Stellar Scaffold Hackathon](https://stellar.org) โ€” a global competition** challenging builders worldwide to ship production-grade dApps using the Stellar Scaffold CLI toolchain on Soroban. SecureFlow took the top spot. The project stood out for its complete end-to-end implementation: a Soroban smart contract handling real on-chain escrow logic, a React frontend auto-wired to contract clients via `stellar-scaffold`, and a gasless relay backend that makes blockchain interactions seamless for users. @@ -70,6 +72,45 @@ SecureFlow solves the freelance trust problem. When you hire someone online toda --- +## ๐Ÿš€ Roadmap & Vision + +SecureFlow is graduating from hackathon winner to a **production-grade, audited, privacy-preserving +escrow protocol**. The work is organized into four public milestones โ€” each tracked as labelled +[issues](https://github.com/Secureflow-protocol/secureflow/issues) and aligned with our +[Stellar Community Fund](https://communityfund.stellar.org) (Build) application. + +### ๐Ÿ›ก๏ธ M0 โ€” Open-Source Hardening + +Make the protocol credible and contributor-ready: a comprehensive Soroban test suite (the contract +currently ships none), migration of per-entity data from `instance` โ†’ `persistent` storage so it +scales, structured on-chain events, and contract tests + lint wired into CI. + +### ๐Ÿ” M1 โ€” Security & Audit Prep + +Get audit-ready: fund-conservation invariants and property tests, bounds-checked arbiter awards, a +global emergency circuit-breaker, supply-chain scanning, and reproducible WASM builds. _(Targets the +free **SCF Audit Bank**.)_ + +### ๐Ÿ•ถ๏ธ M2 โ€” Zero-Knowledge Privacy Layer _(our differentiator)_ + +Bring privacy to on-chain work โ€” features no other Stellar freelancing primitive has: + +- **ZK reputation proofs** โ€” prove "completed โ‰ฅ N jobs" / "rating โ‰ฅ X" without revealing clients or projects. +- **ZK freelancer credentials** โ€” Sybil-resistant, privacy-preserving identity/skill proofs. +- **ZK dispute evidence** โ€” prove a deliverable met the agreed conditions without exposing the work. + +### ๐ŸŒ M3 โ€” Product Growth + +Make it a product people use daily: an event-driven indexer (replacing polling), USDC/stablecoin +settlement, streaming/time-based payments, dispute-escalation tiers with arbiter staking, and a +hardened transaction UX. + +> ๐Ÿ“‹ Track everything on the [public roadmap board](https://github.com/Secureflow-protocol/secureflow/issues) +> and [milestones](https://github.com/Secureflow-protocol/secureflow/milestones). Contributions to any +> milestone are welcome โ€” see [Contributing](#contributing). + +--- + ## Architecture ``` @@ -146,8 +187,8 @@ cargo install stellar-scaffold-cli ```bash # 1. Clone -git clone https://github.com/HyperSafeD/SecureFlow-scaffold.git -cd SecureFlow-scaffold +git clone https://github.com/Secureflow-protocol/secureflow.git +cd secureflow # 2. Install frontend dependencies npm install @@ -277,7 +318,7 @@ pub fn rate_freelancer(escrow_id: u32, rating: u32, review: String, depositor: A ## Project Structure ``` -SecureFlow-scaffold/ +secureflow/ โ”œโ”€โ”€ contracts/ โ”‚ โ””โ”€โ”€ secureflow/ # Soroban smart contract (Rust) โ”‚ โ””โ”€โ”€ src/ @@ -316,7 +357,7 @@ SecureFlow is an open-source project growing beyond the hackathon. We welcome co ### Getting Involved -1. Check the [open issues](https://github.com/HyperSafeD/SecureFlow-scaffold/issues) โ€” they're labelled and scoped to be tackled solo +1. Check the [open issues](https://github.com/Secureflow-protocol/secureflow/issues) โ€” they're labelled and scoped to be tackled solo 2. Fork the repo and create a branch: `git checkout -b feat/your-feature` 3. Make your changes (run `npm run lint` and `npm test` before pushing) 4. Open a PR against `main` @@ -352,17 +393,17 @@ Please read [CONTRIBUTING.md](CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](CODE_OF_ ## License -MIT โ€” see [LICENSE](LICENSE). +Apache 2.0 โ€” see [LICENSE](LICENSE). ---
-**๐Ÿ† Stellar Scaffold Hackathon Winner** +**๐Ÿ† Global Stellar Hackathon Winner** Built with Rust, React, and the Stellar ecosystem. -Open source under HyperSafeD โ€” contributions welcome. +Open source under [Secureflow-protocol](https://github.com/Secureflow-protocol) โ€” contributions welcome. -[Stellar](https://stellar.org) ยท [Soroban Docs](https://developers.stellar.org/docs/smart-contracts) ยท [Scaffold CLI](https://github.com/stellar/scaffold-stellar) ยท [HyperSafeD](https://github.com/HyperSafeD) +[Stellar](https://stellar.org) ยท [Soroban Docs](https://developers.stellar.org/docs/smart-contracts) ยท [Scaffold CLI](https://github.com/stellar/scaffold-stellar) ยท [Secureflow-protocol](https://github.com/Secureflow-protocol)
diff --git a/brand/org-avatar.png b/brand/org-avatar.png new file mode 100644 index 0000000..baf30eb Binary files /dev/null and b/brand/org-avatar.png differ diff --git a/brand/org-avatar.svg b/brand/org-avatar.svg new file mode 100644 index 0000000..01cb2b2 --- /dev/null +++ b/brand/org-avatar.svg @@ -0,0 +1,39 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/brand/org-avatar@1024.png b/brand/org-avatar@1024.png new file mode 100644 index 0000000..a7aee65 Binary files /dev/null and b/brand/org-avatar@1024.png differ