Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clarify scope of IBC #197

Merged
merged 3 commits into from
Aug 17, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 7 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
@@ -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

Expand All @@ -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

Expand All @@ -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 |
| --------------------------------------------------- | ---------------------------------- | ----- |
Expand All @@ -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 |
| ------------------------------------------ | ----------------------- | ----- |
Expand Down
8 changes: 4 additions & 4 deletions spec/ics-001-ics-standard/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ stage: draft
category: meta
author: Christopher Goes <cwgoes@tendermint.com>
created: 2019-02-12
modified: 2019-04-11
modified: 2019-08-17
---

## What is an ICS?
Expand Down Expand Up @@ -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.
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion spec/ics-002-client-semantics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <joon@tendermint.com>, Christopher Goes <cwgoes@tendermint.com>
Expand Down
2 changes: 1 addition & 1 deletion spec/ics-003-connection-semantics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cwgoes@tendermint.com>, Juwoon Yun <joon@tendermint.com>
Expand Down
2 changes: 1 addition & 1 deletion spec/ics-004-channel-and-packet-semantics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cwgoes@tendermint.com>
created: 2019-03-07
Expand Down
2 changes: 1 addition & 1 deletion spec/ics-018-relayer-algorithms/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
ics: 18
title: Relayer Algorithms
stage: draft
category: ibc-core
category: IBC/TAO
requires: 24, 25, 26
author: Christopher Goes <cwgoes@tendermint.com>
created: 2019-03-07
Expand Down
2 changes: 1 addition & 1 deletion spec/ics-020-fungible-token-transfer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
ics: 20
title: Fungible Token Transfer
stage: draft
category: ibc-app
category: IBC/APP
requires: 25, 26
author: Christopher Goes <cwgoes@tendermint.com>
created: 2019-07-15
Expand Down
2 changes: 1 addition & 1 deletion spec/ics-023-vector-commitments/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cwgoes@tendermint.com>
created: 2019-04-16
modified: 2019-05-11
Expand Down
2 changes: 1 addition & 1 deletion spec/ics-024-host-requirements/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cwgoes@tendermint.com>
created: 2019-04-16
Expand Down
2 changes: 1 addition & 1 deletion spec/ics-025-handler-interface/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 <cwgoes@tendermint.com>
created: 2019-04-23
Expand Down
2 changes: 1 addition & 1 deletion spec/ics-026-relayer-module/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
ics: 26
title: Relayer Module
stage: Draft
category: ibc-core
category: IBC/TAO
author: Christopher Goes <cwgoes@tendermint.com>
created: 2019-06-09
modified: 2019-07-29
Expand Down