From 4e2f60718f647412bb165d6ae8bff2bb56776327 Mon Sep 17 00:00:00 2001 From: Christopher Goes Date: Sat, 17 Aug 2019 16:27:48 +0200 Subject: [PATCH] Merge PR #197: Clarify scope of IBC --- README.md | 16 +++++++--------- spec/ics-001-ics-standard/README.md | 8 ++++---- spec/ics-002-client-semantics/README.md | 2 +- spec/ics-003-connection-semantics/README.md | 2 +- .../README.md | 2 +- spec/ics-018-relayer-algorithms/README.md | 2 +- spec/ics-020-fungible-token-transfer/README.md | 2 +- spec/ics-023-vector-commitments/README.md | 2 +- spec/ics-024-host-requirements/README.md | 2 +- spec/ics-025-handler-interface/README.md | 2 +- spec/ics-026-relayer-module/README.md | 2 +- 11 files changed, 20 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index 8fd01f28d..bec4bfb09 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ -# Interchain Standards Development +# Interchain Standards ![banner](./assets/interchain-standards-image.jpg) ## Synopsis -This repository is the canonical location for development and documentation of inter-chain standards utilised by the Cosmos network & interchain ecosystem. Initially it will be used to consolidate design documentation for the inter-blockchain communication protocol (IBC), encoding standards for Cosmos chains, and miscellaneous utilities such as off-chain message signing. +This repository is the canonical location for development and documentation of inter-chain standards utilised by the Cosmos network & interchain ecosystem. It shall be used to consolidate design rationale, protocol semantics, and encoding descriptions for the inter-blockchain protocol (IBC), including both the core transport, authentication, & ordering layer (IBC/TAO) and the application layers describing packet encoding & processing semantics (IBC/APP). Contributions are welcome. + +The rendered, ordered set of all interchain standards written so far can be read as [a single PDF](./spec.pdf). ## Standardisation @@ -14,19 +16,15 @@ To propose a new standard, [open an issue](https://github.com/cosmos/ics/issues/ See [PROCESS.md](PROCESS.md) for a description of the standardisation process. -Quick references & interchain standards can be read as [a single PDF](./spec.pdf). - ## IBC Quick References -The subject of most initial interchain standards is the inter-blockchain communication protocol, "IBC". +If you are diving in or planning to review inter-blockchain communication protocol specifications, the following are required reading: -If you are diving in or planning to review specifications, the following are recommended reading: - [IBC Architecture](./ibc/1_IBC_ARCHITECTURE.md) - [IBC Design Principles](./ibc/2_IBC_DESIGN_PRINCIPLES.md) - [IBC Terminology](./ibc/3_IBC_TERMINOLOGY.md) - [IBC Usecases](./ibc/4_IBC_USECASES.md) - [IBC Design Patterns](./ibc/5_IBC_DESIGN_PATTERNS.md) -- [IBC specification progress tracking](https://github.com/cosmos/ics/issues/26) ## Interchain Standards @@ -38,7 +36,7 @@ All standards in the "draft" stage are listed here in order of their ICS numbers | ------------------------------ | -------------------------- | ----- | | [1](spec/ics-001-ics-standard) | ICS Specification Standard | Draft | -### IBC (Core) +### IBC/TAO | Interchain Standard Number | Standard Title | Stage | | --------------------------------------------------- | ---------------------------------- | ----- | @@ -52,7 +50,7 @@ All standards in the "draft" stage are listed here in order of their ICS numbers | [25](spec/ics-025-handler-interface) | Handler Interface | Draft | | [26](spec/ics-026-relayer-module) | Relayer Module | Draft | -### IBC (Application) +### IBC/APP | Interchain Standard Number | Standard Title | Stage | | ------------------------------------------ | ----------------------- | ----- | diff --git a/spec/ics-001-ics-standard/README.md b/spec/ics-001-ics-standard/README.md index 036a82e6e..849793021 100644 --- a/spec/ics-001-ics-standard/README.md +++ b/spec/ics-001-ics-standard/README.md @@ -5,7 +5,7 @@ stage: draft category: meta author: Christopher Goes created: 2019-02-12 -modified: 2019-04-11 +modified: 2019-08-17 --- ## What is an ICS? @@ -49,9 +49,8 @@ See [README.md](../../README.md) for a description of the ICS acceptance stages. `category` - ICS category, one of the following: - `meta` - A standard about the ICS process -- `ibc-core` - A standard about the inter-blockchain communication system core protocol. -- `ibc-app` - A standard about the inter-blockchain communication system application layer. -- `misc` - A standard about miscellaneous / auxiliary features, e.g. message signing +- `IBC/TAO` - A standard about an inter-blockchain communication system core transport, authentication, and ordering layer protocol. +- `IBC/APP` - A standard about an inter-blockchain communication system application layer protocol. `author` - ICS author(s) & contact information (in order of preference: email, GitHub handle, Twitter handle, other contact methods likely to elicit response). The first author is the primary "owner" of the ICS and is responsible for advancing it through the standardisation process. @@ -165,6 +164,7 @@ the ICS process. Please direct all comments to the ICS repository maintainers. March 4th, 2019: Initial draft finished and submitted as a PR March 7th, 2019: Draft merged April 11th, 2019: Updates to pseudocode formatting, add definitions subsection +August 17th, 2019: Clarifications to categories ## Copyright diff --git a/spec/ics-002-client-semantics/README.md b/spec/ics-002-client-semantics/README.md index 3da7171f8..f3369b0fd 100644 --- a/spec/ics-002-client-semantics/README.md +++ b/spec/ics-002-client-semantics/README.md @@ -2,7 +2,7 @@ ics: 2 title: Client Semantics stage: draft -category: ibc-core +category: IBC/TAO requires: 23, 24 required-by: 3 author: Juwoon Yun , Christopher Goes diff --git a/spec/ics-003-connection-semantics/README.md b/spec/ics-003-connection-semantics/README.md index 6faacc1a2..f4b7b841d 100644 --- a/spec/ics-003-connection-semantics/README.md +++ b/spec/ics-003-connection-semantics/README.md @@ -2,7 +2,7 @@ ics: 3 title: Connection Semantics stage: draft -category: ibc-core +category: IBC/TAO requires: 2, 23, 24 required-by: 4, 25 author: Christopher Goes , Juwoon Yun diff --git a/spec/ics-004-channel-and-packet-semantics/README.md b/spec/ics-004-channel-and-packet-semantics/README.md index c6702a692..f2d81a1ec 100644 --- a/spec/ics-004-channel-and-packet-semantics/README.md +++ b/spec/ics-004-channel-and-packet-semantics/README.md @@ -2,7 +2,7 @@ ics: 4 title: Channel & Packet Semantics stage: draft -category: ibc-core +category: IBC/TAO requires: 2, 3, 5, 23, 24 author: Christopher Goes created: 2019-03-07 diff --git a/spec/ics-018-relayer-algorithms/README.md b/spec/ics-018-relayer-algorithms/README.md index 1f0bd6af2..b3797355b 100644 --- a/spec/ics-018-relayer-algorithms/README.md +++ b/spec/ics-018-relayer-algorithms/README.md @@ -2,7 +2,7 @@ ics: 18 title: Relayer Algorithms stage: draft -category: ibc-core +category: IBC/TAO requires: 24, 25, 26 author: Christopher Goes created: 2019-03-07 diff --git a/spec/ics-020-fungible-token-transfer/README.md b/spec/ics-020-fungible-token-transfer/README.md index fa90bbd16..91d75d6b1 100644 --- a/spec/ics-020-fungible-token-transfer/README.md +++ b/spec/ics-020-fungible-token-transfer/README.md @@ -2,7 +2,7 @@ ics: 20 title: Fungible Token Transfer stage: draft -category: ibc-app +category: IBC/APP requires: 25, 26 author: Christopher Goes created: 2019-07-15 diff --git a/spec/ics-023-vector-commitments/README.md b/spec/ics-023-vector-commitments/README.md index 9fe5f18b0..3f1d71d2a 100644 --- a/spec/ics-023-vector-commitments/README.md +++ b/spec/ics-023-vector-commitments/README.md @@ -3,7 +3,7 @@ ics: 23 title: Vector Commitments stage: draft required-by: 2, 3, 4 -category: ibc-core +category: IBC/TAO author: Christopher Goes created: 2019-04-16 modified: 2019-05-11 diff --git a/spec/ics-024-host-requirements/README.md b/spec/ics-024-host-requirements/README.md index 40c5acb24..77c5b683e 100644 --- a/spec/ics-024-host-requirements/README.md +++ b/spec/ics-024-host-requirements/README.md @@ -2,7 +2,7 @@ ics: 24 title: Host State Machine Requirements stage: draft -category: ibc-core +category: IBC/TAO required-by: 2, 3, 4, 5, 18 author: Christopher Goes created: 2019-04-16 diff --git a/spec/ics-025-handler-interface/README.md b/spec/ics-025-handler-interface/README.md index d01bf06c2..7e0f693d0 100644 --- a/spec/ics-025-handler-interface/README.md +++ b/spec/ics-025-handler-interface/README.md @@ -2,7 +2,7 @@ ics: 25 title: Handler Interface stage: draft -category: ibc-core +category: IBC/TAO requires: 2, 3, 4, 23, 24 author: Christopher Goes created: 2019-04-23 diff --git a/spec/ics-026-relayer-module/README.md b/spec/ics-026-relayer-module/README.md index 99fd59908..142d76cd2 100644 --- a/spec/ics-026-relayer-module/README.md +++ b/spec/ics-026-relayer-module/README.md @@ -2,7 +2,7 @@ ics: 26 title: Relayer Module stage: Draft -category: ibc-core +category: IBC/TAO author: Christopher Goes created: 2019-06-09 modified: 2019-07-29