Skip to content

Latest commit

 

History

History

architecture

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Architecture Decision Records (ADR)

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 # Description Status
001 Repository structure for ibc-rs Accepted
002 IBC Relayer in Rust Accepted
003 IBC handlers implementation Accepted
004 Relayer domain decomposition Accepted
005 Relayer v0 implementation Accepted
006 Hermes v0.2.0 Use-Cases Proposed
007 Error Management Accepted
008 ICS20 implementation Accepted
009 ChainEndpoint and ChainHandle methods standardization Accepted
010 Unified approach for CLI arguments for Hermes v1.0.0 Proposed
011 Light client crates extraction Proposed