Architecture Decision Records (ADR)

July 21, 2022 ยท View on GitHub

This is a location to record all high-level architecture decisions in the IBC-RS project.

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 is or should be.

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.

To suggest an ADR, please make use of the ADR template provided.

Table of Contents

ADR #DescriptionStatus
001Repository structure for ibc-rsAccepted
002IBC Relayer in RustAccepted
003IBC handlers implementationAccepted
004Relayer domain decompositionAccepted
005Relayer v0 implementationAccepted
006Hermes v0.2.0 Use-CasesProposed
007Error ManagementAccepted
008ICS20 implementationAccepted
009ChainEndpoint and ChainHandle methods standardizationAccepted
010Unified approach for CLI arguments for Hermes v1.0.0Proposed
011Light client crates extractionProposed