Merge pull request #165 from InjectiveLabs/feat/ibc_channel_module_qu…

…eries

Feat/ibc channel module queries

source/includes/_changelog.md

@@ -2,9 +2,10 @@
 
 ## 9999-99-99
 - Updated the API documentation to include all queries and messages for the `tendermint` module
-- Python SDK v1.5.0
+- Python SDK v1.6.0
   - Added support for all queries from the `tendermint` module
-  - Added support for all queries from the `IBC transfer` modulee
+  - Added support for all queries from the `IBC transfer` module
+  - Added support for all queries from the `IBC core channel` module
 
 ## 2024-03-08
 - Updated the API documentation to include all queries and messages for the `distribution` and `chain exchange` modules

source/includes/_ibctransfer.md

@@ -1,6 +1,6 @@
 # - IBC Transfer
 
-Includes all the messages and queries associated to transfers from the IBC chain module
+Includes all the messages and queries associated to transfers from the IBC transfer module
 
 ## DenomTrace
 

source/includes/_tendermint.md

@@ -698,7 +698,7 @@ No parameters
 **Data**
 
 <!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./source/json_tables/chain/tendermint/data.json) -->
-<table class="JSON-TO-HTML-TABLE"><thead><tr><th class="parameter-th">Parameter</th><th class="type-th">Type</th><th class="description-th">Description</th></tr></thead><tbody ><tr ><td class="parameter-td td_text">txs</td><td class="type-td td_text">Bytes Array</td><td class="description-td td_text">Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid.  We're just agreeing on the order first. This means that block.AppHash does not include these txs.</td></tr></tbody></table>
+<table class="JSON-TO-HTML-TABLE"><thead><tr><th class="parameter-th">Parameter</th><th class="type-th">Type</th><th class="description-th">Description</th></tr></thead><tbody ><tr ><td class="parameter-td td_text">txs</td><td class="type-td td_text">Byte Array</td><td class="description-td td_text">Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid.  We're just agreeing on the order first. This means that block.AppHash does not include these txs.</td></tr></tbody></table>
 <!-- MARKDOWN-AUTO-DOCS:END -->
 
 <br/>
@@ -1132,7 +1132,7 @@ func main() {
 **Data**
 
 <!-- MARKDOWN-AUTO-DOCS:START (JSON_TO_HTML_TABLE:src=./source/json_tables/chain/tendermint/data.json) -->
-<table class="JSON-TO-HTML-TABLE"><thead><tr><th class="parameter-th">Parameter</th><th class="type-th">Type</th><th class="description-th">Description</th></tr></thead><tbody ><tr ><td class="parameter-td td_text">txs</td><td class="type-td td_text">Bytes Array</td><td class="description-td td_text">Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid.  We're just agreeing on the order first. This means that block.AppHash does not include these txs.</td></tr></tbody></table>
+<table class="JSON-TO-HTML-TABLE"><thead><tr><th class="parameter-th">Parameter</th><th class="type-th">Type</th><th class="description-th">Description</th></tr></thead><tbody ><tr ><td class="parameter-td td_text">txs</td><td class="type-td td_text">Byte Array</td><td class="description-td td_text">Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid.  We're just agreeing on the order first. This means that block.AppHash does not include these txs.</td></tr></tbody></table>
 <!-- MARKDOWN-AUTO-DOCS:END -->
 
 <br/>

source/index.html.md

@@ -36,6 +36,7 @@ includes:
   - derivatives
   - spot
   - binaryoptions
+  - ibccorechannel
   - ibctransfer
   - insurance
   - oracle

source/json_tables/chain/ibc/core/channel/channel.json

@@ -0,0 +1,7 @@
+[
+    {"Parameter": "state", "Type": "State", "Description": "Current state of the channel end"},
+    {"Parameter": "ordering", "Type": "Order", "Description": "Whether the channel is ordered or unordered"},
+    {"Parameter": "counterparty", "Type": "Counterparty", "Description": "Counterparty channel end"},
+    {"Parameter": "connection_hops", "Type": "String Array", "Description": "List of connection identifiers, in order, along which packets sent on this channel will travel"},
+    {"Parameter": "version", "Type": "String", "Description": "Opaque channel version, which is agreed upon during the handshake"}
+]

source/json_tables/chain/ibc/core/channel/counterparty.json

@@ -0,0 +1,4 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port on the counterparty chain which owns the other end of the channel"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel end on the counterparty chain"}
+]

source/json_tables/chain/ibc/core/channel/identifiedChannel.json

