mirror of
https://github.com/mimblewimble/grin.git
synced 2025-01-21 11:31:08 +03:00
5cb8025ddd
* cleanup legacy "3 dot" check (#2625)
* Allow to peers behind NAT to get up to preferred_max connections (#2543)
Allow to peers behind NAT to get up to preffered_max connections
If peer has only outbound connections it's mot likely behind NAT and we should not stop it from getting more outbound connections
* Reduce usage of unwrap in p2p crate (#2627)
Also change store crate a bit
* Simplify (and fix) output_pos cleanup during chain compaction (#2609)
* expose leaf pos iterator
use it for various things in txhashset when iterating over outputs
* fix
* cleanup
* rebuild output_pos index (and clear it out first) when compacting the chain
* fixup tests
* refactor to match on (output, proof) tuple
* add comments to compact() to explain what is going on.
* get rid of some boxing around the leaf_set iterator
* cleanup
* [docs] Add switch commitment documentation (#2526)
* remove references to no-longer existing switch commitment hash
(as switch commitments were removed in ca8447f3bd
and moved into the blinding factor of the Pedersen Commitment)
* some rewording (points vs curves) and fix of small formatting issues
* Add switch commitment documentation
* [docs] Documents in grin repo had translated in Korean. (#2604)
* Start to M/W intro translate in Korean
* translate in Korean
* add korean translation on intro
* table_of_content.md translate in Korean.
* table_of_content_KR.md finish translate in Korean, start to translate State_KR.md
* add state_KR.md & commit some translation in State_KR.md
* WIP stat_KR.md translation
* add build_KR.md && stratum_KR.md
* finish translate stratum_KR.md & table_of_content_KR.md
* rename intro.KR.md to intro_KR.md
* add intro_KR.md file path each language's intro.md
* add Korean translation file path to stratum.md & table_of_contents.md
* fix difference with grin/master
* Fix TxHashSet file filter for Windows. (#2641)
* Fix TxHashSet file filter for Windows.
* rustfmt
* Updating regexp
* Adding in test case
* Display the current download rate rather than the average when syncing the chain (#2633)
* When syncing the chain, calculate the displayed download speed using the current rate from the most recent iteration, rather than the average download speed from the entire syncing process.
* Replace the explicitly ignored variables in the pattern with an implicit ignore
* remove root = true from editorconfig (#2655)
* Add Medium post to intro (#2654)
Spoke to @yeastplume who agreed it makes sense to add the "Grin Transactions Explained, Step-by-Step" Medium post to intro.md
Open for suggestions on a better location.
* add a new configure item for log_max_files (#2601)
* add a new configure item for log_max_files
* rustfmt
* use a constant instead of multiple 32
* rustfmt
* Fix the build warning of deprecated trim_right_matches (#2662)
* [DOC] state.md, build.md and chain directory documents translate in Korean. (#2649)
* add md files for translation.
* start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md
* add dandelion_KR.md && simulation_KR.md for Korean translation.
* add md files for translation.
* start to translation fast-sync, code_structure. add file build_KR.md, states_KR.md
* add dandelion_KR.md && simulation_KR.md for Korean translation.
* remove some useless md files for translation. this is rearrange set up translation order.
* add dot end of sentence & translate build.md in korean
* remove fast-sync_KR.md
* finish build_KR.md translation
* finish build_KR.md translation
* finish translation state_KR.md & add phrase in state.md to move other language md file
* translate blocks_and_headers.md && chain_sync.md in Korean
* add . in chain_sync.md , translation finished in doc/chain dir.
* fix some miss typos
* Api documentation fixes (#2646)
* Fix the API documentation for Chain Validate (v1/chain/validate). It was documented as a POST, but it is actually a GET request, which can be seen in its handler ChainValidationHandler
* Update the API V1 route list response to include the headers and merkleproof routes. Also clarify that for the chain/outputs route you must specify either byids or byheight to select outputs.
* refactor(ci): reorganize CI related code (#2658)
Break-down the CI related code into smaller more maintainable pieces.
* Specify grin or nanogrins in API docs where applicable (#2642)
* Set Content-Type in API client (#2680)
* Reduce number of unwraps in chain crate (#2679)
* fix: the restart of state sync doesn't work sometimes (#2687)
* let check_txhashset_needed return true on abnormal case (#2684)
* Reduce number of unwwaps in api crate (#2681)
* Reduce number of unwwaps in api crate
* Format use section
* Small QoL improvements for wallet developers (#2651)
* Small changes for wallet devs
* Move create_nonce into Keychain trait
* Replace match by map_err
* Add flag to Slate to skip fee check
* Fix secp dependency
* Remove check_fee flag in Slate
* Add Japanese edition of build.md (#2697)
* catch the panic to avoid peer thread quit early (#2686)
* catch the panic to avoid peer thread quit before taking the chance to ban
* move catch wrapper logic down into the util crate
* log the panic info
* keep txhashset.rs untouched
* remove a warning
* [DOC] dandelion.md, simulation.md ,fast-sync.md and pruning.md documents translate in Korean. (#2678)
* Show response code in API client error message (#2683)
It's hard to investigate what happens when an API client error is
printed out
* Add some better logging for get_outputs_by_id failure states (#2705)
* Switch commitment doc fixes (#2645)
Fix some typos and remove the use of parentheses in a
couple of places to make the reading flow a bit better.
* docs: update/add new README.md badges (#2708)
Replace existing badges with SVG counterparts and add a bunch of new ones.
* Update intro.md (#2702)
Add mention of censoring attack prevented by range proofs
* use sandbox folder for txhashset validation on state sync (#2685)
* use sandbox folder for txhashset validation on state sync
* rustfmt
* use temp directory as the sandbox instead actual db_root txhashset dir
* rustfmt
* move txhashset overwrite to the end of full validation
* fix travis-ci test
* rustfmt
* fix: hashset have 2 folders including txhashset and header
* rustfmt
*
(1)switch to rebuild_header_mmr instead of copy the sandbox header mmr
(2)lock txhashset when overwriting and opening and rebuild
* minor improve on sandbox_dir
* add Japanese edition of state.md (#2703)
* Attempt to fix broken TUI locale (#2713)
Can confirm that on the same machine 1.0.2 TUI looks great and is broken on
the current master. Bump of `cursive` version fixed it for me.
Fixes #2676
* clean the header folder in sandbox (#2716)
* forgot to clean the header folder in sandbox in #2685
* Reduce number of unwraps in servers crate (#2707)
It doesn't include stratum server which is sufficiently changed in 1.1
branch and adapters, which is big enough for a separate PR.
* rustfmt
* change version to beta
140 lines
4.5 KiB
Markdown
140 lines
4.5 KiB
Markdown
# Grin - Build, Configuration, and Running
|
||
|
||
*Read this in other languages: [Español](build_ES.md), [Korean](build_KR.md), [日本語](build_JP.md).*
|
||
|
||
## Supported Platforms
|
||
|
||
Longer term, most platforms will likely be supported to some extent.
|
||
Grin's programming language `rust` has build targets for most platforms.
|
||
|
||
What's working so far?
|
||
|
||
* Linux x86\_64 and macOS [grin + mining + development]
|
||
* Not Windows 10 yet [grin kind-of builds. No mining yet. Help wanted!]
|
||
|
||
## Requirements
|
||
|
||
* rust 1.31+ (use [rustup]((https://www.rustup.rs/))- i.e. `curl https://sh.rustup.rs -sSf | sh; source $HOME/.cargo/env`)
|
||
* if rust is already installed, you can simply update version with `rustup update`
|
||
* clang
|
||
* ncurses and libs (ncurses, ncursesw5)
|
||
* zlib libs (zlib1g-dev or zlib-devel)
|
||
* pkg-config
|
||
* libssl-dev
|
||
* linux-headers (reported needed on Alpine linux)
|
||
* llvm
|
||
|
||
For Debian-based distributions (Debian, Ubuntu, Mint, etc), all in one line (except Rust):
|
||
|
||
```sh
|
||
apt install build-essential cmake git libgit2-dev clang libncurses5-dev libncursesw5-dev zlib1g-dev pkg-config libssl-dev llvm
|
||
```
|
||
|
||
For Mac:
|
||
|
||
```sh
|
||
xcode-select --install
|
||
brew install --with-toolchain llvm
|
||
brew install pkg-config
|
||
brew install openssl
|
||
```
|
||
|
||
## Build steps
|
||
|
||
```sh
|
||
git clone https://github.com/mimblewimble/grin.git
|
||
cd grin
|
||
cargo build --release
|
||
```
|
||
|
||
Grin can also be built in debug mode (without the `--release` flag, but using the `--debug` or the `--verbose` flag) but this will render fast sync prohibitively slow due to the large overhead of cryptographic operations.
|
||
|
||
## Build errors
|
||
|
||
See [Troubleshooting](https://github.com/mimblewimble/docs/wiki/Troubleshooting)
|
||
|
||
## What was built?
|
||
|
||
A successful build gets you:
|
||
|
||
* `target/release/grin` - the main grin binary
|
||
|
||
All data, configuration and log files created and used by grin are located in the hidden
|
||
`~/.grin` directory (under your user home directory) by default. You can modify all configuration
|
||
values by editing the file `~/.grin/main/grin-server.toml`.
|
||
|
||
It is also possible to have grin create its data files in the current directory. To do this, run
|
||
|
||
```sh
|
||
grin server config
|
||
```
|
||
|
||
Which will generate a `grin-server.toml` file in the current directory, pre-configured to use
|
||
the current directory for all of its data. Running grin from a directory that contains a
|
||
`grin-server.toml` file will use the values in that file instead of the default
|
||
`~/.grin/main/grin-server.toml`.
|
||
|
||
While testing, put the grin binary on your path like this:
|
||
|
||
```sh
|
||
export PATH=`pwd`/target/release:$PATH
|
||
```
|
||
|
||
assuming you are running from the root directory of your Grin installation.
|
||
|
||
You can then run `grin` directly (try `grin help` for more options).
|
||
|
||
## Configuration
|
||
|
||
Grin attempts to run with sensible defaults, and can be further configured via
|
||
the `grin-server.toml` file. This file is generated by grin on its first run, and
|
||
contains documentation on each available option.
|
||
|
||
While it's recommended that you perform all grin server configuration via
|
||
`grin-server.toml`, it's also possible to supply command line switches to grin that
|
||
override any settings in the file.
|
||
|
||
For help on grin commands and their switches, try:
|
||
|
||
```sh
|
||
grin help
|
||
grin wallet help
|
||
grin client help
|
||
```
|
||
|
||
## Docker
|
||
|
||
```sh
|
||
docker build -t grin -f etc/Dockerfile .
|
||
```
|
||
For floonet, use `etc/Dockerfile.floonet` instead
|
||
|
||
You can bind-mount your grin cache to run inside the container.
|
||
|
||
```sh
|
||
docker run -it -d -v $HOME/.grin:/root/.grin grin
|
||
```
|
||
If you prefer to use a docker named volume, you can pass `-v dotgrin:/root/.grin` instead.
|
||
Using a named volume copies default configurations upon volume creation.
|
||
|
||
## Cross-platform builds
|
||
|
||
Rust (cargo) can build grin for many platforms, so in theory running `grin`
|
||
as a validating node on your low powered device might be possible.
|
||
To cross-compile `grin` on a x86 Linux platform and produce ARM binaries,
|
||
say, for a Raspberry Pi.
|
||
|
||
## Using grin
|
||
|
||
The wiki page [Wallet User Guide](https://github.com/mimblewimble/docs/wiki/Wallet-User-Guide)
|
||
and linked pages have more information on what features we have,
|
||
troubleshooting, etc.
|
||
|
||
## Mining in Grin
|
||
|
||
Please note that all mining functions for Grin have moved into a separate, standalone package called
|
||
[grin-miner](https://github.com/mimblewimble/grin-miner). Once your Grin code node is up and running,
|
||
you can start mining by building and running grin-miner against your running Grin node.
|
||
|
||
For grin-miner to be able to communicate with your grin node, make sure that you have `enable_stratum_server = true`
|
||
in your `grin-server.toml` configuration file and you have a wallet listener running (`grin wallet listen`).
|