cosmos-sdk/docs/architecture
Amaury Martiny 7cd25abb87
Proto Tx with Any (#7276)
* WIP on protobuf keys

* Use Type() and Bytes() in sr25519 pub key Equals

* Add tests

* Add few more tests

* Update other pub/priv key types Equals

* Fix PrivKey's Sign method

* Rename variables in tests

* Fix infinite recursive calls

* Use tm ed25519 keys

* Add Sign and VerifySignature tests

* Remove ed25519 and sr25519 references

* proto linting

* Add proto crypto file

* Implement some of the new multisig proto type methods

* Add tests for MultisigThresholdPubKey

* Add tests for pubkey pb/amino conversion functions

* Move crypto types.go and register new proto pubkeys

* Add missing pointer ref

* Address review comments

* panic in MultisigThresholdPubKey VerifySignature

* Use internal crypto.PubKey in multisig

* Add tests for MultisigThresholdPubKey VerifyMultisignature

* Only keep LegacyAminoMultisigThresholdPubKey and move to proto keys to v1

* Remove conversion functions and introduce internal PubKey type

* Override Amino marshaling for proto pubkeys

* Merge master

* Make proto-gen

* Start removal of old PubKeyMultisigThreshold references

* Fix tests

* Fix solomachine

* Fix ante handler tests

* Pull latest go-amino

* Remove ed25519

* Remove old secp256k1 PubKey and PrivKey

* Uncomment test case

* Fix linting issues

* More linting

* Revert tests keys values

* Add Amino overrides to proto keys

* Add pubkey test

* Fix tests

* Use threshold isntead of K

* Standardize Type

* Revert standardize types commit

* Fix build

* Fix lint

* Fix lint

* Add comment

* Register crypto.PubKey

* Add empty key in BuildSimTx

* Simplify proto names

* Unpack interfaces for signing desc

* Fix IBC tests?

* Format proto

* Use secp256k1 in ibc

* Fixed merge issues

* Uncomment tests

* Update x/ibc/testing/solomachine.go

* UnpackInterfaces for solomachine types

* Remove old multisig

* Add amino marshal for multisig

* Fix lint

* Correctly register amino

* One test left!

* Remove old struct

* Fix test

* Fix test

* Unpack into tmcrypto

* Remove old threshold pubkey tests

* Fix register amino

* Fix lint

* Use sdk crypto PubKey in multisig UnpackInterfaces

* Potential fix?

* Register LegacyAminoPubKey

* Register our own PubKey

* Register tmcrypto PubKey

* Register both PubKeys

* Register interfaces in test

* Refactor fiels

* Add comments

* Use anil's suggestion

* Add norace back

* Check nil

* Address comments

* FIx lint

* Add tests for solomachine unpack interfaces

* Fix query tx by hash

* Better name in amino register

* Display StdTx instead of proto Tx

* Remove useless check

Co-authored-by: Aaron Craelius <aaronc@users.noreply.github.com>
Co-authored-by: blushi <marie.gauthier63@gmail.com>
Co-authored-by: Alexander Bezobchuk <alexanderbez@users.noreply.github.com>
Co-authored-by: colin axnér <25233464+colin-axner@users.noreply.github.com>
2020-09-21 16:48:28 +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 Proto Tx with Any (#7276) 2020-09-21 16:48:28 +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 ADR-027: Make rules more precise (#7220) 2020-09-11 14:46:37 +00:00
adr-template.md x/ibc-transfer: ADR001 source tracing implementation (#6871) 2020-08-14 17:46:26 -04:00
README.md Propose ADR 027: Deterministic Protobuf Serialization (#6979) 2020-08-19 17:22:15 +00: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

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