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 transfer module queries #164

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

aarmoa
Copy link
Contributor

@aarmoa aarmoa commented Apr 17, 2024

  • Added documentation for IBC Transfer module queries

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

Solves CHAIN-76

Summary by CodeRabbit

  • New Features

    • Added support for queries from the tendermint and IBC transfer modules in the Python SDK v1.5.0.
    • Introduced new JSON schema files for IBC transfer functionalities like denom tracing, token transfers, and escrow account queries.
    • Expanded the JSON schema files for Tendermint to include block, transaction, and consensus details.
    • Included new topics ibctransfer and tendermint in the documentation index.
  • Documentation

    • Improved Markdown documentation by adding structural elements like line breaks and JSON-to-HTML table conversions for better readability and data presentation.
  • Style

    • Enhanced formatting in multiple Markdown files for clarity and visual appeal.

Copy link

coderabbitai bot commented Apr 17, 2024

Walkthrough

The recent updates primarily involve the addition of JSON schema definitions for various blockchain functionalities, focusing on IBC transfer and Tendermint specifics. Additionally, there are cosmetic changes like line breaks in Markdown files and new JSON table conversions, all aimed at enhancing documentation and SDK support.

Changes

File Path Change Summary
source/includes/_account.md, source/includes/_binaryoptions.md, source/includes/_chainexchange.md, source/includes/_derivatives.md, source/includes/_spot.md, source/includes/_staking.md Added struct definitions, JSON table conversions, and line breaks for formatting.
source/includes/_changelog.md, source/index.html.md Updated changelog and index to include new SDK support and topics.
source/json_tables/chain/ibc/..., source/json_tables/chain/tendermint/... Introduced numerous JSON schemas detailing structures and queries for IBC transfer and Tendermint functionalities.

Poem

🐇✨
In the world of code and chain,
New JSON paths, we ascertain.
Through the docs, we hop and leap,
Tendermint secrets, we now keep.
Celebrate, for changes are sown,
In blockchain fields, where seeds have grown. 🌱
🐇✨


Recent Review Details

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 76c84b4 and 443ae68.
Files selected for processing (51)
  • 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/_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/height.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 (1)
  • source/includes/_ibctransfer.md: Error: Message exceeds token limit
Files skipped from review due to trivial changes (14)
  • source/json_tables/chain/ibc/transfer/queryDenomTraceResponse.json
  • source/json_tables/chain/ibc/transfer/queryDenomTracesResponse.json
  • source/json_tables/chain/ibc/transfer/queryEscrowAddressResponse.json
  • source/json_tables/chain/ibc/transfer/queryTotalEscrowForDenomResponse.json
  • source/json_tables/chain/tendermint/block.json
  • source/json_tables/chain/tendermint/evidenceList.json
  • source/json_tables/chain/tendermint/getBlockByHeightRequest.json
  • source/json_tables/chain/tendermint/getSyncingResponse.json
  • source/json_tables/chain/tendermint/getValidatorSetByHeightResponse.json
  • source/json_tables/chain/tendermint/header.json
  • source/json_tables/chain/tendermint/module.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 (284)
source/json_tables/chain/ibc/transfer/queryTotalEscrowForDenomRequest.json (1)

2-2: Consider enhancing the description for "denom" to provide more context about what "Token denom" refers to, possibly including examples or a more detailed explanation.

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

2-2: Consider specifying the expected format of the "hash" in the description, such as whether it should be in hexadecimal, base64, etc., to avoid confusion.

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

2-2: The description for "hash" could be improved by adding more context about what this hash represents and how it is used within the system.

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

2-2: Consider expanding the description for "pagination" to explain how pagination is handled, what the default values are, and how it affects the response.

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

2-2: Consider specifying the expected format of the "trace" in the description, such as the expected structure of port_id, channel_id, and denom, to avoid confusion.

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

2-2: Ensure the type 'isEvidence_Sum' is well-documented elsewhere in the SDK or documentation.

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

2-3: LGTM! The parameters are clearly defined and appropriate for the context.

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

2-3: LGTM! Consistent with similar endpoints, ensuring a uniform API response structure.

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

2-3: LGTM! The parameters are clearly defined and appropriate for the IBC transfer module context.

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

2-3: LGTM! The parameters are clearly defined and relevant for node information.

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

