deprecate block mode in proto (Finschia#923)

* feat: deprecate block mode in proto * add changelog
zemyblue · Mar 10, 2023 · b626dec · b626dec
1 parent ce8d910
commit b626dec
Show file tree

Hide file tree

Showing 4 changed files with 69 additions and 70 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -74,6 +74,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * (x/bank) [\#876](https://github.com/line/lbm-sdk/pull/876) Add `MultiSend` deactivation
 * (x/auth) [\#891](https://github.com/line/lbm-sdk/pull/891) deprecate `cosmos.tx.v1beta1.Service/GetBlockWithTxs` and add `lbm.tx.v1beta1.Service/GetBlockWithTxs` for lbm
 * (abci) [\#892](https://github.com/line/lbm-sdk/pull/892) remove the incompatible field `index=14` in `TxResponse`
+* (proto) [\#923](https://github.com/line/lbm-sdk/pull/923) deprecate broadcast mode `block`
 
 ### Build, CI
 * (ci) [\#829](https://github.com/line/lbm-sdk/pull/829) automate release process

diff --git a/docs/core/proto-docs.md b/docs/core/proto-docs.md
@@ -8199,7 +8199,7 @@ BroadcastMode specifies the broadcast mode for the TxService.Broadcast RPC metho
 | Name | Number | Description |
 | ---- | ------ | ----------- |
 | BROADCAST_MODE_UNSPECIFIED | 0 | zero-value for mode ordering |
-| BROADCAST_MODE_BLOCK | 1 | BROADCAST_MODE_BLOCK defines a tx broadcasting mode where the client waits for the tx to be committed in a block. |
+| BROADCAST_MODE_BLOCK | 1 | DEPRECATED: use BROADCAST_MODE_SYNC instead, |
 | BROADCAST_MODE_SYNC | 2 | BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for a CheckTx execution response only. |
 | BROADCAST_MODE_ASYNC | 3 | BROADCAST_MODE_ASYNC defines a tx broadcasting mode where the client returns immediately. |
 

diff --git a/proto/cosmos/tx/v1beta1/service.proto b/proto/cosmos/tx/v1beta1/service.proto
@@ -87,9 +87,8 @@ message BroadcastTxRequest {
 enum BroadcastMode {
   // zero-value for mode ordering
   BROADCAST_MODE_UNSPECIFIED = 0;
-  // BROADCAST_MODE_BLOCK defines a tx broadcasting mode where the client waits for
-  // the tx to be committed in a block.
-  BROADCAST_MODE_BLOCK = 1;
+  // DEPRECATED: use BROADCAST_MODE_SYNC instead,
+  BROADCAST_MODE_BLOCK = 1 [deprecated = true];
   // BROADCAST_MODE_SYNC defines a tx broadcasting mode where the client waits for
   // a CheckTx execution response only.
   BROADCAST_MODE_SYNC = 2;

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