haveno/README.md

87 lines
5.3 KiB
Markdown
Raw Permalink Normal View History

2022-11-18 20:47:07 +01:00
<div align="center">
2021-05-05 02:20:30 +02:00
<img src="https://raw.githubusercontent.com/haveno-dex/haveno-meta/721e52919b28b44d12b6e1e5dac57265f1c05cda/logo/haveno_logo_landscape.svg" alt="Haveno logo">
2022-11-11 15:20:36 +01:00
[![Codacy Badge](https://app.codacy.com/project/badge/Grade/505405b43cb74d5a996f106a3371588e)](https://app.codacy.com/gh/haveno-dex/haveno/dashboard)
2022-11-18 20:47:07 +01:00
![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/haveno-dex/haveno/build.yml?branch=master)
[![GitHub issues with bounty](https://img.shields.io/github/issues-search/haveno-dex/haveno?color=%23fef2c0&label=Issues%20with%20bounties&query=project%3Ahaveno-dex%2F2)](https://github.com/orgs/haveno-dex/projects/2) |
[![Twitter Follow](https://img.shields.io/twitter/follow/HavenoDEX?style=social)](https://twitter.com/havenodex)
2022-11-18 20:47:07 +01:00
[![Matrix rooms](https://img.shields.io/badge/Matrix%20room-%23haveno-blue)](https://matrix.to/#/#haveno:monero.social) [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/haveno-dex/.github/blob/master/CODE_OF_CONDUCT.md)
2021-05-05 02:20:30 +02:00
</div>
2021-05-05 02:20:01 +02:00
2021-05-05 02:20:30 +02:00
## What is Haveno?
2021-05-05 02:20:01 +02:00
2023-05-15 18:44:48 +02:00
Haveno (pronounced ha‧ve‧no) is a platform for people who want to exchange [Monero](https://getmonero.org) for fiat currencies like EUR, GBP, and USD or other cryptocurrencies like BTC, ETH, and BCH.
2021-05-05 02:20:01 +02:00
2022-01-21 12:08:44 +01:00
Main features:
- All communications are routed through **Tor**, to preserve your privacy
- Trades are **peer-to-peer**: trades on Haveno will happen between people only, there is no central authority.
2022-01-21 12:08:44 +01:00
- Trades are **non-custodial**: Haveno provides arbitration in case something goes wrong during the trade, but we will never have access to your funds.
- There is **No token**, because we don't need it. Transactions between traders are secured by non-custodial multisignature transactions on the Monero network.
- The revenue generated by Haveno will be managed by an entity called Council (more info soon), composed by members of the Monero/Haveno community, not the Haveno Core Team and will be used to **fund Haveno and Monero** development.
2022-01-21 12:08:44 +01:00
See the [FAQ on our website](https://haveno.exchange/faq/) for more information.
2021-05-05 02:20:01 +02:00
2021-05-05 02:20:30 +02:00
## Status of the project
A live test network is online and users can already run Haveno and make test trades between each others using Monero's stagenet. See the [instructions to build Haveno and connect to the network](https://github.com/haveno-dex/haveno/blob/master/docs/installing.md). Note that Haveno is still very much in development. If you find issues or bugs, please let us know.
2021-05-05 02:20:30 +02:00
2022-05-06 10:28:56 +02:00
Main repositories:
2021-05-05 02:20:30 +02:00
2022-05-06 10:28:56 +02:00
- **[haveno](https://github.com/haveno-dex/haveno)** - This repository. The core of Haveno.
- **[haveno-ui](https://github.com/haveno-dex/haveno-ui)** - The user interface.
- **[haveno-ts](https://github.com/haveno-dex/haveno-ts)** - TypeScript library for using Haveno.
- **[haveno-meta](https://github.com/haveno-dex/haveno-meta)** - For project-wide discussions and proposals.
2021-05-05 02:20:30 +02:00
2022-05-06 10:28:56 +02:00
If you wish to help, take a look at the repositories above and look for open issues. We run a bounty program to incentivize development. See [Bounties](#bounties)
2021-05-05 02:20:30 +02:00
2022-11-09 16:05:55 +01:00
The PGP keys of the core team members are in `gpg_keys/`.
2021-05-05 02:20:30 +02:00
## Keep in touch and help out!
2022-05-06 10:28:56 +02:00
Haveno is a community-driven project. For it to be successful it's fundamental to have the support and help of the community. Join the community rooms on our Matrix server:
2021-05-05 02:20:30 +02:00
- General discussions: **Haveno** ([#haveno:monero.social](https://matrix.to/#/#haveno:monero.social)) relayed on IRC/Libera (`#haveno`)
- Development discussions: **Haveno Development** ([#haveno-dev:monero.social](https://matrix.to/#/#haveno-dev:monero.social)) relayed on IRC/Libera (`#haveno-dev`)
2021-05-05 02:20:30 +02:00
Email: contact@haveno.exchange
Website: [haveno.exchange](https://haveno.exchange)
2021-05-05 02:20:30 +02:00
2021-10-30 15:34:32 +02:00
## Running a local Haveno test network
2021-10-30 15:34:32 +02:00
See [docs/installing.md](docs/installing.md)
2021-10-30 15:34:32 +02:00
## Contributing to Haveno
2021-05-05 02:20:30 +02:00
2022-05-06 10:28:56 +02:00
See the [developer guide](docs/developer-guide.md) to get started developing for Haveno.
2021-05-05 02:20:30 +02:00
2021-10-30 15:34:32 +02:00
See [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) for our styling guides.
If you are not able to contribute code and want to contribute development resources, [donations](#support) fund development bounties.
## Bounties
To incentivize development and reward contributors we adopt a simple bounty system. Contributors may be awarded bounties after completing a task (resolving an issue). Take a look at the issues eligible for a bounty on the [dedicated Kanban board](https://github.com/orgs/haveno-dex/projects/2) or look for [issues labelled '💰bounty'](https://github.com/haveno-dex/haveno/issues?q=is%3Aissue+is%3Aopen+label%3A%F0%9F%92%B0bounty) in the main `haveno` repository. [Details and conditions for receiving a bounty](docs/bounties.md).
2021-05-05 02:20:30 +02:00
## Support and sponsorships
2021-05-05 02:20:30 +02:00
To bring Haveno to life, we need resources. If you have the possibility, please consider [becoming a sponsor](https://haveno.exchange/sponsors/) or donating to the project:
2021-05-05 02:20:30 +02:00
### Monero
2021-05-05 02:20:30 +02:00
`42sjokkT9FmiWPqVzrWPFE5NCJXwt96bkBozHf4vgLR9hXyJDqKHEHKVscAARuD7in5wV1meEcSTJTanCTDzidTe2cFXS1F`
<!-- ![Qr code](https://raw.githubusercontent.com/haveno-dex/haveno/master/media/qrhaveno.png) -->
2021-05-05 02:20:30 +02:00
If you are using a wallet that supports OpenAlias (like the 'official' CLI and GUI wallets), you can simply put `fund@haveno.exchange` as the "receiver" address.
### Bitcoin
`1AKq3CE1yBAnxGmHXbNFfNYStcByNDc5gQ`
2022-11-18 20:47:07 +01:00
<!-- ![Qr code](https://raw.githubusercontent.com/haveno-dex/haveno/master/media/qrbtc.png) -->