2017-11-21 03:06:52 +03:00
|
|
|
# Documentation structure
|
2018-03-17 21:08:40 +03:00
|
|
|
|
[1.1.0] Merge master into 1.1.0 (#2720)
* 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 ca8447f3bd49e80578770da841e5fbbac2c23cde
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
2019-04-01 13:47:48 +03:00
|
|
|
*Read this in other languages: [Korean](table_of_contents_KR.md).*
|
|
|
|
|
|
2018-03-17 21:08:40 +03:00
|
|
|
## Explaining grin
|
2018-10-03 23:31:28 +03:00
|
|
|
|
2018-06-13 19:03:34 +03:00
|
|
|
- [intro](intro.md) - Technical introduction to grin
|
2018-03-17 21:08:40 +03:00
|
|
|
- [grin4bitcoiners](grin4bitcoiners.md) - Explaining grin from a bitcoiner's perspective
|
|
|
|
|
|
|
|
|
|
## Understand the grin implementation
|
2018-10-03 23:31:28 +03:00
|
|
|
|
2017-12-04 23:35:18 +03:00
|
|
|
- [chain_sync](chain/chain_sync.md) - About how Grin's blockchain is synchronized
|
|
|
|
|
- [blocks_and_headers](chain/blocks_and_headers.md) - How Grin tracks blocks and headers on the chain
|
2018-10-03 23:31:28 +03:00
|
|
|
- [contract_ideas](contract_ideas.md) - Ideas on how to implement contracts
|
2018-03-17 21:08:40 +03:00
|
|
|
- [dandelion/dandelion](dandelion/dandelion.md) - About transaction propagation and cut-through. Stemming and fluffing!
|
2018-07-20 19:09:47 +03:00
|
|
|
- [dandelion/simulation](dandelion/simulation.md) - Dandelion simulation - aggregating transaction without lock_height Stemming and fluffing!
|
2017-11-21 03:06:52 +03:00
|
|
|
- [internal/pool](internal/pool.md) - Technical explanation of the transaction pool
|
|
|
|
|
- [merkle](merkle.md) - Technical explanation of grin's favorite kind of merkle trees
|
2018-03-17 21:08:40 +03:00
|
|
|
- [merkle_proof graph](merkle_proof/merkle_proof.png) - Example merkle proof with pruning applied
|
2017-11-21 03:06:52 +03:00
|
|
|
- [pruning](pruning.md) - Technical explanation of pruning
|
2018-07-22 22:12:07 +03:00
|
|
|
- [stratum](stratum.md) - Technical explanation of Grin Stratum RPC protocol
|
2018-10-09 16:50:31 +03:00
|
|
|
- [transaction UML](wallet/transaction/basic-transaction-wf.png) - UML of an interactive transaction (aggregating transaction without `lock_height`)
|
2018-03-17 21:08:40 +03:00
|
|
|
|
|
|
|
|
## Build and use
|
2018-10-03 23:31:28 +03:00
|
|
|
|
2018-10-09 16:50:31 +03:00
|
|
|
- [api](api/api.md) - Explaining the different APIs in Grin and how to use them
|
2018-03-17 21:08:40 +03:00
|
|
|
- [build](build.md) - Explaining how to build and run the Grin binaries
|
2018-09-25 23:14:10 +03:00
|
|
|
- [release](release_instruction.md) - Instructions of making a release
|
2018-08-30 13:47:04 +03:00
|
|
|
- [usage](usage.md) - Explaining how to use grin in Testnet3
|
2018-08-01 20:57:25 +03:00
|
|
|
- [wallet](wallet/usage.md) - Explains the wallet design and `grin wallet` sub-commands
|
2018-03-17 21:08:40 +03:00
|
|
|
|
2018-10-03 23:31:28 +03:00
|
|
|
## External (wiki)
|
|
|
|
|
|
2018-03-17 21:08:40 +03:00
|
|
|
- [FAQ](https://github.com/mimblewimble/docs/wiki/FAQ) - Frequently Asked Questions
|
|
|
|
|
- [Building grin](https://github.com/mimblewimble/docs/wiki/Building)
|
|
|
|
|
- [How to use grin](https://github.com/mimblewimble/docs/wiki/How-to-use-grin)
|
|
|
|
|
- [Hacking and contributing](https://github.com/mimblewimble/docs/wiki/Hacking-and-contributing)
|
