diff --git a/README.md b/README.md index d673a723..4baf8e96 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,137 @@ -Patched Branch for App -Any changes must be made to the patched_changes (this) branch only if something is less of a patch, and more of a core functionality you can request this from the haveno core team. +# Haveno Exchange, Marketplace & Chat Messaging Protocol Core -Explaination of changes +

+ +
+ + + +

-Changed protocol serialization from 'A' to 'X' to indicate a clear significant change in structure -Changes the daemon to be a shadowJar instead \ No newline at end of file +--- + +## ⚑ What Is Haveno? + +**Haveno** is a free, open-source peer-to-peer exchange platform for Monero (XMR) and other privacy-focused assets. Built on top of Tor for anonymity, it allows users to trade securely without exposing their identity, IP address, or relying on central servers. + +We are now entering a **new phase of development** β€” expanding Haveno’s decentralized trading engine to support a full **decentralized marketplace**, enabling the secure trading of physical and digital items via onion-routed infrastructure. + +> Think Monero + eBay, but with no centralized control, and fully private. + +--- + +## πŸš€ Project Highlights + +- βœ… Full Haveno App for Desktop & Android (macOS, Linux, Windows) +- βœ… gRPC over Tor SOCKS5 tunnel support +- βœ… Encrypted database & AES SharedPreferences +- βœ… Cross-platform Dart SDK +- βœ… Docker deployment support +- βœ… Fluent UI and secure chat +- βœ… **Upcoming: decentralized item trading with multisig escrow** +- βœ… **Upcoming: decentralized chat messaging system, no central servers. Secure, private and simple to use.** + +--- + +## πŸ§ͺ Try Haveno Now + +**Download the latest pre-release builds:** +πŸ“¦ [Releases](https://github.com/KewbitXMR/haveno-app/releases) + +Be aware: Current builds are connected to **Stagenet**, a Monero test network. +Do not send real funds! + +πŸ“± [Android Universal APK](https://haveno.com/downloads/) +πŸ’» [macOS Intel & Silicon](https://haveno.wiki/en/install-guide) +🐧 [Linux AppImage (Beta)](https://haveno.com/downloads/) +🐳 [Docker Hub (server-related deployments)](https://hub.docker.com/u/havenodex) + +> iOS and Windows Desktop versions are in progress. + +--- + +## πŸ“¦ Marketplace Extension (WIP) + +We are now actively building: +- πŸ›’ Item-based listings with escrow logic +- βœ… Full arbitration protocol extensions +- πŸ“€ Decentralized shipment commitment proofs +- πŸ” Encrypted item metadata +- πŸ’¬ Integrated chat messaging for item trades +- βš™οΈ Fully p2p over Tor with zero server trust + +πŸ“– [Marketplace Protocol Spec (Coming Soon)](#) +πŸ“– [How to list physical goods securely (Coming Soon)](#) +πŸ“– [Integrating payments with XMR or eGift codes (Coming Soon)](#) + +--- + +## πŸ“š Helpful Guides + +- [Install Haveno on Desktop](https://haveno.com/documentation/installing-haveno-on-desktop/) +- [Install Haveno on Android](https://haveno.com/documentation/install-haveno-on-a-mobile-device/) +- [Setup a Secure Tor Relay with Haveno](https://haveno.com/documentation/tor-setup/) +- [Running Haveno with Docker](https://haveno.com/documentation/installing-the-haveno-daemon-with-docker-securely/) +- [Operating a Custom Haveno Network](https://haveno.com/documentation/setup-a-custom-haveno-network-seednode-with-docker/) +- [Telegram Integration for Notifications](https://haveno.com/documentation/using-telegram-to-manage-your-haveno-account/) + +--- + +## πŸ“‘ Network & Federation + +The Haveno network is fully decentralized but supports **federated networks** (similar to Matrix or Mastodon). You can either join existing Haveno networks or host your own. + +Anyone can contribute from developers, advocates, and sysadmins to: +- Deploy their own network +- Become arbitrators +- Operate price feeds +- Collect trade fees **legally** (we do not condone or support in any way the use of our software fo illict activity in any any juridication where it is not legally permitted.) + +πŸ“– [How to Configure a Custom Network (Coming Soon)](#) +πŸ“– [How Arbitration Works in Haveno (Coming Soon)](#) + +--- + +## 🧩 Roadmap + +| Feature | Status | +|--------|--------| +| Protocol Core (v1) | βœ… Complete | +| Dart SDK + Documentation | βœ… Complete | +| Desktop UI (Linux/macOS) | βœ… Stable | +| Android UI | βœ… Stable | +| Marketplace Extension | πŸ›  In Progress | +| Rust + Python SDKs | πŸ›  In Progress | +| Arbitrator UX + Tools | πŸ”œ Pending | +| Client Authentication (Onion) | πŸ”œ Pending | +| Biometric Unlock (Mobile) | πŸ”œ Planned | +| iOS Support | πŸ”œ Planned | +| Multi-Currency Atomic Swaps | πŸ”œ Planned | +| FIDO2 Auth for TX | πŸ”œ Planned | + +--- + +## πŸ›  Contributing + +Testing old phones, laptops, and edge devices helps us the most right now. + +Want to contribute code, translations, docs, or host a network? + +- [Open an Issue](https://github.com/KewbitXMR/haveno-app/issues) +- [Join Our Discussions](https://xmr.social/c/Haveno) +- [Submit Pull Requests](https://github.com/KewbitXMR/haveno-app/pulls) +- [Follow Kewbit on X](https://x.com/kewbit) + +--- + +## ⚠️ Disclaimer + +> This software is in testing. The Haveno Protocol Core connects to a Haveno Daemon but does not itself process or hold any financial assets or act as a financial intermediary. You are responsible for complying with local laws regarding privacy-preserving technologies and trade. + +--- + +## ❀️ Thanks + +Huge thanks to the Monero community, Haveno contributors, and anyone running seed nodes, [operating haveno networks](https://haveno.com/networks/) or Tor relays to power freedom of trade. + +Support and transparency logs can be found on [Kewbit's Privacy Blog](https://kewbit.org). \ No newline at end of file