-
Notifications
You must be signed in to change notification settings - Fork 38
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
feat: refactor ICQ module documentation [NTRN-349] #219
Open
sotnikov-s
wants to merge
36
commits into
main
Choose a base branch
from
feat/refactor-icq-module-documentation
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 1 commit
Commits
Show all changes
36 commits
Select commit
Hold shift + click to select a range
b40035e
redesign the ICQ module documentation
sotnikov-s 40cf0c3
remove target chain page
sotnikov-s 5e05801
Merge branch 'main' of github.com:neutron-org/neutron-docs into feat/…
sotnikov-s 7424e0f
Merge branch 'main' of github.com:neutron-org/neutron-docs into feat/…
sotnikov-s cf493d9
add a HowTo for chosing of connection ID for ICQ
sotnikov-s 11e0065
fix ICQs known bugs sidebar element path
sotnikov-s 4b29a30
add more explanations (IBC connection role, entry points, sudo calls,…
sotnikov-s d9bd882
add missing keywords highlighting
sotnikov-s b39ce02
fix misprints
sotnikov-s 0111af7
add tx filter determination howto section, add pruning mention in pri…
sotnikov-s 902e649
make steps in howtos headers
sotnikov-s 5ddbce1
add explanation section for TX query submitted results verification
sotnikov-s de05b73
rm interchainqueries TODO file
sotnikov-s df5fc29
remove -typed suffix for ICQ types
sotnikov-s cbfeb42
add a howto section for simple ICQ registration with contract code sn…
sotnikov-s cbdc0fa
refine KV ICQ registration howtos
sotnikov-s c0b24e7
move code snippets into details in interchainqueries howto
sotnikov-s c7666f6
add a how to section for TX ICQ
sotnikov-s a9995ab
update code links and polish KV and custom KV ICQ howtos
sotnikov-s 0dabdb7
add ToC and more Might be interesting links for ICQ docs
sotnikov-s b5e86bb
Merge branch 'main' of github.com:neutron-org/neutron-docs into feat/…
sotnikov-s 51ca9e3
fox links to ICQ module
sotnikov-s feb7f06
update msg type names
sotnikov-s 0ec51b7
update example of ICQ module params
sotnikov-s 4cfc026
minor fixes to ICQ module docs
sotnikov-s 3b32fa0
Merge branch 'main' of github.com:neutron-org/neutron-docs into feat/…
sotnikov-s 9983744
fix links to ICQ module for v4.0
sotnikov-s 46d7e03
update ICQ howto contract links
sotnikov-s 50d6f64
move link to RPC node configuration to a note for better visibility
sotnikov-s 3b2e8ed
apply ChatGPT for improving writing style and fixing grammar
sotnikov-s 70529f9
fix wording in ICS32 team mention
sotnikov-s 327d36a
put link to ICQ relayer explanation in ICQs explanation sections inst…
sotnikov-s 98d7214
add alternative way of finding events for transactions filter
sotnikov-s bbfa169
add links to neutron ICQ relayer implementation
sotnikov-s ad236dc
refactor how to find tx filter for gaia v21.0.0
sotnikov-s a7e13b2
add explanation section that highlights reliance of KV ICQ on target …
sotnikov-s 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 |
---|---|---|
|
@@ -17,7 +17,7 @@ Typical Flow of KV Interchain Queries Usage: | |
|
||
4. The smart contract registers a KV Interchain Query with the necessary set of keys. The registered query is saved in the `interchainqueries` module's state. | ||
|
||
5. An Interchain Query relayer reads the state of the `interchainqueries` module, finds the registered query and its parameters, and performs the `abci_query` RPC. This call returns a set of key-value pairs along with proofs from the `IAVL tree`. | ||
5. An [Interchain Query relayer](/neutron/modules/interchain-queries/explanation#what-is-an-interchain-query-relayer) reads the state of the `interchainqueries` module, finds the registered query and its parameters, and performs the `abci_query` RPC. This call returns a set of key-value pairs along with proofs from the `IAVL tree`. | ||
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. right now I think it works more like:
|
||
|
||
6. The relayer submits the key-value pairs and proofs to the `interchainqueries` module. This operation is called KV Interchain Query result submission. The module verifies the result using the proofs, stores it on-chain, and notifies the owning smart contract about the new result. | ||
|
||
|
@@ -28,7 +28,6 @@ Typical Flow of KV Interchain Queries Usage: | |
**Might be interesting:** | ||
- [How to register and handle a KV Interchain Query](/neutron/modules/interchain-queries/how-to#how-to-register-and-handle-a-kv-interchain-query) | ||
- [How to register and handle a KV Interchain Query with custom keys](/neutron/modules/interchain-queries/how-to#how-to-register-and-handle-a-kv-interchain-query-with-custom-keys) | ||
- [What is an Interchain Query relayer?](/neutron/modules/interchain-queries/explanation#what-is-an-interchain-query-relayer) | ||
|
||
## How do TX Interchain Queries work? | ||
swelf19 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
|
@@ -47,7 +46,7 @@ Typical Flow of TX Interchain Queries Usage: | |
|
||
4. The smart contract registers a TX Interchain Query with the specified set of transaction filters. The registered query is saved in the `interchainqueries` module's state. | ||
|
||
5. An Interchain Query relayer reads the state of the `interchainqueries` module, finds the registered query and its parameters, and performs the `tx_search` RPC. This call returns a list of transactions that match the filters and have been successfully processed on the remote chain. | ||
5. An [Interchain Query relayer](/neutron/modules/interchain-queries/explanation#what-is-an-interchain-query-relayer) reads the state of the `interchainqueries` module, finds the registered query and its parameters, and performs the `tx_search` RPC. This call returns a list of transactions that match the filters and have been successfully processed on the remote chain. | ||
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.
Or am i mistaken? |
||
|
||
6. The relayer submits the list of transactions along with a few headers for each transaction (used to verify the result) to the `interchainqueries` module. This operation is called TX Interchain Query result submission. The module verifies the result using the headers and passes the data to the owning smart contract. | ||
|
||
|
@@ -60,7 +59,6 @@ Typical Flow of TX Interchain Queries Usage: | |
- [How to find out what transaction filter to use](/neutron/modules/interchain-queries/how-to#how-to-find-out-what-transaction-filter-to-use) | ||
- [Why doesn't interchainqueries module store TX query results?](/neutron/modules/interchain-queries/explanation#why-doesnt-interchainqueries-module-store-tx-query-results) | ||
- [Why is it mandatory to do contract's side verification of submitted TX Interchain Query results?](/neutron/modules/interchain-queries/explanation#why-is-it-mandatory-to-do-contracts-side-verification-of-submitted-tx-interchain-query-results) | ||
- [What is an Interchain Query relayer?](/neutron/modules/interchain-queries/explanation#what-is-an-interchain-query-relayer) | ||
|
||
## What is an Interchain Query relayer? | ||
|
||
|
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.
?