mimblewimble / docs

Documentation for Grin and Mimblewimble

Grin Documentation

Requirements

Clone repo and navigate to directory:

git clone --recursive https://github.com/mimblewimble/docs.git

Local

Install the following software:

• MkDocs
• MkDocs Material theme

Then start the local Mkdocs server:

mkdocs serve

Container

Start the local MkDocs server:

docker build -t docs -f Containerfile .
docker run -p 8000:8000 -v ./:/app/:ro docs:latest

Test

Visit http://localhost:8000 to see live changes.

When ready, push changes to your forked repo and then submit a PR.

docs's Issues

why kernel MMR can not be pruned?

can someone please explain why kernel MMR can't be pruned as the other two MMR?

Error returned, discarding txhashset extension: Other Error: output vs rproof MMRs different sizes

I can't get the node to start

rustc --version
rustc 1.32.0 (9fda7c223 2019-01-16)

uname -r
4.15.0-39-generic

lsb_release -a
No LSB modules are available.
Distributor ID: Ubuntu
Description: Ubuntu 18.04.1 LTS
Release: 18.04
Codename: bionic

cat ~/grin/grin-server.log

20190119 21:23:22.983 INFO grin_util::logger - log4rs is initialized, file level: Debug, stdout level: Warn, min. level: Debug
20190119 21:23:22.983 INFO grin - Using configuration file at /home/wpatino/grin/grin-server.toml
20190119 21:23:22.983 INFO grin - This is Grin version 1.0.0 (git v1.0.0), built for x86_64-unknown-linux-gnu by rustc 1.31.1 (b6c32da9b 2018-12-18).
20190119 21:23:22.983 DEBUG grin - Built with profile "release", features "".
20190119 21:23:22.983 WARN grin::cmd::server - Starting GRIN in UI mode...
20190119 21:23:22.984 INFO grin_servers::grin::server - Starting server, genesis block: 40adad0aec27
20190119 21:23:23.029 DEBUG grin_chain::txhashset::txhashset - Error returned, discarding txhashset extension: Other Error: output vs rproof MMRs different sizes
Cause: Unknown
Backtrace:
20190119 21:23:23.056 ERROR grin_util::logger -
thread 'main' panicked at 'called Result::unwrap() on an Err value: Chain(Error { inner:

Other Error: output vs rproof MMRs different sizes })': libcore/result.rs:1009stack backtrace:
0: 0x55d03677879d - backtrace::backtrace::trace::hd74837959dc31a2c
1: 0x55d0367779b2 - <backtrace::capture::Backtrace as core::default::Default>::default::hfbe03539066da14f
2: 0x55d036777a29 - backtrace::capture::Backtrace::new::hd9d47426559d8b68
3: 0x55d036701630 - grin_util::logger::send_panic_to_log::{{closure}}::h6b81febaf2dee014
4: 0x55d036849226 - std::panicking::rust_panic_with_hook::hde420d6fd4455550
at libstd/panicking.rs:480
5: 0x55d036848d71 - std::panicking::continue_panic_fmt::h8f394f3c578bcc76
at libstd/panicking.rs:390
6: 0x55d036848c55 - rust_begin_unwind
at libstd/panicking.rs:325
7: 0x55d036892ccc - core::panicking::panic_fmt::hca5dc4e8b320bc56
at libcore/panicking.rs:77
8: 0x55d035fd2419 - core::result::unwrap_failed::h830a8bfc4a83e400
9: 0x55d035f6e3b0 - grin::cmd::server::start_server::h865872809e516a65
10: 0x55d035f6f068 - grin::cmd::server::server_command::hc789d325932205ed
11: 0x55d035ffe9fc - grin::real_main::h7464ec6aee075aa9
12: 0x55d035ffcee5 - grin::main::h76cf7ec850a9936e
13: 0x55d035fcb1d2 - std::rt::lang_start::{{closure}}::hd67b3eb73f2382c8
14: 0x55d036848bf2 - std::rt::lang_start_internal::{{closure}}::hafa8ecdacd368ebb
at libstd/rt.rs:59
- std::panicking::try::do_call::h8c0dbb48abbdf4df
at libstd/panicking.rs:310
15: 0x55d03685b2c9 - __rust_maybe_catch_panic
at libpanic_unwind/lib.rs:102
16: 0x55d03682a44a - std::panicking::try::hbc21637ba5f64d73
at libstd/panicking.rs:289
- std::panic::catch_unwind::h954917b922b8d970
at libstd/panic.rs:392
- std::rt::lang_start_internal::h5b2de3cc38c3b406
at libstd/rt.rs:58
17: 0x55d035fff364 - main
18: 0x7f96e773db96 - __libc_start_main
19: 0x55d035f41980 -
20: 0x0 -