2-4: Please add descriptions for 'type', 'key', and 'data' parameters to enhance clarity and usability.

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

2-4: Please add descriptions for 'p2p', 'block', and 'app' parameters to enhance clarity and usability.

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

2-5: LGTM! The block ID flags are clearly defined and appropriate for the context.

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

1-4: LGTM! The JSON schema for node information is well-defined and clear.

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

1-4: LGTM! The JSON schema for querying escrow addresses is correctly defined with required parameters.

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

1-4: LGTM! The JSON schema for requesting validator sets by height is well-structured and includes appropriate parameters.

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

1-4: LGTM! The JSON schema for IBC core height data is accurately defined and clear.

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

1-3: LGTM! The JSON schema for transaction data in the Tendermint module is well-defined and includes a detailed description.

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

1-5: LGTM! The JSON schema for the latest validator set response is comprehensive and clearly defined.

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

1-6: LGTM! The JSON schema for commit data in the Tendermint module is well-structured and includes all necessary parameters.

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

1-6: LGTM! The JSON schema for commit signatures in the Tendermint module is comprehensive and clearly defined.

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

2-2: LGTM! The parameter "data" is well-defined.


3-3: LGTM! The parameter "path" is well-defined.

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

9-9: LGTM! The parameter "height" is well-defined.

source/index.html.md (2)

39-39: LGTM! The inclusion of "ibctransfer" in the documentation topics is appropriate.


43-43: LGTM! The inclusion of "tendermint" in the documentation topics is appropriate.

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

2-2: LGTM! The parameter "protocol_version" is well-defined.


4-4: LGTM! The parameter "listen_addr" is well-defined.


5-5: LGTM! The parameter "network" is well-defined.


6-6: LGTM! The parameter "version" is well-defined.


7-7: LGTM! The parameter "channels" is well-defined.


9-9: LGTM! The parameter "other" is well-defined.

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

2-2: LGTM! The parameter "source_port" is well-defined.


3-3: LGTM! The parameter "source_channel" is well-defined.


4-4: LGTM! The parameter "token" is well-defined.


5-5: LGTM! The parameter "sender" is well-defined.


6-6: LGTM! The parameter "receiver" is well-defined.


7-7: LGTM! The parameter "timeout_height" is well-defined.


8-8: LGTM! The parameter "timeout_timestamp" is well-defined.


9-9: LGTM! The parameter "memo" is well-defined.

source/includes/_changelog.md (1)

8-8: LGTM! The changelog entry for the distribution and chain exchange modules is accurate.

source/includes/_ibctransfer.md (19)

5-5: Consider correcting the possible spelling mistake: "transfers from the IBC chain module".


6-6: Consider adding a comma after "DenomTrace" for better readability.


150-150: Consider using a heading instead of emphasis for "DenomTrace".


158-158: Consider correcting the possible spelling mistake: "Queries all denomination traces".


279-279: Consider using a heading instead of emphasis for "PageRequest".


326-326: Consider using a heading instead of emphasis for "PageResponse".


334-334: Consider correcting the possible spelling mistake: "Queries a denomination hash information".


335-335: Consider adding a comma after "DenomHash" for better readability.


469-469: Consider correcting the possible spelling mistake: "Returns the escrow address for a particular port and channel id".


471-471: Consider using "ID" in uppercase when referring to "identification".


603-603: Consider correcting the possible spelling mistake: "Returns the total amount of tokens in escrow based on the denom".


605-605: Consider using "number of tokens" instead of "amount of tokens" if referring to countable items.


746-746: Consider correcting the possible spelling mistake: "Defines a msg to transfer fungible tokens".


748-748: Consider using "i.e.," instead of "i.e" for correct abbreviation punctuation.


956-956: Consider using a heading instead of emphasis for "TxResponse".


976-976: Consider using a heading instead of emphasis for "ABCIMessageLog".


995-995: Consider using a heading instead of emphasis for "StringEvent".


1004-1004: Consider using a heading instead of emphasis for "EventAttribute".


1014-1014: Consider using a heading instead of emphasis for "Attribute".

source/includes/_account.md (21)

197-197: Ensure consistency in the use of terminology in documentation.

Consider using "token denomination" instead of "token denom" for clarity and professionalism in the documentation.


229-229: Ensure consistency in the use of terminology in documentation.

