From db15dcb2562d6f06ad698fb5ce84d655a7886e36 Mon Sep 17 00:00:00 2001 From: Rootul P Date: Wed, 31 May 2023 14:17:34 -0400 Subject: [PATCH] chore: ban naked returns (#1865) --- .golangci.yml | 6 ++++++ x/blob/keeper/params.go | 4 ++-- x/blob/types/builder.go | 2 +- x/mint/keeper/keeper.go | 2 +- x/qgb/client/verify.go | 20 ++++++++++---------- x/qgb/keeper/keeper.go | 2 +- x/qgb/types/validator.go | 2 +- 7 files changed, 22 insertions(+), 16 deletions(-) diff --git a/.golangci.yml b/.golangci.yml index 5ea761402f..371f88bc10 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -7,5 +7,11 @@ linters: - exportloopref - gofumpt - misspell + - nakedret - revive - prealloc + +linters-settings: + nakedret: + # Ban the use of naked returns because they reduce code readability. + max-func-lines: 0 # override the default: 30 diff --git a/x/blob/keeper/params.go b/x/blob/keeper/params.go index d5bf514f39..f34626ab22 100644 --- a/x/blob/keeper/params.go +++ b/x/blob/keeper/params.go @@ -21,11 +21,11 @@ func (k Keeper) SetParams(ctx sdk.Context, params types.Params) { // GasPerBlobByte returns the GasPerBlobByte param func (k Keeper) GasPerBlobByte(ctx sdk.Context) (res uint32) { k.paramStore.Get(ctx, types.KeyGasPerBlobByte, &res) - return + return res } // GovSquareSizeUpperBound returns the GovMaxSquareSize param func (k Keeper) GovSquareSizeUpperBound(ctx sdk.Context) (res uint64) { k.paramStore.Get(ctx, types.KeyGovMaxSquareSize, &res) - return + return res } diff --git a/x/blob/types/builder.go b/x/blob/types/builder.go index 6bc8d55227..9e3172cf19 100644 --- a/x/blob/types/builder.go +++ b/x/blob/types/builder.go @@ -281,5 +281,5 @@ func QueryAccount(ctx context.Context, conn *grpc.ClientConn, encCfg encoding.Co } accNum, seqNum = acc.GetAccountNumber(), acc.GetSequence() - return + return accNum, seqNum, nil } diff --git a/x/mint/keeper/keeper.go b/x/mint/keeper/keeper.go index 4b01d1127f..d3c02ee028 100644 --- a/x/mint/keeper/keeper.go +++ b/x/mint/keeper/keeper.go @@ -56,7 +56,7 @@ func (k Keeper) GetMinter(ctx sdk.Context) (minter types.Minter) { } k.cdc.MustUnmarshal(b, &minter) - return + return minter } // SetMinter sets the minter. diff --git a/x/qgb/client/verify.go b/x/qgb/client/verify.go index ed5afcfac4..6fc0180f72 100644 --- a/x/qgb/client/verify.go +++ b/x/qgb/client/verify.go @@ -215,7 +215,7 @@ func VerifyShares(ctx context.Context, logger tmlog.Logger, config VerifyConfig, logger.Debug("getting shares proof from tendermint node") sharesProofs, err := trpc.ProveShares(ctx, height, startShare, endShare) if err != nil { - return + return false, err } logger.Debug("verifying shares proofs") @@ -224,14 +224,14 @@ func VerifyShares(ctx context.Context, logger tmlog.Logger, config VerifyConfig, // which the nmt shares proof is verified against. if !sharesProofs.VerifyProof() { logger.Info("proofs from shares to data root are invalid") - return + return false, err } logger.Info("proofs from shares to data root are valid") qgbGRPC, err := grpc.Dial(config.CelesGRPC, grpc.WithTransportCredentials(insecure.NewCredentials())) if err != nil { - return + return false, err } defer func(qgbGRPC *grpc.ClientConn) { err := qgbGRPC.Close() @@ -247,7 +247,7 @@ func VerifyShares(ctx context.Context, logger tmlog.Logger, config VerifyConfig, &types.QueryDataCommitmentRangeForHeightRequest{Height: height}, ) if err != nil { - return + return false, err } logger.Info( @@ -265,24 +265,24 @@ func VerifyShares(ctx context.Context, logger tmlog.Logger, config VerifyConfig, logger.Debug("getting the data root to commitment inclusion proof") dcProof, err := trpc.DataRootInclusionProof(ctx, height, resp.DataCommitment.BeginBlock, resp.DataCommitment.EndBlock) if err != nil { - return + return false, err } heightI := int64(height) block, err := trpc.Block(ctx, &heightI) if err != nil { - return + return false, err } ethClient, err := ethclient.Dial(config.EVMRPC) if err != nil { - return + return false, err } defer ethClient.Close() qgbWrapper, err := wrapper.NewQuantumGravityBridge(config.ContractAddr, ethClient) if err != nil { - return + return false, err } logger.Info("verifying that the data root was committed to in the QGB contract") @@ -295,7 +295,7 @@ func VerifyShares(ctx context.Context, logger tmlog.Logger, config VerifyConfig, dcProof.Proof, ) if err != nil { - return + return false, err } if isCommittedTo { @@ -304,7 +304,7 @@ func VerifyShares(ctx context.Context, logger tmlog.Logger, config VerifyConfig, logger.Info("the QGB contract didn't commit to the provided shares") } - return + return isCommittedTo, nil } func VerifyDataRootInclusion( diff --git a/x/qgb/keeper/keeper.go b/x/qgb/keeper/keeper.go index 5c0d05b263..1b37ea331e 100644 --- a/x/qgb/keeper/keeper.go +++ b/x/qgb/keeper/keeper.go @@ -40,7 +40,7 @@ func NewKeeper(cdc codec.BinaryCodec, storeKey storetypes.StoreKey, paramSpace p // GetParams returns the parameters from the store func (k Keeper) GetParams(ctx sdk.Context) (params types.Params) { k.paramSpace.GetParamSet(ctx, ¶ms) - return + return params } // SetParams sets the parameters in the store diff --git a/x/qgb/types/validator.go b/x/qgb/types/validator.go index 06b8c890f6..137df75009 100644 --- a/x/qgb/types/validator.go +++ b/x/qgb/types/validator.go @@ -144,7 +144,7 @@ func (ibv InternalBridgeValidators) TotalPower() (out uint64) { for _, v := range ibv { out += v.Power } - return + return out } // HasDuplicates returns true if there are duplicates in the set.