From eec57ba988a65cfeb8bfda28a0f3755236e90793 Mon Sep 17 00:00:00 2001 From: Jacob Gadikian Date: Thu, 31 Aug 2023 02:10:01 +0800 Subject: [PATCH] code consistency --- .golangci.yml | 2 ++ cmd/feegrant.go | 6 ++--- relayer/chains/cosmos/event_parser.go | 8 +++---- relayer/chains/cosmos/feegrant.go | 4 ++-- relayer/chains/cosmos/query.go | 9 ++++---- relayer/chains/cosmos/tx.go | 4 ++-- relayer/chains/penumbra/event_parser.go | 8 +++---- relayer/chains/penumbra/grpc_query.go | 2 +- relayer/chains/penumbra/msg.go | 6 ++--- relayer/packet-tx.go | 17 +++++++-------- relayer/processor/types.go | 10 ++++----- relayer/provider/matcher.go | 29 +++++++++++++++---------- relayer/strategies.go | 6 ++--- 13 files changed, 58 insertions(+), 53 deletions(-) diff --git a/.golangci.yml b/.golangci.yml index 485d5872f..941823bea 100644 --- a/.golangci.yml +++ b/.golangci.yml @@ -64,6 +64,8 @@ linters-settings: # Do NOT whine about the following, full explanation found in: # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#description-of-available-rules rules: + - name: exported + disabled: true - name: use-any disabled: true - name: if-return diff --git a/cmd/feegrant.go b/cmd/feegrant.go index 26a30c327..f62ac1bff 100644 --- a/cmd/feegrant.go +++ b/cmd/feegrant.go @@ -27,7 +27,7 @@ func feegrantConfigureBaseCmd(a *appState) *cobra.Command { func feegrantConfigureBasicCmd(a *appState) *cobra.Command { var numGrantees int var update bool - var delete bool + var deleteChain bool var updateGrantees bool var grantees []string @@ -63,7 +63,7 @@ func feegrantConfigureBasicCmd(a *appState) *cobra.Command { return fmt.Errorf("could not get granter key from '%s'", granterKeyOrAddr) } - if delete { + if deleteChain { fmt.Printf("Deleting %s feegrant configuration\n", chain) cfgErr := a.performConfigLockingOperation(cmd.Context(), func() error { @@ -140,7 +140,7 @@ func feegrantConfigureBasicCmd(a *appState) *cobra.Command { }, } - cmd.Flags().BoolVar(&delete, "delete", false, "delete the feegrant configuration") + cmd.Flags().BoolVar(&deleteChain, "delete", false, "delete the feegrant configuration") cmd.Flags().BoolVar(&update, "overwrite-granter", false, "allow overwriting the existing granter") cmd.Flags().BoolVar(&updateGrantees, "overwrite-grantees", false, "allow overwriting existing grantees") cmd.Flags().IntVar(&numGrantees, "num-grantees", 10, "number of grantees that will be feegranted with basic allowances") diff --git a/relayer/chains/cosmos/event_parser.go b/relayer/chains/cosmos/event_parser.go index 04923d232..e9cfde686 100644 --- a/relayer/chains/cosmos/event_parser.go +++ b/relayer/chains/cosmos/event_parser.go @@ -153,12 +153,12 @@ type clientInfo struct { header []byte } -func (c clientInfo) ClientState(trustingPeriod time.Duration) provider.ClientState { +func (res clientInfo) ClientState(trustingPeriod time.Duration) provider.ClientState { return provider.ClientState{ - ClientID: c.clientID, - ConsensusHeight: c.consensusHeight, + ClientID: res.clientID, + ConsensusHeight: res.consensusHeight, TrustingPeriod: trustingPeriod, - Header: c.header, + Header: res.header, } } diff --git a/relayer/chains/cosmos/feegrant.go b/relayer/chains/cosmos/feegrant.go index c1ea091f0..e8cc38dce 100644 --- a/relayer/chains/cosmos/feegrant.go +++ b/relayer/chains/cosmos/feegrant.go @@ -199,7 +199,7 @@ func (cc *CosmosProvider) GetTxFeeGrant() (txSignerKey string, feeGranterKey str if lastGranteeIdx >= 0 && lastGranteeIdx <= len(cc.PCfg.FeeGrants.ManagedGrantees)-1 { txSignerKey = cc.PCfg.FeeGrants.ManagedGrantees[lastGranteeIdx] - cc.PCfg.FeeGrants.GranteeLastSignerIndex = cc.PCfg.FeeGrants.GranteeLastSignerIndex + 1 + cc.PCfg.FeeGrants.GranteeLastSignerIndex++ if cc.PCfg.FeeGrants.GranteeLastSignerIndex == len(cc.PCfg.FeeGrants.ManagedGrantees) { cc.PCfg.FeeGrants.GranteeLastSignerIndex = 0 @@ -271,7 +271,7 @@ func (cc *CosmosProvider) EnsureBasicGrants(ctx context.Context, memo string) (* } if !hasGrant { - grantsNeeded += 1 + grantsNeeded++ fmt.Printf("Grant will be created on chain for granter %s and grantee %s\n", granterAddr, granteeAddr) grantMsg, err := cc.getMsgGrantBasicAllowance(granterAcc, granteeAcc) if err != nil { diff --git a/relayer/chains/cosmos/query.go b/relayer/chains/cosmos/query.go index 5521f72f3..de19d4031 100644 --- a/relayer/chains/cosmos/query.go +++ b/relayer/chains/cosmos/query.go @@ -27,7 +27,6 @@ import ( "github.com/cosmos/cosmos-sdk/codec" sdk "github.com/cosmos/cosmos-sdk/types" - sdkerrors "github.com/cosmos/cosmos-sdk/types/errors" grpctypes "github.com/cosmos/cosmos-sdk/types/grpc" "github.com/cosmos/cosmos-sdk/types/query" bankTypes "github.com/cosmos/cosmos-sdk/x/bank/types" @@ -420,7 +419,7 @@ func (cc *CosmosProvider) QueryClientStateResponse(ctx context.Context, height i // check if client exists if len(value) == 0 { - return nil, sdkerrors.Wrap(clienttypes.ErrClientNotFound, srcClientId) + return nil, errorsmod.Wrap(clienttypes.ErrClientNotFound, srcClientId) } cdc := codec.NewProtoCodec(cc.Cdc.InterfaceRegistry) @@ -469,7 +468,7 @@ func (cc *CosmosProvider) QueryClientConsensusState(ctx context.Context, chainHe // check if consensus state exists if len(value) == 0 { - return nil, sdkerrors.Wrap(clienttypes.ErrConsensusStateNotFound, clientid) + return nil, errorsmod.Wrap(clienttypes.ErrConsensusStateNotFound, clientid) } cdc := codec.NewProtoCodec(cc.Cdc.InterfaceRegistry) @@ -666,7 +665,7 @@ func (cc *CosmosProvider) queryConnectionABCI(ctx context.Context, height int64, // check if connection exists if len(value) == 0 { - return nil, sdkerrors.Wrap(conntypes.ErrConnectionNotFound, connectionID) + return nil, errorsmod.Wrap(conntypes.ErrConnectionNotFound, connectionID) } cdc := codec.NewProtoCodec(cc.Cdc.InterfaceRegistry) @@ -1264,7 +1263,7 @@ func (cc *CosmosProvider) QueryConsensusStateABCI(ctx context.Context, clientID // check if consensus state exists if len(value) == 0 { - return nil, sdkerrors.Wrap(clienttypes.ErrConsensusStateNotFound, clientID) + return nil, errorsmod.Wrap(clienttypes.ErrConsensusStateNotFound, clientID) } // TODO do we really want to create a new codec? ChainClient exposes proto.Marshaler diff --git a/relayer/chains/cosmos/tx.go b/relayer/chains/cosmos/tx.go index 22f9caa2b..f5e7cd2d5 100644 --- a/relayer/chains/cosmos/tx.go +++ b/relayer/chains/cosmos/tx.go @@ -495,8 +495,8 @@ func (cc *CosmosProvider) mkTxResult(resTx *coretypes.ResultTx) (*sdk.TxResponse if !ok { return nil, fmt.Errorf("expecting a type implementing intoAny, got: %T", txbz) } - any := p.AsAny() - return sdk.NewResponseResultTx(resTx, any, ""), nil + anyResult := p.AsAny() + return sdk.NewResponseResultTx(resTx, anyResult, ""), nil } func parseEventsFromTxResponse(resp *sdk.TxResponse) []provider.RelayerEvent { diff --git a/relayer/chains/penumbra/event_parser.go b/relayer/chains/penumbra/event_parser.go index c6084e60f..d7ba37a21 100644 --- a/relayer/chains/penumbra/event_parser.go +++ b/relayer/chains/penumbra/event_parser.go @@ -33,13 +33,13 @@ type ibcMessageInfo interface { MarshalLogObject(enc zapcore.ObjectEncoder) error } -func (ccp *PenumbraChainProcessor) ibcMessagesFromBlockEvents( +func (pcp *PenumbraChainProcessor) ibcMessagesFromBlockEvents( beginBlockEvents, endBlockEvents []abci.Event, height uint64, base64Encoded bool, ) (res []ibcMessage) { - chainID := ccp.chainProvider.ChainId() - res = append(res, ibcMessagesFromEvents(ccp.log, beginBlockEvents, chainID, height, base64Encoded)...) - res = append(res, ibcMessagesFromEvents(ccp.log, endBlockEvents, chainID, height, base64Encoded)...) + chainID := pcp.chainProvider.ChainId() + res = append(res, ibcMessagesFromEvents(pcp.log, beginBlockEvents, chainID, height, base64Encoded)...) + res = append(res, ibcMessagesFromEvents(pcp.log, endBlockEvents, chainID, height, base64Encoded)...) return res } diff --git a/relayer/chains/penumbra/grpc_query.go b/relayer/chains/penumbra/grpc_query.go index 6bce3d892..9c3f98ac6 100644 --- a/relayer/chains/penumbra/grpc_query.go +++ b/relayer/chains/penumbra/grpc_query.go @@ -41,7 +41,7 @@ func (cc *PenumbraProvider) Invoke(ctx context.Context, method string, req, repl // In both cases, we don't allow empty request req (it will panic unexpectedly). if reflect.ValueOf(req).IsNil() { - return sdkerrors.Wrap(sdkerrors.ErrInvalidRequest, "request cannot be nil") + return errorsmod.Wrap(sdkerrors.ErrInvalidRequest, "request cannot be nil") } // Case 1. Broadcasting a Tx. diff --git a/relayer/chains/penumbra/msg.go b/relayer/chains/penumbra/msg.go index 35de1b8cb..0bb7f9c75 100644 --- a/relayer/chains/penumbra/msg.go +++ b/relayer/chains/penumbra/msg.go @@ -35,11 +35,11 @@ func PenumbraMsg(rm provider.RelayerMessage) sdk.Msg { func PenumbraMsgs(rm ...provider.RelayerMessage) []sdk.Msg { sdkMsgs := make([]sdk.Msg, 0) for _, rMsg := range rm { - switch rMsg.(type) { + switch msg := rMsg.(type) { case PenumbraMessage: - sdkMsgs = append(sdkMsgs, rMsg.(PenumbraMessage).Msg) + sdkMsgs = append(sdkMsgs, msg.Msg) case cosmos.CosmosMessage: - sdkMsgs = append(sdkMsgs, rMsg.(cosmos.CosmosMessage).Msg) + sdkMsgs = append(sdkMsgs, msg.Msg) default: fmt.Printf("got data of type %T but wanted PenumbraMessage \n", rMsg) return nil diff --git a/relayer/packet-tx.go b/relayer/packet-tx.go index 54f341430..e868c4a67 100644 --- a/relayer/packet-tx.go +++ b/relayer/packet-tx.go @@ -115,15 +115,14 @@ func (c *Chain) SendTransferMsg(ctx context.Context, log *zap.Logger, dst *Chain ) } return err - } else { - if result.SuccessfullySent() { - c.log.Info( - "Successfully sent a transfer", - zap.String("src_chain_id", c.ChainID()), - zap.String("dst_chain_id", dst.ChainID()), - zap.Object("send_result", result), - ) - } + } else if result.SuccessfullySent() { + c.log.Info( + "Successfully sent a transfer", + zap.String("src_chain_id", c.ChainID()), + zap.String("dst_chain_id", dst.ChainID()), + zap.Object("send_result", result), + ) } + return nil } diff --git a/relayer/processor/types.go b/relayer/processor/types.go index 1f1b1454c..ed731b28a 100644 --- a/relayer/processor/types.go +++ b/relayer/processor/types.go @@ -236,11 +236,11 @@ func (connectionKey ConnectionKey) PreInitKey() ConnectionKey { } } -func (k ConnectionKey) MarshalLogObject(enc zapcore.ObjectEncoder) error { - enc.AddString("connection_id", k.ConnectionID) - enc.AddString("client_id", k.ClientID) - enc.AddString("counterparty_connection_id", k.CounterpartyConnID) - enc.AddString("counterparty_client_id", k.CounterpartyClientID) +func (connectionKey ConnectionKey) MarshalLogObject(enc zapcore.ObjectEncoder) error { + enc.AddString("connection_id", connectionKey.ConnectionID) + enc.AddString("client_id", connectionKey.ClientID) + enc.AddString("counterparty_connection_id", connectionKey.CounterpartyConnID) + enc.AddString("counterparty_client_id", connectionKey.CounterpartyClientID) return nil } diff --git a/relayer/provider/matcher.go b/relayer/provider/matcher.go index d8bcc797a..d3d6aca7d 100644 --- a/relayer/provider/matcher.go +++ b/relayer/provider/matcher.go @@ -35,9 +35,12 @@ func ClientsMatch(ctx context.Context, src, dst ChainProvider, existingClient cl return "", nil } - switch ec := existingClientState.(type) { - case *tmclient.ClientState: - nc := newClient.(*tmclient.ClientState) + if ec, ok := existingClientState.(*tmclient.ClientState); ok { + nc, ok := newClient.(*tmclient.ClientState) + if !ok { + return "", fmt.Errorf("got type(%T) expected type(*tmclient.ClientState)", newClient) + } + return cometMatcher(ctx, src, dst, existingClient.ClientId, ec, nc) } @@ -64,15 +67,17 @@ func CheckForMisbehaviour( return nil, err } - switch header := clientMsg.(type) { - case *tmclient.Header: - misbehavior, err = checkTendermintMisbehaviour(ctx, clientID, header, cachedHeader, counterparty) - if err != nil { - return nil, err - } - if misbehavior == nil && err == nil { - return nil, nil - } + header, ok := clientMsg.(*tmclient.Header) + if !ok { + return nil, nil + } + + misbehavior, err = checkTendermintMisbehaviour(ctx, clientID, header, cachedHeader, counterparty) + if err != nil { + return nil, err + } + if misbehavior == nil && err == nil { + return nil, nil } return misbehavior, nil diff --git a/relayer/strategies.go b/relayer/strategies.go index b61c9f95f..705ebc274 100644 --- a/relayer/strategies.go +++ b/relayer/strategies.go @@ -118,15 +118,15 @@ type path struct { } // chainProcessor returns the corresponding ChainProcessor implementation instance for a pathChain. -func (chain *Chain) chainProcessor(log *zap.Logger, metrics *processor.PrometheusMetrics) processor.ChainProcessor { +func (c *Chain) chainProcessor(log *zap.Logger, metrics *processor.PrometheusMetrics) processor.ChainProcessor { // Handle new ChainProcessor implementations as cases here - switch p := chain.ChainProvider.(type) { + switch p := c.ChainProvider.(type) { case *penumbraprocessor.PenumbraProvider: return penumbraprocessor.NewPenumbraChainProcessor(log, p) case *cosmos.CosmosProvider: return cosmos.NewCosmosChainProcessor(log, p, metrics) default: - panic(fmt.Errorf("unsupported chain provider type: %T", chain.ChainProvider)) + panic(fmt.Errorf("unsupported chain provider type: %T", c.ChainProvider)) } }