Skip to content

Commit 7a7af7b

Browse files
Update readme
1 parent 79b0969 commit 7a7af7b

File tree

2 files changed

+28
-10
lines changed

2 files changed

+28
-10
lines changed

README.md

Lines changed: 25 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,40 @@ We welcome contributions from all developers. Please refer to our detailed [cont
2222

2323
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.
2424

25-
## Joining the Testnet
25+
## Trying out the testnet
2626

2727
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).
2828

2929
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] .
3030

3131
### Logging
32+
3233
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.
3334

3435
Here are the commands as recommended for different scenarios:
3536

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`
4043

4144
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:
53+
54+
- [Node RPC readme](rpc/README.md)
55+
- [Wallet RPC readme](wallet/wallet-rpc-daemon/README.md)
56+
57+
## Running a node in a rented public server or a Virtual Private Server (VPS)
58+
59+
Please read the documentation on the recommended security practices when running a public server:
60+
61+
- [Node service readme](build-tools/linux-systemd-service/README.md)

SECURITY.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
1-
Mintlayer runs a responsible disclosure program for security issues, as such all security issues should be reported to [email protected] or [email protected].
1+
Mintlayer runs a responsible disclosure program for security issues, as such all security issues should be reported to [email protected] or [email protected] or [email protected].
2+
23
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/).
34

45
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.
56

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).
78

89
Security issues may not be publicly announced until Mintlayer agrees.

0 commit comments

Comments
 (0)