mirror of
https://github.com/monero-project/monero-docs.git
synced 2025-01-08 20:09:31 +00:00
Update overview of directory and executables to 0.16.0.0 release
This commit is contained in:
Piotr Włodarek
parent
0fa555256e
commit
0e1bad2618
2 changed files with 41 additions and 29 deletions
|
|
@ -5,76 +5,88 @@ title: Interacting with Monero | Monero Documentation
|
||||||
|
|
||||||
You can interact with Monero via desktop GUI, commandline interface, and programming API.
|
You can interact with Monero via desktop GUI, commandline interface, and programming API.
|
||||||
|
|
||||||
On top of that, Monero nodes interact with each other in a peer-to-peer network.
|
On top of that, Monero nodes interact with each other in a peer-to-peer network.
|
||||||
|
|
||||||
## Installation directory overview
|
## Installation directory overview
|
||||||
|
|
||||||
Once unpacked you will see several executable files. You will also find a nice PDF guide for the GUI wallet.
|
Once unpacked you will see several executable files. You will also find a nice PDF guide for the GUI wallet.
|
||||||
|
|
||||||
Monero project nicely decouples network node logic from wallet logic.
|
Monero project nicely decouples network node logic from wallet logic.
|
||||||
Wallet logic is offered through three independent user interfaces - the GUI, the CLI, and the HTTP API.
|
Wallet logic is offered through three independent user interfaces - the GUI, the CLI, and the HTTP API.
|
||||||
|
|
||||||
```
|
```
|
||||||
# cd monero-gui-v0.14.0.0
|
# cd monero-gui-v0.16.0.0
|
||||||
|
|
||||||
# ---- guide to Monero GUI ----
|
# ---- guide to Monero GUI ----
|
||||||
|
|
||||||
monero-GUI-guide.pdf
|
monero-gui-wallet-guide.pdf
|
||||||
|
|
||||||
# ---- executable files -----------
|
# ---- main executable files -----------
|
||||||
|
|
||||||
monerod
|
monerod
|
||||||
|
|
||||||
monero-wallet-cli
|
|
||||||
monero-wallet-gui
|
monero-wallet-gui
|
||||||
monero-wallet-rpc
|
|
||||||
|
|
||||||
monero-gen-trusted-multisig
|
# ---- extra executable files -----------
|
||||||
|
|
||||||
monero-blockchain-export
|
extra/monero-wallet-cli
|
||||||
monero-blockchain-import
|
extra/monero-wallet-rpc
|
||||||
|
|
||||||
monero-blockchain-mark-spent-outputs
|
extra/monero-blockchain-prune
|
||||||
monero-blockchain-usage
|
extra/monero-gen-trusted-multisig
|
||||||
monero-blockchain-ancestry
|
extra/monero-gen-ssl-cert
|
||||||
monero-blockchain-depth
|
|
||||||
|
|
||||||
start-gui.sh
|
extra/monero-blockchain-export
|
||||||
|
extra/monero-blockchain-import
|
||||||
|
|
||||||
# ---- directories ----------------
|
# ---- don't bother with these ----------
|
||||||
|
|
||||||
libs
|
extra/monero-blockchain-stats
|
||||||
plugins
|
extra/monero-blockchain-mark-spent-outputs
|
||||||
qml
|
extra/monero-blockchain-prune-known-spent-data
|
||||||
|
extra/monero-blockchain-usage
|
||||||
|
extra/monero-blockchain-ancestry
|
||||||
|
extra/monero-blockchain-depth
|
||||||
```
|
```
|
||||||
|
|
||||||
## Executables - what is what
|
## Executables
|
||||||
|
|
||||||
| Executable | Description
|
| Executable | Description
|
||||||
| -------------------------- |:-----------------------------------------------------------------------------------------------------------------------------------
|
| -------------------------- |:-----------------------------------------------------------------------------------------------------------------------------------
|
||||||
| `monerod` | The full node daemon. Does not require a wallet. <br />[Documentation](/interacting/monerod-reference/).
|
| `monerod` | The full node daemon. Does not require a wallet. <br />[Documentation](/interacting/monerod-reference/).
|
||||||
| `monero-wallet-gui` | Wallet logic and __graphical__ user interface. <br />Requires `monerod` running.
|
| `monero-wallet-gui` | Wallet logic and __graphical__ user interface. <br />Requires `monerod` running.
|
||||||
| `monero-wallet-cli` | Wallet logic and __commandline__ user interface. <br />Requires `monerod` running.
|
| `monero-wallet-cli` | Wallet logic and __commandline__ user interface. <br />Requires `monerod` running.
|
||||||
| `monero-wallet-rpc` | Wallet logic and __HTTP API__ (JSON-RPC protocol). <br />Requires `monerod` running.
|
| `monero-wallet-rpc` | Wallet logic and __HTTP API__ (JSON-RPC protocol). <br />Requires `monerod` running.
|
||||||
|
| `monero-blockchain-prune` | Prune existing local blockchain. This saves 2/3 of disk space (85GB -> 28GB as of June 2020). This is preferable over `monerod --prune-blockchain` which only logically releases space inside the file while the file remains large. The `monero-blockchain-prune` creates a shrinked copy of the blockchain file. See [tutorial1](https://monero.stackexchange.com/questions/11454/how-do-i-utilize-blockchain-pruning-in-the-gui-monero-wallet-gui), [tutorial2](https://www.publish0x.com/solareclipse/howto-prune-shrink-the-database-of-the-monero-blockchain-on-xpgwjx).
|
||||||
|
| `monero-gen-ssl-cert` | Generate 4096 bit RSA private key and self signed TLS certificate for use with `monerod` RPC interface. See the [pull request](https://github.com/monero-project/monero/pull/5495).
|
||||||
|
| `monero-gen-trusted-multisig` | Tool to generate a set of multisig wallets. <br />See chapter on [multisignatures](/multisignature).
|
||||||
| `monero-blockchain-export` | Tool to export blockchain to `blockchain.raw` file.
|
| `monero-blockchain-export` | Tool to export blockchain to `blockchain.raw` file.
|
||||||
| `monero-blockchain-import` | Tool to import [blockchain.raw](https://downloads.getmonero.org/blockchain.raw) - ideally your own trusted copy.
|
| `monero-blockchain-import` | Tool to import [blockchain.raw](https://downloads.getmonero.org/blockchain.raw) - ideally your own trusted copy.
|
||||||
| `monero-gen-trusted-multisig` | Tool to generate a set of multisig wallets. <br />See chapter on [multisignatures](/multisignature).
|
|
||||||
|
## Executables - legacy
|
||||||
|
|
||||||
|
You most likely should not bother with these legacy or very specialized tools.
|
||||||
|
|
||||||
|
| Executable | Description
|
||||||
|
| -------------------------- |:-----------------------------------------------------------------------------------------------------------------------------------
|
||||||
|
| `monero-blockchain-stats` | Generate stats like tx/day, blocks/day, bytes/day based on your local blockchain.
|
||||||
| `monero-blockchain-mark-spent-outputs` | Advanced tool to mitigate potential privacy issues related to Monero forks. You normally shouldn't be concerned with that.<br />See the [commit](https://github.com/monero-project/monero/commit/df6fad4c627b99a5c3e2b91b69a0a1cc77c4be14#diff-0410fba131d9a7024ed4dcf9fb4a4e07) and [pull request](https://github.com/monero-project/monero/pull/3322).
|
| `monero-blockchain-mark-spent-outputs` | Advanced tool to mitigate potential privacy issues related to Monero forks. You normally shouldn't be concerned with that.<br />See the [commit](https://github.com/monero-project/monero/commit/df6fad4c627b99a5c3e2b91b69a0a1cc77c4be14#diff-0410fba131d9a7024ed4dcf9fb4a4e07) and [pull request](https://github.com/monero-project/monero/pull/3322).
|
||||||
|
| `monero-blockchain-prune-known-spent-data` | Previous limited pruning tool to prune select "known spent" transaction outputs (from the before RCT era). Nowadays prefer `monero-blockchain-prune`. This only saves ~200 MB. See the [commit](https://github.com/monero-project/monero/commit/d855f9bb92dbfab707a0e37505906366de818a14).
|
||||||
| `monero-blockchain-usage` | Advanced tool to mitigate potential privacy issues related to Monero forks. You normally shouldn't be concerned with that.<br />See the [commit](https://github.com/monero-project/monero/commit/0590f62ab64cf023d397b995072035986931a6b4) and the [pull request](https://github.com/monero-project/monero/pull/3322).
|
| `monero-blockchain-usage` | Advanced tool to mitigate potential privacy issues related to Monero forks. You normally shouldn't be concerned with that.<br />See the [commit](https://github.com/monero-project/monero/commit/0590f62ab64cf023d397b995072035986931a6b4) and the [pull request](https://github.com/monero-project/monero/pull/3322).
|
||||||
| `monero-blockchain-ancestry` | Advanced research tool to learn ancestors of a transaction, block or chain. Irrelevant for normal users. See this [pull request](https://github.com/monero-project/monero/pull/4147/files).
|
| `monero-blockchain-ancestry` | Advanced research tool to learn ancestors of a transaction, block or chain. Irrelevant for normal users. See this [pull request](https://github.com/monero-project/monero/pull/4147/files).
|
||||||
| `monero-blockchain-depth` | Advanced research tool to learn depth of a transaction, block or chain. Irrelevant for normal users. See this [commit](https://github.com/monero-project/monero/commit/289880d82d3cb206a2cf4ae67d2deacdab43d4f4#diff-34abcc1a0c100efb273bf36fb95ebfa0).
|
| `monero-blockchain-depth` | Advanced research tool to learn depth of a transaction, block or chain. Irrelevant for normal users. See this [commit](https://github.com/monero-project/monero/commit/289880d82d3cb206a2cf4ae67d2deacdab43d4f4#diff-34abcc1a0c100efb273bf36fb95ebfa0).
|
||||||
|
|
||||||
|
|
||||||
## Interacting
|
## Interacting
|
||||||
|
|
||||||
There are quite a few ways you can interact with Monero software.
|
There are quite a few ways you can interact with Monero software.
|
||||||
Perhaps the most surprising for newcomers is that `monerod` daemon accepts interactive keyboard commands while it is running.
|
Perhaps the most surprising for newcomers is that `monerod` daemon accepts interactive keyboard commands while it is running.
|
||||||
|
|
||||||
Also, please note that HTTP API is split across `monerod` and `monero-wallet-rpc`. You need to run and call both daemons to explore the full API.
|
Also, please note that HTTP API is split across `monerod` and `monero-wallet-rpc`. You need to run and call both daemons to explore the full API.
|
||||||
This follows the node-logic vs wallet-logic split mentioned earlier.
|
This follows the node-logic vs wallet-logic split mentioned earlier.
|
||||||
|
|
||||||
All wallet implementations depend on the `monerod` running.
|
All wallet implementations depend on the `monerod` running.
|
||||||
|
|
||||||
| Executable | p2p network | node commands via keyboard | node HTTP API | wallet commands via keyboard | wallet HTTP API | wallet via GUI
|
| Executable | p2p network | node commands via keyboard | node HTTP API | wallet commands via keyboard | wallet HTTP API | wallet via GUI
|
||||||
| -------------------------- | ------------------- | -------------------------- | ------------- | ---------------------------- | --------------- | --------------
|
| -------------------------- | ------------------- | -------------------------- | ------------- | ---------------------------- | --------------- | --------------
|
||||||
| `monerod` | ✔ | ✔ | ✔ | | |
|
| `monerod` | ✔ | ✔ | ✔ | | |
|
||||||
| `monero-wallet-cli` | | | | ✔ | |
|
| `monero-wallet-cli` | | | | ✔ | |
|
||||||
|
|
|
||||||
|
|
@ -9,14 +9,14 @@ nav:
|
||||||
- Interacting:
|
- Interacting:
|
||||||
- Download: 'interacting/download-monero-binaries.md'
|
- Download: 'interacting/download-monero-binaries.md'
|
||||||
- Verify: 'interacting/verify-monero-binaries.md'
|
- Verify: 'interacting/verify-monero-binaries.md'
|
||||||
- What is what overview: 'interacting/overview.md'
|
- Overview: 'interacting/overview.md'
|
||||||
|
- Config file: 'interacting/monero-config-file.md'
|
||||||
- monerod: 'interacting/monerod-reference.md'
|
- monerod: 'interacting/monerod-reference.md'
|
||||||
- monero-wallet-cli: 'interacting/monero-wallet-cli-reference.md'
|
- monero-wallet-cli: 'interacting/monero-wallet-cli-reference.md'
|
||||||
- monero-wallet-gui: 'interacting/monero-wallet-gui-reference.md'
|
- monero-wallet-gui: 'interacting/monero-wallet-gui-reference.md'
|
||||||
|
- monero-wallet-rpc: 'interacting/monero-wallet-rpc-reference.md'
|
||||||
- monero-blockchain-export: 'interacting/monero-blockchain-export-reference.md'
|
- monero-blockchain-export: 'interacting/monero-blockchain-export-reference.md'
|
||||||
- monero-blockchain-import: 'interacting/monero-blockchain-import-reference.md'
|
- monero-blockchain-import: 'interacting/monero-blockchain-import-reference.md'
|
||||||
- monero-wallet-rpc: 'interacting/monero-wallet-rpc-reference.md'
|
|
||||||
- Config file: 'interacting/monero-config-file.md'
|
|
||||||
- Technical specs: 'technical-specs.md'
|
- Technical specs: 'technical-specs.md'
|
||||||
- Cryptography:
|
- Cryptography:
|
||||||
- Introduction: 'cryptography/introduction.md'
|
- Introduction: 'cryptography/introduction.md'
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue