cosmos-sdk/docs/architecture
Marie Gauthier 489599b70f
Remove the old message PublicKey proto oneof (#7390)
* Remove unused PublicKey type and update docs

* Update wording

* Update proto/cosmos/base/crypto/v1beta1/crypto.proto

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Edit docs

* Move crypto.proto to multisig

* Proto linting

* Update docs/architecture/adr-020-protobuf-transaction-encoding.md

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>

* Update wording for Public Key Encoding

Co-authored-by: Amaury Martiny <amaury.martiny@protonmail.com>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
Co-authored-by: Robert Zaremba <robert@zaremba.ch>
2020-09-29 10:01:54 +00:00
..
README.md Propose ADR 027: Deterministic Protobuf Serialization (#6979) 2020-08-19 17:22:15 +00:00
adr-001-coin-source-tracing.md x/ibc-transfer: ADR001 source tracing implementation (#6871) 2020-08-14 17:46:26 -04:00
adr-002-docs-structure.md Fix typo (#5523) 2020-01-15 08:14:25 +01:00
adr-003-dynamic-capability-store.md Merge PR #6007: update 03 adr 2020-04-16 14:19:06 -04:00
adr-004-split-denomination-keys.md Added glossary explaning Denomination Key (#7330) 2020-09-16 10:27:01 -07:00
adr-006-secret-store-replacement.md Update ADR 006 (#5326) 2019-11-19 09:51:39 +00:00
adr-007-specialization-groups.md Merge PR #4827: ADR 007 / 008: Specialization Groups Abstraction / CERT Group 2019-09-30 15:05:29 -04:00
adr-008-dCERT-group.md Merge PR #4827: ADR 007 / 008: Specialization Groups Abstraction / CERT Group 2019-09-30 15:05:29 -04:00
adr-009-evidence-module.md docs: link checker (#5860) 2020-03-24 11:21:30 +01:00
adr-010-modular-antehandler.md Merge PR #5006: Modular AnteDecorator 2019-10-10 08:46:09 -04:00
adr-011-generalize-genesis-accounts.md rename RegisterCodec to RegisterLegacyAminoCodec (#7243) 2020-09-07 14:47:12 +00:00
adr-012-state-accessors.md Rename *codec.Codec to *codec.LegacyAmino (#6991) 2020-08-10 19:41:21 +00:00
adr-013-metrics.md Merge PR #6761: telemetry: use UTC() in wrappers 2020-07-17 15:33:50 -04:00
adr-014-proportional-slashing.md Rename adt-014-proportional-slashing.md to adr-014-proportional-slashing.md 2020-03-10 15:27:53 -04:00
adr-015-ibc-packet-receiver.md x/ibc: IBC alpha (#5277) 2020-04-08 20:57:52 -04:00
adr-016-validator-consensus-key-rotation.md Merge PR #5233: ADR 016: Validator consensus key rotation 2020-01-05 16:57:18 -05:00
adr-017-historical-header-module.md Merge PR #5340: ADR 17: Historical header module 2019-12-04 10:18:02 -05:00
adr-018-extendable-voting-period.md Merge PR #5459: ADR 18: Extendable Governance Voting Periods 2020-02-04 11:23:49 -05:00
adr-019-protobuf-state-encoding.md Rename *codec.Codec to *codec.LegacyAmino (#6991) 2020-08-10 19:41:21 +00:00
adr-020-protobuf-transaction-encoding.md Remove the old message PublicKey proto oneof (#7390) 2020-09-29 10:01:54 +00:00
adr-021-protobuf-query-encoding.md client: rename CliContext to Context (#6290) 2020-06-01 12:46:03 +00:00
adr-022-custom-panic-handling.md ADR 022 - Custom baseapp panic handling (#6072) 2020-05-13 11:09:46 -04:00
adr-023-protobuf-naming.md rename blacklist to blocked (#6455) 2020-06-17 13:32:49 +00:00
adr-024-coin-metadata.md ADR 024 - Coin Metadata (#6253) 2020-06-07 01:05:22 +00:00
adr-025-ibc-passive-channels.md docs: ADR 025 for passive channels (#6250) 2020-06-08 01:07:00 -04:00
adr-026-ibc-client-recovery-mechanisms.md Merge PR #6488: Initial ADR for IBC client recovery mechanisms 2020-08-10 18:19:08 +02:00
adr-027-deterministic-protobuf-serialization.md Followup suggestions from ADR-027 updates (#7232) (#7379) 2020-09-28 09:42:57 +00:00
adr-template.md x/ibc-transfer: ADR001 source tracing implementation (#6871) 2020-08-14 17:46:26 -04:00
readme.md~origin_master-docs Merge PR #5379: New docs V1 (merge master-docs to master) 2019-12-10 09:29:46 -05:00

README.md

order parent
false
order
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