cosmos-sdk/docs/architecture/README.md

74 lines
3.7 KiB
Markdown
Raw Normal View History

---
order: false
parent:
order: false
---
# Architecture Decision Records (ADR)
This is a location to record all high-level architecture decisions in the Cosmos-SDK.
An Architectural Decision (**AD**) is a software design choice that addresses a functional or non-functional requirement that is architecturally significant.
An Architecturally Significant Requirement (**ASR**) is a requirement that has a measurable effect on a software systems architecture and quality.
An Architectural Decision Record (**ADR**) captures a single AD, such as often done when writing personal notes or meeting minutes; the collection of ADRs created and maintained in a project constitute its decision log. All these are within the topic of Architectural Knowledge Management (AKM).
You can read more about the ADR concept in this [blog post](https://product.reverb.com/documenting-architecture-decisions-the-reverb-way-a3563bb24bd0#.78xhdix6t).
## Rationale
ADRs are intended to be the primary mechanism for proposing new feature designs and new processes, for collecting community input on an issue, and for documenting the design decisions.
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.
## Creating new ADR
Read about the [PROCESS](./PROCESS.md).
## ADR Table of Contents
### Accepted
ADR 001: coin cross-chain transfer source tracing (#6662) * adr: coin cross-chain transfer source tracing * update pros and cons * update spec README * Update docs/architecture/adr-001-coin-source-tracing.md Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com> * Apply suggestions from code review Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com> * Update docs/architecture/adr-001-coin-source-tracing.md * address comments from review * update ADR with Send/Recv logic * final touches * Apply suggestions from code review Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> * address comments from review * address @aaronc review comments * Apply suggestions from code review Co-authored-by: colin axner <25233464+colin-axner@users.noreply.github.com> * use SplitN * custom denom validation reference * address some comments from review * more updates based on Colin's review * final draft with changes to relay.go * undo proto changes * address @aaronc review comments * why do I keep updating the proto files? * address @AdityaSripal comments * address more comments * typos * final ammendments * minor fix * address more comments * update example * Update docs/architecture/adr-001-coin-source-tracing.md Co-authored-by: Anil Kumar Kammari <anil@vitwit.com> * address more comments * update prefix example Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com> Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> Co-authored-by: colin axner <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Anil Kumar Kammari <anil@vitwit.com>
2020-08-03 04:39:26 -07:00
- [ADR 001: Coin Source Tracing](./adr-001-coin-source-tracing.md)
- [ADR 002: SDK Documentation Structure](./adr-002-docs-structure.md)
- [ADR 006: Secret Store Replacement](./adr-006-secret-store-replacement.md)
- [ADR 009: Evidence Module](./adr-009-evidence-module.md)
- [ADR 010: Modular AnteHandler](./adr-010-modular-antehandler.md)
- [ADR 019: Protocol Buffer State Encoding](./adr-019-protobuf-state-encoding.md)
- [ADR 020: Protocol Buffer Transaction Encoding](./adr-020-protobuf-transaction-encoding.md)
- [ADR 026: IBC Client Recovery Mechanisms](./adr-026-ibc-client-recovery-mechanisms.md)
- [ADR 029: Fee Grant Module](./adr-029-fee-grant-module.md)
### Proposed
- [ADR 003: Dynamic Capability Store](./adr-003-dynamic-capability-store.md)
- [ADR 004: Split Denomination Keys](./adr-004-split-denomination-keys.md)
- [ADR 011: Generalize Genesis Accounts](./adr-011-generalize-genesis-accounts.md)
- [ADR 012: State Accessors](./adr-012-state-accessors.md)
2020-03-24 03:21:30 -07:00
- [ADR 013: Metrics](./adr-013-metrics.md)
- [ADR 015: IBC Packet Receiver](./adr-015-ibc-packet-receiver.md)
- [ADR 016: Validator Consensus Key Rotation](./adr-016-validator-consensus-key-rotation.md)
- [ADR 017: Historical Header Module](./adr-017-historical-header-module.md)
- [ADR 018: Extendable Voting Periods](./adr-018-extendable-voting-period.md)
- [ADR 021: Protocol Buffer Query Encoding](./adr-021-protobuf-query-encoding.md)
- [ADR 022: Custom baseapp panic handling](./adr-022-custom-panic-handling.md)
- [ADR 023: Protocol Buffer Naming and Versioning](./adr-023-protobuf-naming.md)
- [ADR 024: Coin Metadata](./adr-024-coin-metadata.md)
ADR 001: coin cross-chain transfer source tracing (#6662) * adr: coin cross-chain transfer source tracing * update pros and cons * update spec README * Update docs/architecture/adr-001-coin-source-tracing.md Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com> * Apply suggestions from code review Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com> * Update docs/architecture/adr-001-coin-source-tracing.md * address comments from review * update ADR with Send/Recv logic * final touches * Apply suggestions from code review Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> * address comments from review * address @aaronc review comments * Apply suggestions from code review Co-authored-by: colin axner <25233464+colin-axner@users.noreply.github.com> * use SplitN * custom denom validation reference * address some comments from review * more updates based on Colin's review * final draft with changes to relay.go * undo proto changes * address @aaronc review comments * why do I keep updating the proto files? * address @AdityaSripal comments * address more comments * typos * final ammendments * minor fix * address more comments * update example * Update docs/architecture/adr-001-coin-source-tracing.md Co-authored-by: Anil Kumar Kammari <anil@vitwit.com> * address more comments * update prefix example Co-authored-by: billy rennekamp <billy.rennekamp@gmail.com> Co-authored-by: Christopher Goes <cwgoes@pluranimity.org> Co-authored-by: colin axner <25233464+colin-axner@users.noreply.github.com> Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com> Co-authored-by: Anil Kumar Kammari <anil@vitwit.com>
2020-08-03 04:39:26 -07:00
- [ADR 025: IBC Passive Channels](./adr-025-ibc-passive-channels.md)
- [ADR 027: Deterministic Protobuf Serialization](./adr-027-deterministic-protobuf-serialization.md)
- [ADR 028: Public Key Addresses](./adr-028-public-key-addresses.md)
- [ADR 031: Protobuf Msg Services](./adr-031-msg-service.md)
- [ADR 032: Typed Events](./adr-032-typed-events.md)