Commit graph

203 commits

Author SHA1 Message Date
Ignotus Peverell
86aea875de
Full clang, not only libclang, is required
Fixes #1449
2018-09-04 16:03:49 -07:00
Blade Doyle
a1141cab39 Record ideal miner behavior based on job_id value (#1461)
We have a very low default value for "attempt_time_per_block", which exposed an issue with the miner.  This change documents the correct / ideal behavior.
2018-09-03 19:15:18 +01:00
Quentin Le Sceller
544a296f77
Fix typos and unused imports (#1466)
* Fix typos and unused imports
2018-09-03 13:09:28 +02:00
Ignotus Peverell
9f7625e8aa
Single line package install for Debian-based distros 2018-09-01 23:17:25 +01:00
Yeastplume
11d24fe0c1
update docs to reflect new file layout (#1444) 2018-08-30 11:47:04 +01:00
JackRack
436e68d6e0 Updated docs (#1418)
Updated docs to reflect new dependencies
2018-08-29 14:09:53 -04:00
Antioch Peverell
e5d43fee44
tweak excess example in docs (#1443)
* tweak excess example in docs

* remove reference to ECDSA signature.
remove references to passing sums of blinding factors around

* cleanup reference to _what_ is signed

* tweak who knows the private key
2018-08-29 12:54:33 +01:00
Ignotus Peverell
953d910776
Quick build guide update 2018-08-24 20:10:22 +01:00
Michalis Kargakis
dda88f193b Fix typo + git ignore wallet data (#1350)
* Ignore wallet data

* Fix typo
2018-08-13 23:28:01 +01:00
jaspervdm
498ea9718e Improved basic transaction diagram (#1313)
* Fixed basic transaction diagram
* Offset is not part of kernel (it is stored in the tx)
* Explicitly write down calculation of xS
2018-08-06 11:34:11 -07:00
obxium
77ce26257f Update wallet link (#1310) 2018-08-01 13:57:25 -04:00
yeastplume
7f4ea04757 wallet documentation updates 2018-08-01 11:05:10 +01:00
Yeastplume
658a686cc1
[WIP] Wallet documentation (#1302)
* doc update

* change and reorganise wallet documentation

* Redo wallet arch document, update design document with current info, move older design document into 'goals.md'

* Redo wallet arch document, update design document with current info, move older design document into 'goals.md'
2018-07-30 17:10:43 +01:00
Quentin Le Sceller
d67556a6dd Add Stratum documentation (#1283) 2018-07-22 12:12:07 -07:00
beaver-tooth
46c666ae75 Update local network setup doc (#1276)
* Update local network setup doc
* Updated local net doc with a few clarifications
2018-07-20 23:05:54 -07:00
yuntai
a1bd593800 [Simple] Fix a broken link in doc/table_of_contents (#1279)
* [Simple] Fix a broken link in doc/table_of_contents
2018-07-20 12:09:47 -04:00
Conor Scott
bff0c6b6c6 Update necessary rust version in build doc (#1258)
* Update necessary rust version in build doc
* Add 'rustup update' as option in build docs
2018-07-16 02:01:21 +01:00
emmick4
92bfb7e819 Update build.md (#1252)
Don't specify building from testnet3 since it doesn't include necessary commits
2018-07-12 20:52:43 +01:00
obxium
64db4d92f0 Update build documentation (#1236)
- Correct order of operations in build steps
2018-07-09 22:07:09 -07:00
mimblewimble-robot
6f296005d0 [milestone/testnet3] Update Dandelion Doc and Simulation (#1226)
* Update doc and simulation
2018-07-07 22:30:09 -04:00
mimblewimble-robot
cb0ce311dc document kernel offsets (finally) (#1197) 2018-06-25 16:14:48 -04:00
mimblewimble-robot
b7b90f4c24 document proposals for - * conditional timelocked outputs, and * conditional relative timelocked outputs (#1192) 2018-06-25 07:34:49 -04:00
yeastplume
f058b14aea Merge: Compiling at least 2018-06-22 09:33:42 +01:00
Jeffrey Esquivel S
77eaf76706 Fix typo (#1181) 2018-06-20 09:31:55 -04:00
Ignotus Peverell
9b69b5376d
More @tromp feedback 2018-06-17 00:48:54 +01:00
Ignotus Peverell
df2d109281
Typo fix 2018-06-16 21:06:09 +01:00
Ignotus Peverell
c2a4211660
Re-added bitcoin in the atomic swap section
Also added some minor clarifications on the setup and verification of `x*G` on other chain, as well as a more detailed section on how this would work on bitcoin.
2018-06-16 18:15:02 +01:00
Ignotus Peverell
934668d3f3
Fixes to the atomic swap section
Can only swap with Ethereum right now, not Bitcoin. Pubkey derivation is a hash function.
2018-06-16 16:46:28 +01:00
Ignotus Peverell
7993e511ea
Minor: markdown formatting 2018-06-14 22:18:29 +01:00
Quentin Le Sceller
c4f438fdb2
Typo and formatting (#1170) 2018-06-14 17:15:52 -04:00
Ignotus Peverell
922b04608f
Clarification on range element count and parent insertion 2018-06-13 21:14:28 +01:00
Quentin Le Sceller
8f4dbfa540 Many typo fixes (#1158)
* Typo fix
* Parameterise
2018-06-13 17:03:34 +01:00
yuntai
d07c5a128a [Trivial] Typo fixed (#1150) 2018-06-08 11:15:12 -04:00
Quentin Le Sceller
a6590ea0ae
Add doc and persistent storage for docker (#1140)
* Add docker doc
2018-06-07 14:04:51 -04:00
Ignotus Peverell
1bd7ece6e8
Doc drop, all unfinished drafts 2018-06-05 06:46:07 +01:00
Quentin Le Sceller
b6c31ebc78 Remove unused error type switch commitment (#1104)
* Remove unused switch commitment error

* Rustfmt

* Updated doc
2018-05-30 14:45:27 -04:00
Gary Yu
81a1f12f36 doc: 'intro.md' support both English and Chinese version. (#1090) 2018-05-29 03:40:47 +01:00
cake808
7c1af97f82 typo fixed: anonimity -> anonymity (#1095) 2018-05-28 15:17:30 -04:00
Ignotus Peverell
bd5b916550
Clarified the scaling bullet point 2018-05-28 19:00:03 +01:00
Ignotus Peverell
18be73630d
Various small clarifications 2018-05-28 00:27:28 +01:00
Ignotus Peverell
24e21f013d
First pass at a colored paper TOC 2018-05-16 03:22:41 +01:00
Ignotus Peverell
54b06a6fcb
Minor code structure doc fixes 2018-05-13 20:02:25 +01:00
Ignotus Peverell
9909e8e2ff
Release builds 2018-05-12 20:24:23 +01:00
Quentin Le Sceller
dd861c8d8c Update Dandelion simulation doc (#1034) 2018-05-08 21:57:22 +01:00
duub qnnp
8e57c40851 update a successful build results (#1051)
remove the mining folder of the expected results list
2018-05-08 21:48:56 +01:00
Quentin Le Sceller
9ecad86d43
Fix typo in simulation.md (#1022) 2018-05-01 14:18:51 -04:00
Yeastplume
4c6a193e01
[WIP] Miner removal (#979)
* Beginning to remove in-process miner

* rustfmt

* rustfmt

* rustfmt

* rustfmt

* remove pow crate and put remnants into core

* rustfmt

* fix test compilation in core and chain

* rustfmt

* Updating server tests to use test miner

* rustfmt

* rustfmt

* remove pow from test matrix

* adding basic stratum stats to TUI

* run stratum server at all times, and halt messages while syncing

* fix core tests

* add ability to run internal test miner for cuckoo 16 testing

* modify build instructions
2018-04-24 09:18:24 +01:00
chri2
ffa5bfe16f Update build.md (#960) 2018-04-16 09:58:50 +01:00
Quentin Le Sceller
cbfd3803bf
Update simulation.md 2018-04-11 11:26:25 -04:00
Ignotus Peverell
0596b753a0
Added @tromp's idea of a server-facilitated interaction 2018-04-03 21:15:12 +01:00
Ignotus Peverell
c7cc91a8ea
First pass at wallet design doc 2018-04-03 20:14:01 +01:00
Ignotus Peverell
10addfcd79
Bump up minimum rustc version 2018-03-27 19:10:37 +01:00
Simon B
a951f01ac6 fix 5w -> w5, add zlib-devel (#872) 2018-03-26 13:48:50 +01:00
Yeastplume
6f264b2f7e
Testnet2 test fixes (#870)
* use dev genesis for automated tests

* never test block time on automated tests

* automated genesis block creation
2018-03-26 12:07:04 +01:00
Ignotus Peverell
327293d28e Genesis, version changes and doc for testnet2 (#865)
* Bump up crates versions

* Finally add a Cargo.lock to avoid dependency breakages

* Build doc update for testnet2

* Fix test framework not really using its mining config

* Testnet2 genesis, best so far at 128 difficulty (a nice number)

* Minor build doc update
2018-03-26 10:48:46 +01:00
metoro
ed78e1a721 Copy tweaks (#834)
* Fix typo

* Pedantic text tweaks
2018-03-21 08:30:39 -04:00
Roman Zeyde
e312054714 Fix small formatting issue at dandelion.md (#811) 2018-03-19 16:55:48 +00:00
Simon B
7c3994e521 Cleanup docs before testnet2 (#798)
* move FAQ.md to https://github.com/mimblewimble/docs/wiki/FAQ and unduplicate (Troubleshooting segment already present on its own wiki page)
* Update doc/style and move it into CONTRIBUTING.
* group up docs overview for more clarity
* link to previously unlinked content in the docs overview
* update + cleanup doc/build
* Update links to reflect troubleshooting is now only in the wiki
* More link fixes and spelling
* Remove doc/usage.md that I've faile to keep updated, and use a wiki page instead
* Last forgotten CONTRIBUTING.md fix
2018-03-17 18:08:40 +00:00
Antioch Peverell
2552b34118
remove difficulty field from block_header (derive from total_difficulty) (#777)
* remove difficulty field from block_header (derive from total_difficulty)

* address feedback on PR and general cleanup

* rustfmt

* rework pow/difficulty validation in pipe::validate_header
now that we only have total_difficulty available

* cleanup various todos

* rustfmt

* rework DifficultyIterator to track header and prev_header state

* rustfmt caught some garbage syntax

* cleanup
2018-03-15 15:16:34 -04:00
Ignotus Peverell
851d7c7b9b
Turns out libncurses5w is also required 2018-03-10 21:46:34 +00:00
Ignotus Peverell
86371e66ab
Added libncurses to the dependency list 2018-03-10 21:08:52 +00:00
Adam Jonas
a059bbde0d typo fix (#754) 2018-03-07 10:45:55 -05:00
Ignotus Peverell
1ab43df807
Update install instructions with rustfmt-preview 2018-03-06 00:53:08 +00:00
Yeastplume
1143d84238
Remove Sumtree References and disambiguate some naming (#747)
* start of renamathon

* api renaming

* Rename UTXO-Output to lessen ambiguity

* compile warning

* compile error

* readme fix

* remove file commit in error
2018-03-05 19:33:44 +00:00
Quentin Le Sceller
f2d709cb01 Fix wrong images in Dandelion docs (#742) 2018-03-02 17:59:41 +00:00
Quentin Le Sceller
6d7125b336 Add Dandelion docs (#740)
* Add scenario
* Update dandelion aggregation explanation
2018-03-02 03:18:47 +00:00
Ignotus Peverell
b3104fe2f6
Typo fix 2018-03-01 19:15:38 +00:00
Quentin Le Sceller
0d15e22f97 Update contracts.md (#737) 2018-02-28 12:46:25 -05:00
Ignotus Peverell
6f675e18e3
Clarified current limitation for atomic swap 2018-02-27 19:42:09 +00:00
Ignotus Peverell
47cc921486
Really, no blake2 here 2018-02-27 18:00:51 +00:00
Quentin Le Sceller
a0d2fb0eab Add initial Dandelion doc (#732) 2018-02-26 22:43:08 +00:00
Ignotus Peverell
34e47749de
secp256k1 uses sha 256, not blake2 2018-02-26 19:31:54 +00:00
Ignotus Peverell
4f95fcef47
Minor header formatting fix 2018-02-26 19:15:39 +00:00
Ignotus Peverell
787891bf9e
First pass at a more formal contracts doc 2018-02-24 20:24:41 +00:00
John Tromp
bc9a1cfeed tweak intro (#728) 2018-02-24 13:59:21 +00:00
Antioch Peverell
c2ca6ad03f
diagram how Merkle proof and pruning interact (proposed) (#722) 2018-02-21 12:20:02 -05:00
Brad Neuman
f081f75283 Fix small typo in intro.md (#717)
fee -> feel
2018-02-20 12:04:56 -05:00
yeastplume
7dcbb8824d clarify transaction weight on diagram 2018-02-12 13:22:59 +00:00
yeastplume
2639f13710 error fix 2018-02-12 13:02:05 +00:00
yeastplume
f22f9d83be adding transaction workflow diagram, for reference 2018-02-12 12:55:08 +00:00
Simon B
765996a630 rustfmt install instruction gotcha (#663)
* rustfmt install instruction gotcha

rustfmt stopped working for me. It turns out people started having trouble with this last year already https://github.com/rust-lang-nursery/rustfmt/issues/2304

* rustfmt on a single file now works! Secrets inside

After `rustup component add rustfmt-preview` I get rustfmt as a command in my terminal.

`rustfmt --help` reveals --write-mode [replace|overwrite|display|plain|diff|coverage|checkstyle] and we've been using the default which is either `overwrite` or `replace` (depending on rustfmt version) and this was changing a bunch of files and a messed up workflow.

* Newcomer-friendly explanation how to use `rustfmt`
2018-01-30 08:36:18 -05:00
AntiochP
7e7c8e157e
coinbase maturity and output lock height docs (#597)
* wip - coinbase maturity and output lock height docs

* tbd spend an output

* expand on how we prove ownership of an output to spend it

* add proposed solution

* fixup output hash description
2018-01-16 07:46:49 -05:00
Brian Anderson
31f91dc487 Minor edits to FAQ (#602)
* Fix markup in faq

* faq: 'level 2' -> 'layer 2'

* faq: 'waller' -> 'wallet'

* Fix markup in TOC
2018-01-12 09:43:31 +00:00
Ignotus Peverell
bc171a4423
A bit more doc on pruning and validation 2018-01-10 19:57:47 +00:00
yeastplume
c805f67020 adding clang dependency to build doc 2018-01-03 10:14:59 +00:00
udiWertheimer
23e045d9b7 Add another rocksdb compile error fix to FAQ entry (#565)
On Fedora, Linux headers aren't enough to build `rocksdb`, as suggested in #549. `clang` is also required. Adds note to troubleshooting to help with this.
2018-01-03 01:05:56 +00:00
Harm Aarts
dc3a2113bd Add rocksdb compile error help (#563)
* Add minor document fixes

- fix broken link
- fix shell command formatting
- fix typo

* Add FAQ entry dealing with rocksdb

When compiling Grin without Linux headers the build process exits with
an opaque error message. Adding the header files fixes this.

References #549.
2017-12-31 21:47:26 +00:00
Ignotus Peverell
74ba0d5e88
Fix small typo and remove traling spaces at PoW docs (#534)
Fix small typo and remove traling spaces at PoW docs
2017-12-21 19:32:43 +00:00
Simon B
99186e90f0 better error messages + some cleanup (#497)
* distinguish select (among futures) from select coins. Regex search in project for select\b shows we hardly use select, but maybe could use it to add timeouts more cleanly. ("Want to add a timeout to any future? Just do a select of that future and a timeout future!" from https://aturon.github.io/blog/2016/08/11/futures/)

* remove a trailing space

* FAQ.md - fix typo

* wallet: display problematic tx

* update FAQ build troubleshooting to cover #443

* stdout_log_level = Info
file_log_level = Debug

* sync: show total diff @ height when syncronization is completed

* better wallet send dest format error

* move INFO "Client conn ... lost" and "Connected to peer" down to Debug

* move some level=Info to Debug, add 1000-block outputs
2017-12-18 08:17:11 -05:00
Roman Zeyde
6bdc28e4e0 Fix small typo and remove traling spaces at PoW docs 2017-12-15 10:14:14 +02:00
Simon B
c59f3ddb7c add doc/FAQ#troubleshooting for serde_json version select error + link to it from build.md (#487) 2017-12-14 13:07:26 -05:00
Andrew Bellenie
7ef752f61c Breakout listen -i to separate method (#337)
* Rename wallet 'receive' to 'listen'
* Handle use of previous 'receive' command gracefully and clarify docs
* Move listen port from main wallet config to subcommand and break input out into own file method
* Clean up arg description
* Add placeholder to docs for file method in wallet
* Tidy wallet help text
* Rename pending wallet 'receive' to 'request'
* Restore receive method for file based transactions
2017-12-14 01:13:04 +01:00
Michalis Kargakis
e13f622395 Add docs about cross-compiling ARM binaries (#457) 2017-12-10 18:42:39 +00:00
Maxime
fa91e4dc15 homogenize MimbleWimble writing (#438) 2017-12-07 16:13:36 -05:00
Jeremy Bokobza
19da9ad1e0 Small documentation improvements (#418) 2017-12-05 00:57:03 +00:00
AntiochP
d3e5acccf9
initial docs and images to describe receiving a block and simple sync. (#405)
* intial docs and images to describe receiving a block and simple sync.

* add some more description text

* svg -> png

* updated simple_sync diagram to include sync_head

* rename "block head" -> "body head"

* wip - sync_on_form diagram (kill me now)

* tidy up diagram for "sync on fork"

* consolidate the chain docs
2017-12-04 15:35:18 -05:00
Simon B
90a1187bf7 doc/wallet: replace all [tbd] with some minimal text, partly from grin help wallet ... (#391) 2017-11-28 21:22:46 -05:00
bit
29b4a6df40 Doc fix: wallet receive -> wallet listen (#357) 2017-11-28 21:22:04 -05:00
Simon B
0fb15641fe Add doc/usage that explains status and functionality grin at Testnet1 (#392) 2017-11-25 12:59:17 -05:00
Simon B
b21da1cbb6 FAQ: corrections (#390)
* FAQ: fix capitalization
* FAQ: friendlier answers. Move Q: crash/hangs under the Troubleshooting section
* FAQ: add missing A for block size/target mean time
* FAQ: Add link to grintest.net (see also #325)
* FAQ corrections
- link to Scripting discussion
- Quantum unsafe, says A.P.
2017-11-25 12:44:05 -05:00