Update overview of interacting with Monero

This commit is contained in:
Piotr Włodarek 2018-10-19 13:29:46 +02:00
parent 0f59b2f50a
commit 631d02b013
2 changed files with 37 additions and 3 deletions

View file

@ -97,7 +97,7 @@ The following options define how the API behaves.
| `--confirm-external-bind` | Confirm you consciously set `--rpc-bind-ip` to non-localhost IP and you understand the consequences. | `--confirm-external-bind` | Confirm you consciously set `--rpc-bind-ip` to non-localhost IP and you understand the consequences.
| `--restricted-rpc` | Restrict API to view only commands and do not return privacy sensitive data. Note this does not make sense with `--rpc-restricted-bind-port` because you would end up with two restricted APIs. | `--restricted-rpc` | Restrict API to view only commands and do not return privacy sensitive data. Note this does not make sense with `--rpc-restricted-bind-port` because you would end up with two restricted APIs.
| `--rpc-login` | Specify `username[:password]` required to connect to API. Practical usage seems limited because API communication is in plain text over HTTP. | `--rpc-login` | Specify `username[:password]` required to connect to API. Practical usage seems limited because API communication is in plain text over HTTP.
| `--rpc-access-control-origins` | Specify a comma separated list of origins to allow cross origin resource sharing. | `--rpc-access-control-origins` | Specify a comma separated list of origins to allow cross origin resource sharing. This is useful if you want to use `monerod` API directly from a web browser via JavaScript (say in a pure-fronted web appp scenario). With this option `monerod` will put proper HTTP CORS headers to its responses. You will also need to set `--rpc-login` if you use this option. Normally though, the API is used by backend app and this option isn't necessary.
#### Speed nad Reliability #### Speed nad Reliability

View file

@ -15,7 +15,39 @@ On top of that, Monero nodes interact with each other in a peer-to-peer network.
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.
![Monero Directory](/images/monero-dir.png "Monero Unpacked") ```
# ---- PDF guide to Monero GUI ----
monero-GUI-guide.pdf
# ---- Executable files -----------
monerod
monero-wallet-cli
monero-wallet-gui
monero-wallet-rpc
monero-gen-trusted-multisig
monero-blockchain-export
monero-blockchain-import
monero-blockchain-blackball
monero-blockchain-usage
monero-blockchain-ancestry
monero-blockchain-depth
start-gui.sh
# ---- Directories ----------------
libs
plugins
qml
```
## Executables - what is what
| Executable | Description | Executable | Description
| -------------------------- |:----------------------------------------------------------------------------------------------------------------------------------- | -------------------------- |:-----------------------------------------------------------------------------------------------------------------------------------
@ -28,6 +60,8 @@ Wallet logic is offered through three independent user interfaces - the GUI, the
| `monero-gen-trusted-multisig` | Tool to generate a set of multisig wallets. <br />See chapter on [multisignatures](/multisignature). | `monero-gen-trusted-multisig` | Tool to generate a set of multisig wallets. <br />See chapter on [multisignatures](/multisignature).
| `monero-blockchain-blackball` | Advanced tool to mitigate privacy issues related to Monero forks. <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-blackball` | Advanced tool to mitigate privacy issues related to Monero forks. <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-usage` | Advanced tool to mitigate privacy issues related to Monero forks. <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 privacy issues related to Monero forks. <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-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