Consider using "transaction response" instead of "TxResponse" for clarity and professionalism in the documentation.


249-249: Ensure consistency in the use of terminology in documentation.

Consider using "ABCI message log" instead of "ABCIMessageLog" for clarity and professionalism in the documentation.


259-259: Ensure consistency in the use of terminology in documentation.

Consider using "string event" instead of "StringEvent" for clarity and professionalism in the documentation.


268-268: Ensure consistency in the use of terminology in documentation.

Consider using "event attribute" instead of "EventAttribute" for clarity and professionalism in the documentation.


Line range hint 296-296: Ensure consistency in the use of terminology in documentation.

Consider using "token denomination" instead of "token denom" for clarity and professionalism in the documentation.


518-518: Ensure consistency in the use of terminology in documentation.

Consider using "transaction response" instead of "TxResponse" for clarity and professionalism in the documentation.


538-538: Ensure consistency in the use of terminology in documentation.

Consider using "ABCI message log" instead of "ABCIMessageLog" for clarity and professionalism in the documentation.


557-557: Ensure consistency in the use of terminology in documentation.

Consider using "string event" instead of "StringEvent" for clarity and professionalism in the documentation.


566-566: Ensure consistency in the use of terminology in documentation.

Consider using "event attribute" instead of "EventAttribute" for clarity and professionalism in the documentation.


Line range hint 584-584: Ensure consistency in the use of terminology in documentation.

Consider using "token denomination" instead of "token denom" for clarity and professionalism in the documentation.


816-816: Ensure consistency in the use of terminology in documentation.

Consider using "transaction response" instead of "TxResponse" for clarity and professionalism in the documentation.


836-836: Ensure consistency in the use of terminology in documentation.

Consider using "ABCI message log" instead of "ABCIMessageLog" for clarity and professionalism in the documentation.


855-855: Ensure consistency in the use of terminology in documentation.

Consider using "string event" instead of "StringEvent" for clarity and professionalism in the documentation.


864-864: Ensure consistency in the use of terminology in documentation.

Consider using "event attribute" instead of "EventAttribute" for clarity and professionalism in the documentation.


Line range hint 882-882: Ensure consistency in the use of terminology in documentation.

Consider using "token denomination" instead of "token denom" for clarity and professionalism in the documentation.


1114-1114: Ensure consistency in the use of terminology in documentation.

Consider using "transaction response" instead of "TxResponse" for clarity and professionalism in the documentation.


1134-1134: Ensure consistency in the use of terminology in documentation.

Consider using "ABCI message log" instead of "ABCIMessageLog" for clarity and professionalism in the documentation.


1153-1153: Ensure consistency in the use of terminology in documentation.

Consider using "string event" instead of "StringEvent" for clarity and professionalism in the documentation.


1162-1162: Ensure consistency in the use of terminology in documentation.

Consider using "event attribute" instead of "EventAttribute" for clarity and professionalism in the documentation.


Line range hint 1180-1180: Ensure consistency in the use of terminology in documentation.

Consider using "token denomination" instead of "token denom" for clarity and professionalism in the documentation.

source/includes/_staking.md (17)

143-143: Consider adding a blank line before the **DecCoin** section for better readability and consistency with other sections.


284-284: Consider adding a blank line before the **ValidatorOutstandingRewards** section for better readability and consistency with other sections.


292-292: Consider adding a blank line before the **DecCoin** section for better readability and consistency with other sections.


433-433: Consider adding a blank line before the **ValidatorAccumulatedCommission** section for better readability and consistency with other sections.


441-441: Consider adding a blank line before the **DecCoin** section for better readability and consistency with other sections.


573-573: Consider adding a blank line before the **PageRequest** section for better readability and consistency with other sections.


597-597: Consider adding a blank line before the **ValidatorSlashEvent** section for better readability and consistency with other sections.


606-606: Consider adding a blank line before the **PageResponse** section for better readability and consistency with other sections.


750-750: Consider adding a blank line before the **DecCoin** section for better readability and consistency with other sections.


927-927: Consider adding a blank line before the **DelegationDelegatorReward** section for better readability and consistency with other sections.


936-936: Consider adding a blank line before the **DecCoin** section for better readability and consistency with other sections.


1331-1331: Consider adding a blank line before the **DecCoin** section for better readability and consistency with other sections.


