tendermint/docs/architecture
Ian Tan 3c98cec2c2 Add ADR entry for `ProposeTx` (#1813)
This adds an ADR entry addressing the implementation of a `ProposeTx`
method in the ABCI proposed in #1776. Fundamentally, this proposal gives
some control of block proposals to the application. The initial use case is
to support the Minimal Viable Plasma specification.
2018-08-08 23:12:36 +04:00
..
img added initial trust metric design doc and code 2017-11-14 18:26:06 -05:00
README.md adr: update readme 2018-06-23 09:29:46 -04:00
adr-001-logging.md docs: update and clean up adr 2017-09-15 19:31:37 -04:00
adr-002-event-subscription.md docs: update and clean up adr 2017-09-15 19:31:37 -04:00
adr-003-abci-app-rpc.md docs: update and clean up adr 2017-09-15 19:31:37 -04:00
adr-004-historical-validators.md docs: update and clean up adr 2017-09-15 19:31:37 -04:00
adr-005-consensus-params.md Updates -> ValidatoSetUpdates 2017-12-19 13:03:39 -06:00
adr-006-trust-metric.md added changes based on PR comments to the proposal 2017-11-15 17:59:48 -05:00
adr-007-trust-metric-usage.md adr: update 007 trust metric usage 2017-12-10 19:00:44 -05:00
adr-008-priv-validator.md Make types use Amino; Refactor PrivValidator* to FilePV/SocketPV 2018-03-31 00:18:43 +02:00
adr-009-ABCI-design.md adr: update readme 2018-06-23 09:29:46 -04:00
adr-010-crypto-changes.md fixes from review 2018-06-23 09:29:46 -04:00
adr-011-monitoring.md update ADR 2018-06-20 12:38:45 +04:00
adr-012-ABCI-propose-tx.md Add ADR entry for `ProposeTx` (#1813) 2018-08-08 23:12:36 +04:00
adr-012-peer-transport.md adr: PeerTransport (#2069) 2018-07-27 02:27:19 +02:00
adr-013-symmetric-crypto.md (squash this) change adr number, remove redundancy in function names 2018-08-02 10:43:47 -07:00
adr-014-secp-malleability.md (squash this) indicate what Ethereum does 2018-08-03 17:49:46 -07:00
adr-015-crypto-encoding.md (Squash this) Be more explicit about the exact encoding of the secp signature 2018-08-02 23:27:16 -07:00
adr-016-protocol-versions.md adr: protocol versioning 2018-08-03 20:21:40 -04:00
adr-017-chain-versions.md adr: chain-versions 2018-08-03 20:23:37 -04:00
adr-018-ABCI-Validators.md adr-018: abci validators 2018-08-05 12:45:27 -04:00
adr-019-multisigs.md [ADR] Proposal for multisignature encoding (#1960) 2018-08-08 23:10:33 +04:00
adr-template.md docs: update and clean up adr 2017-09-15 19:31:37 -04:00

README.md

Architecture Decision Records (ADR)

This is a location to record all high-level architecture decisions in the tendermint project.

You can read more about the ADR concept in this blog post.

An ADR should provide:

  • Context on the relevant goals and the current state
  • Proposed changes to achieve the goals
  • Summary of pros and cons
  • References
  • Changelog

Note the distinction between an ADR and a spec. The ADR provides the context, intuition, reasoning, and justification for a change in architecture, or for the architecture of something new. The spec is much more compressed and streamlined summary of everything as it stands today.

If recorded decisions turned out to be lacking, convene a discussion, record the new decisions here, and then modify the code to match.

Note the context/background should be written in the present tense.