From 992dc8b2dc7d201c7b8cd440c24ed6ef1bf4e69c Mon Sep 17 00:00:00 2001 From: Alexander Bezobchuk Date: Thu, 21 Feb 2019 03:49:57 -0500 Subject: [PATCH] Merge PR #3691: Minor Error Message Cleanup * cleanup error messages * Add pending log entry * Rename Message to Error in ErrorResponse --- PENDING.md | 3 ++- types/rest/rest.go | 8 ++++---- x/auth/ante.go | 2 +- x/auth/keeper.go | 8 +++++--- x/staking/querier/querier.go | 20 +++++++++++--------- 5 files changed, 23 insertions(+), 18 deletions(-) diff --git a/PENDING.md b/PENDING.md index 4402fa0f65..d95004516d 100644 --- a/PENDING.md +++ b/PENDING.md @@ -45,9 +45,10 @@ ### SDK +* [\#3665] Overhaul sdk.Uint type in preparation for Coins Int -> Uint migration. +* \#3691 Cleanup error messages * \#3456 Integrate in the Int.ToDec() convenience function * [\#3300] Update the spec-spec, spec file reorg, and TOC updates. -* [\#3665] Overhaul sdk.Uint type in preparation for Coins's Int -> Uint migration. ### Tendermint diff --git a/types/rest/rest.go b/types/rest/rest.go index b19c8fddb6..1cf2b8bb59 100644 --- a/types/rest/rest.go +++ b/types/rest/rest.go @@ -111,13 +111,13 @@ func ReadRESTReq(w http.ResponseWriter, r *http.Request, cdc *codec.Codec, req i // ErrorResponse defines the attributes of a JSON error response. type ErrorResponse struct { - Code int `json:"code,omitempty"` - Message string `json:"message"` + Code int `json:"code,omitempty"` + Error string `json:"error"` } // NewErrorResponse creates a new ErrorResponse instance. -func NewErrorResponse(code int, msg string) ErrorResponse { - return ErrorResponse{Code: code, Message: msg} +func NewErrorResponse(code int, err string) ErrorResponse { + return ErrorResponse{Code: code, Error: err} } // WriteErrorResponse prepares and writes a HTTP error diff --git a/x/auth/ante.go b/x/auth/ante.go index ddf9dbecd1..a4131f4c8c 100644 --- a/x/auth/ante.go +++ b/x/auth/ante.go @@ -146,7 +146,7 @@ func GetSignerAcc(ctx sdk.Context, ak AccountKeeper, addr sdk.AccAddress) (Accou if acc := ak.GetAccount(ctx, addr); acc != nil { return acc, sdk.Result{} } - return nil, sdk.ErrUnknownAddress(addr.String()).Result() + return nil, sdk.ErrUnknownAddress(fmt.Sprintf("account %s does not exist", addr)).Result() } // ValidateMemo validates the memo size. diff --git a/x/auth/keeper.go b/x/auth/keeper.go index 84899fa1c3..3727981cf3 100644 --- a/x/auth/keeper.go +++ b/x/auth/keeper.go @@ -1,6 +1,8 @@ package auth import ( + "fmt" + "github.com/tendermint/tendermint/crypto" codec "github.com/cosmos/cosmos-sdk/codec" @@ -143,7 +145,7 @@ func (ak AccountKeeper) IterateAccounts(ctx sdk.Context, process func(Account) ( func (ak AccountKeeper) GetPubKey(ctx sdk.Context, addr sdk.AccAddress) (crypto.PubKey, sdk.Error) { acc := ak.GetAccount(ctx, addr) if acc == nil { - return nil, sdk.ErrUnknownAddress(addr.String()) + return nil, sdk.ErrUnknownAddress(fmt.Sprintf("account %s does not exist", addr)) } return acc.GetPubKey(), nil } @@ -152,7 +154,7 @@ func (ak AccountKeeper) GetPubKey(ctx sdk.Context, addr sdk.AccAddress) (crypto. func (ak AccountKeeper) GetSequence(ctx sdk.Context, addr sdk.AccAddress) (uint64, sdk.Error) { acc := ak.GetAccount(ctx, addr) if acc == nil { - return 0, sdk.ErrUnknownAddress(addr.String()) + return 0, sdk.ErrUnknownAddress(fmt.Sprintf("account %s does not exist", addr)) } return acc.GetSequence(), nil } @@ -160,7 +162,7 @@ func (ak AccountKeeper) GetSequence(ctx sdk.Context, addr sdk.AccAddress) (uint6 func (ak AccountKeeper) setSequence(ctx sdk.Context, addr sdk.AccAddress, newSequence uint64) sdk.Error { acc := ak.GetAccount(ctx, addr) if acc == nil { - return sdk.ErrUnknownAddress(addr.String()) + return sdk.ErrUnknownAddress(fmt.Sprintf("account %s does not exist", addr)) } if err := acc.SetSequence(newSequence); err != nil { diff --git a/x/staking/querier/querier.go b/x/staking/querier/querier.go index e842c2197f..4230dc6a43 100644 --- a/x/staking/querier/querier.go +++ b/x/staking/querier/querier.go @@ -1,6 +1,8 @@ package querier import ( + "fmt" + abci "github.com/tendermint/tendermint/abci/types" "github.com/cosmos/cosmos-sdk/codec" @@ -142,7 +144,7 @@ func queryValidator(ctx sdk.Context, cdc *codec.Codec, req abci.RequestQuery, k errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } validator, found := k.GetValidator(ctx, params.ValidatorAddr) @@ -162,7 +164,7 @@ func queryValidatorDelegations(ctx sdk.Context, cdc *codec.Codec, req abci.Reque errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } delegations := k.GetValidatorDelegations(ctx, params.ValidatorAddr) @@ -179,7 +181,7 @@ func queryValidatorUnbondingDelegations(ctx sdk.Context, cdc *codec.Codec, req a errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } unbonds := k.GetUnbondingDelegationsFromValidator(ctx, params.ValidatorAddr) @@ -196,7 +198,7 @@ func queryDelegatorDelegations(ctx sdk.Context, cdc *codec.Codec, req abci.Reque errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } delegations := k.GetAllDelegatorDelegations(ctx, params.DelegatorAddr) @@ -213,7 +215,7 @@ func queryDelegatorUnbondingDelegations(ctx sdk.Context, cdc *codec.Codec, req a errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } unbondingDelegations := k.GetAllUnbondingDelegations(ctx, params.DelegatorAddr) @@ -232,7 +234,7 @@ func queryDelegatorValidators(ctx sdk.Context, cdc *codec.Codec, req abci.Reques errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } validators := k.GetDelegatorValidators(ctx, params.DelegatorAddr, stakingParams.MaxValidators) @@ -249,7 +251,7 @@ func queryDelegatorValidator(ctx sdk.Context, cdc *codec.Codec, req abci.Request errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } validator, err := k.GetDelegatorValidator(ctx, params.DelegatorAddr, params.ValidatorAddr) @@ -269,7 +271,7 @@ func queryDelegation(ctx sdk.Context, cdc *codec.Codec, req abci.RequestQuery, k errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } delegation, found := k.GetDelegation(ctx, params.DelegatorAddr, params.ValidatorAddr) @@ -289,7 +291,7 @@ func queryUnbondingDelegation(ctx sdk.Context, cdc *codec.Codec, req abci.Reques errRes := cdc.UnmarshalJSON(req.Data, ¶ms) if errRes != nil { - return []byte{}, sdk.ErrUnknownAddress("") + return []byte{}, sdk.ErrInternal(fmt.Sprintf("failed to parse params: %s", err)) } unbond, found := k.GetUnbondingDelegation(ctx, params.DelegatorAddr, params.ValidatorAddr)