1500-1500: Consider adding a blank line before the **TxResponse** section for better readability and consistency with other sections.


1520-1520: Consider adding a blank line before the **ABCIMessageLog** section for better readability and consistency with other sections.


1539-1539: Consider adding a blank line before the **StringEvent** section for better readability and consistency with other sections.


1548-1548: Consider adding a blank line before the **EventAttribute** section for better readability and consistency with other sections.


1558-1558: Consider adding a blank line before the **Attribute** section for better readability and consistency with other sections.

source/includes/_binaryoptions.md (5)

Line range hint 1-11: LGTM! The introductory section and the BinaryOptionsMarkets documentation are clear and well-structured.


133-139: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [136-160]

LGTM! The BinaryOptionsMarket table is correctly formatted and informative.


380-386: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [161-383]

LGTM! The OracleType table is correctly formatted and provides essential information clearly.


410-416: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [384-603]

LGTM! The documentation for MsgInstantBinaryOptionsMarketLaunch is comprehensive and includes clear examples.


612-618: > 📝 NOTE

This review was outside the diff hunks and was mapped to the diff hunk with the greatest overlap. Original lines [604-1189]

LGTM! The documentation for MsgCreateBinaryOptionsLimitOrder, MsgCreateBinaryOptionsMarketOrder, and MsgCancelBinaryOptionsOrder is detailed and includes practical examples.

source/includes/_chainexchange.md (40)

136-136: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


187-187: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


344-344: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


484-484: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


494-494: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


679-679: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


688-688: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


866-866: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


875-875: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


884-884: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


1027-1027: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


1175-1175: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


1184-1184: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


1460-1460: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


1624-1624: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


1633-1633: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


1959-1959: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


1969-1969: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


2424-2424: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


2435-2435: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


2444-2444: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


2455-2455: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


2613-2613: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


2624-2624: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


2823-2823: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


2835-2835: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


3090-3090: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


3243-3243: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


3416-3416: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


3836-3836: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


3845-3845: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4266-4266: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4315-4315: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4331-4331: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4663-4663: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4683-4683: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4693-4693: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4702-4702: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4711-4711: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.


4721-4721: Consider using Markdown headings instead of bold for section titles to improve document structure and navigation.

source/includes/_spot.md (60)

152-152: Consider using a heading tag for "SpotMarket" to improve document structure and accessibility.


169-169: Consider using a heading tag for "MarketStatus" to improve document structure and accessibility.


323-323: Consider using a heading tag for "SpotMarket" to improve document structure and accessibility.


340-340: Consider using a heading tag for "MarketStatus" to improve document structure and accessibility.


509-509: Consider using a heading tag for "FullSpotMarket" to improve document structure and accessibility.


518-518: Consider using a heading tag for "SpotMarket" to improve document structure and accessibility.


535-535: Consider using a heading tag for "MarketStatus" to improve document structure and accessibility.


547-547: Consider using a heading tag for "MidPriceAndTOB" to improve document structure and accessibility.


709-709: Consider using a heading tag for "FullSpotMarket" to improve document structure and accessibility.


718-718: Consider using a heading tag for "SpotMarket" to improve document structure and accessibility.


735-735: Consider using a heading tag for "MarketStatus" to improve document structure and accessibility.


747-747: Consider using a heading tag for "MidPriceAndTOB" to improve document structure and accessibility.


891-891: Consider using a heading tag for "OrderSide" to improve document structure and accessibility.


927-927: Consider using a heading tag for "Level" to improve document structure and accessibility.


1113-1113: Consider using a heading tag for "TrimmedSpotLimitOrder" to improve document structure and accessibility.


1320-1320: Consider using a heading tag for "TrimmedSpotLimitOrder" to improve document structure and accessibility.


1491-1491: Consider using a heading tag for "TrimmedSpotLimitOrder" to improve document structure and accessibility.


1653-1653: Consider using a heading tag for "TrimmedSpotLimitOrder" to improve document structure and accessibility.


1994-1994: Consider using a heading tag for "TxResponse" to improve document structure and accessibility.


2014-2014: Consider using a heading tag for "ABCIMessageLog" to improve document structure and accessibility.


2024-2024: Consider using a heading tag for "Event" to improve document structure and accessibility.


