Commit graph

82 commits

Author SHA1 Message Date
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
Simon B
ce82c82b0d Add doc/table_of_contents.md (#311)
* add doc/table_of_contents, initial attempt, based on https://lists.launchpad.net/mimblewimble/msg00024.html
And explain and link to build.md about creating folders server and wallet manually.
* add Files in this folder (doc)
* rename headlines
* docs: extract code and directory structure to code_structure.md
2017-11-20 19:06:51 -05:00
Michalis Kargakis
1f0808fc24 Markdown fixes + gitignore addition (#334)
* Markdown fixes in doc/build.md

Signed-off-by: Michalis Kargakis <mkargaki@redhat.com>

* Ignore grin.log and wallet.seed
2017-11-20 14:33:35 +00:00
Andrew Bellenie
2d1ed9ba52
Fix for issue #318 (#323)
* Rename wallet 'receive' to 'listen'
* Handle use of previous 'receive' command gracefully and clarify docs
2017-11-19 01:55:26 -05:00
Andrew Bellenie
2e87f40b91 Add note about memory requirements to build docs (#301) 2017-11-17 19:42:21 -05:00
Simon B
c426d79ecc FAQ, first attempt (condensed from gitter chat) (#298) 2017-11-17 19:12:55 -05:00
windsok
10380c0ce0 Update build.md (#284)
* Add required minimum version for Rust (Build fails on Ubuntu 16.04 LTS with 1.17.0, but works fine with a manual install of 1.21.0, so I am assuming that 1.21.0 is the minimum)
* Make it clearer that grin.toml needs to be copied into the server directory
2017-11-16 23:18:45 -05:00
Yeastplume
341269d95f
Testnet doc (#278)
* attempt to continue if duplicate coinbase commit is found

* updating docs for testnet
2017-11-16 19:58:41 +00:00
Daniel Tsui
d7fd730153 Correct dir name in advanced example+fix typo (#262)
This PR clarifies the directory name in the advanced example of `build.md`, and fixes a minor typo.
2017-11-13 20:27:53 -05:00
AntiochP
54dbda6bc2
advanced example wallet needs to point to node api 2017-11-12 13:58:51 -05:00
Yeastplume
024a016bce small doc fix 2017-11-07 21:49:03 +00:00
clwmckenna
81bd764fd0 Update build.md (#231)
Add info about config files
2017-11-03 12:45:05 -04:00
bgmrk
4dfa7c1770 Update grin4bitcoiners.md with basic supply information (#227) 2017-11-02 19:38:37 -04:00
Ignotus Peverell
e4ebb7c7cb
Cleanup HTTP APIs, update ports to avoid gap, rustfmt
Moved the HTTP APIs away from the REST endpoint abstraction and
to simpler Hyper handlers. Re-established all routes as v1.
Changed wallet receiver port to 13415 to avoid a gap in port
numbers.

Finally, rustfmt seems to have ignored specific files arguments,
running on everything.
2017-10-31 19:42:56 -04:00
Jeremy Bokobza
508349e799 intro.md review (#202) 2017-10-31 18:50:36 -04:00
AntiochP
68cfbbecad "grin wallet init" to create the initial wallet.seed file (#198)
* "wallet init" to create the initial wallet.seed file
* cleanup and better error msgs
* add some basic wallet docs
* cleanup and make passphrase optional
2017-10-24 17:34:34 +00:00
Ignotus Peverell
1582ec4e73
Fixing repository links after move 2017-10-23 17:20:32 +00:00
bgmrk
7f0d638107 Contract Ideas (#194)
* Contract Ideas - Began to catalogue mentions of different contract ideas from the email list.
* Add files via upload
2017-10-23 16:32:15 +00:00
Ignotus Peverell
837ef0fd03
Added detail about kernel sticking around 2017-10-17 03:20:31 +00:00
Yeastplume
8f76746e84 Switch commitments (#179)
* Adding switch commit to grin outputs
* logging output fix
* adding switch commitment hash to sum tree node
* added hash_with to Hashed trait, to allow for hashing to include another writeable element
* adding hash_with as method in hashed trait
2017-10-16 21:23:10 +00:00
Ignotus Peverell
472912c68c
Added clarification about block struct 2017-10-15 20:44:34 +00:00
Ignotus Peverell
dd90031902
Doc tweaks after feedback 2017-10-15 20:44:34 +00:00