mirror of
https://github.com/tendermint/tendermint.git
synced 2026-01-05 04:55:18 +00:00
109814c85a
While discussing a question about the indexing interface (#7044), we found some confusion about the intent of the design decisions in ADR 065. Based on discussion with the original authors of the ADR, this commit adds some language to the Decisions section to spell out the intentions more clearly, and to call out future work that this ADR did not explicitly decide about.
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
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
Rejected
Proposed
- ADR-007: Trust-Metric-Usage
- ADR-012: Peer-Transport
- ADR-013: Symmetric-Crypto
- ADR-022: ABCI-Errors
- ADR-030: Consensus-Refactor
- ADR-037: Deliver-Block
- ADR-038: Non-Zero-Start-Height
- ADR-041: Proposer-Selection-via-ABCI
- ADR-045: ABCI-Evidence
- ADR-057: RPC
- ADR-069: Node Initialization
- ADR-071: Proposer-Based Timestamps
- ADR-072: Restore Requests for Comments