2033-2033: Consider using a heading tag for "StringEvent" to improve document structure and accessibility.


2042-2042: Consider using a heading tag for "EventAttribute" to improve document structure and accessibility.


2052-2052: Consider using a heading tag for "Attribute" to improve document structure and accessibility.


2320-2320: Consider using a heading tag for "SpotOrder" to improve document structure and accessibility.


2331-2331: Consider using a heading tag for "OrderInfo" to improve document structure and accessibility.


2343-2343: Consider using a heading tag for "OrderType" to improve document structure and accessibility.


2389-2389: Consider using a heading tag for "TxResponse" to improve document structure and accessibility.


2409-2409: Consider using a heading tag for "ABCIMessageLog" to improve document structure and accessibility.


2419-2419: Consider using a heading tag for "Event" to improve document structure and accessibility.


2428-2428: Consider using a heading tag for "StringEvent" to improve document structure and accessibility.


2437-2437: Consider using a heading tag for "EventAttribute" to improve document structure and accessibility.


2447-2447: Consider using a heading tag for "Attribute" to improve document structure and accessibility.


2712-2712: Consider using a heading tag for "SpotOrder" to improve document structure and accessibility.


2723-2723: Consider using a heading tag for "OrderInfo" to improve document structure and accessibility.


2735-2735: Consider using a heading tag for "OrderType" to improve document structure and accessibility.


2781-2781: Consider using a heading tag for "TxResponse" to improve document structure and accessibility.


2801-2801: Consider using a heading tag for "ABCIMessageLog" to improve document structure and accessibility.


2811-2811: Consider using a heading tag for "Event" to improve document structure and accessibility.


2820-2820: Consider using a heading tag for "StringEvent" to improve document structure and accessibility.


2829-2829: Consider using a heading tag for "EventAttribute" to improve document structure and accessibility.


2839-2839: Consider using a heading tag for "Attribute" to improve document structure and accessibility.


3067-3067: Consider using a heading tag for "TxResponse" to improve document structure and accessibility.


3087-3087: Consider using a heading tag for "ABCIMessageLog" to improve document structure and accessibility.


3097-3097: Consider using a heading tag for "Event" to improve document structure and accessibility.


3106-3106: Consider using a heading tag for "StringEvent" to improve document structure and accessibility.


3115-3115: Consider using a heading tag for "EventAttribute" to improve document structure and accessibility.


3125-3125: Consider using a heading tag for "Attribute" to improve document structure and accessibility.


3509-3509: Consider using a heading tag for "OrderData" to improve document structure and accessibility.


3521-3521: Consider using a heading tag for "SpotOrder" to improve document structure and accessibility.


3532-3532: Consider using a heading tag for "DerivativeOrder" to improve document structure and accessibility.


3544-3544: Consider using a heading tag for "OrderMask" to improve document structure and accessibility.


3559-3559: Consider using a heading tag for "OrderInfo" to improve document structure and accessibility.


3571-3571: Consider using a heading tag for "OrderType" to improve document structure and accessibility.


3625-3625: Consider using a heading tag for "TxResponse" to improve document structure and accessibility.


3645-3645: Consider using a heading tag for "ABCIMessageLog" to improve document structure and accessibility.


3655-3655: Consider using a heading tag for "Event" to improve document structure and accessibility.


3664-3664: Consider using a heading tag for "StringEvent" to improve document structure and accessibility.


3673-3673: Consider using a heading tag for "EventAttribute" to improve document structure and accessibility.


3683-3683: Consider using a heading tag for "Attribute" to improve document structure and accessibility.

source/includes/_derivatives.md (81)

300-300: Consider using a heading instead of bold for "Level" to maintain semantic HTML structure and improve accessibility.


459-459: Consider using a heading instead of bold for "TrimmedDerivativeLimitOrder" to maintain semantic HTML structure and improve accessibility.


619-619: Consider using a heading instead of bold for "TrimmedDerivativeLimitOrder" to maintain semantic HTML structure and improve accessibility.


785-785: Consider using a heading instead of bold for "TrimmedDerivativeLimitOrder" to maintain semantic HTML structure and improve accessibility.


948-948: Consider using a heading instead of bold for "TrimmedDerivativeLimitOrder" to maintain semantic HTML structure and improve accessibility.


1133-1133: Consider using a heading instead of bold for "FullDerivativeMarket" to maintain semantic HTML structure and improve accessibility.


1144-1144: Consider using a heading instead of bold for "DerivativeMarket" to maintain semantic HTML structure and improve accessibility.


1167-1167: Consider using a heading instead of bold for "OracleType" to maintain semantic HTML structure and improve accessibility.


1186-1186: Consider using a heading instead of bold for "MarketStatus" to maintain semantic HTML structure and improve accessibility.


1198-1198: Consider using a heading instead of bold for "PerpetualMarketState" to maintain semantic HTML structure and improve accessibility.


1207-1207: Consider using a heading instead of bold for "PerpetualMarketInfo" to maintain semantic HTML structure and improve accessibility.


1219-1219: Consider using a heading instead of bold for "PerpetualMarketFunding" to maintain semantic HTML structure and improve accessibility.


1229-1229: Consider using a heading instead of bold for "ExpiryFuturesMarketInfo" to maintain semantic HTML structure and improve accessibility.


1406-1406: Consider using a heading instead of bold for "FullDerivativeMarket" to maintain semantic HTML structure and improve accessibility.


1417-1417: Consider using a heading instead of bold for "DerivativeMarket" to maintain semantic HTML structure and improve accessibility.


1440-1440: Consider using a heading instead of bold for "OracleType" to maintain semantic HTML structure and improve accessibility.


1459-1459: Consider using a heading instead of bold for "MarketStatus" to maintain semantic HTML structure and improve accessibility.


1471-1471: Consider using a heading instead of bold for "PerpetualMarketState" to maintain semantic HTML structure and improve accessibility.


1480-1480: Consider using a heading instead of bold for "PerpetualMarketInfo" to maintain semantic HTML structure and improve accessibility.


1492-1492: Consider using a heading instead of bold for "PerpetualMarketFunding" to maintain semantic HTML structure and improve accessibility.


1502-1502: Consider using a heading instead of bold for "ExpiryFuturesMarketInfo" to maintain semantic HTML structure and improve accessibility.


1795-1795: Consider using a heading instead of bold for "DerivativePosition" to maintain semantic HTML structure and improve accessibility.


1805-1805: Consider using a heading instead of bold for "Position" to maintain semantic HTML structure and improve accessibility.


2019-2019: Consider using a heading instead of bold for "DerivativePosition" to maintain semantic HTML structure and improve accessibility.


2029-2029: Consider using a heading instead of bold for "Position" to maintain semantic HTML structure and improve accessibility.


2196-2196: Consider using a heading instead of bold for "Position" to maintain semantic HTML structure and improve accessibility.


2362-2362: Consider using a heading instead of bold for "EffectivePosition" to maintain semantic HTML structure and improve accessibility.


2510-2510: Consider using a heading instead of bold for "PerpetualMarketInfo" to maintain semantic HTML structure and improve accessibility.


2651-2651: Consider using a heading instead of bold for "ExpiryFuturesMarketInfo" to maintain semantic HTML structure and improve accessibility.


2798-2798: Consider using a heading instead of bold for "PerpetualMarketFunding" to maintain semantic HTML structure and improve accessibility.


2958-2958: Consider using a heading instead of bold for "TrimmedDerivativeConditionalOrder" to maintain semantic HTML structure and improve accessibility.


3175-3175: Consider using a heading instead of bold for "OracleType" to maintain semantic HTML structure and improve accessibility.


3205-3205: Consider using a heading instead of bold for "TxResponse" to maintain semantic HTML structure and improve accessibility.


3225-3225: Consider using a heading instead of bold for "ABCIMessageLog" to maintain semantic HTML structure and improve accessibility.


3235-3235: Consider using a heading instead of bold for "Event" to maintain semantic HTML structure and improve accessibility.


3244-3244: Consider using a heading instead of bold for "StringEvent" to maintain semantic HTML structure and improve accessibility.


3253-3253: Consider using a heading instead of bold for "EventAttribute" to maintain semantic HTML structure and improve accessibility.


3263-3263: Consider using a heading instead of bold for "Attribute" to maintain semantic HTML structure and improve accessibility.


3478-3478: Consider using a heading instead of bold for "OracleType" to maintain semantic HTML structure and improve accessibility.


3508-3508: Consider using a heading instead of bold for "TxResponse" to maintain semantic HTML structure and improve accessibility.


3528-3528: Consider using a heading instead of bold for "ABCIMessageLog" to maintain semantic HTML structure and improve accessibility.


3538-3538: Consider using a heading instead of bold for "Event" to maintain semantic HTML structure and improve accessibility.


3547-3547: Consider using a heading instead of bold for "StringEvent" to maintain semantic HTML structure and improve accessibility.


3556-3556: Consider using a heading instead of bold for "EventAttribute" to maintain semantic HTML structure and improve accessibility.


3566-3566: Consider using a heading instead of bold for "Attribute" to maintain semantic HTML structure and improve accessibility.


3834-3834: Consider using a heading instead of bold for "DerivativeOrder" to maintain semantic HTML structure and improve accessibility.


3846-3846: Consider using a heading instead of bold for "OrderInfo" to maintain semantic HTML structure and improve accessibility.


3858-3858: Consider using a heading instead of bold for "OrderType" to maintain semantic HTML structure and improve accessibility.


3904-3904: Consider using a heading instead of bold for "TxResponse" to maintain semantic HTML structure and improve accessibility.


3924-3924: Consider using a heading instead of bold for "ABCIMessageLog" to maintain semantic HTML structure and improve accessibility.


3934-3934: Consider using a heading instead of bold for "Event" to maintain semantic HTML structure and improve accessibility.


3943-3943: Consider using a heading instead of bold for "StringEvent" to maintain semantic HTML structure and improve accessibility.


3952-3952: Consider using a heading instead of bold for "EventAttribute" to maintain semantic HTML structure and improve accessibility.


3962-3962: Consider using a heading instead of bold for "Attribute" to maintain semantic HTML structure and improve accessibility.


4232-4232: Consider using a heading instead of bold for "DerivativeOrder" to maintain semantic HTML structure and improve accessibility.


4244-4244: Consider using a heading instead of bold for "OrderInfo" to maintain semantic HTML structure and improve accessibility.


4256-4256: Consider using a heading instead of bold for "OrderType" to maintain semantic HTML structure and improve accessibility.


4302-4302: Consider using a heading instead of bold for "TxResponse" to maintain semantic HTML structure and improve accessibility.


4322-4322: Consider using a heading instead of bold for "ABCIMessageLog" to maintain semantic HTML structure and improve accessibility.


4332-4332: Consider using a heading instead of bold for "Event" to maintain semantic HTML structure and improve accessibility.


4341-4341: Consider using a heading instead of bold for "StringEvent" to maintain semantic HTML structure and improve accessibility.


4350-4350: Consider using a heading instead of bold for "EventAttribute" to maintain semantic HTML structure and improve accessibility.


4360-4360: Consider using a heading instead of bold for "Attribute" to maintain semantic HTML structure and improve accessibility.


4567-4567: Consider using a heading instead of bold for "OrderMask" to maintain semantic HTML structure and improve accessibility.


4610-4610: Consider using a heading instead of bold for "TxResponse" to maintain semantic HTML structure and improve accessibility.


4630-4630: Consider using a heading instead of bold for "ABCIMessageLog" to maintain semantic HTML structure and improve accessibility.


4640-4640: Consider using a heading instead of bold for "Event" to maintain semantic HTML structure and improve accessibility.


4649-4649: Consider using a heading instead of bold for "StringEvent" to maintain semantic HTML structure and improve accessibility.


4658-4658: Consider using a heading instead of bold for "EventAttribute" to maintain semantic HTML structure and improve accessibility.


4668-4668: Consider using a heading instead of bold for "Attribute" to maintain semantic HTML structure and improve accessibility.


5052-5052: Consider using a heading instead of bold for "OrderData" to maintain semantic HTML structure and improve accessibility.


5064-5064: Consider using a heading instead of bold for "SpotOrder" to maintain semantic HTML structure and improve accessibility.


5075-5075: Consider using a heading instead of bold for "DerivativeOrder" to maintain semantic HTML structure and improve accessibility.


5087-5087: Consider using a heading instead of bold for "OrderMask" to maintain semantic HTML structure and improve accessibility.


5102-5102: Consider using a heading instead of bold for "OrderInfo" to maintain semantic HTML structure and improve accessibility.


