Skip to content

Commit

Permalink
chore: add warning explanation in `cosmos/base/tendermint/v1beta1/que…
Browse files Browse the repository at this point in the history
…ry.proto`
  • Loading branch information
zemyblue committed Aug 22, 2023
1 parent e436174 commit ca8997c
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 0 deletions.
5 changes: 5 additions & 0 deletions docs/core/proto-docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -3668,6 +3668,11 @@ VersionInfo is the type for the GetNodeInfoResponse message.
### Service
Service defines the gRPC querier service for tendermint queries.

WARNING: For compatibility with cosmos-sdk API, the result converted from Ostracon block type
to tendermint block type without `entropy` is returned.
Therefore, verification fails with the tendermint block validation method.
For original information, please check `lbm/base/ostracon/v1/query.proto`.

| Method Name | Request Type | Response Type | Description | HTTP Verb | Endpoint |
| ----------- | ------------ | ------------- | ------------| ------- | -------- |
| `GetNodeInfo` | [GetNodeInfoRequest](#cosmos.base.tendermint.v1beta1.GetNodeInfoRequest) | [GetNodeInfoResponse](#cosmos.base.tendermint.v1beta1.GetNodeInfoResponse) | GetNodeInfo queries the current node info. | GET|/cosmos/base/tendermint/v1beta1/node_info|
Expand Down
5 changes: 5 additions & 0 deletions proto/cosmos/base/tendermint/v1beta1/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,11 @@ import "cosmos/base/query/v1beta1/pagination.proto";
option go_package = "github.com/Finschia/finschia-sdk/client/grpc/tmservice";

// Service defines the gRPC querier service for tendermint queries.
//
// WARNING: For compatibility with cosmos-sdk API, the result converted from Ostracon block type
// to tendermint block type without `entropy` is returned.
// Therefore, verification fails with the tendermint block validation method.
// For original information, please check `lbm/base/ostracon/v1/query.proto`.
service Service {
// GetNodeInfo queries the current node info.
rpc GetNodeInfo(GetNodeInfoRequest) returns (GetNodeInfoResponse) {
Expand Down

0 comments on commit ca8997c

Please sign in to comment.