@@ -0,0 +1,9 @@
+[
+    {"Parameter": "state", "Type": "State", "Description": "Current state of the channel end"},
+    {"Parameter": "ordering", "Type": "Order", "Description": "Whether the channel is ordered or unordered"},
+    {"Parameter": "counterparty", "Type": "Counterparty", "Description": "Counterparty channel end"},
+    {"Parameter": "connection_hops", "Type": "String Array", "Description": "List of connection identifiers, in order, along which packets sent on this channel will travel"},
+    {"Parameter": "version", "Type": "String", "Description": "Opaque channel version, which is agreed upon during the handshake"},
+    {"Parameter": "port_id", "Type": "String", "Description": "Port identifier"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel identifier"}
+]

source/json_tables/chain/ibc/core/channel/order.json

@@ -0,0 +1,5 @@
+[
+    {"Code": "0", "Name": "ORDER_NONE_UNSPECIFIED"},
+    {"Code": "1", "Name": "ORDER_UNORDERED"},
+    {"Code": "2", "Name": "ORDER_ORDERED"}
+]

source/json_tables/chain/ibc/core/channel/packetState.json

@@ -0,0 +1,6 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port identifier"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel identifier"},
+    {"Parameter": "sequence", "Type": "Integer", "Description": "Packet sequence"},
+    {"Parameter": "data", "Type": "Byte Array", "Description": "Embedded data that represents packet state"}
+]

source/json_tables/chain/ibc/core/channel/queryChannelClientStateRequest.json

@@ -0,0 +1,4 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"}
+]

source/json_tables/chain/ibc/core/channel/queryChannelClientStateResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "identified_client_state", "Type": "IdentifiedChannel", "Description": "Client state associated with the channel"},
+    {"Parameter": "proof", "Type": "Byte Array", "Description": "Merkle proof of existence"},
+    {"Parameter": "proof_height", "Type": "Height", "Description": "Height at which the proof was retrieved"}
+]

source/json_tables/chain/ibc/core/channel/queryChannelConsensusStateRequest.json

@@ -0,0 +1,6 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"},
+    {"Parameter": "revision_number", "Type": "Integer", "Description": "Revision number of the consensus state", "Required": "Yes"},
+    {"Parameter": "revision_height", "Type": "Integer", "Description": "Revision height of the consensus state", "Required": "Yes"}
+]

source/json_tables/chain/ibc/core/channel/queryChannelConsensusStateResponse.json

@@ -0,0 +1,6 @@
+[
+    {"Parameter": "consensus_state", "Type": "Any", "Description": "Consensus state associated with the channel"},
+    {"Parameter": "client_id", "Type": "String", "Description": "Client ID associated with the consensus state"},
+    {"Parameter": "proof", "Type": "Byte Array", "Description": "Merkle proof of existence"},
+    {"Parameter": "proof_height", "Type": "Height", "Description": "Height at which the proof was retrieved"}
+]

source/json_tables/chain/ibc/core/channel/queryChannelRequest.json

@@ -0,0 +1,4 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"}
+]

source/json_tables/chain/ibc/core/channel/queryChannelResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "channel", "Type": "Channel", "Description": "Channel details"},
+    {"Parameter": "proof", "Type": "Byte Array", "Description": "Merkle proof of existence"},
+    {"Parameter": "proof_height", "Type": "Height", "Description": "Height at which the proof was retrieved"}
+]

source/json_tables/chain/ibc/core/channel/queryChannelsRequest.json

@@ -0,0 +1,3 @@
+[
+    {"Parameter": "pagination", "Type": "PageRequest", "Description": "The optional pagination for the request", "Required": "No"}
+]

source/json_tables/chain/ibc/core/channel/queryChannelsResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "channels", "Type": "IdentifiedChannel Array", "Description": "List of channels"},
+    {"Parameter": "pagination", "Type": "PageResponse", "Description": "Pagination information in the response"},
+    {"Parameter": "height", "Type": "Height", "Description": "Query block height"}
+]

source/json_tables/chain/ibc/core/channel/queryConnectionChannelsRequest.json

@@ -0,0 +1,4 @@
+[
+    {"Parameter": "connection", "Type": "String", "Description": "Connection unique identifier", "Required": "Yes"},
+    {"Parameter": "pagination", "Type": "PageRequest", "Description": "The optional pagination for the request", "Required": "No"}
+]

source/json_tables/chain/ibc/core/channel/queryConnectionChannelsResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "channels", "Type": "IdentifiedChannel Array", "Description": "List of channels"},
+    {"Parameter": "pagination", "Type": "PageResponse", "Description": "Pagination information in the response"},
+    {"Parameter": "height", "Type": "Height", "Description": "Query block height"}
+]

source/json_tables/chain/ibc/core/channel/queryNextSequenceReceiveRequest.json

@@ -0,0 +1,4 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"}
+]

