mukan-sdk/docs/architecture

sidebar_position
1

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 system’s 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.

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.

Use RFC 2119 Keywords

When writing ADRs, follow the same best practices for writing RFCs. When writing RFCs, key words are used to signify the requirements in the specification. These words are often capitalized: "MUST," "MUST NOT," "REQUIRED," "SHALL," "SHALL NOT," "SHOULD," "SHOULD NOT," "RECOMMENDED," "MAY," and "OPTIONAL." They are to be interpreted as described in RFC 2119.

ADR Table of Contents

Accepted

• ADR 002: SDK Documentation Structure
• ADR 004: Split Denomination Keys
• ADR 006: Secret Store Replacement
• ADR 009: Evidence Module
• ADR 010: Modular AnteHandler
• ADR 019: Protocol Buffer State Encoding
• ADR 020: Protocol Buffer Transaction Encoding
• ADR 021: Protocol Buffer Query Encoding
• ADR 023: Protocol Buffer Naming and Versioning
• ADR 029: Fee Grant Module
• ADR 030: Message Authorization Module
• ADR 031: Protobuf Msg Services
• ADR 055: ORM
• ADR 058: Auto-Generated CLI
• ADR 060: ABCI 1.0 (Phase I)
• ADR 061: Liquid Staking

Proposed

• ADR 003: Dynamic Capability Store
• ADR 011: Generalize Genesis Accounts
• ADR 012: State Accessors
• ADR 013: Metrics
• ADR 016: Validator Consensus Key Rotation
• ADR 017: Historical Header Module
• ADR 018: Extendable Voting Periods
• ADR 022: Custom baseapp panic handling
• ADR 024: Coin Metadata
• ADR 027: Deterministic Protobuf Serialization
• ADR 028: Public Key Addresses
• ADR 032: Typed Events
• ADR 033: Inter-module RPC
• ADR 035: Rosetta API Support
• ADR 037: Governance Split Votes
• ADR 038: State Listening
• ADR 039: Epoched Staking
• ADR 040: Storage and SMT State Commitments
• ADR 046: Module Params
• ADR 054: Semver Compatible SDK Modules
• ADR 057: App Wiring
• ADR 059: Test Scopes
• ADR 062: Collections State Layer
• ADR 063: Core Module API
• ADR 065: Store V2
• ADR 076: Transaction Malleability Risk Review and Recommendations

Draft

• ADR 044: Guidelines for Updating Protobuf Definitions
• ADR 047: Extend Upgrade Plan
• ADR 053: Go Module Refactoring
• ADR 068: Preblock