Skip to content
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/ibc connection module queries #167

Merged
merged 5 commits into from
Jul 30, 2024
Merged

Conversation

aarmoa
Copy link
Contributor

@aarmoa aarmoa commented Apr 25, 2024

  • Added documentation for IBC Core Connection module queries

NOTE: Do not merge this PR until Python SDK v1.6.0 is released in master

Solves CHAIN-85

Summary by CodeRabbit

  • Documentation
    • Improved document layout with consistent formatting across multiple sections.
    • Updated the change log to reflect the latest support features in Python SDK v1.6.0.
    • Added new modules related to IBC and Tendermint to the documentation.
    • Introduced comprehensive JSON schemas to enhance API documentation and data interaction capabilities.

Copy link

coderabbitai bot commented Apr 25, 2024

Walkthrough

The recent updates focus on enhancing documentation and API interaction across various modules. Format improvements in multiple markdown files ensure better readability, while the addition of new modules and comprehensive JSON schemas in the IBC and Tendermint areas enhance functionality and clarity in data handling and API usage.

Changes

Files Change Summary
.../_account.md, .../_binaryoptions.md, .../_chainexchange.md, .../_derivatives.md, .../_spot.md, .../_staking.md Added <br/> tags for improved layout.
.../_changelog.md Updated to reflect new features in Python SDK v1.6.0.
source/index.html.md New modules added: ibccorechannel, ibccoreclient, ibccoreconnection, ibctransfer, tendermint.
.../chain/ibc/core/.../*.json, .../chain/tendermint/*.json Introduced comprehensive JSON schemas for enhanced API documentation.

🐇💻
In the garden of code, where the data trees grow,
A rabbit hopped in, with updates in tow.
With a flick of his tail, new schemas were planted,
And with <br/> tags, the docs were enchanted.
So hop along coders, explore with delight,
The fields of IBC under moon's soft light.


Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits Files that changed from the base of the PR and between 06bb030 and 06caa4c.
Files selected for processing (121)
  • source/includes/_account.md (28 hunks)
  • source/includes/_binaryoptions.md (53 hunks)
  • source/includes/_chainexchange.md (40 hunks)
  • source/includes/_changelog.md (1 hunks)
  • source/includes/_derivatives.md (97 hunks)
  • source/includes/_ibccoreclient.md (1 hunks)
  • source/includes/_ibccoreconnection.md (1 hunks)
  • source/includes/_ibctransfer.md (1 hunks)
  • source/includes/_spot.md (60 hunks)
  • source/includes/_staking.md (42 hunks)
  • source/index.html.md (1 hunks)
  • source/json_tables/chain/ibc/core/channel/channel.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/counterparty.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/identifiedChannel.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/order.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/packetState.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryChannelClientStateRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryChannelClientStateResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryChannelConsensusStateRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryChannelConsensusStateResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryChannelRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryChannelResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryChannelsRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryChannelsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryConnectionChannelsRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryConnectionChannelsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryNextSequenceReceiveRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryNextSequenceReceiveResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementsRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketCommitmentRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketCommitmentResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketCommitmentsRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketCommitmentsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketReceiptRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryPacketReceiptResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryUnreceivedAcksRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryUnreceivedAcksResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryUnreceivedPacketsRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/queryUnreceivedPacketsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/channel/state.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/consensusStateWithHeight.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/identifiedClientState.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/params.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryClientParamsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryClientStateRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryClientStateResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryClientStatesRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryClientStatesResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryClientStatusRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryClientStatusResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryConsensusStateHeightsRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryConsensusStateHeightsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryConsensusStateRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryConsensusStateResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryConsensusStatesRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryConsensusStatesResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryUpgradedClientStateResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/client/queryUpgradedConsensusStateResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/connectionEnd.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/counterparty.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/identifiedConnection.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/params.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryClientConnectionsRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryClientConnectionsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionClientStateRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionClientStateResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionConsensusStateRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionConsensusStateResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionParamsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionsRequest.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/queryConnectionsResponse.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/state.json (1 hunks)
  • source/json_tables/chain/ibc/core/connection/version.json (1 hunks)
  • source/json_tables/chain/ibc/core/height.json (1 hunks)
  • source/json_tables/chain/ibc/core/merklePrefix.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/denomTrace.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/msgTransfer.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryDenomHashRequest.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryDenomHashResponse.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryDenomTraceRequest.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryDenomTraceResponse.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryDenomTracesRequest.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryDenomTracesResponse.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryEscrowAddressRequest.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryEscrowAddressResponse.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryTotalEscrowForDenomRequest.json (1 hunks)
  • source/json_tables/chain/ibc/transfer/queryTotalEscrowForDenomResponse.json (1 hunks)
  • source/json_tables/chain/tendermint/abciQueryRequest.json (1 hunks)
  • source/json_tables/chain/tendermint/abciQueryResponse.json (1 hunks)
  • source/json_tables/chain/tendermint/block.json (1 hunks)
  • source/json_tables/chain/tendermint/blockID.json (1 hunks)
  • source/json_tables/chain/tendermint/blockIDFlag.json (1 hunks)
  • source/json_tables/chain/tendermint/commit.json (1 hunks)
  • source/json_tables/chain/tendermint/commitSig.json (1 hunks)
  • source/json_tables/chain/tendermint/consensus.json (1 hunks)
  • source/json_tables/chain/tendermint/data.json (1 hunks)
  • source/json_tables/chain/tendermint/defaultNodeInfo.json (1 hunks)
  • source/json_tables/chain/tendermint/defaultNodeInfoOther.json (1 hunks)
  • source/json_tables/chain/tendermint/evidence.json (1 hunks)
  • source/json_tables/chain/tendermint/evidenceList.json (1 hunks)
  • source/json_tables/chain/tendermint/getBlockByHeightRequest.json (1 hunks)
  • source/json_tables/chain/tendermint/getBlockByHeightResponse.json (1 hunks)
  • source/json_tables/chain/tendermint/getLatestBlockResponse.json (1 hunks)
  • source/json_tables/chain/tendermint/getLatestValidatorSetResponse.json (1 hunks)
  • source/json_tables/chain/tendermint/getNodeInfoResponse.json (1 hunks)
  • source/json_tables/chain/tendermint/getSyncingResponse.json (1 hunks)
  • source/json_tables/chain/tendermint/getValidatorSetByHeightRequest.json (1 hunks)
  • source/json_tables/chain/tendermint/getValidatorSetByHeightResponse.json (1 hunks)
  • source/json_tables/chain/tendermint/header.json (1 hunks)
  • source/json_tables/chain/tendermint/module.json (1 hunks)
  • source/json_tables/chain/tendermint/partSetHeader.json (1 hunks)
  • source/json_tables/chain/tendermint/proofOp.json (1 hunks)
  • source/json_tables/chain/tendermint/proofOps.json (1 hunks)
  • source/json_tables/chain/tendermint/protocolVersion.json (1 hunks)
  • source/json_tables/chain/tendermint/validator.json (1 hunks)
  • source/json_tables/chain/tendermint/versionInfo.json (1 hunks)
Files not summarized due to errors (3)
  • source/includes/_ibccoreclient.md: Error: Message exceeds token limit
  • source/includes/_ibccoreconnection.md: Error: Message exceeds token limit
  • source/includes/_ibctransfer.md: Error: Message exceeds token limit
Files skipped from review due to trivial changes (39)
  • source/json_tables/chain/ibc/core/channel/identifiedChannel.json
  • source/json_tables/chain/ibc/core/channel/order.json
  • source/json_tables/chain/ibc/core/channel/packetState.json
  • source/json_tables/chain/ibc/core/channel/queryChannelConsensusStateRequest.json
  • source/json_tables/chain/ibc/core/channel/queryNextSequenceReceiveRequest.json
  • source/json_tables/chain/ibc/core/channel/queryNextSequenceReceiveResponse.json
  • source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementResponse.json
  • source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementsRequest.json
  • source/json_tables/chain/ibc/core/channel/queryPacketCommitmentRequest.json
  • source/json_tables/chain/ibc/core/channel/queryPacketCommitmentsResponse.json
  • source/json_tables/chain/ibc/core/channel/queryPacketReceiptResponse.json
  • source/json_tables/chain/ibc/core/channel/queryUnreceivedAcksRequest.json
  • source/json_tables/chain/ibc/core/channel/queryUnreceivedAcksResponse.json
  • source/json_tables/chain/ibc/core/channel/queryUnreceivedPacketsRequest.json
  • source/json_tables/chain/ibc/core/channel/state.json
  • source/json_tables/chain/ibc/core/client/identifiedClientState.json
  • source/json_tables/chain/ibc/core/client/queryClientStatesResponse.json
  • source/json_tables/chain/ibc/core/client/queryClientStatusResponse.json
  • source/json_tables/chain/ibc/core/client/queryConsensusStateHeightsResponse.json
  • source/json_tables/chain/ibc/core/client/queryConsensusStatesRequest.json
  • source/json_tables/chain/ibc/core/client/queryConsensusStatesResponse.json
  • source/json_tables/chain/ibc/core/connection/counterparty.json
  • source/json_tables/chain/ibc/core/connection/queryConnectionParamsResponse.json
  • source/json_tables/chain/ibc/core/connection/queryConnectionResponse.json
  • source/json_tables/chain/ibc/core/connection/queryConnectionsResponse.json
  • source/json_tables/chain/ibc/core/connection/state.json
  • source/json_tables/chain/ibc/core/merklePrefix.json
  • source/json_tables/chain/ibc/transfer/denomTrace.json
  • source/json_tables/chain/ibc/transfer/queryDenomTraceRequest.json
  • source/json_tables/chain/ibc/transfer/queryDenomTraceResponse.json
  • source/json_tables/chain/ibc/transfer/queryDenomTracesResponse.json
  • source/json_tables/chain/tendermint/block.json
  • source/json_tables/chain/tendermint/blockIDFlag.json
  • source/json_tables/chain/tendermint/commit.json
  • source/json_tables/chain/tendermint/evidenceList.json
  • source/json_tables/chain/tendermint/getLatestValidatorSetResponse.json
  • source/json_tables/chain/tendermint/proofOps.json
  • source/json_tables/chain/tendermint/validator.json
  • source/json_tables/chain/tendermint/versionInfo.json
Additional comments not posted (123)
source/json_tables/chain/tendermint/getSyncingResponse.json (1)

1-3: The JSON schema for the syncing status is correctly defined and well-documented.

source/json_tables/chain/ibc/core/client/queryClientParamsResponse.json (1)

1-3: Verify the type "params" used in the JSON schema. If it's a custom type, consider adding a reference or explanation for clarity.

source/json_tables/chain/ibc/transfer/queryTotalEscrowForDenomResponse.json (1)

1-3: The JSON schema for the total escrow amount is correctly defined and well-documented.

source/json_tables/chain/ibc/transfer/queryTotalEscrowForDenomRequest.json (1)

1-3: The JSON schema for the request to query the total escrow amount for a specific token denomination is correctly defined and well-documented.

source/json_tables/chain/tendermint/getBlockByHeightRequest.json (1)

1-3: The JSON schema for the request to get a block by its height is correctly defined and well-documented.

source/json_tables/chain/ibc/transfer/queryEscrowAddressResponse.json (1)

1-3: The JSON schema for the escrow account address is correctly defined and well-documented.

source/json_tables/chain/ibc/core/client/queryClientStatusRequest.json (1)

1-3: The JSON schema for the request to query a client's status is correctly defined and well-documented.

source/json_tables/chain/ibc/core/connection/queryConnectionClientStateRequest.json (1)

1-3: The JSON schema for the request to query a connection's client state is correctly defined and well-documented.

source/json_tables/chain/ibc/core/client/queryClientStateRequest.json (1)

1-3: The JSON schema for queryClientStateRequest is correctly defined with the necessary details for the client_id parameter.

source/json_tables/chain/ibc/core/connection/queryConnectionRequest.json (1)

1-3: The JSON schema for queryConnectionRequest is correctly defined with the necessary details for the connection_id parameter.

source/json_tables/chain/ibc/core/channel/queryChannelsRequest.json (1)

1-3: The JSON schema for queryChannelsRequest correctly defines the optional pagination parameter with appropriate type and description.

source/json_tables/chain/ibc/core/client/queryClientStatesRequest.json (1)

1-3: The JSON schema for queryClientStatesRequest correctly defines the optional pagination parameter with appropriate type and description.

source/json_tables/chain/ibc/core/connection/queryConnectionsRequest.json (1)

1-3: The JSON schema for queryConnectionsRequest correctly defines the optional pagination parameter with appropriate type and description.

source/json_tables/chain/ibc/transfer/queryDenomTracesRequest.json (1)

1-3: The JSON schema for queryDenomTracesRequest correctly defines the optional pagination parameter with appropriate type and description.

source/json_tables/chain/ibc/core/connection/queryClientConnectionsRequest.json (1)

2-2: The "client_id" parameter is well-defined and marked as required, which is appropriate for its usage.

source/json_tables/chain/ibc/core/client/queryUpgradedConsensusStateResponse.json (1)

2-2: The "upgraded_consensus_state" parameter is appropriately typed as "Any" and has a clear description.

source/json_tables/chain/ibc/transfer/queryDenomHashRequest.json (1)

2-2: The "trace" parameter is well-defined and marked as required, with a clear description of its format.

source/json_tables/chain/tendermint/blockID.json (1)

2-2: The "hash" parameter is appropriately typed as "Bytes" and has a clear description.

source/json_tables/chain/tendermint/evidence.json (1)

2-2: The "sum" parameter is appropriately typed as "isEvidence_Sum" and has a clear description of the valid types.

source/json_tables/chain/tendermint/getBlockByHeightResponse.json (2)

2-2: The "block_id" parameter is appropriately typed as "BlockID" and has a clear description.


3-3: The "sdk_block" parameter is appropriately typed as "Block" and has a clear description.

source/json_tables/chain/tendermint/getLatestBlockResponse.json (1)

1-4: The JSON schema for the latest block response is correctly formatted and provides clear parameter descriptions.

source/json_tables/chain/ibc/core/client/consensusStateWithHeight.json (1)

1-4: The JSON schema for consensus state with height is well-structured and provides clear parameter descriptions.

source/json_tables/chain/tendermint/defaultNodeInfoOther.json (1)

1-4: The JSON schema for default node information is correctly formatted and provides clear parameter descriptions.

source/json_tables/chain/ibc/core/channel/queryUnreceivedPacketsResponse.json (1)

1-4: The JSON schema for querying unreceived packets is well-structured and provides clear parameter descriptions.

source/json_tables/chain/tendermint/getNodeInfoResponse.json (1)

1-4: The JSON schema for getting node information is well-structured and provides clear parameter descriptions.

source/json_tables/chain/ibc/core/channel/queryChannelClientStateRequest.json (1)

1-4: The JSON schema for querying channel client state is well-structured and provides clear parameter descriptions, including the required status.

source/json_tables/chain/ibc/core/channel/queryChannelRequest.json (1)

1-4: The JSON schema for queryChannelRequest is correctly defined with clear and necessary parameters.

source/json_tables/chain/ibc/core/connection/version.json (1)

1-4: The JSON schema for version is well-defined, with appropriate types and descriptions for each parameter.

source/json_tables/chain/ibc/transfer/queryEscrowAddressRequest.json (1)

1-4: The JSON schema for queryEscrowAddressRequest is correctly defined, ensuring clarity and consistency with other IBC-related schemas.

source/json_tables/chain/tendermint/getValidatorSetByHeightRequest.json (1)

1-4: The JSON schema for getValidatorSetByHeightRequest is well-structured, with clear parameter definitions and appropriate data types.

source/json_tables/chain/tendermint/module.json (1)

1-5: The JSON schema for module information is correctly defined, with clear descriptions and types for each parameter.

source/json_tables/chain/ibc/core/height.json (1)

1-4: The JSON schema for height is well-defined, with appropriate integer types and clear descriptions.

source/json_tables/chain/ibc/core/client/queryConsensusStateHeightsRequest.json (1)

1-4: The JSON schema for queryConsensusStateHeightsRequest is correctly defined, with necessary parameters and clear descriptions.

source/json_tables/chain/ibc/core/channel/counterparty.json (1)

1-4: The JSON schema for counterparty is well-defined, maintaining consistency with other IBC-related schemas and providing clear parameter descriptions.

source/json_tables/chain/ibc/core/channel/queryConnectionChannelsRequest.json (1)

1-4: The JSON structure for the queryConnectionChannelsRequest is clear and well-defined.

source/json_tables/chain/ibc/core/channel/queryChannelResponse.json (1)

1-5: The JSON structure for the queryChannelResponse is clear and well-defined, appropriately including proof-related parameters.

source/json_tables/chain/tendermint/getValidatorSetByHeightResponse.json (1)

1-5: The JSON structure for the getValidatorSetByHeightResponse is clear and well-defined, appropriately including pagination details.

source/json_tables/chain/ibc/core/channel/queryChannelsResponse.json (1)

1-5: The JSON structure for the queryChannelsResponse is clear and well-defined, appropriately including pagination and height details.

source/json_tables/chain/ibc/core/channel/queryConnectionChannelsResponse.json (1)

1-5: The JSON structure for the queryConnectionChannelsResponse is clear and well-defined, appropriately including pagination and height details.

source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementsResponse.json (1)

1-5: The JSON structure for the queryPacketAcknowledgementsResponse is clear and well-defined, appropriately including pagination and height details.

source/json_tables/chain/ibc/core/client/params.json (1)

1-3: The JSON structure for the IBC core client params is clear and well-defined, providing crucial information about client restrictions.

source/json_tables/chain/ibc/core/channel/queryPacketCommitmentResponse.json (1)

2-4: The JSON schema definitions are clear and well-structured. Each parameter's type and description are appropriately detailed.

source/json_tables/chain/ibc/core/channel/queryPacketAcknowledgementRequest.json (1)

2-4: The JSON schema definitions are clear and well-structured. Each parameter's type, description, and requirement status are appropriately detailed.

source/json_tables/chain/ibc/core/channel/queryPacketReceiptRequest.json (1)

2-4: The JSON schema definitions are clear and well-structured. Each parameter's type, description, and requirement status are appropriately detailed.

source/json_tables/chain/ibc/core/client/queryClientStateResponse.json (1)

2-4: The JSON schema definitions are clear and well-structured. Each parameter's type and description are appropriately detailed.

source/json_tables/chain/ibc/core/client/queryConsensusStateResponse.json (1)

2-4: The JSON schema definitions are clear and well-structured. Each parameter's type and description are appropriately detailed.

source/json_tables/chain/ibc/core/connection/queryClientConnectionsResponse.json (1)

2-4: The JSON schema definitions are clear and well-structured. Each parameter's type and description are appropriately detailed.

source/json_tables/chain/ibc/core/channel/queryChannelClientStateResponse.json (1)

2-4: The JSON schema definitions are clear and well-structured. Each parameter's type and description are appropriately detailed.

source/json_tables/chain/ibc/core/connection/queryConnectionClientStateResponse.json (1)

2-4: The JSON schema definitions are clear and well-structured. Each parameter's type and description are appropriately detailed.

source/json_tables/chain/tendermint/commitSig.json (1)

5-5: LGTM! The structure and descriptions for other parameters are clear and concise.

source/json_tables/chain/ibc/core/channel/queryPacketCommitmentsRequest.json (1)

2-4: LGTM! The parameters are well-defined, and the required fields are appropriately marked.

source/json_tables/chain/ibc/core/connection/queryConnectionConsensusStateRequest.json (1)

2-4: LGTM! The parameters are well-defined, and the required fields are appropriately marked.

source/json_tables/chain/ibc/core/channel/queryChannelConsensusStateResponse.json (1)

2-5: LGTM! The parameters are well-defined, and the descriptions are clear.

source/json_tables/chain/ibc/core/connection/queryConnectionConsensusStateResponse.json (1)

2-5: LGTM! The parameters are well-defined, and the descriptions are clear.

source/json_tables/chain/ibc/core/channel/channel.json (1)

1-7: The JSON structure for IBC channel parameters is well-formed and clear. Each parameter's type and description are appropriate and provide necessary details for SDK users.

source/json_tables/chain/ibc/core/connection/connectionEnd.json (1)

1-7: The JSON structure for IBC connection parameters is well-formed and clear. Each parameter's type and description are appropriate and provide necessary details for SDK users.

source/json_tables/chain/tendermint/abciQueryResponse.json (1)

1-11: The JSON structure for Tendermint ABCI query response parameters is well-formed and clear. Each parameter's type and description are appropriate and provide necessary details for SDK users.

source/json_tables/chain/ibc/core/connection/identifiedConnection.json (1)

1-8: The JSON structure for identified IBC connection parameters is well-formed and clear. Each parameter's type and description are appropriate and provide necessary details for SDK users.

source/json_tables/chain/tendermint/defaultNodeInfo.json (1)

1-10: The JSON structure for default node information parameters is well-formed and clear. Each parameter's type and description are appropriate and provide necessary details for SDK users.

source/index.html.md (1)

39-46: The inclusion of new IBC and Tendermint modules in the documentation index is correctly formatted and follows the existing structure. This update will help users find information about these new modules easily.

source/json_tables/chain/ibc/transfer/msgTransfer.json (1)

1-10: The JSON structure for IBC transfer message parameters is well-formed and clear. Each parameter's type and description are appropriate and provide necessary details for SDK users.

source/json_tables/chain/tendermint/header.json (1)

1-16: The JSON structure for Tendermint block header parameters is well-formed and clear. Each parameter's type and description are appropriate and provide necessary details for SDK users.

source/includes/_spot.md (60)

152-152: Ensure consistent use of HTML line breaks for spacing in documentation.


169-169: Ensure consistent use of HTML line breaks for spacing in documentation.


323-323: Ensure consistent use of HTML line breaks for spacing in documentation.


340-340: Ensure consistent use of HTML line breaks for spacing in documentation.


509-509: Ensure consistent use of HTML line breaks for spacing in documentation.


518-518: Ensure consistent use of HTML line breaks for spacing in documentation.


535-535: Ensure consistent use of HTML line breaks for spacing in documentation.


547-547: Ensure consistent use of HTML line breaks for spacing in documentation.


709-709: Ensure consistent use of HTML line breaks for spacing in documentation.


718-718: Ensure consistent use of HTML line breaks for spacing in documentation.


735-735: Ensure consistent use of HTML line breaks for spacing in documentation.


747-747: Ensure consistent use of HTML line breaks for spacing in documentation.


891-891: Ensure consistent use of HTML line breaks for spacing in documentation.


927-927: Ensure consistent use of HTML line breaks for spacing in documentation.


1113-1113: Ensure consistent use of HTML line breaks for spacing in documentation.


1320-1320: Ensure consistent use of HTML line breaks for spacing in documentation.


1491-1491: Ensure consistent use of HTML line breaks for spacing in documentation.


1653-1653: Ensure consistent use of HTML line breaks for spacing in documentation.


1994-1994: Ensure consistent use of HTML line breaks for spacing in documentation.


2014-2014: Ensure consistent use of HTML line breaks for spacing in documentation.


2024-2024: Ensure consistent use of HTML line breaks for spacing in documentation.


2033-2033: Ensure consistent use of HTML line breaks for spacing in documentation.


2042-2042: Ensure consistent use of HTML line breaks for spacing in documentation.


2052-2052: Ensure consistent use of HTML line breaks for spacing in documentation.


2320-2320: Ensure consistent use of HTML line breaks for spacing in documentation.


2331-2331: Ensure consistent use of HTML line breaks for spacing in documentation.


2343-2343: Ensure consistent use of HTML line breaks for spacing in documentation.


2389-2389: Ensure consistent use of HTML line breaks for spacing in documentation.


2409-2409: Ensure consistent use of HTML line breaks for spacing in documentation.


2419-2419: Ensure consistent use of HTML line breaks for spacing in documentation.


2428-2428: Ensure consistent use of HTML line breaks for spacing in documentation.


2437-2437: Ensure consistent use of HTML line breaks for spacing in documentation.


2447-2447: Ensure consistent use of HTML line breaks for spacing in documentation.


2712-2712: Ensure consistent use of HTML line breaks for spacing in documentation.


2723-2723: Ensure consistent use of HTML line breaks for spacing in documentation.


2735-2735: Ensure consistent use of HTML line breaks for spacing in documentation.


2781-2781: Ensure consistent use of HTML line breaks for spacing in documentation.


2801-2801: Ensure consistent use of HTML line breaks for spacing in documentation.


2811-2811: Ensure consistent use of HTML line breaks for spacing in documentation.


2820-2820: Ensure consistent use of HTML line breaks for spacing in documentation.


2829-2829: Ensure consistent use of HTML line breaks for spacing in documentation.


2839-2839: Ensure consistent use of HTML line breaks for spacing in documentation.


3067-3067: Ensure consistent use of HTML line breaks for spacing in documentation.


3087-3087: Ensure consistent use of HTML line breaks for spacing in documentation.


3097-3097: Ensure consistent use of HTML line breaks for spacing in documentation.


3106-3106: Ensure consistent use of HTML line breaks for spacing in documentation.


3115-3115: Ensure consistent use of HTML line breaks for spacing in documentation.


3125-3125: Ensure consistent use of HTML line breaks for spacing in documentation.


3509-3509: Ensure consistent use of HTML line breaks for spacing in documentation.


3521-3521: Ensure consistent use of HTML line breaks for spacing in documentation.


3532-3532: Ensure consistent use of HTML line breaks for spacing in documentation.


3544-3544: Ensure consistent use of HTML line breaks for spacing in documentation.


3559-3559: Ensure consistent use of HTML line breaks for spacing in documentation.


3571-3571: Ensure consistent use of HTML line breaks for spacing in documentation.


3625-3625: Ensure consistent use of HTML line breaks for spacing in documentation.


3645-3645: Ensure consistent use of HTML line breaks for spacing in documentation.


3655-3655: Ensure consistent use of HTML line breaks for spacing in documentation.


3664-3664: Ensure consistent use of HTML line breaks for spacing in documentation.


3673-3673: Ensure consistent use of HTML line breaks for spacing in documentation.


3683-3683: Ensure consistent use of HTML line breaks for spacing in documentation.


Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai generate interesting stats about this repository and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

Comment on lines +1 to +5
[
{"Parameter": "p2p", "Type": "Integer", "Description": ""},
{"Parameter": "block", "Type": "Integer", "Description": ""},
{"Parameter": "app", "Type": "Integer", "Description": ""}
]
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please add descriptions for the parameters "p2p", "block", and "app" to enhance clarity and usability of the schema.

{"Parameter": "data", "Type": "Bytes", "Description": "Query data", "Required": "No"},
{"Parameter": "path", "Type": "String", "Description": "Query path", "Required": "Yes"},
{"Parameter": "haight", "Type": "Integer", "Description": "Block height", "Required": "No"},
{"Parameter": "prove", "Type": "Boolean", "Description": "", "Required": "No"}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a description for the "prove" parameter to enhance clarity.

Comment on lines +234 to +256
import asyncio

from google.protobuf import symbol_database

from pyinjective.async_client import AsyncClient
from pyinjective.client.model.pagination import PaginationOption
from pyinjective.core.network import Network


async def main() -> None:
network = Network.testnet()
client = AsyncClient(network)

pagination = PaginationOption(skip=2, limit=4)

states = await client.fetch_ibc_client_states(pagination=pagination)
print(states)


if __name__ == "__main__":
symbol_db = symbol_database.Default()
asyncio.get_event_loop().run_until_complete(main())
```
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ensure proper error handling in the Python example for querying all IBC light clients. Currently, exceptions such as network failures or invalid parameters are not handled.

+ try:
    states = await client.fetch_ibc_client_states(pagination=pagination)
    print(states)
+ except Exception as e:
+     print(f"An error occurred: {e}")

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
import asyncio
from google.protobuf import symbol_database
from pyinjective.async_client import AsyncClient
from pyinjective.client.model.pagination import PaginationOption
from pyinjective.core.network import Network
async def main() -> None:
network = Network.testnet()
client = AsyncClient(network)
pagination = PaginationOption(skip=2, limit=4)
states = await client.fetch_ibc_client_states(pagination=pagination)
print(states)
if __name__ == "__main__":
symbol_db = symbol_database.Default()
asyncio.get_event_loop().run_until_complete(main())
```
import asyncio
from google.protobuf import symbol_database
from pyinjective.async_client import AsyncClient
from pyinjective.client.model.pagination import PaginationOption
from pyinjective.core.network import Network
async def main() -> None:
network = Network.testnet()
client = AsyncClient(network)
pagination = PaginationOption(skip=2, limit=4)
try:
states = await client.fetch_ibc_client_states(pagination=pagination)
print(states)
except Exception as e:
print(f"An error occurred: {e}")
if __name__ == "__main__":
symbol_db = symbol_database.Default()
asyncio.get_event_loop().run_until_complete(main())

Comment on lines +279 to +330
func main() {
network := common.LoadNetwork("testnet", "lb")
tmClient, err := rpchttp.New(network.TmEndpoint, "/websocket")
if err != nil {
panic(err)
}

senderAddress, cosmosKeyring, err := chainclient.InitCosmosKeyring(
os.Getenv("HOME")+"/.injectived",
"injectived",
"file",
"inj-user",
"12345678",
"5d386fbdbf11f1141010f81a46b40f94887367562bd33b452bbaa6ce1cd1381e", // keyring will be used if pk not provided
false,
)

if err != nil {
panic(err)
}

clientCtx, err := chainclient.NewClientContext(
network.ChainId,
senderAddress.String(),
cosmosKeyring,
)

if err != nil {
panic(err)
}

clientCtx = clientCtx.WithNodeURI(network.TmEndpoint).WithClient(tmClient)

chainClient, err := chainclient.NewChainClient(
clientCtx,
network,
common.OptionGasPrices(client.DefaultGasPriceWithDenom),
)

if err != nil {
panic(err)
}

pagination := query.PageRequest{Offset: 2, Limit: 4}
ctx := context.Background()

res, err := chainClient.FetchIBCClientStates(ctx, &pagination)
if err != nil {
fmt.Println(err)
}

fmt.Print(res)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the Go example, consider handling the error right after the json.MarshalIndent function to check for serialization issues when querying all IBC light clients.

+ str, err := json.MarshalIndent(res, "", " ")
+ if err != nil {
+     fmt.Println("Error marshalling response:", err)
+     return
+ }
  fmt.Print(string(str))

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
func main() {
network := common.LoadNetwork("testnet", "lb")
tmClient, err := rpchttp.New(network.TmEndpoint, "/websocket")
if err != nil {
panic(err)
}
senderAddress, cosmosKeyring, err := chainclient.InitCosmosKeyring(
os.Getenv("HOME")+"/.injectived",
"injectived",
"file",
"inj-user",
"12345678",
"5d386fbdbf11f1141010f81a46b40f94887367562bd33b452bbaa6ce1cd1381e", // keyring will be used if pk not provided
false,
)
if err != nil {
panic(err)
}
clientCtx, err := chainclient.NewClientContext(
network.ChainId,
senderAddress.String(),
cosmosKeyring,
)
if err != nil {
panic(err)
}
clientCtx = clientCtx.WithNodeURI(network.TmEndpoint).WithClient(tmClient)
chainClient, err := chainclient.NewChainClient(
clientCtx,
network,
common.OptionGasPrices(client.DefaultGasPriceWithDenom),
)
if err != nil {
panic(err)
}
pagination := query.PageRequest{Offset: 2, Limit: 4}
ctx := context.Background()
res, err := chainClient.FetchIBCClientStates(ctx, &pagination)
if err != nil {
fmt.Println(err)
}
fmt.Print(res)
func main() {
network := common.LoadNetwork("testnet", "lb")
tmClient, err := rpchttp.New(network.TmEndpoint, "/websocket")
if err != nil {
panic(err)
}
senderAddress, cosmosKeyring, err := chainclient.InitCosmosKeyring(
os.Getenv("HOME")+"/.injectived",
"injectived",
"file",
"inj-user",
"12345678",
"5d386fbdbf11f1141010f81a46b40f94887367562bd33b452bbaa6ce1cd1381e", // keyring will be used if pk not provided
false,
)
if err != nil {
panic(err)
}
clientCtx, err := chainclient.NewClientContext(
network.ChainId,
senderAddress.String(),
cosmosKeyring,
)
if err != nil {
panic(err)
}
clientCtx = clientCtx.WithNodeURI(network.TmEndpoint).WithClient(tmClient)
chainClient, err := chainclient.NewChainClient(
clientCtx,
network,
common.OptionGasPrices(client.DefaultGasPriceWithDenom),
)
if err != nil {
panic(err)
}
pagination := query.PageRequest{Offset: 2, Limit: 4}
ctx := context.Background()
res, err := chainClient.FetchIBCClientStates(ctx, &pagination)
if err != nil {
fmt.Println(err)
}
str, err := json.MarshalIndent(res, "", " ")
if err != nil {
fmt.Println("Error marshalling response:", err)
return
}
fmt.Print(string(str))
}

@@ -0,0 +1,3 @@
[
{"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."}
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider clarifying the description of "txs" to ensure users understand the implications of the transactions not being validated at this stage.

- "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."
+ "Description": "Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid. Transactions are ordered first, and validity is assessed later. This means that block.AppHash does not include these txs."

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change
{"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."}
{"Parameter": "txs", "Type": "Byte Array", "Description": "Txs that will be applied by state @ block.Height+1. NOTE: not all txs here are valid. Transactions are ordered first, and validity is assessed later. This means that block.AppHash does not include these txs."}

@@ -133,6 +133,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -183,6 +184,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -339,6 +341,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -478,6 +481,7 @@ No parameters
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -487,6 +491,7 @@ No parameters
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -671,6 +676,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -679,6 +685,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -856,6 +863,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -864,6 +872,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -872,6 +881,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1014,6 +1024,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1161,6 +1172,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1169,6 +1181,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1444,6 +1457,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1607,6 +1621,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1615,6 +1630,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1940,6 +1956,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1949,6 +1966,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -2403,6 +2421,7 @@ No parameters
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for section titles to improve document structure and accessibility.

@@ -1459,6 +1477,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "PerpetualMarketInfo".

Using emphasis (**PerpetualMarketInfo**) instead of a proper heading (e.g., ### PerpetualMarketInfo) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -1470,6 +1489,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "PerpetualMarketFunding".

Using emphasis (**PerpetualMarketFunding**) instead of a proper heading (e.g., ### PerpetualMarketFunding) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -1479,6 +1499,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "ExpiryFuturesMarketInfo".

Using emphasis (**ExpiryFuturesMarketInfo**) instead of a proper heading (e.g., ### ExpiryFuturesMarketInfo) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -1771,6 +1792,7 @@ No parameters
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "DerivativePosition".

Using emphasis (**DerivativePosition**) instead of a proper heading (e.g., ### DerivativePosition) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -1780,6 +1802,7 @@ No parameters
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "Position".

Using emphasis (**Position**) instead of a proper heading (e.g., ### Position) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -1993,6 +2016,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "DerivativePosition".

Using emphasis (**DerivativePosition**) instead of a proper heading (e.g., ### DerivativePosition) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -2002,6 +2026,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "Position".

Using emphasis (**Position**) instead of a proper heading (e.g., ### Position) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -2168,6 +2193,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "Position".

Using emphasis (**Position**) instead of a proper heading (e.g., ### Position) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -2333,6 +2359,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "EffectivePosition".

Using emphasis (**EffectivePosition**) instead of a proper heading (e.g., ### EffectivePosition) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -2480,6 +2507,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "PerpetualMarketInfo".

Using emphasis (**PerpetualMarketInfo**) instead of a proper heading (e.g., ### PerpetualMarketInfo) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -2620,6 +2648,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "ExpiryFuturesMarketInfo".

Using emphasis (**ExpiryFuturesMarketInfo**) instead of a proper heading (e.g., ### ExpiryFuturesMarketInfo) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -2766,6 +2795,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "PerpetualMarketFunding".

Using emphasis (**PerpetualMarketFunding**) instead of a proper heading (e.g., ### PerpetualMarketFunding) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -2925,6 +2955,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "TrimmedDerivativeConditionalOrder".

Using emphasis (**TrimmedDerivativeConditionalOrder**) instead of a proper heading (e.g., ### TrimmedDerivativeConditionalOrder) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3141,6 +3172,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "OracleType".

Using emphasis (**OracleType**) instead of a proper heading (e.g., ### OracleType) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3170,6 +3202,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "TxResponse".

Using emphasis (**TxResponse**) instead of a proper heading (e.g., ### TxResponse) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3189,6 +3222,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "ABCIMessageLog".

Using emphasis (**ABCIMessageLog**) instead of a proper heading (e.g., ### ABCIMessageLog) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3198,6 +3232,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "Event".

Using emphasis (**Event**) instead of a proper heading (e.g., ### Event) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3206,6 +3241,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "StringEvent".

Using emphasis (**StringEvent**) instead of a proper heading (e.g., ### StringEvent) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3214,6 +3250,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "EventAttribute".

Using emphasis (**EventAttribute**) instead of a proper heading (e.g., ### EventAttribute) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3223,6 +3260,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "Attribute".

Using emphasis (**Attribute**) instead of a proper heading (e.g., ### Attribute) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3437,6 +3475,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "OracleType".

Using emphasis (**OracleType**) instead of a proper heading (e.g., ### OracleType) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3466,6 +3505,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "TxResponse".

Using emphasis (**TxResponse**) instead of a proper heading (e.g., ### TxResponse) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3485,6 +3525,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "ABCIMessageLog".

Using emphasis (**ABCIMessageLog**) instead of a proper heading (e.g., ### ABCIMessageLog) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3494,6 +3535,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "Event".

Using emphasis (**Event**) instead of a proper heading (e.g., ### Event) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3502,6 +3544,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "StringEvent".

Using emphasis (**StringEvent**) instead of a proper heading (e.g., ### StringEvent) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3510,6 +3553,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "EventAttribute".

Using emphasis (**EventAttribute**) instead of a proper heading (e.g., ### EventAttribute) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3519,6 +3563,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "Attribute".

Using emphasis (**Attribute**) instead of a proper heading (e.g., ### Attribute) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@@ -3786,6 +3831,7 @@ func main() {
<!-- MARKDOWN-AUTO-DOCS:END -->

<br/>

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider using a heading instead of emphasis for "DerivativeOrder".

Using emphasis (**DerivativeOrder**) instead of a proper heading (e.g., ### DerivativeOrder) might affect the document's structure and readability, especially in markdown renderers that use headings to generate navigation menus.

@aarmoa aarmoa merged commit 387d3f3 into main Jul 30, 2024
6 checks passed
@aarmoa aarmoa deleted the feat/ibc_connection_module_queries branch July 30, 2024 19:08
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant