You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/neutron/modules/interchain-queries/api.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,12 +1,12 @@
1
1
# API
2
2
3
-
This page contains the `interchainqueries` module's interface description: the endpoints the module exposes and the `sudo` messages the module issues. Each endpoint is explained in a dedicated section with links to request and response models, and an example of interaction with the module via the endpoint. The links to the request and response models also provide more information about request parameters and response values.
3
+
This page describes the interface of the `interchainqueries` module, including the endpoints it provides and the `sudo` messages it issues. Each endpoint is detailed in its own section, with links to the request and response models, as well as examples of how to interact with the module using the endpoint. The request and response model links also offer more details about the request parameters and response values.
4
4
5
-
Please be aware that the examples do not necessarily reflect the current state on the chain; they are listed here only to visualize the request formation and response payload in a user-friendly way.
5
+
Please note that the examples are for demonstration purposes only and may not reflect the current state of the chain. They are included to help visualize how requests are formed and what the response payloads look like.
6
6
7
7
**Endpoints**
8
8
9
-
This section lists piblic RPC API of the `interchainqueries` module.
9
+
This section lists the public RPC API of the `interchainqueries` module.
10
10
11
11
Queries:
12
12
-[Params](#params);
@@ -24,7 +24,7 @@ Messages:
24
24
25
25
**Sudo**
26
26
27
-
This section lists `sudo` messages issued by the `interchainqueries` module to smart contracts owning Interchain Queries.
27
+
This section lists the `sudo` messages that the `interchainqueries` module sends to smart contracts that own Interchain Queries.
28
28
29
29
-[MessageTxQueryResult](#messagetxqueryresult)
30
30
-[MessageKvQueryResult](#messagekvqueryresult)
@@ -33,7 +33,7 @@ This section lists `sudo` messages issued by the `interchainqueries` module to s
33
33
34
34
### Params
35
35
36
-
Queries the current parameters of the module.
36
+
Fetches the current parameters of the`interchainqueries` module.
Registers a new Interchain Query in the `interchainqueries` module. This message is supposed to be issues only by a smart contract. The caller contract is charged a query registration deposit automatically in the amount defined as the module's query deposit parameter. The deposit is paid back on the query removal. Make sure to have enough assets on the contract's account at the time of the message execution.
269
+
Registers a new Interchain Query in the `interchainqueries` module. This message should only be issued by a smart contract. The calling contract is automatically charged a query registration deposit, based on the module's query deposit parameter. The deposit is refunded when the query is removed. Ensure the contract's account has sufficient assets at the time of message execution.
270
270
271
-
Returns an ID assigned to the registered query. Handle this message response via a reply handler in order to make use of the ID.
271
+
The response includes the ID assigned to the registered query. Use a reply handler to process this response and utilize the query ID.
Submits a result of an Interchain Query execution to the chain. This message handling may include passing of the result to the query's owner smart contract for processing which might be a pretty gas-consumable operation.
292
+
Submits the result of an Interchain Query execution to the chain. Handling this message may involve forwarding the result to the smart contract that owns the query for processing, which could require significant gas usage.
@@ -302,7 +302,7 @@ Submits a result of an Interchain Query execution to the chain. This message han
302
302
303
303
### RemoveInterchainQuery
304
304
305
-
Removes a given Interchain Query and its results from the module. Can be removed only by the owner of the query during the query's submit timeout, and by anyone after the query has been timed out. The query deposit is returned to the caller on a success call.
305
+
Removes a specific Interchain Query and its results from the module. The query can only be removed by its owner during the query's submit timeout. After the timeout, anyone can remove it. Upon successful removal, the query deposit is refunded to the caller.
@@ -341,7 +341,7 @@ Updates params of the interchainqueries module. Only callable by the module's au
341
341
342
342
### MessageTxQueryResult
343
343
344
-
MessageTxQueryResult is the model of the `sudo` message sent to a smart contract on a TX Interchain Query result submission. The owner of a TX Interchain Query must define a `sudo`entry_point for handling `tx_query_result` messages and place the needed logic there. The `tx_query_result` handler is treated by the `interchainqueries` module as a callback that is called each time a TX query result is submitted.
344
+
MessageTxQueryResult is the model of the `sudo` message sent to a smart contract when a TX Interchain Query result is submitted. The owner of a TX Interchain Query must implement a `sudo`entry point to handle `tx_query_result` messages and include the necessary logic in it. The `tx_query_result` handler functions as a callback, triggered by the `interchainqueries` module each time a TX query result is submitted.
-[Message model in neutron-sdk](https://docs.rs/neutron-sdk/0.11.0/neutron_sdk/sudo/msg/enum.SudoMsg.html#variant.TxQueryResult)
@@ -359,9 +359,9 @@ Events emission on failure:
359
359
360
360
### MessageKvQueryResult
361
361
362
-
MessageKVQueryResult is the model of the `sudo` message sent to a smart contract on a KV Interchain Query result submission. If the owner of a KV Interchain Query wants to handle the query updates, it must define a `sudo`entry_point for handling `kv_query_result` messages and place the needed logic there. The `kv_query_result` handler is treated by the `interchainqueries` module as a callback that is called each time a KV query result is submitted.
362
+
MessageKvQueryResult is the model of the `sudo` message sent to a smart contract when a KV Interchain Query result is submitted. If the owner of a KV Interchain Query wants to handle updates, they must implement a `sudo`entry point to process `kv_query_result` messages and include the necessary logic in it. The `kv_query_result` handler acts as a callback, triggered by the `interchainqueries` module whenever a KV query result is submitted.
363
363
364
-
Note that there is no query result sent, only the query ID. In order to access the actual result, use the Query/QueryResult RPC of the `interchainqueries` module.
364
+
Note that the message does not include the actual query result, only the query ID. To access the result data, use the `Query/QueryResult` RPC of the `interchainqueries` module.
0 commit comments