-
Notifications
You must be signed in to change notification settings - Fork 129
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add docs/build folder * add module structure * add provider messages to docs -- wip * add message description to docs * add provider params * add consumer params * remove params.md * fix links * add overview * add IBC channel handshake * add OnRecvPacket * move democracy module to build/modules * remove duplicate democracy module page * add begin/end-block info * udpate intro section * add info on provider state * add consumer state * add state intro * add TODOs * add CLI * WIP - add provider CLI, gRPC, REST docs * fix typos * add consumer docs wip * provider docs nits * consumer docs nits * consumer docs improvement * merge main * add collapsible sections * update overview * docs: fix broken docs; cleanup versions (#2321) * docs: update config and supported verisons * fix broken config * fix broken version import * add back missing image * expand toc level * fix broken link --------- Co-authored-by: Simon Noetzlin <[email protected]> Co-authored-by: MSalopek <[email protected]>
- Loading branch information
1 parent
6aced39
commit d0a1398
Showing
26 changed files
with
4,650 additions
and
343 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,7 +5,7 @@ release/ | |
docs/tla/states/ | ||
*.out | ||
vendor/ | ||
build/ | ||
/build/ | ||
.vscode | ||
.idea | ||
__debug_* | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
{ | ||
"label": "Build", | ||
"position": 3 | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
sidebar_position: 1 | ||
--- | ||
|
||
# Overview | ||
|
||
ICS consists of two main modules: | ||
|
||
* [x/provider](./02-provider.md) | ||
* Provides to consumer chains updated information of opted in validators. | ||
* Distributes ICS rewards to opted in validators. | ||
* Jails and slashes validators that misbehave on consumer chains. | ||
* [x/consumer](./03-consumer.md) | ||
* Sends to the consensus engine the validator sets received from the provider chain. | ||
* Splits consumer block rewards and sends ICS rewards to the provider chain. | ||
* Notifies the provider chain of downtime infractions. | ||
|
||
Note that `x/types` contains types shared by both modules. | ||
|
||
In addition, the following modules are added to ICS to extend its functionality: | ||
|
||
* [x/democracy](04-democracy.md) |
Oops, something went wrong.