mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-06 21:36:26 +00:00
daaf5d6441
* Update docs references from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update DOCS_README to reflect current reality Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update vuepress config with current versions and updated discussions link Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update generated docs versions Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update docs build to use temp folder instead of home Signed-off-by: Thane Thomson <connect@thanethomson.com> * Document build-docs Makefile target Signed-off-by: Thane Thomson <connect@thanethomson.com> * Add serve-docs Makefile target to serve local build of docs Signed-off-by: Thane Thomson <connect@thanethomson.com> * Ensure 404 page is copied during docs build Signed-off-by: Thane Thomson <connect@thanethomson.com> * Redirect /master/ to /main/ Signed-off-by: Thane Thomson <connect@thanethomson.com> * Attempt to resolve #7908 Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update OpenAPI references from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update CHANGELOG references from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update Docker readme references from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update UPGRADING references from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update package-specific documentation references from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update spec references from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update all code comment references to docs site from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Build v0.34.x as "latest" Signed-off-by: Thane Thomson <connect@thanethomson.com> * Explicitly mark v0.34 docs as latest in version selector Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update all links from docs.tendermint.com/main to docs.tendermint.com/latest Signed-off-by: Thane Thomson <connect@thanethomson.com> * ci: Redeploy docs on pushes to v0.34.x Signed-off-by: Thane Thomson <connect@thanethomson.com> * Temporarily copy spec directory into docs while building Signed-off-by: Thane Thomson <connect@thanethomson.com> * Add nav link to main and clearly mark as unstable Signed-off-by: Thane Thomson <connect@thanethomson.com> * Revert to only publishing docs in nav for v0.34 and v0.33 with no latest Signed-off-by: Thane Thomson <connect@thanethomson.com> * Link to docs.tendermint.com/v0.34 from RFCs Signed-off-by: Thane Thomson <connect@thanethomson.com> * Rather just use main for all docs.tendermint.com references on main branch Signed-off-by: Thane Thomson <connect@thanethomson.com> * Rename GitHub tree links from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update link for ABCI Rust client Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update github links from master to main Signed-off-by: Thane Thomson <connect@thanethomson.com> * Update badges in root readme Signed-off-by: Thane Thomson <connect@thanethomson.com> * Remove codecov badge since we do not use it any more Signed-off-by: Thane Thomson <connect@thanethomson.com> * Remove Java and Kotlin tutorials Signed-off-by: Thane Thomson <connect@thanethomson.com> * Remove specs from docs build Signed-off-by: Thane Thomson <connect@thanethomson.com> * Migrate spec links to GitHub repo from docs site Signed-off-by: Thane Thomson <connect@thanethomson.com> * Remove references to non-existent PEX reactor spec Signed-off-by: Thane Thomson <connect@thanethomson.com> * Fix linting badge in README Signed-off-by: Thane Thomson <connect@thanethomson.com> Signed-off-by: Thane Thomson <connect@thanethomson.com>
order, parent
| order | parent | ||
|---|---|---|---|
| 1 |
|
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
Implemented
- ADR-001: Logging
- ADR-002: Event-Subscription
- ADR-003: ABCI-APP-RPC
- ADR-004: Historical-Validators
- ADR-005: Consensus-Params
- ADR-008: Priv-Validator
- ADR-009: ABCI-Design
- ADR-010: Crypto-Changes
- ADR-011: Monitoring
- ADR-014: Secp-Malleability
- ADR-015: Crypto-Encoding
- ADR-016: Protocol-Versions
- ADR-017: Chain-Versions
- ADR-018: ABCI-Validators
- ADR-019: Multisigs
- ADR-020: Block-Size
- ADR-021: ABCI-Events
- ADR-025: Commit
- ADR-026: General-Merkle-Proof
- ADR-033: Pubsub
- ADR-034: Priv-Validator-File-Structure
- ADR-043: Blockchain-RiRi-Org
- ADR-044: Lite-Client-With-Weak-Subjectivity
- ADR-046: Light-Client-Implementation
- ADR-047: Handling-Evidence-From-Light-Client
- ADR-051: Double-Signing-Risk-Reduction
- ADR-052: Tendermint-Mode
- ADR-053: State-Sync-Prototype
- ADR-054: Crypto-Encoding-2
- ADR-055: Protobuf-Design
- ADR-056: Light-Client-Amnesia-Attacks
- ADR-059: Evidence-Composition-and-Lifecycle
- ADR-062: P2P-Architecture
- ADR-063: Privval-gRPC
- ADR-066: E2E-Testing
- ADR-072: Restore Requests for Comments
- ADR-077: Block Retention
- ADR-078: Non-zero Genesis
- ADR-079: ED25519 Verification
- ADR-080: Reverse Sync
Accepted
- ADR-006: Trust-Metric
- ADR-024: Sign-Bytes
- ADR-035: Documentation
- ADR-039: Peer-Behaviour
- ADR-060: Go-API-Stability
- ADR-061: P2P-Refactor-Scope
- ADR-065: Custom Event Indexing
- ADR-068: Reverse-Sync
- ADR-067: Mempool Refactor
- ADR-075: RPC Event Subscription Interface
- ADR-076: Combine Spec and Tendermint Repositories
- ADR-081: Protocol Buffers Management
Deprecated
None
Rejected
Proposed
- ADR-007: Trust-Metric-Usage
- ADR-012: Peer-Transport
- ADR-013: Symmetric-Crypto
- ADR-022: ABCI-Errors
- ADR-030: Consensus-Refactor
- ADR-036: Empty Blocks via ABCI
- ADR-037: Deliver-Block
- ADR-038: Non-Zero-Start-Height
- ADR-040: Blockchain Reactor Refactor
- ADR-041: Proposer-Selection-via-ABCI
- ADR-042: State Sync Design
- ADR-045: ABCI-Evidence
- ADR-050: Improved Trusted Peering
- ADR-057: RPC
- ADR-064: Batch Verification
- ADR-069: Node Initialization
- ADR-071: Proposer-Based Timestamps
- ADR-073: Adopt LibP2P
- ADR-074: Migrate Timeout Parameters to Consensus Parameters