refactor!: remove broadcast mode block (cosmos#12659)

CHANGELOG.md

@@ -77,8 +77,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 * [#12596](https://github.com/cosmos/cosmos-sdk/pull/12596) Remove all imports of the non-existent gogo/protobuf v1.3.3 to ease downstream use and go workspaces.
 * [#12187](https://github.com/cosmos/cosmos-sdk/pull/12187) Add batch operation for x/nft module.
 * [#12693](https://github.com/cosmos/cosmos-sdk/pull/12693) Make sure the order of each node is consistent when emitting proto events.
-* [#12455](https://github.com/cosmos/cosmos-sdk/pull/12455) Show attempts count in error for signing.
-* [#12886](https://github.com/cosmos/cosmos-sdk/pull/12886) Amortize cost of processing cache KV store
+* [#12455](https://github.com/cosmos/cosmos-sdk/pull/12455) Show attempts count in error for signing. 
+* [#12885](https://github.com/cosmos/cosmos-sdk/pull/12885) Amortize cost of processing cache KV store
 * [#12953](https://github.com/cosmos/cosmos-sdk/pull/12953) Change the default priority mechanism to be based on gas price.
 * [#13048](https://github.com/cosmos/cosmos-sdk/pull/13048) Add handling of AccountNumberStoreKeyPrefix to the x/auth simulation decoder.
 * [#13101](https://github.com/cosmos/cosmos-sdk/pull/13101) Remove weights from `simapp/params` and `testutil/sims`. They are now in their respective modules.
@@ -113,6 +113,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 ### API Breaking Changes
 
 * !(storev2alpha1) [#13370](https://github.com/cosmos/cosmos-sdk/pull/13370) remove storev2alpha1
+* (tx) [#12659](https://github.com/cosmos/cosmos-sdk/pull/12659) Remove broadcast mode `block`.
 * (context) [#13063](https://github.com/cosmos/cosmos-sdk/pull/13063) Update `Context#CacheContext` to automatically emit all events on the parent context's `EventManager`.
 * (x/bank) [#12706](https://github.com/cosmos/cosmos-sdk/pull/12706) Removed the `testutil` package from the `x/bank/client` package.
 * (simapp) [#12747](https://github.com/cosmos/cosmos-sdk/pull/12747) Remove `simapp.MakeTestEncodingConfig`. Please use `moduletestutil.MakeTestEncodingConfig` (`types/module/testutil`) in tests instead.
@@ -149,6 +150,8 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### CLI Breaking Changes
 
+* (tx) [#12659](https://github.com/cosmos/cosmos-sdk/pull/12659) Remove broadcast mode `block`.
+
 ### Bug Fixes
 
 * [#13145](https://github.com/cosmos/cosmos-sdk/pull/13145) Fix panic when calling `String()` to a Record struct type.

UPGRADING.md

@@ -35,6 +35,11 @@ The SDK has migrated from `gogo/protobuf` (which is currently unmaintained), to
 This means you should replace all imports of `github.com/gogo/protobuf` to `github.com/cosmos/gogoproto`.
 This allows you to remove the replace directive `replace github.com/gogo/protobuf => github.com/regen-network/protobuf v1.3.3-alpha.regen.1` from your `go.mod` file.
 
+### Transactions
+
+Broadcast mode `block` was deprecated and has been removed. Please use `sync` mode instead.
+When upgrading your tests from `block` to `sync` and checking for a transaction code, you might need to query the transaction first (with its hash) to get the correct code.
+
 ### `x/gov`
 
 #### Minimum Proposal Deposit At Time of Submission

client/broadcast.go

@@ -28,11 +28,8 @@ func (ctx Context) BroadcastTx(txBytes []byte) (res *sdk.TxResponse, err error)
  case flags.BroadcastAsync:
  res, err = ctx.BroadcastTxAsync(txBytes)
 
- case flags.BroadcastBlock:
- res, err = ctx.BroadcastTxCommit(txBytes)
-
  default:
- return nil, fmt.Errorf("unsupported return type %s; supported types: sync, async, block", ctx.BroadcastMode)
+ return nil, fmt.Errorf("unsupported return type %s; supported types: sync, async", ctx.BroadcastMode)
  }
 
  return res, err
@@ -81,39 +78,6 @@ func CheckTendermintError(err error, tx tmtypes.Tx) *sdk.TxResponse {
  }
 }
 
-// BroadcastTxCommit broadcasts transaction bytes to a Tendermint node and
-// waits for a commit. An error is only returned if there is no RPC node
-// connection or if broadcasting fails.
-//
-// NOTE: This should ideally not be used as the request may timeout but the tx
-// may still be included in a block. Use BroadcastTxAsync or BroadcastTxSync
-// instead.
-func (ctx Context) BroadcastTxCommit(txBytes []byte) (*sdk.TxResponse, error) {
- node, err := ctx.GetNode()
- if err != nil {
- return nil, err
- }
-
- res, err := node.BroadcastTxCommit(context.Background(), txBytes)
- if err == nil {
- return sdk.NewResponseFormatBroadcastTxCommit(res), nil
- }
-
- // with these changes(https://github.com/tendermint/tendermint/pull/7683)
- // in tendermint, we receive both an error and a non-empty res from TM. Here
- // we handle the case where both are relevant. Note: without this edge-case handling,
- // CLI is breaking (for few transactions ex: executing unathorized messages in feegrant)
- // this check is added to tackle the particular case.
- if strings.Contains(err.Error(), "transaction encountered error") {
- return sdk.NewResponseFormatBroadcastTxCommit(res), nil
- }
-
- if errRes := CheckTendermintError(err, txBytes); errRes != nil {
- return errRes, nil
- }
- return sdk.NewResponseFormatBroadcastTxCommit(res), err
-}
-
 // BroadcastTxSync broadcasts transaction bytes to a Tendermint node
 // synchronously (i.e. returns after CheckTx execution).
 func (ctx Context) BroadcastTxSync(txBytes []byte) (*sdk.TxResponse, error) {
@@ -170,8 +134,6 @@ func normalizeBroadcastMode(mode tx.BroadcastMode) string {
  switch mode {
  case tx.BroadcastMode_BROADCAST_MODE_ASYNC:
  return "async"
- case tx.BroadcastMode_BROADCAST_MODE_BLOCK:
- return "block"
  case tx.BroadcastMode_BROADCAST_MODE_SYNC:
  return "sync"
  default:

client/broadcast_test.go

@@ -21,10 +21,6 @@ type MockClient struct {
  err error
 }
 
-func (c MockClient) BroadcastTxCommit(ctx context.Context, tx tmtypes.Tx) (*coretypes.ResultBroadcastTxCommit, error) {
- return nil, c.err
-}
-
 func (c MockClient) BroadcastTxAsync(ctx context.Context, tx tmtypes.Tx) (*coretypes.ResultBroadcastTx, error) {
  return nil, c.err
 }
@@ -50,7 +46,6 @@ func TestBroadcastError(t *testing.T) {
 
  modes := []string{
  flags.BroadcastAsync,
- flags.BroadcastBlock,
  flags.BroadcastSync,
  }
 

client/config/toml.go

@@ -23,7 +23,7 @@ keyring-backend = "{{ .KeyringBackend }}"
 output = "{{ .Output }}"
 # <host>:<port> to Tendermint RPC interface for this chain
 node = "{{ .Node }}"
-# Transaction broadcasting mode (sync|async|block)
+# Transaction broadcasting mode (sync|async)
 broadcast-mode = "{{ .BroadcastMode }}"
 `