Change scalability paragraph in "Grin for Bitcoiners" doc

Current:

Pushing that further, between blocks, most outputs end up being spent sooner or later by another input. So all spent outputs can be safely removed. And the whole blockchain can be stored, downloaded and fully verified in just a few gigabytes or less (assuming a number of transactions similar to bitcoin).

This means that the Grin blockchain scales with the number of users (unspent outputs), not the number of transactions. At the moment, there is one caveat to that: a small piece of data (called a kernel, about 100 bytes) needs to stay around for each transaction. But we're working on optimizing that as well.

Suggested by tromp:

Pushing that further, between blocks, most outputs end up being spent sooner or later as a transaction input. So all spent outputs can be safely removed.
That leaves only the kernel of a transaction as having a lasting impact (at around 100 bytes) on the size of the blockchain.
Asymptotically, a Mimblewimble blockchain grows at roughly one quarter the rate of a bitcoin blockchain, while offering much better privacy.

Add note regarding Debain 9 build

Quote from renzo:

allowed myself update some docs and mention the wallet needs GLIBC_2.27 or higher, there were complaints from people not being able to run the wallet on Debian 9, I am also affected, so I added this: https://github.com/mimblewimble/docs/wiki/Wallet-User-Guide#system-requirements

Task: For the wallet to be compatible with Debian 9 it has to be built on Ubuntu 16.04. If that doesn't happen soon, then add an admonition in the wallet quick setup guide.

Node Wont start

Hi.

Ive followed the very simple guide to install the full node software.

But when I run grin nothing happens, any suggestions?

Its being installed becuase i created a wallet but later on it cant connect because nothing is running.

//Thanks B

Coalesce "Contributing" docs

https://github.com/mimblewimble/docs/wiki/Hacking-and-contributing
https://github.com/mimblewimble/grin/blob/master/CONTRIBUTING.md

Merging these docs into a single one would be beneficial to keep the instructions up to date and in a single place for better maintainance. The R&D "Hacking and contributing" section in the wiki can point directly to CONTRIBUTING.md in mimblewimble/grin as it's probably desirable to keep the latter.

Grin Wallet wont confirm

I have made a transaction into my wallet, but the balance never confirms. when I run the txs command, it shows 0 confirmations even after hours.

Can't install grin node

I try to install grin node, using
grin -v1.0.1-487947758-linux-amd64.tgz
I get a message:
tar: Options '-[0-7][lmh]' not supported by this tar
What should I install?
My GPU is Nvidia GTX 1070.

Cant start mining

Recovery word phrase is invalid

I figured out that I've opened issue in /docs... omg, I will open new issue on /grin

---

I presume, word phrase in recovery process should be entered as originaly presented, every word separated by space? I did copy paste of words, I've run a new node, synced and now I get this message "Recovery word phrase is invalid" when I run command "./grin wallet recover"
Any suggestions?
Should have saved damn files...

this is the error i get when trying to recover wallet
20190124 21:55:07.256 ERROR grin_wallet::command - Error recovering seed - IO error
Wallet command failed: IO error

Compile error linux mint

error: Could not compile zeroize.
warning: build failed, waiting for other jobs to finish...
error: build failed

Release Linux Mint 18.3 Sylvia 64-bit
Kernel Linux 4.15.0-43-generic x86_64
MATE 1.18.0

small README changes

For better usability change

git clone https://github.com/mimblewimble/docs.git cd docs

into

git clone https://github.com/mimblewimble/docs.git && cd docs

then its a one-liner for your shell.

Question: Why does Grin uses files to send transactions?

Is there a reason why the current way to transact doesn't have a concept of address? I might be missing something here, but looks quite cumbersome to get people to use it unless they're programmers.

In other words: Is this 1985?

Build failing on Mac

I am getting build errors on Mac.

