Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-21 03:21:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
grin/doc/table_of_contents.md
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

2 KiB
Raw Blame History

Documentation structure

Explaining grin

  • intro - Technical introduciton to grin
  • grin4bitcoiners - Explaining grin from a bitcoiner's perspective

Understand the grin implementation

  • chain_sync - About how Grin's blockchain is synchronized
  • blocks_and_headers - How Grin tracks blocks and headers on the chain
  • contractideas - Ideas on how to implement contracts
  • dandelion/dandelion - About transaction propagation and cut-through. Stemming and fluffing!
  • dandelion/simulating - Dandelium simulation - aggregating transaction without lock_height Stemming and fluffing!
  • internal/pool - Technical explanation of the transaction pool
  • merkle - Technical explanation of grin's favorite kind of merkle trees
  • merkle_proof graph - Example merkle proof with pruning applied
  • pruning - Technical explanation of pruning
  • rangeproofs - Technical explanation of range proofs
  • [transaction UML](transaction/aggregating transaction without lock_height) - UML of an interactive transaction

Build and use

  • build - Explaining how to build and run the Grin binaries
  • usage - Explaining how to use grin in Testnet1
  • local_net - Technical explanation of how to test Grin locally, simulating several peers, for full integration testing and network simulations
  • wallet - Explains the wallet design and grin wallet sub-commands

External (wiki)