You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+25-8Lines changed: 25 additions & 8 deletions
Original file line number
Diff line number
Diff line change
@@ -22,23 +22,40 @@ We welcome contributions from all developers. Please refer to our detailed [cont
22
22
23
23
To compile the code, you will need to install Rust. Instructions for this can be found in our contributing guide. After installation, use the `cargo build` command to build the project and `cargo test` to run the tests.
24
24
25
-
## Joining the Testnet
25
+
## Trying out the testnet
26
26
27
27
To join the testnet, you have the option to use pre-built binaries or compile the code yourself. The build instructions are available [here](https://docs.mintlayer.org/testnet/node-setup-cli).
28
28
29
29
To run the node, use the following command: `cargo run --bin node-daemon -- testnet`. To launch the command line wallet, use this command: `cargo run --bin wallet-cli -- --network testnet`. To launch the GUI wallet, use this command: `cargo run --bin node-gui`. You can get testnet coins from [the faucet](https://faucet.mintlayer.org/) in order to use the testnet, alternatively you can email [email protected] .
30
30
31
31
### Logging
32
+
32
33
The logging of mintlayer-core is configured via the `RUST_LOG` environment variable. All log messages are printed to the terminal screen; we prefer simplicity over complicated log machinery. For example, to see all logs of the `info` level and above (the default level for normal operation), you can run the node with `RUST_LOG=info cargo run --bin node-daemon -- testnet`. If you're facing an issue, it's recommended to use `RUST_LOG=debug` instead. We recommend using these commands that not only print the logs on the screen, but also write them to a file in case you face an issue. On Linux, this can be achieved using `tee` as shown below.
33
34
34
35
Here are the commands as recommended for different scenarios:
35
36
36
-
For normal operation
37
-
- Node daemon: `RUST_LOG=info cargo run --release --bin node-daemon -- testnet 2>&1 | tee ../mintlayer.log`
38
-
- CLI Wallet: `RUST_LOG=info cargo run --release --bin wallet-cli -- testnet 2>&1 | tee ../wallet-cli.log`
39
-
- GUI: `RUST_LOG=info cargo run --release --bin node-gui 2>&1 | tee ../node-gui.log`
37
+
For normal operation (replace testnet by mainnet to run the mainnet node)
38
+
Note: spaces don't matter, so these are aligned for readability
39
+
- Node daemon: `RUST_LOG=info cargo run --release --bin node-daemon -- testnet 2>&1 | tee ../mintlayer.log`
40
+
- CLI Wallet: `RUST_LOG=info cargo run --release --bin wallet-cli -- testnet 2>&1 | tee ../wallet-cli.log`
41
+
- RPC Wallet: `RUST_LOG=info cargo run --release --bin wallet-rpc-daemon -- testnet 2>&1 | tee ../wallet-cli.log`
42
+
- GUI: `RUST_LOG=info cargo run --release --bin node-gui -- testnet 2>&1 | tee ../node-gui.log`
40
43
41
44
For heavy debugging operation
42
-
- Node daemon: `RUST_LOG=debug cargo run --bin node-daemon -- testnet 2>&1 | tee ../mintlayer.log`
43
-
- CLI Wallet: `RUST_LOG=debug cargo run --bin wallet-cli -- testnet 2>&1 | tee ../wallet-cli.log`
44
-
- GUI: `RUST_LOG=debug cargo run --bin node-gui 2>&1 | tee ../node-gui.log`
45
+
- Node daemon: `RUST_LOG=debug cargo run --bin node-daemon -- testnet 2>&1 | tee ../mintlayer.log`
46
+
- CLI Wallet: `RUST_LOG=debug cargo run --bin wallet-cli -- testnet 2>&1 | tee ../wallet-cli.log`
47
+
- RPC Wallet: `RUST_LOG=debug cargo run --bin wallet-rpc-daemon -- testnet 2>&1 | tee ../wallet-cli.log`
48
+
- GUI: `RUST_LOG=debug cargo run --bin node-gui -- testnet 2>&1 | tee ../node-gui.log`
49
+
50
+
## Communicating with the node and wallet
51
+
52
+
Communication with the node and the wallet is possible through RPC. Details on that can be found in:
Mintlayer runs a responsible disclosure program for security issues, as such all security issues should be reported to [email protected] or [email protected].
If you disclose a valid security issue then you may be eligible for a bounty paid in ML see the details [here](https://www.mintlayer.org/bug-bounties/).
3
4
4
5
It's best to err on the side of caution, if you find something you think is security related but not eligible for the bounty or something you're not 100% sure about then let us know on the above email addresses anyway as we treat each report on a report by report basis so you may still be paid a bounty.
5
6
6
-
GPG keys for Ben and Sam can be found [here for Ben](https://www.mintlayer.org/assets/keys/ben) and [here for Sam](https://www.mintlayer.org/assets/keys/samer).
7
+
GPG keys for Enrico and Sam can be found [here for Enrico](https://www.mintlayer.org/assets/keys/enrico) and [here for Sam](https://www.mintlayer.org/assets/keys/samer).
7
8
8
9
Security issues may not be publicly announced until Mintlayer agrees.
0 commit comments