Robert Zaremba
435fc83ba7
* Updating the ADR template Introducing few small sections to the template: * Summary: IMHO it's very valuable for every reader to quickly see what this ADR is about. Must be short. * Backwards Compatibility -- each ADR MUST analyze backward compatibility issue. Let's make it clear and put as the ADR subsection. * Test Cases -- often, when analyzing a problem and implementing a solution, it's very useful to define test-cases. Hence it SHOULD be a part of the template. Inspiration: Enterprise Ethreum Alliance Proposal [template](https://github.com/EntEthAlliance/EEPs/blob/master/draft/templates/EEP0002-Standards_Proposal_Template.md) * change Summary -> Abstract
order, parent
| order | parent | ||
|---|---|---|---|
| false |
|
Architecture Decision Records (ADR)
This is a location to record all high-level architecture decisions in the Cosmos-SDK.
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.
Please add a entry below in your Pull Request for an ADR.
ADR Table of Contents
- ADR 001: Coin Source Tracing
- ADR 002: SDK Documentation Structure
- ADR 003: Dynamic Capability Store
- ADR 004: Split Denomination Keys
- ADR 006: Secret Store Replacement
- ADR 009: Evidence Module
- ADR 010: Modular AnteHandler
- ADR 011: Generalize Genesis Accounts
- ADR 012: State Accessors
- ADR 013: Metrics
- ADR 015: IBC Packet Receiver
- ADR 016: Validator Consensus Key Rotation
- ADR 017: Historical Header Module
- ADR 018: Extendable Voting Periods
- ADR 019: Protocol Buffer State Encoding
- ADR 020: Protocol Buffer Transaction Encoding
- ADR 021: Protocol Buffer Query Encoding
- ADR 022: Custom baseapp panic handling
- ADR 023: Protocol Buffer Naming and Versioning
- ADR 024: Coin Metadata
- ADR 025: IBC Passive Channels
- ADR 026: IBC Client Recovery Mechanisms
- ADR 027: Deterministic Protobuf Serialization