cosmos-sdk/docs/spec
Federico Kunze 5d5f0149a4 Merge PR #4599: Supply module spec
* supply spec

* update spec

* update other modules

* update distr

* update spec according to latest refactors

* Apply suggestions from code review

Co-Authored-By: Alexander Bezobchuk <alexanderbez@users.noreply.github.com>

* updated spec

* Apply suggestions from code review

Co-Authored-By: Marko <marbar3778@yahoo.com>

* final updates

* Apply suggestions from code review

Co-Authored-By: Alessio Treglia <quadrispro@ubuntu.com>

* word wrap in supply concepts

* edits to concepts
2019-07-01 18:47:55 +02:00
..
_ics Merge PR #3637: DOCS: Add readme to specs 2019-02-13 10:05:03 -08:00
_proposals Merge PR #3637: DOCS: Add readme to specs 2019-02-13 10:05:03 -08:00
addresses Merge PR #3637: DOCS: Add readme to specs 2019-02-13 10:05:03 -08:00
auth Revert "Generalize auth/types.StdSignature (#4507)" (#4512) 2019-06-08 11:04:52 +01:00
bank Merge PR #4541: Events Tracking / Tendermint v0.32.0 Update 2019-06-26 18:03:25 +02:00
circuit-breaker Merge PR #3898: Circuit breaker high level explanation 2019-03-25 16:37:05 +01:00
crisis Merge PR #4541: Events Tracking / Tendermint v0.32.0 Update 2019-06-26 18:03:25 +02:00
distribution Merge PR #4599: Supply module spec 2019-07-01 18:47:55 +02:00
governance Merge PR #4599: Supply module spec 2019-07-01 18:47:55 +02:00
ibc Merge PR #4074: Fix Docs Typo 2019-04-09 08:53:34 -04:00
mint Merge PR #4599: Supply module spec 2019-07-01 18:47:55 +02:00
params Merge PR #3683: spec-spec update, spec file reorg, TOC updates 2019-02-20 13:21:57 -05:00
reserve-pool Merge PR #3281: Staking Spec Upgrade 2019-01-21 19:52:03 -05:00
slashing Merge PR #4629: Emit Warning Events when Validator Misses Blocks 2019-06-28 13:53:30 -04:00
staking Merge PR #4599: Supply module spec 2019-07-01 18:47:55 +02:00
store docs/spec: flesh out dir structure and update index 2018-06-16 00:39:15 -07:00
supply Merge PR #4599: Supply module spec 2019-07-01 18:47:55 +02:00
README.md Merge PR #4599: Supply module spec 2019-07-01 18:47:55 +02:00
SPEC-SPEC.md Merge PR #4404: Update Spec to include params 2019-05-24 12:18:07 -04:00

README.md

Specifications

This directory contains specifications for the modules of the Cosmos SDK as well as Interchain Standards (ICS) and other specifications.

SDK applications hold this state in a Merkle store. Updates to the store may be made during transactions and at the beginning and end of every block.

SDK specifications

  • Store - The core Merkle store that holds the state.
  • Bech32 - Address format for Cosmos SDK applications.

Modules specifications

  • Auth - The structure and authentication of accounts and transactions.
  • Bank - Sending tokens.
  • Governance - Proposals and voting.
  • Staking - Proof-of-stake bonding, delegation, etc.
  • Slashing - Validator punishment mechanisms.
  • Distribution - Fee distribution, and staking token provision distribution.
  • Crisis - Halting the blockchain under certain circumstances.
  • Mint - Staking token provision creation.
  • Params - Globally available parameter store.
  • IBC - Inter-Blockchain Communication (IBC) protocol.
  • Supply - Total supply of the chain.

Interchain standards

  • ICS30 - Signed messages standard.

For details on the underlying blockchain and p2p protocols, see the Tendermint specification.