source/json_tables/chain/ibc/core/channel/queryNextSequenceReceiveResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "next_sequence_receive", "Type": "Integer", "Description": "Next sequence receive number"},
+    {"Parameter": "proof", "Type": "Byte Array", "Description": "Merkle proof of existence"},
+    {"Parameter": "proof_height", "Type": "Height", "Description": "Height at which the proof was retrieved"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementRequest.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"},
+    {"Parameter": "sequence", "Type": "Integer", "Description": "Packet sequence", "Required": "Yes"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "acknowledgement", "Type": "Byte Array", "Description": "Success flag to mark if the receipt exists"},
+    {"Parameter": "proof", "Type": "Byte Array", "Description": "Merkle proof of existence"},
+    {"Parameter": "proof_height", "Type": "Height", "Description": "Height at which the proof was retrieved"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementsRequest.json

@@ -0,0 +1,6 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"},
+    {"Parameter": "pagination", "Type": "PageRequest", "Description": "The optional pagination for the request", "Required": "No"},
+    {"Parameter": "packet_commitment_sequences", "Type": "Integer Array", "Description": "List of packet sequences", "Required": "No"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementsResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "acknowledgements", "Type": "PacketState Array", "Description": "Acknowledgements details"},
+    {"Parameter": "pagination", "Type": "PageResponse", "Description": "Pagination information in the response"},
+    {"Parameter": "height", "Type": "Height", "Description": "Query block height"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketCommitmentRequest.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"},
+    {"Parameter": "sequence", "Type": "Integer", "Description": "Packet sequence", "Required": "Yes"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketCommitmentResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "commitment", "Type": "Byte Array", "Description": "Packet associated with the request fields"},
+    {"Parameter": "proof", "Type": "Byte Array", "Description": "Merkle proof of existence"},
+    {"Parameter": "proof_height", "Type": "Height", "Description": "Height at which the proof was retrieved"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketCommitmentsRequest.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"},
+    {"Parameter": "pagination", "Type": "PageRequest", "Description": "The optional pagination for the request", "Required": "No"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketCommitmentsResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "commitments", "Type": "PacketState Array", "Description": "Commitments information"},
+    {"Parameter": "pagination", "Type": "PageResponse", "Description": "Pagination information in the response"},
+    {"Parameter": "height", "Type": "Height", "Description": "Query block height"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketReceiptRequest.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"},
+    {"Parameter": "sequence", "Type": "Integer", "Description": "Packet sequence", "Required": "Yes"}
+]

source/json_tables/chain/ibc/core/channel/queryPacketReceiptResponse.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "received", "Type": "Boolean", "Description": "Success flag to mark if the receipt exists"},
+    {"Parameter": "proof", "Type": "Byte Array", "Description": "Merkle proof of existence"},
+    {"Parameter": "proof_height", "Type": "Height", "Description": "Height at which the proof was retrieved"}
+]

source/json_tables/chain/ibc/core/channel/queryUnreceivedAcksRequest.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"},
+    {"Parameter": "packet_ack_sequences", "Type": "Integer Array", "Description": "List of acknowledgement sequences", "Required": "No"}
+]

source/json_tables/chain/ibc/core/channel/queryUnreceivedAcksResponse.json

@@ -0,0 +1,4 @@
+[
+    {"Parameter": "sequences", "Type": "Integer Array", "Description": "List of unreceived packet sequences"},
+    {"Parameter": "height", "Type": "Height", "Description": "Query block height"}
+]

source/json_tables/chain/ibc/core/channel/queryUnreceivedPacketsRequest.json

@@ -0,0 +1,5 @@
+[
+    {"Parameter": "port_id", "Type": "String", "Description": "Port unique identifier", "Required": "Yes"},
+    {"Parameter": "channel_id", "Type": "String", "Description": "Channel unique identifier", "Required": "Yes"},
+    {"Parameter": "packet_commitment_sequences", "Type": "Integer Array", "Description": "List of packet sequences", "Required": "No"}
+]

source/json_tables/chain/ibc/core/channel/queryUnreceivedPacketsResponse.json

@@ -0,0 +1,4 @@
+[
+    {"Parameter": "sequences", "Type": "Integer Array", "Description": "List of unreceived packet sequences"},
+    {"Parameter": "height", "Type": "Height", "Description": "Query block height"}
+]

source/json_tables/chain/ibc/core/channel/state.json

@@ -0,0 +1,7 @@
+[
+    {"Code": "0", "Name": "STATE_UNINITIALIZED_UNSPECIFIED"},
+    {"Code": "1", "Name": "STATE_INIT"},
+    {"Code": "2", "Name": "STATE_TRYOPEN"},
+    {"Code": "3", "Name": "STATE_OPEN"},
+    {"Code": "4", "Name": "STATE_CLOSED"}
+]

source/json_tables/chain/tendermint/data.json

@@ -1,3 +1,3 @@
 [
-    {"Parameter": "txs", "Type": "Bytes Array", "Description": "Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid.  We're just agreeing on the order first. This means that block.AppHash does not include these txs."}
+    {"Parameter": "txs", "Type": "Byte Array", "Description": "Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid.  We're just agreeing on the order first. This means that block.AppHash does not include these txs."}
 ]