1b9f144b9d
* Add ADR 026: Protocol Buffer Regencode * Use Regencode in ADR-020 * Apply suggestions from code review Co-authored-by: Aaron Craelius <aaron@regen.network> * Add reasoning behind omitting empty fields * Rename to ADR 026: Deterministic Protobuf Serialization * i++ * explicitely -> explicitly * Fix description of optional values * Update reasoning behind omitting default values * Fix empty -> defaut * Update docs/architecture/adr-027-deterministic-protobuf-serialization.md Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> * Add rules to avoid duplicate encoding and specify packed fields * Add rule for variant encoding * Add surrogate pair to test UTF-8 encoding Co-authored-by: Aaron Craelius <aaron@regen.network> Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com> |
||
|---|---|---|
| .. | ||
| README.md | ||
| adr-001-coin-source-tracing.md | ||
| adr-002-docs-structure.md | ||
| adr-003-dynamic-capability-store.md | ||
| adr-004-split-denomination-keys.md | ||
| adr-006-secret-store-replacement.md | ||
| adr-007-specialization-groups.md | ||
| adr-008-dCERT-group.md | ||
| adr-009-evidence-module.md | ||
| adr-010-modular-antehandler.md | ||
| adr-011-generalize-genesis-accounts.md | ||
| adr-012-state-accessors.md | ||
| adr-013-metrics.md | ||
| adr-014-proportional-slashing.md | ||
| adr-015-ibc-packet-receiver.md | ||
| adr-016-validator-consensus-key-rotation.md | ||
| adr-017-historical-header-module.md | ||
| adr-018-extendable-voting-period.md | ||
| adr-019-protobuf-state-encoding.md | ||
| adr-020-protobuf-transaction-encoding.md | ||
| adr-021-protobuf-query-encoding.md | ||
| adr-022-custom-panic-handling.md | ||
| adr-023-protobuf-naming.md | ||
| adr-024-coin-metadata.md | ||
| adr-025-ibc-passive-channels.md | ||
| adr-026-ibc-client-recovery-mechanisms.md | ||
| adr-027-deterministic-protobuf-serialization.md | ||
| adr-template.md | ||
| readme.md~origin_master-docs | ||
README.md
| 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