--- stderr
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/emmintrin.h:3427:10: error: returning 'int' from a function with incompatible result type '__m128' (vector of 4 'float' values)
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avxintrin.h:2228:10: error: invalid conversion between vector type '__m256' (vector of 8 'float' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avxintrin.h:3115:10: error: invalid conversion between vector type '__m256d' (vector of 4 'double' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avxintrin.h:3133:10: error: invalid conversion between vector type '__m256' (vector of 8 'float' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:971:10: error: invalid conversion between vector type '__m512d' (vector of 8 'double' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:982:10: error: invalid conversion between vector type '__m512d' (vector of 8 'double' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:992:10: error: invalid conversion between vector type '__m512d' (vector of 8 'double' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1021:10: error: invalid conversion between vector type '__m512' (vector of 16 'float' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1032:10: error: invalid conversion between vector type '__m512' (vector of 16 'float' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1042:10: error: invalid conversion between vector type '__m512' (vector of 16 'float' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1126:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1136:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1144:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1154:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1164:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1172:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1182:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1192:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1200:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size
fatal error: too many errors emitted, stopping now [-ferror-limit=]
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/emmintrin.h:3427:10: error: returning 'int' from a function with incompatible result type '__m128' (vector of 4 'float' values), err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avxintrin.h:2228:10: error: invalid conversion between vector type '__m256' (vector of 8 'float' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avxintrin.h:3115:10: error: invalid conversion between vector type '__m256d' (vector of 4 'double' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avxintrin.h:3133:10: error: invalid conversion between vector type '__m256' (vector of 8 'float' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:971:10: error: invalid conversion between vector type '__m512d' (vector of 8 'double' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:982:10: error: invalid conversion between vector type '__m512d' (vector of 8 'double' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:992:10: error: invalid conversion between vector type '__m512d' (vector of 8 'double' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1021:10: error: invalid conversion between vector type '__m512' (vector of 16 'float' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1032:10: error: invalid conversion between vector type '__m512' (vector of 16 'float' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1042:10: error: invalid conversion between vector type '__m512' (vector of 16 'float' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1126:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1136:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1144:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1154:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1164:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1172:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1182:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1192:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
/Library/Developer/CommandLineTools/usr/lib/clang/10.0.0/include/avx512fintrin.h:1200:10: error: invalid conversion between vector type '__m512i' (vector of 8 'long long' values) and integer type 'int' of different size, err: true
fatal error: too many errors emitted, stopping now [-ferror-limit=], err: true
thread 'main' panicked at 'Unable to generate bindings: ()', src/libcore/result.rs:1009:5
note: Run with RUST_BACKTRACE=1 for a backtrace.

warning: build failed, waiting for other jobs to finish...
error: build failed

Is there any way around this? I'm new to this, so apologies for the lack of troubleshooting.

[WIP] Suggestions to improve the DOCS

Changes

• In Quickstart/Install/Linux "Replace $VESION with..." - Should be $VERSION
• [Windows only] in Quickstart/Install/Windows change set PATH=%PATH%;C:\Users\%USER%\AppData\Local to set PATH=%PATH%;C:\Users\%USER%\AppData\Local\Grin OR set PATH=%PATH%;$PATH_TO_FOLDER_CONTAINING_GRIN_BINARIES

Additions

• Explain how to install ToR prior to showing the command grin-wallet listen
• [Linux only] in Quickstart/Install/Linux show how to download the tar.gz files using just the CLI
  eg:

wget https://github.com/mimblewimble/grin/releases/latest/download/grin-$VERSION-linux-amd64.tar.gz
wget https://github.com/mimblewimble/grin-wallet/releases/latest/download/grin-wallet-$VERSION-linux-amd64.tar.gz

• [Windows only] in Quickstart/Install/Windows tell users to install Microsoft Visual C++ 2015 from https://www.microsoft.com/en-us/download/details.aspx?id=52685 (Grin won't work without it)

How does a client connect to grin wallet?

How does a client connect to grin wallet?

"How to: Run a Grin node on Google Cloud for free" docs are outdated

Some of the things that need updating:

• remove references to grin.toml, instead add instructions to create a grin-wallet.toml, explain how access & modify it via the ~/.grin dir
• update for mainnet (port number, etc)
• mention when the user should do something different if they want to connect to floonet

If this sounds OK let me know and I'll open a PR

the meaning of prev_root

I don't understand its meaning.

Why for the genesis block(mainnet), it has prev_root 0000000000000000002a8bc32f43277fe9c063b9c99ea252b483941dcd06e217
and for floo net, it is 00000000000000000017ff4903ef366c8f62e3151ba74e41b8332a126542f538?

Thanks.

CSS Issue on hyperlinkgs

See these screen caps:

On hover:

cannot create directory file exists

When typing mkdir ~/grin it doesn't let you make the directory since the previous command creates a file named grin and Ubuntu will not let you have a file and a folder with the same name in the same directory.