diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..27fb307 --- /dev/null +++ b/.editorconfig @@ -0,0 +1,13 @@ +root = true + +[*] +charset = utf-8 +end_of_line = lf +insert_final_newline = true +indent_style = space +indent_size = 2 +trim_trailing_whitespace = true +max_line_length = 120 + +[*.py] +indent_size = 4 diff --git a/docs/interacting/monero-blockchain-export-reference.md b/docs/interacting/monero-blockchain-export-reference.md new file mode 100644 index 0000000..f06b682 --- /dev/null +++ b/docs/interacting/monero-blockchain-export-reference.md @@ -0,0 +1,74 @@ +--- +title: monero-blockchain-export - Reference | Monero Documentation +--- +# `monero-blockchain-export` - Reference + +!!! warning + Nowadays, there is little usage for raw blockchain export / import. In the past the p2p blockchain download was much slower. Back than blockchain.raw file was used to speed up the process at the expense of trusting the source. + +## Overview + +The tool dumps local blockchain to raw format, known as the `blockchain.raw` file. + +This could be useful if you want to process blockchain efficiently with your custom tools, +as the raw format is probably easier to work with than Monero's custom lmdb database. + +The tool works on your local copy of the blockchain. It does **not** require `monerod` running. + +## Syntax + +`./monero-blockchain-export [options]` + +Example: + +`./monero-blockchain-export --help` + +## Running + +Go to directory where you unpacked Monero. + +`./monero-blockchain-export --stagenet --output-file=/tmp/blockchain.raw` + + +## Options + +### Help + +| Option | Description +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------- +| `--help` | Enlist available options. + +### Pick network + +| Option | Description +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------- +| (missing) | By default monero-blockchain-export assumes [mainnet](/infrastructure/networks#mainnet). +| `--stagenet` | Export [stagenet](/infrastructure/networks#stagenet) blockchain. +| `--testnet` | Export [testnet](/infrastructure/networks#testnet) blockchain. + +### Logging + +Specifying the log file path is not supported. + +| Option | Description +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------- +| `--log-level` | `0-4` with `0` being minimal logging and `4` being full tracing. Defaults to `0`. These are general presets and do not directly map to severity levels. For example, even with minimal `0`, you may see some most important `INFO` entries. Example:
`./monero-blockchain-export --log-level=1` + +### Input + +| Option | Description +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------- +| `--data-dir` | Full path to data directory. This is where the blockchain, log files, and p2p network memory are stored. For defaults and details see [data directory](/interacting/overview/#data-directory). +| `--database` | The only valid value seems to be `lmdb` (the default). + +### Output + +| Option | Description +|---------------------|-------------------------------------------------------------------------------------------------------------------------------------- +| `--output-file` | Specify output file path. The default is `$DATA_DIR/export/blockchain.raw`. Example:
`./monero-blockchain-export --output-file=/tmp/blockchain.raw` +| `--blocksdat` | Output in blocks.dat format. +| `--block-stop` | Block number to stop the export at. Value `0` means full export (the default). + +## Reference + +* [https://github.com/monero-project/monero/tree/master/src/blockchain_utilities](https://github.com/monero-project/monero/tree/master/src/blockchain_utilities) diff --git a/docs/interacting/monerod-reference.md b/docs/interacting/monerod-reference.md index 2084f5c..4c5d158 100644 --- a/docs/interacting/monerod-reference.md +++ b/docs/interacting/monerod-reference.md @@ -62,9 +62,9 @@ The following groups are only to make reference easier to follow. The daemon its | Option | Description |---------------------|-------------------------------------------------------------------------------------------------------------------------------------- -| `--help` | Enlists available options. -| `--version` | Shows `monerod` version to stdout. Example:
`Monero 'Lithium Luna' (v0.12.3.0-release)` -| `--os-version` | Shows build timestamp and target operating system. Example output:
`OS: Linux #1 SMP PREEMPT Fri Aug 24 12:48:58 UTC 2018 4.18.5-arch1-1-ARCH`. +| `--help` | Enlist available options. +| `--version` | Show `monerod` version to stdout. Example:
`Monero 'Lithium Luna' (v0.12.3.0-release)` +| `--os-version` | Show build timestamp and target operating system. Example output:
`OS: Linux #1 SMP PREEMPT Fri Aug 24 12:48:58 UTC 2018 4.18.5-arch1-1-ARCH`. #### Pick network diff --git a/mkdocs.yml b/mkdocs.yml index a80aa5b..7de891c 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -13,6 +13,7 @@ nav: - Config: 'interacting/monero-config-file.md' - monerod: 'interacting/monerod-reference.md' - monero-wallet-gui: 'interacting/monero-wallet-gui-reference.md' + - monero-blockchain-export: 'interacting/monero-blockchain-export-reference.md' - Technical specs: 'technical-specs.md' - Cryptography: - Introduction: 'cryptography/introduction.md'