chore(types): add MustAccAddressFromBech32 util func (backport #12201) (

#12205)

CHANGELOG.md

@@ -66,6 +66,7 @@ Ref: https://keepachangelog.com/en/1.0.0/
 
 ### Improvements
 
+* (types) [\#12201](https://github.com/cosmos/cosmos-sdk/pull/12201) Add `MustAccAddressFromBech32` util function
 * [\#11693](https://github.com/cosmos/cosmos-sdk/pull/11693) Add validation for gentx cmd.
 * [\#11686](https://github.com/cosmos/cosmos-sdk/pull/11686) Update the min required Golang version to `1.17`.
 * (x/auth/vesting) [\#11652](https://github.com/cosmos/cosmos-sdk/pull/11652) Add util functions for `Period(s)`

server/rosetta/converter.go

@@ -212,7 +212,6 @@ func (c converter) UnsignedTx(ops []*rosettatypes.Operation) (tx authsigning.Tx,
  }
 
  return builder.GetTx(), nil
-
 }
 
 // Msg unmarshals the rosetta metadata to the given sdk.Msg
@@ -334,7 +333,6 @@ func (c converter) BalanceOps(status string, events []abci.Event) []*rosettatype
 // has changed and rosetta needs to reflect those changes too.
 // The balance operations are multiple, one for each denom.
 func sdkEventToBalanceOperations(status string, event abci.Event) (operations []*rosettatypes.Operation, isBalanceEvent bool) {
-
  var (
  accountIdentifier string
  coinChange sdk.Coins
@@ -345,10 +343,7 @@ func sdkEventToBalanceOperations(status string, event abci.Event) (operations []
  default:
  return nil, false
  case banktypes.EventTypeCoinSpent:
- spender, err := sdk.AccAddressFromBech32((string)(event.Attributes[0].Value))
- if err != nil {
- panic(err)
- }
+ spender := sdk.MustAccAddressFromBech32((string)(event.Attributes[0].Value))
  coins, err := sdk.ParseCoinsNormalized((string)(event.Attributes[1].Value))
  if err != nil {
  panic(err)
@@ -359,10 +354,7 @@ func sdkEventToBalanceOperations(status string, event abci.Event) (operations []
  accountIdentifier = spender.String()
 
  case banktypes.EventTypeCoinReceived:
- receiver, err := sdk.AccAddressFromBech32((string)(event.Attributes[0].Value))
- if err != nil {
- panic(err)
- }
+ receiver := sdk.MustAccAddressFromBech32((string)(event.Attributes[0].Value))
  coins, err := sdk.ParseCoinsNormalized((string)(event.Attributes[1].Value))
  if err != nil {
  panic(err)
@@ -516,7 +508,7 @@ func (c converter) HashToTxType(hashBytes []byte) (txType TransactionType, realH
 // StatusToSyncStatus converts a tendermint status to rosetta sync status
 func (c converter) SyncStatus(status *tmcoretypes.ResultStatus) *rosettatypes.SyncStatus {
  // determine sync status
- var stage = StatusPeerSynced
+ stage := StatusPeerSynced
  if status.SyncInfo.CatchingUp {
  stage = StatusPeerSyncing
  }
@@ -584,7 +576,6 @@ func (c converter) Peers(peers []tmcoretypes.Peer) []*rosettatypes.Peer {
 // OpsAndSigners takes transactions bytes and returns the operation, is signed is true it will return
 // the account identifiers which have signed the transaction
 func (c converter) OpsAndSigners(txBytes []byte) (ops []*rosettatypes.Operation, signers []*rosettatypes.AccountIdentifier, err error) {
-
  rosTx, err := c.ToRosetta().Tx(txBytes, nil)
  if err != nil {
  return nil, nil, err
@@ -678,7 +669,6 @@ func (c converter) PubKey(pubKey *rosettatypes.PublicKey) (cryptotypes.PubKey, e
 
 // SigningComponents takes a sdk tx and construction metadata and returns signable components
 func (c converter) SigningComponents(tx authsigning.Tx, metadata *ConstructionMetadata, rosPubKeys []*rosettatypes.PublicKey) (txBytes []byte, payloadsToSign []*rosettatypes.SigningPayload, err error) {
-
  // verify metadata correctness
  feeAmount, err := sdk.ParseCoinsNormalized(metadata.GasPrice)
  if err != nil {

simapp/export.go

@@ -84,10 +84,8 @@ func (app *SimApp) prepForZeroHeightGenesis(ctx sdk.Context, jailAllowedAddrs []
  panic(err)
  }
 
- delAddr, err := sdk.AccAddressFromBech32(delegation.DelegatorAddress)
- if err != nil {
- panic(err)
- }
+ delAddr := sdk.MustAccAddressFromBech32(delegation.DelegatorAddress)
+
  _, _ = app.DistrKeeper.WithdrawDelegationRewards(ctx, delAddr, valAddr)
  }
 
@@ -119,10 +117,7 @@ func (app *SimApp) prepForZeroHeightGenesis(ctx sdk.Context, jailAllowedAddrs []
  if err != nil {
  panic(err)
  }
- delAddr, err := sdk.AccAddressFromBech32(del.DelegatorAddress)
- if err != nil {
- panic(err)
- }
+ delAddr := sdk.MustAccAddressFromBech32(del.DelegatorAddress)
  app.DistrKeeper.Hooks().BeforeDelegationCreated(ctx, delAddr, valAddr)
  app.DistrKeeper.Hooks().AfterDelegationModified(ctx, delAddr, valAddr)
  }

types/address.go

@@ -154,6 +154,16 @@ func VerifyAddressFormat(bz []byte) error {
  return nil
 }
 
+// MustAccAddressFromBech32 calls AccAddressFromBech32 and panics on error.
+func MustAccAddressFromBech32(address string) AccAddress {
+ addr, err := AccAddressFromBech32(address)
+ if err != nil {
+ panic(err)
+ }
+
+ return addr
+}
+
 // AccAddressFromBech32 creates an AccAddress from a Bech32 string.
 func AccAddressFromBech32(address string) (addr AccAddress, err error) {
  if len(strings.TrimSpace(address)) == 0 {

types/tx/types.go

@@ -118,10 +118,7 @@ func (t *Tx) GetSigners() []sdk.AccAddress {
  // ensure any specified fee payer is included in the required signers (at the end)
  feePayer := t.AuthInfo.Fee.Payer
  if feePayer != "" && !seen[feePayer] {
- payerAddr, err := sdk.AccAddressFromBech32(feePayer)
- if err != nil {
- panic(err)
- }
+ payerAddr := sdk.MustAccAddressFromBech32(feePayer)
  signers = append(signers, payerAddr)
  seen[feePayer] = true
  }
@@ -138,11 +135,7 @@ func (t *Tx) GetFee() sdk.Coins {
 func (t *Tx) FeePayer() sdk.AccAddress {
  feePayer := t.AuthInfo.Fee.Payer
  if feePayer != "" {
- payerAddr, err := sdk.AccAddressFromBech32(feePayer)
- if err != nil {
- panic(err)
- }
- return payerAddr
+ return sdk.MustAccAddressFromBech32(feePayer)
  }
  // use first signer as default if no payer specified
  return t.GetSigners()[0]
@@ -151,11 +144,7 @@ func (t *Tx) FeePayer() sdk.AccAddress {
 func (t *Tx) FeeGranter() sdk.AccAddress {
  feePayer := t.AuthInfo.Fee.Granter
  if feePayer != "" {
- granterAddr, err := sdk.AccAddressFromBech32(feePayer)
- if err != nil {
- panic(err)
- }
- return granterAddr
+ return sdk.MustAccAddressFromBech32(feePayer)
  }
  return nil
 }

x/auth/tx/builder.go

@@ -134,11 +134,7 @@ func (w *wrapper) GetFee() sdk.Coins {
 func (w *wrapper) FeePayer() sdk.AccAddress {
  feePayer := w.tx.AuthInfo.Fee.Payer
  if feePayer != "" {
- payerAddr, err := sdk.AccAddressFromBech32(feePayer)
- if err != nil {
- panic(err)
- }
- return payerAddr
+ return sdk.MustAccAddressFromBech32(feePayer)
  }
  // use first signer as default if no payer specified
  return w.GetSigners()[0]
@@ -147,11 +143,7 @@ func (w *wrapper) FeePayer() sdk.AccAddress {
 func (w *wrapper) FeeGranter() sdk.AccAddress {
  feePayer := w.tx.AuthInfo.Fee.Granter
  if feePayer != "" {
- granterAddr, err := sdk.AccAddressFromBech32(feePayer)
- if err != nil {
- panic(err)
- }
- return granterAddr
+ return sdk.MustAccAddressFromBech32(feePayer)
  }
  return nil
 }

x/authz/keeper/grpc_query.go

@@ -107,7 +107,8 @@ func (k Keeper) GranterGrants(c context.Context, req *authz.QueryGranterGrantsRe
 
  var grants []*authz.GrantAuthorization
  pageRes, err := query.FilteredPaginate(authzStore, req.Pagination, func(key []byte, value []byte,
- accumulate bool) (bool, error) {
+ accumulate bool,
+ ) (bool, error) {
  auth, err := unmarshalAuthorization(k.cdc, value)
  if err != nil {
  return false, err
@@ -156,7 +157,8 @@ func (k Keeper) GranteeGrants(c context.Context, req *authz.QueryGranteeGrantsRe
 
  var authorizations []*authz.GrantAuthorization
  pageRes, err := query.FilteredPaginate(store, req.Pagination, func(key []byte, value []byte,
- accumulate bool) (bool, error) {
+ accumulate bool,
+ ) (bool, error) {
  auth, err := unmarshalAuthorization(k.cdc, value)
  if err != nil {
  return false, err

x/authz/keeper/keeper.go

@@ -73,7 +73,7 @@ func (k Keeper) update(ctx sdk.Context, grantee sdk.AccAddress, granter sdk.AccA
 // DispatchActions attempts to execute the provided messages via authorization
 // grants from the message signer to the grantee.
 func (k Keeper) DispatchActions(ctx sdk.Context, grantee sdk.AccAddress, msgs []sdk.Msg) ([][]byte, error) {
- var results = make([][]byte, len(msgs))
+ results := make([][]byte, len(msgs))
  for i, msg := range msgs {
  signers := msg.GetSigners()
  if len(signers) != 1 {
@@ -198,7 +198,8 @@ func (k Keeper) GetCleanAuthorization(ctx sdk.Context, grantee sdk.AccAddress, g
 // This function should be used with caution because it can involve significant IO operations.
 // It should not be used in query or msg services without charging additional gas.
 func (k Keeper) IterateGrants(ctx sdk.Context,
- handler func(granterAddr sdk.AccAddress, granteeAddr sdk.AccAddress, grant authz.Grant) bool) {
+ handler func(granterAddr sdk.AccAddress, granteeAddr sdk.AccAddress, grant authz.Grant) bool,
+) {
  store := ctx.KVStore(k.storeKey)
  iter := sdk.KVStorePrefixIterator(store, GrantKey)
  defer iter.Close()
@@ -232,20 +233,14 @@ func (k Keeper) ExportGenesis(ctx sdk.Context) *authz.GenesisState {
 // InitGenesis new authz genesis
 func (k Keeper) InitGenesis(ctx sdk.Context, data *authz.GenesisState) {
  for _, entry := range data.Authorization {
- grantee, err := sdk.AccAddressFromBech32(entry.Grantee)
- if err != nil {
- panic(err)
- }
- granter, err := sdk.AccAddressFromBech32(entry.Granter)
- if err != nil {
- panic(err)
- }
+ grantee := sdk.MustAccAddressFromBech32(entry.Grantee)
+ granter := sdk.MustAccAddressFromBech32(entry.Granter)
  a, ok := entry.Authorization.GetCachedValue().(authz.Authorization)
  if !ok {
  panic("expected authorization")
  }
 
- err = k.SaveGrant(ctx, grantee, granter, a, entry.Expiration)
+ err := k.SaveGrant(ctx, grantee, granter, a, entry.Expiration)
  if err != nil {
  panic(err)
  }

x/bank/keeper/genesis.go

@@ -16,10 +16,7 @@ func (k BaseKeeper) InitGenesis(ctx sdk.Context, genState *types.GenesisState) {
 
  genState.Balances = types.SanitizeGenesisBalances(genState.Balances)
  for _, balance := range genState.Balances {
- addr, err := sdk.AccAddressFromBech32(balance.Address)
- if err != nil {
- panic(err)
- }
+ addr := balance.GetAddress()
 
  if err := k.initBalances(ctx, addr, balance.Coins); err != nil {
  panic(fmt.Errorf("error on setting balances %w", err))

x/bank/keeper/msg_server.go

@@ -81,10 +81,8 @@ func (k msgServer) MultiSend(goCtx context.Context, msg *types.MsgMultiSend) (*t
  }
 
  for _, out := range msg.Outputs {
- accAddr, err := sdk.AccAddressFromBech32(out.Address)
- if err != nil {
- panic(err)
- }
+ accAddr := sdk.MustAccAddressFromBech32(out.Address)
+
  if k.BlockedAddr(accAddr) {
  return nil, sdkerrors.Wrapf(sdkerrors.ErrUnauthorized, "%s is not allowed to receive transactions", out.Address)
  }

x/bank/simulation/operations.go

@@ -328,10 +328,7 @@ func sendMsgMultiSend(
  sequenceNumbers := make([]uint64, len(msg.Inputs))
 
  for i := 0; i < len(msg.Inputs); i++ {
- addr, err := sdk.AccAddressFromBech32(msg.Inputs[i].Address)
- if err != nil {
- panic(err)
- }
+ addr := sdk.MustAccAddressFromBech32(msg.Inputs[i].Address)
  acc := ak.GetAccount(ctx, addr)
  accountNumbers[i] = acc.GetAccountNumber()
  sequenceNumbers[i] = acc.GetSequence()
@@ -342,10 +339,7 @@ func sendMsgMultiSend(
  err error
  )
 
- addr, err := sdk.AccAddressFromBech32(msg.Inputs[0].Address)
- if err != nil {
- panic(err)
- }
+ addr := sdk.MustAccAddressFromBech32(msg.Inputs[0].Address)
 
  // feePayer is the first signer, i.e. first input address
  feePayer := ak.GetAccount(ctx, addr)

x/bank/types/balance.go

@@ -3,7 +3,6 @@ package types
 import (
  "bytes"
  "encoding/json"
- "fmt"
  "sort"
 
  "github.com/cosmos/cosmos-sdk/codec"
@@ -15,12 +14,7 @@ var _ exported.GenesisBalance = (*Balance)(nil)
 
 // GetAddress returns the account address of the Balance object.
 func (b Balance) GetAddress() sdk.AccAddress {
- addr, err := sdk.AccAddressFromBech32(b.Address)
- if err != nil {
- panic(fmt.Errorf("couldn't convert %q to account address: %v", b.Address, err))
- }
-
- return addr
+ return sdk.MustAccAddressFromBech32(b.Address)
 }
 
 // GetCoins returns the account coins of the Balance object.

x/distribution/keeper/genesis.go

@@ -15,15 +15,8 @@ func (k Keeper) InitGenesis(ctx sdk.Context, data types.GenesisState) {
  k.SetParams(ctx, data.Params)
 
  for _, dwi := range data.DelegatorWithdrawInfos {
- delegatorAddress, err := sdk.AccAddressFromBech32(dwi.DelegatorAddress)
- if err != nil {
- panic(err)
- }
- withdrawAddress, err := sdk.AccAddressFromBech32(dwi.WithdrawAddress)
- if err != nil {
- panic(err)
- }
-
+ delegatorAddress := sdk.MustAccAddressFromBech32(dwi.DelegatorAddress)
+ withdrawAddress := sdk.MustAccAddressFromBech32(dwi.WithdrawAddress)
  k.SetDelegatorWithdrawAddr(ctx, delegatorAddress, withdrawAddress)
  }
 
@@ -72,10 +65,8 @@ func (k Keeper) InitGenesis(ctx sdk.Context, data types.GenesisState) {
  if err != nil {
  panic(err)
  }
- delegatorAddress, err := sdk.AccAddressFromBech32(del.DelegatorAddress)
- if err != nil {
- panic(err)
- }
+ delegatorAddress := sdk.MustAccAddressFromBech32(del.DelegatorAddress)
+
  k.SetDelegatorStartingInfo(ctx, valAddr, delegatorAddress, del.StartingInfo)
  }
  for _, evt := range data.ValidatorSlashEvents {

x/distribution/keeper/proposal_handler.go

@@ -12,13 +12,12 @@ func HandleCommunityPoolSpendProposal(ctx sdk.Context, k Keeper, p *types.Commun
  return sdkerrors.Wrapf(sdkerrors.ErrUnauthorized, "%s is not allowed to receive external funds", p.Recipient)
  }
 
- recipient, addrErr := sdk.AccAddressFromBech32(p.Recipient)
- if addrErr != nil {
- return addrErr
+ recipient, err := sdk.AccAddressFromBech32(p.Recipient)
+ if err != nil {
+ return err
  }
 
- err := k.DistributeFromFeePool(ctx, p.Amount, recipient)
- if err != nil {
+ if err := k.DistributeFromFeePool(ctx, p.Amount, recipient); err != nil {
  return err
  }