zolfa
/
tendermint
1
0
Fork 0
Code Issues 0 Pull Requests 0 Projects 0 Releases 221 Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
8410 Commits
183 Branches
291 MiB
 
 
 
 
 
 
Tree: a736530e01
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'a736530e01'
${ noResults }
tendermint/docs/architecture
Tess Rinearson a736530e01
docs/architecture: add missing ADRs to README, update status of ADR 034 (#5663) 		4 years ago
..
img docs: adr-046 add bisection algorithm details (#4496) 5 years ago
README.md docs/architecture: add missing ADRs to README, update status of ADR 034 (#5663) 4 years ago
adr-001-logging.md [R4R] libs/log: add year to log format (#2707) 6 years ago
adr-002-event-subscription.md docs: fix links (#4531) 5 years ago
adr-003-abci-app-rpc.md docs: update and clean up adr 7 years ago
adr-004-historical-validators.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-005-consensus-params.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-006-trust-metric.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-007-trust-metric-usage.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-008-priv-validator.md [pv] add ability to use ipc validator (#2866) 6 years ago
adr-009-ABCI-design.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-010-crypto-changes.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-011-monitoring.md docs: fix links (#4531) 5 years ago
adr-012-peer-transport.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-013-symmetric-crypto.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-014-secp-malleability.md Fix some broken links (#5261) 4 years ago
adr-015-crypto-encoding.md docs: minor doc fixes (#4335) 5 years ago
adr-016-protocol-versions.md adr-016: update int64->uint64; add version to ConsensusParams (#2667) 6 years ago
adr-017-chain-versions.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-018-ABCI-Validators.md docs: fix links (#4531) 5 years ago
adr-019-multisigs.md lint markdown docs using a stop-words and write-good linters (#2195) 6 years ago
adr-020-block-size.md update ADR-020 (#3116) 6 years ago
adr-021-abci-events.md adr-021: note about tag spacers (#2362) 6 years ago
adr-022-abci-errors.md [ADR] ABCI errors and events (#2314) 6 years ago
adr-023-ABCI-propose-tx.md Fix some broken links (#5261) 4 years ago
adr-024-sign-bytes.md [ADR][DRAFT] 024: SignBytes and validator types in privval (#2445) 6 years ago
adr-025-commit.md Update ADR-025 and mark it as Accepted (#3958) 5 years ago
adr-026-general-merkle-proof.md add adr (#2553) 6 years ago
adr-028-libp2p.md ADR: add missing numbers as blank templates (#5154) 4 years ago
adr-029-check-tx-consensus.md abci: remove setOption (#5447) 4 years ago
adr-030-consensus-refactor.md [WIP] Fill in consensus core details in ADR 030 (#2696) 6 years ago
adr-031-changelog.md ADR: add missing numbers as blank templates (#5154) 4 years ago
adr-033-pubsub.md adr-033 update 6 years ago
adr-034-priv-validator-file-structure.md docs/architecture: add missing ADRs to README, update status of ADR 034 (#5663) 4 years ago
adr-035-documentation.md docs ADR (#2828) 6 years ago
adr-036-empty-blocks-abci.md ADR: add missing numbers as blank templates (#5154) 4 years ago
adr-037-deliver-block.md libs/common: refactor libs/common 01 (#4230) 5 years ago
adr-038-non-zero-start-height.md ADR: add missing numbers as blank templates (#5154) 4 years ago
adr-039-peer-behaviour.md adr: PeerBehaviour updates (#3558) 6 years ago
adr-040-blockchain-reactor-refactor.md [ADR] ADR-36: blockchain reactor refactor spec (#3506) 6 years ago
adr-041-proposer-selection-via-abci.md adr renames (#3622) 6 years ago
adr-042-state-sync.md lite2: indicate success/failure of Update (#4536) 5 years ago
adr-043-blockchain-riri-org.md docs: fix links (#4531) 5 years ago
adr-044-lite-client-with-weak-subjectivity.md Fix some broken links (#5261) 4 years ago
adr-045-abci-evidence.md Fix some broken links (#5261) 4 years ago
adr-046-light-client-implementation.md lite2: make maxClockDrift an option (#4616) 5 years ago
adr-047-handling-evidence-from-light-client.md docs: fix links to adr 56 (#5464) 4 years ago
adr-050-improved-trusted-peering.md adr#50: improve trusted peering (#4072) 5 years ago
adr-051-double-signing-risk-reduction.md consensus: double-sign risk reduction (ADR-51) (#5147) 4 years ago
adr-052-tendermint-mode.md Docs staging (#4407) 5 years ago
adr-053-state-sync-prototype.md adr-053: update after state sync merge (#4768) 5 years ago
adr-054-crypto-encoding-2.md docs: amend adr-54 with changes in the sdk (#4684) 5 years ago
adr-055-protobuf-design.md proto: folder structure adhere to buf (#5025) 4 years ago
adr-056-light-client-amnesia-attacks.md docs: revise ADR 56, documenting short term decision around amnesia evidence (#5440) 4 years ago
adr-057-RPC.md ADR-057: RPC (#4857) 4 years ago
adr-058-event-hashing.md docs: event hashing ADR 058 (#5134) 4 years ago
adr-059-evidence-composition-and-lifecycle.md evidence: introduction of LightClientAttackEvidence and refactor of evidence lifecycle (#5361) 4 years ago
adr-060-go-api-stability.md adr: add API stability ADR (#5341) 4 years ago
adr-061-p2p-refactor-scope.md docs: add ADR on P2P refactor scope (#5592) 4 years ago
adr-template.md expand ADR template (#5232) 4 years ago

README.md

order parent
1 [{order false}]

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.

Table of Contents: