Closed aarmoa closed 2 months ago
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.
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.
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.
NOTE: Do not merge this PR until Python SDK v1.6.0 is released in master
Solves CHAIN-85
Summary by CodeRabbit