monero-project/monero-docs
monero-project/monero-docs
2
1
Fork 0
mirror of https://github.com/monero-project/monero-docs.git synced 2024-12-22 19:49:22 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Add "Interacting"

Browse source
This commit is contained in:
Piotr Włodarek 2018-01-02 16:22:23 +01:00
parent 69a2ec1f07
commit 4f51d4f3f5
5 changed files with 55 additions and 25 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
docs/directory/overview.md
View file

@ -1,19 +0,0 @@
# Monero directory overview
This considers the released version of Monero software. Once unpacked, directory structure looks like:
![Monero Directory](/images/monero-dir.png "Logo Title Text 1")
## Separation of node and wallet
Monero project nicely decouples node logic `monerod` from wallet logic `monero-wallet-*`.
Wallet logic is offered through three independent user interfaces - the GUI, the CLI, and the HTTP API.
| Executable | Description
| -------------------------- |:-----------------------------------------------------------------------------------------------------------------------------------
| `monerod` | The full node daemon. Does not require a wallet.
| `monero-wallet-gui` | Wallet logic and graphical user interface. Requires `monerod` running.
| `monero-wallet-cli` | Wallet logic and commandline user interface. Requires `monerod` running.
| `monero-wallet-rpc` | Wallet logic and HTTP API (JSON-RPC protocol). Requires `monerod` running.
| `monero-blockchain-export` | Tool to export synchronized blockchain to `blockchain.raw` file.
| `monero-blockchain-import` | Tool to import [blockchain.raw](https://downloads.getmonero.org/blockchain.raw) - ideally your own trusted copy.

3
docs/directory/monerod.md → docs/interacting/monerod.md
View file

@ -2,4 +2,7 @@
https://www.reddit.com/r/Monero/comments/3jhyqc/0mq_help_share_this_exciting_news/
https://monero.stackexchange.com/questions/1482/how-much-information-is-passed-from-the-daemon-to-simplewallet-when-scanning-for?rq=1
https://monero.stackexchange.com/questions/1134/is-it-safe-to-share-a-daemon-with-a-roommate?noredirect=1&lq=1
The Monero daemon is the piece of software that keeps you synced up with the Monero network. That's all it does, it doesn't know about "you" or "your funds" or "your transactions". If you want to do anything on the Monero network, and thus on the Monero blockchain, you have to talk to this daemon that will then talk to the network as a whole by rebroadcasting transactions you initiate. Similarly, if you want to get history from the blockchain, or the current memory pool of transactions, or outputs to mix with, you can ask the daemon for that information.

42
docs/interacting/overview.md Normal file
View file

@ -0,0 +1,42 @@
# Interacting with Monero
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.
## Installation directory overview
This considers the released version of Monero software. Once unpacked, you will notice six executable files:
![Monero Directory](/images/monero-dir.png "Logo Title Text 1")
## Separation of node and wallet
Monero project nicely decouples node logic `monerod` from wallet logic `monero-wallet-*`.
Wallet logic is offered through three independent user interfaces - the GUI, the CLI, and the HTTP API.
| Executable | Description
| -------------------------- |:-----------------------------------------------------------------------------------------------------------------------------------
| `monerod` | The full node daemon. Does not require a wallet.
| `monero-wallet-gui` | Wallet logic and __graphical__ user interface. Requires `monerod` running.
| `monero-wallet-cli` | Wallet logic and __commandline__ user interface. Requires `monerod` running.
| `monero-wallet-rpc` | Wallet logic and __HTTP API__ (JSON-RPC protocol). Requires `monerod` running.
| `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.
## Interacting
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.
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.
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
| -------------------------- | ------------------- | -------------------------- | ------------- | ---------------------------- | --------------- | --------------
| `monerod` | ✔ | ✔ | ✔ | | |
| `monero-wallet-cli` | | | | ✔ | |
| `monero-wallet-rpc` | | | | | ✔ |
| `monero-wallet-gui` | | | | | | ✔

4
docs/tx.md Normal file
View file

@ -0,0 +1,4 @@
# Monero transaction
https://monero.stackexchange.com/questions/2136/understanding-the-structure-of-a-monero-transaction?noredirect=1&lq=1
https://monero.stackexchange.com/questions/6736/how-does-input-reference-the-output-of-some-transaction?noredirect=1&lq=1

12
mkdocs.yml
View file

@ -6,15 +6,15 @@ site_url: 'https://monerodocs.org/'
pages:
- Home: 'index.md'
- Interacting: 'interacting/overview.md'
- Technical Specs: 'technical-specs.md'
- Primitives:
- 'Base58': 'primitives/base58.md'
- Base58: 'primitives/base58.md'
- Address:
- 'Standard': 'public-address/standard-address.md'
- 'Integrated': 'public-address/integrated-address.md'
- 'Subaddress': 'public-address/subaddress.md'
- 'Multisignature': 'multisignature.md'
- 'Directory': 'directory/overview.md'
- Standard: 'public-address/standard-address.md'
- Integrated: 'public-address/integrated-address.md'
- Subaddress: 'public-address/subaddress.md'
- Multisignature: 'multisignature.md'
theme:
name: 'material' # 'material'