Skip to content

Commit 65ba748

Browse files
committed
update build instructions for mainnet
1 parent d3ee734 commit 65ba748

File tree

1 file changed

+37
-23
lines changed

1 file changed

+37
-23
lines changed

docs/installing.md

Lines changed: 37 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,19 @@
1-
# Set up environment
1+
# Build and run Haveno
22

3-
These are the steps needed to build Haveno and test it on our test network or locally.
3+
These are the steps needed to build and run Haveno. You can test it locally or on our test network using the official Haveno repository.
44

5-
## Install dependencies
6-
7-
On Linux and macOS, install Java JDK 21:
5+
> [!note]
6+
> Trying to use Haveno on mainnet?
7+
>
8+
> The official Haveno repository does not operate or endorse any mainnet network. Find a third party network and use their installer or build their repository.
9+
>
10+
> Alternatively you can [create your own mainnet network](create-mainnet.md).
811
9-
```
10-
curl -s "https://get.sdkman.io" | bash
11-
sdk install java 21.0.2.fx-librca
12-
```
12+
## Install dependencies
1313

14-
On Windows, install MSYS2 and Java JDK 21:
14+
On Ubuntu: `sudo apt install make wget git`
1515

16+
On Windows, first install MSYS2:
1617
1. Install [MSYS2](https://www.msys2.org/).
1718
2. Start MSYS2 MINGW64 or MSYS MINGW32 depending on your system. Use MSYS2 for all commands throughout this document.
1819
4. Update pacman: `pacman -Syy`
@@ -21,12 +22,17 @@ On Windows, install MSYS2 and Java JDK 21:
2122
64-bit: `pacman -S mingw-w64-x86_64-toolchain make mingw-w64-x86_64-cmake git`
2223

2324
32-bit: `pacman -S mingw-w64-i686-toolchain make mingw-w64-i686-cmake git`
24-
6. `curl -s "https://get.sdkman.io" | bash`
25-
7. `sdk install java 21.0.2.fx-librca`
25+
26+
On all platforms, install Java JDK 21:
27+
28+
```
29+
curl -s "https://get.sdkman.io" | bash
30+
sdk install java 21.0.2.fx-librca
31+
```
2632

2733
## Build Haveno
2834

29-
If it's the first time you are building Haveno, run the following commands to download the repository, the needed dependencies, and build the latest release:
35+
If it's the first time you are building Haveno, run the following commands to download the repository, the needed dependencies, and build the latest release. If using a third party network, replace the repository URL with theirs:
3036

3137
```
3238
git clone https://github.com/haveno-dex/haveno.git
@@ -45,15 +51,23 @@ git pull
4551
make clean && make
4652
```
4753

48-
Make sure to delete the folder with the local settings, as there are breaking changes between releases:
54+
## Run Haveno
55+
56+
> [!note]
57+
> When you run Haveno, your application folder will be installed to:
58+
> * Linux: `~/.local/share/Haveno/`
59+
> * macOS: `~/Library/Application\ Support/Haveno/`
60+
> * Windows: `~\AppData\Roaming\Haveno\`
4961
50-
On **Linux**: remove everything inside `~/.local/share/haveno-*/xmr_stagenet/`, except the `wallet` folder.
62+
### Mainnet
5163

52-
On **Mac**: remove everything inside `~/Library/Application\ Support/haveno-*/xmr_stagenet/`, except the `wallet` folder.
64+
If you are building a third party repository which supports mainnet, you can start Haveno with:
5365

54-
On **Windows**: remove everything inside `~\AppData\Roaming\haveno-*/xmr_stagenet/`, except the `wallet` folder.
66+
```
67+
make haveno-desktop-mainnet
68+
```
5569

56-
## Join the public test network
70+
### Join the public test network
5771

5872
If you want to try Haveno in a live setup, launch a Haveno instance that will connect to other peers on our public test environment, which runs on Monero's stagenet (you won't need to download the blockchain locally). You'll be able to make test trades with other users and have a preview of Haveno's trade protocol in action. Note that development is very much ongoing. Things are slow and might break.
5973

@@ -67,19 +81,19 @@ Steps:
6781
6. Now if you are taking a trade you'll be asked to confirm you have sent the payment outside Haveno. Confirm in the app and wait for the confirmation of received payment from the other trader.
6882
7. Once the other trader confirms, deposits are sent back to the owners and the trade is complete.
6983

70-
# Run a local test network
84+
### Run a local test network
7185

7286
If you are a developer who wants to test Haveno in a more controlled way, follow the next steps to build a local test environment.
7387

74-
## Run a local XMR testnet
88+
#### Run a local XMR testnet
7589

7690
1. In a new terminal window run `make monerod1-local`
7791
1. In a new terminal window run `make monerod2-local`
7892
3. Now mine the first 150 blocks to a random address before using, so wallets only use the latest output type. Run in one of the terminal windows opened above:
7993

8094
`start_mining 9tsUiG9bwcU7oTbAdBwBk2PzxFtysge5qcEsHEpetmEKgerHQa1fDqH7a4FiquZmms7yM22jdifVAD7jAb2e63GSJMuhY75 1`
8195

82-
## Deploy
96+
#### Deploy
8397

8498
If you are a *screen* user, simply run `make deploy`. This command will open all needed Haveno instances (seednode, user1, user2, arbitrator) using *screen*.
8599

@@ -93,14 +107,14 @@ If you don't use *screen*, open 4 terminal windows and run in each one of them:
93107

94108
If this is the first time launching the arbitrator desktop application, register the arbitrator after the interface opens. Go to the *Account* tab and press `cmd+r`. Confirm the registration of the arbitrator.
95109

96-
## Fund your wallets
110+
#### Fund your wallets
97111

98112
When running user1 and user2, you'll see a Monero address prompted in the terminal. Send test XMR to the addresses of both user1 and user2 to be able to initiate a trade.
99113

100114
You can fund the two wallets by mining some test XMR coins to those addresses. To do so, open a terminal where you ran monerod and run: `start_mining ADDRESS 1`.
101115

102116
monerod will start mining local testnet coins on your device using one thread. Replace `ADDRESS` with the address of user1 first, and then user2's. Run `stop_mining` to stop mining.
103117

104-
## Start testing
118+
#### Start testing
105119

106120
You are all set. Now that everything is running and your wallets are funded, you can create test trades between user1 and user2. Remember to mine a few blocks after opening and accepting the test trade so the transaction will be confirmed.

0 commit comments

Comments
 (0)