5114-5114: Consider using a heading instead of bold for "OrderType" to maintain semantic HTML structure and improve accessibility.


5168-5168: Consider using a heading instead of bold for "TxResponse" to maintain semantic HTML structure and improve accessibility.


5188-5188: Consider using a heading instead of bold for "ABCIMessageLog" to maintain semantic HTML structure and improve accessibility.


5198-5198: Consider using a heading instead of bold for "Event" to maintain semantic HTML structure and improve accessibility.


5207-5207: Consider using a heading instead of bold for "StringEvent" to maintain semantic HTML structure and improve accessibility.


5216-5216: Consider using a heading instead of bold for "EventAttribute" to maintain semantic HTML structure and improve accessibility.


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.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 16

Comment on lines +2 to +3
{"Parameter": "total", "Type": "Integer", "Description": ""},
{"Parameter": "hash", "Type": "Bytes", "Description": ""}
Copy link

Choose a reason for hiding this comment

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

Please provide descriptions for the "total" and "hash" parameters to clarify their roles and significance within the part set header.

Comment on lines +2 to +3
{"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 provide descriptions for the "block" and "app" parameters to clarify their roles and significance within the consensus data.

@@ -0,0 +1,4 @@
[
{"Parameter": "hash", "Type": "Bytes", "Description": "Block hash"},
{"Parameter": "part_set_header", "Type": "PartSetHeader", "Description": ""}
Copy link

Choose a reason for hiding this comment

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

Please provide a description for the "part_set_header" parameter to clarify its role and significance within the block ID.

[
{"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"},
Copy link

Choose a reason for hiding this comment

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

Fix the typo in the parameter name.

-    {"Parameter": "haight", "Type": "Integer", "Description": "Block height", "Required": "No"}
+    {"Parameter": "height", "Type": "Integer", "Description": "Block height", "Required": "No"}

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": "haight", "Type": "Integer", "Description": "Block height", "Required": "No"},
{"Parameter": "height", "Type": "Integer", "Description": "Block height", "Required": "No"},

{"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 clarify its purpose.

{"Parameter": "index", "Type": "Integer", "Description": ""},
{"Parameter": "key", "Type": "Bytes", "Description": ""},
{"Parameter": "value", "Type": "Bytes", "Description": ""},
{"Parameter": "proof_ops", "Type": "ProofOps", "Description": ""},
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 "proof_ops" parameter to clarify its purpose.

{"Parameter": "value", "Type": "Bytes", "Description": ""},
{"Parameter": "proof_ops", "Type": "ProofOps", "Description": ""},
{"Parameter": "height", "Type": "Integer", "Description": "Block height"},
{"Parameter": "codespace", "Type": "String", "Description": ""}
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 "codespace" parameter to clarify its purpose.

@@ -0,0 +1,10 @@
[
{"Parameter": "protocol_version", "Type": "ProtocolVersion", "Description": "Protocol version information"},
{"Parameter": "default_nod_id", "Type": "String", "Description": "Node identifier"},
Copy link

Choose a reason for hiding this comment

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

Fix the typo in the parameter name.

-    {"Parameter": "default_nod_id", "Type": "String", "Description": "Node identifier"}
+    {"Parameter": "default_node_id", "Type": "String", "Description": "Node identifier"}

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": "default_nod_id", "Type": "String", "Description": "Node identifier"},
{"Parameter": "default_node_id", "Type": "String", "Description": "Node identifier"},

{"Parameter": "network", "Type": "String", "Description": "The chain network name"},
{"Parameter": "version", "Type": "String", "Description": "The version number"},
{"Parameter": "channels", "Type": "Bytes", "Description": "Channels information"},
{"Parameter": "moniker", "Type": "String", "Description": ""},
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 "moniker" parameter to clarify its purpose.

- Updated the API documentation to include all queries and messages for the `tendermint` module
- Python SDK v1.5.0
- Added support for all queries from the `tendermint` module
- Added support for all queries from the `IBC transfer` modulee
Copy link

Choose a reason for hiding this comment

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

Fix the typo in the changelog entry.

-  - Added support for all queries from the `IBC transfer` modulee
+  - Added support for all queries from the `IBC transfer` module

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
- Added support for all queries from the `IBC transfer` modulee
- Added support for all queries from the `IBC transfer` module

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.

None yet

1 participant