-
Notifications
You must be signed in to change notification settings - Fork 0
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
docs: docs update #57
Merged
Merged
Changes from 4 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7291b2b
docs update
deepakgudla f2daab4
docs update
deepakgudla d8a3b73
Merge branch 'teja/docs-update' of https://github.com/vitwit/cada int…
deepakgudla 4457050
Update README.md
deepakgudla 6a41745
Update README.md
deepakgudla f0a9067
Update README.md
deepakgudla 8da638d
Update README.md
deepakgudla File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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 | ||||
---|---|---|---|---|---|---|
|
@@ -10,18 +10,33 @@ Note: Ensure that the Avail light client URL is correctly configured for the mod | |||||
|
||||||
# How It Works | ||||||
|
||||||
`Cosmos Chain`: Initiates the process by running the PreBlocker ABCI method. | ||||||
|
||||||
`Request to Relayer`: Sends block range information to the relayer. | ||||||
|
||||||
`Relayer`: Fetches the block data from the Cosmos Provider and posts it to the Avail Light Client. | ||||||
|
||||||
`Avail Light Client`: Confirms whether the data is available. | ||||||
|
||||||
`If Yes`: Broadcast the Avail height and status. | ||||||
|
||||||
`If No`: Retry data submission. | ||||||
|
||||||
`Validators`: Vote to confirm the data availability, updating the status to "Ready" or "Failure" based on results. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
There are main components in the workflow: | ||||||
|
||||||
## 1. Cada | ||||||
The core functionality of the **Cada** module is integrated with and operates on the Cosmos blockchain. | ||||||
|
||||||
In the Cada module: | ||||||
- At each block interval, the `PreBlocker` ABCI method sends a request to the `Relayer`, specifying the range of block heights that are ready to be posted to the **Avail** Data Availability (DA) network. | ||||||
![Data Submission](https://github.com/user-attachments/assets/4e17b98f-ca8c-4b4c-a79e-8c60f123cb2c) | ||||||
![Data Submission](https://github.com/user-attachments/assets/fc4d23cc-f6bd-4210-8407-47a57adcc290) | ||||||
|
||||||
- The chain is responsible for aggregating vote extensions from all validators and verifying whether the data has been made available on Avail. | ||||||
- Since verification requires communicating with the light client, an asynchronous voting mechanism is needed. **Vote extensions** enable this asynchronous voting mechanism for verification purposes. | ||||||
|
||||||
![Vote Extension](https://github.com/user-attachments/assets/c0edb8e7-20fd-468a-9109-4f31718e4467) | ||||||
![Vote Extension](https://github.com/user-attachments/assets/ea5b10ab-fb64-4ed0-8761-44675a852a01) | ||||||
|
||||||
## 2. Relayer | ||||||
The **Relayer** facilitates communication between the Cosmos Chain, the Avail light client, and the Cosmos Provider. | ||||||
|
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.