Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-21 11:31:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
grin/doc/table_of_contents.md
Quentin Le Sceller bcaecdeba7
API Documentation: Node API (#1655) 
* Structure of the api doc

* Initial Node API Doc
2018-10-04 09:35:39 -04:00

2 KiB
Raw Blame History

Documentation structure

Explaining grin

  • intro - Technical introduction 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
  • contract_ideas - Ideas on how to implement contracts
  • dandelion/dandelion - About transaction propagation and cut-through. Stemming and fluffing!
  • dandelion/simulation - Dandelion 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
  • stratum - Technical explanation of Grin Stratum RPC protocol
  • [transaction UML](transaction/aggregating transaction without lock_height) - UML of an interactive transaction

Build and use

  • api - Explaining the different APIs in Grin and how to use them
  • build - Explaining how to build and run the Grin binaries
  • release - Instructions of making a release
  • usage - Explaining how to use grin in Testnet3
  • wallet - Explains the wallet design and grin wallet sub-commands

External (wiki)