chore: add warning explanation of GetBlockWithTxs in `cosmos/tx/v1b…

…eta1/service.proto`
Finschia · Aug 22, 2023 · bf739e0 · bf739e0
1 parent f8d06b8
commit bf739e0
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 3 deletions.
diff --git a/client/docs/statik/statik.go b/client/docs/statik/statik.go
diff --git a/client/docs/swagger-ui/swagger.yaml b/client/docs/swagger-ui/swagger.yaml
@@ -21210,7 +21210,19 @@ paths:
   '/cosmos/tx/v1beta1/txs/block/{height}':
     get:
       summary: GetBlockWithTxs fetches a block with decoded txs.
-      description: 'Since: cosmos-sdk 0.45.2'
+      description: >-
+        Since: cosmos-sdk 0.45.2
+
+        WARNING: In `GetBlockWithTxs` 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 `GetBlockWithTxs` in
+        `lbm/tx/v1beta1/service.proto`.
       operationId: GetBlockWithTxs
       responses:
         '200':

diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md
@@ -8553,7 +8553,7 @@ Service defines a gRPC service for interacting with transactions.
 | `GetTxsEvent` | [GetTxsEventRequest](#cosmos.tx.v1beta1.GetTxsEventRequest) | [GetTxsEventResponse](#cosmos.tx.v1beta1.GetTxsEventResponse) | GetTxsEvent fetches txs by event. | GET|/cosmos/tx/v1beta1/txs|
 | `GetBlockWithTxs` | [GetBlockWithTxsRequest](#cosmos.tx.v1beta1.GetBlockWithTxsRequest) | [GetBlockWithTxsResponse](#cosmos.tx.v1beta1.GetBlockWithTxsResponse) | GetBlockWithTxs fetches a block with decoded txs.
 
-Since: cosmos-sdk 0.45.2 | GET|/cosmos/tx/v1beta1/txs/block/{height}|
+Since: cosmos-sdk 0.45.2 WARNING: In `GetBlockWithTxs` 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 `GetBlockWithTxs` in `lbm/tx/v1beta1/service.proto`. | GET|/cosmos/tx/v1beta1/txs/block/{height}|
 
  <!-- end services -->
 

diff --git a/proto/cosmos/tx/v1beta1/service.proto b/proto/cosmos/tx/v1beta1/service.proto
@@ -39,6 +39,10 @@ service Service {
   // GetBlockWithTxs fetches a block with decoded txs.
   //
   // Since: cosmos-sdk 0.45.2
+  // WARNING: In `GetBlockWithTxs` 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 `GetBlockWithTxs` in `lbm/tx/v1beta1/service.proto`.
   rpc GetBlockWithTxs(GetBlockWithTxsRequest) returns (GetBlockWithTxsResponse) {
     option (google.api.http).get = "/cosmos/tx/v1beta1/txs/block/{height}";
   }

diff --git a/types/tx/service.pb.go b/types/tx/service.pb.go