haveno-app/README.md

# Haveno App

<img src="https://i.ibb.co/J7J9qV4/Screenshot-20240817-203316.jpg" width=150 /> <img src="https://i.ibb.co/Btt17Vg/Screenshot-20240817-203341.jpg" width=150 /> <img src="https://i.ibb.co/1L09NT6/Screenshot-20240817-203431.jpg" width=150 /> <img src="https://i.ibb.co/QDPyJp9/Screenshot-20240817-203535.jpg" width=150 /> <img src="https://i.ibb.co/L011YGW/Screenshot-20240817-203150.jpg" width=150 /> <img src="https://i.ibb.co/64YQR1S/Screenshot-20240817-204709.jpg" width=150 />

## Table of Contents
1. [Prerequisites](#prerequisites)
4. [Project Status](#project-status)
   - [Network Endorsements](#network-endorsements)
6. [Project Activity](#project-activity)
7. [Roadmap](#roadmap)
8. [Contributing](#contributing)

---

## Prerequisites (For Testing)

Before you begin, you'll need to set up a testing environment:

- **Android Device or Emulator:** You can test on a physical Android phone or use an Android simulator via [Android Studio](https://studio.android.com) for advanced users. [BlueStacks](https://www.bluestacks.com/download.html) is another option with a gentler learning curve.
- **Latest Pre-release Builds:** Obtain the latest pre-release builds from the [Releases](https://github.com/KewbitXMR/haveno-app/releases) page. These are typically updated weekly.

**Important:** Follow the instructions in this guide carefully for Haveno Plus to function correctly.

## Setup Your Mobile Device

### Install Tor VPN Relay

To ensure all traffic is securely routed through Tor, you must install and activate a Tor VPN relay on your mobile device. The recommended apps are:

- **[Orbot](https://play.google.com/store/apps/details?id=org.torproject.android):** Officially supported by The Tor Project.
  - [Sourcecode & Releases](https://github.com/guardianproject/orbot/releases/tag/17.3.2-RC-1-tor-0.4.8.12)
- **[InviZible](https://play.google.com/store/apps/details?id=pan.alexander.tordnscrypt.gp):** A popular community alternative.
  - [Sourcecode & Releases](https://github.com/Gedsh/InviZible/releases/tag/v2.3.0-beta)

**Steps:**
1. Download [Orbot on Google Play](https://play.google.com/store/apps/details?id=org.torproject.android) or [InviZible on Google Play](https://play.google.com/store/apps/details?id=pan.alexander.tordnscrypt.gp).
   - Alternatively, download [InviZible on F-Droid](https://f-droid.org/packages/pan.alexander.tordnscrypt.stable/).
2. Open the app of your choice and follow the on-screen instructions to activate it. Ensure that Tor is enabled and the VPN is activated.
3. Configure the VPN relay to route your Haveno Plus app traffic through Tor. The app will not load if a VPN relay is not configured first, by design, for your security.

### Haveno Install Guide

The Haveno Plus app is available as alpha pre-release builds for Android and Windows. Download the app from the [Releases](https://github.com/KewbitXMR/haveno-app/releases) page. The desktop clients are designed to be user-friendly, with custom installers for quick setup.

**Note:** Haveno Plus is currently configured to use the stagenet (a test network) for at least the next 2 months. It is not intended for real-life trading.

## Setup Your Desktop or Server

- **Windows:** (Coming soon)
- **MacOS:** (Coming soon)
- **Android** Alpha (testing)
- **iOS** (Coming soon)
- **Linux:** Alpha (testing)
- **Docker:** (Coming soon)


### Step-by-Step Guides
1. [How to Install Haveno on Desktop](https://haveno.com/documentation/installing-haveno-on-desktop/)
2. [How to Install Haveno on Mobile](https://haveno.com/documentation/install-haveno-on-a-mobile-device/)
3. [How to Install Haveno on Server with Docker](https://haveno.com/documentation/installing-the-haveno-daemon-with-docker-securely/)
4. [How to Setup your own Haveno Network](https://haveno.com/documentation/setup-a-custom-haveno-network-seednode-with-docker/)


## Project Status

Milestone 1: Protocol Interface ✅
Milestone 2: Complete UI + Providers + lots more ✅
Extras not in CCS: 
  - Caching system to ease the load on the daemon SQLite
  - AES encryption on shared shared preferences and DB (not tested, will including on wallet too if nessesary)

The project is currently currently in the testing peroid of Milestone 2 having completed it.

### Network Endorsements

Haveno does not endorse or denounce any particular network. The choice of network will be available upon official release.

## Roadmap

- Dart SDK API ✅ [Haveno Dart SDK](https://pub.dev/packages/haveno)
- Complete UI ✅ (tweaks needed)
- Linux desktop support ✅
- Windows desktop Support 
- MacOS desktop support 
- Android mobile Support 
- Complete full arbitration scope.
- Add client authentication for onion-hosted daemons.
- iOS support. 
- Easy whitelisting and fund transfers to Cake Wallet or similar.
- Biometric security for mobile devices, with PIN or password protection for those without biometric options.
- Standalone version not requiring desktop or server (considerable work; community support may be needed).
- Support for Monero Atomic Swaps

## Contributing

Testing on old phones or laptops and providing high-quality feedback is the best way to contribute. A discussion section will be set up for initial feedback and contributions.

## Disclaimer
Kewbit the maintainers blog is at [Kewbit.org](https://kewbit.org/) official sources for this are located at [https://git.haveno.com/haveno/](Haveno.com's Gitlab). **HAVENO.COM represents the official haveno app website and services as a client to a Haveno Daemon only**,  and **HAVENO.EXCHANGE represents everything else, including not not limited to the p2p server network protocol, daemon nodes and pricenodes**, there are now also lots of app-specific guides located at [haveno documentation](https://haveno.com/documentation/) section of the site, which are atuned towards the new app.

None of the code in this repository (haveno-app) is intrinically holding custody of philosophy in what may be considered 'crypto-assets' OR transmitting any such 'crypto-assets' or other financial services across the the wire, network or the general internet.