ICS-2 Implement Misbehavior

simapp/app.go

@@ -24,6 +24,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/genutil"
 	"github.com/cosmos/cosmos-sdk/x/gov"
 	"github.com/cosmos/cosmos-sdk/x/ibc"
+	ibcclient "github.com/cosmos/cosmos-sdk/x/ibc/02-client"
 	ibctransfer "github.com/cosmos/cosmos-sdk/x/ibc/20-transfer"
 	"github.com/cosmos/cosmos-sdk/x/mint"
 	"github.com/cosmos/cosmos-sdk/x/params"
@@ -193,8 +194,9 @@ func NewSimApp(
 	evidenceKeeper := evidence.NewKeeper(
 		app.cdc, keys[evidence.StoreKey], app.subspaces[evidence.ModuleName], evidence.DefaultCodespace,
 	)
-	evidenceRouter := evidence.NewRouter()
-	// TODO: Register evidence routes.
+	evidenceRouter := evidence.NewRouter().
+		AddRoute(ibcclient.RouterKey, ibcclient.HandlerClientMisbehaviour(app.IBCKeeper.ClientKeeper))
+
 	evidenceKeeper.SetRouter(evidenceRouter)
 	app.EvidenceKeeper = *evidenceKeeper
 

x/evidence/exported/evidence.go

@@ -14,6 +14,12 @@ type Evidence interface {
 	String() string
 	Hash() cmn.HexBytes
 	ValidateBasic() error
+}
+
+// ValidatorEvidence extends Evidence interface to define contract
+// for evidence against malicious validators
+type ValidatorEvidence interface {
+	Evidence
 
 	// The consensus address of the malicious validator at time of infraction
 	GetConsensusAddress() sdk.ConsAddress

x/ibc/02-client/alias.go

@@ -61,24 +61,21 @@ var (
 	KeyRoot                      = types.KeyRoot
 	NewMsgCreateClient           = types.NewMsgCreateClient
 	NewMsgUpdateClient           = types.NewMsgUpdateClient
-	NewMsgSubmitMisbehaviour     = types.NewMsgSubmitMisbehaviour
 	NewQueryClientStateParams    = types.NewQueryClientStateParams
 	NewQueryCommitmentRootParams = types.NewQueryCommitmentRootParams
 	NewClientState               = types.NewClientState
 
 	// variable aliases
-	SubModuleCdc                = types.SubModuleCdc
-	EventTypeCreateClient       = types.EventTypeCreateClient
-	EventTypeUpdateClient       = types.EventTypeUpdateClient
-	EventTypeSubmitMisbehaviour = types.EventTypeSubmitMisbehaviour
-	AttributeValueCategory      = types.AttributeValueCategory
+	SubModuleCdc           = types.SubModuleCdc
+	EventTypeCreateClient  = types.EventTypeCreateClient
+	EventTypeUpdateClient  = types.EventTypeUpdateClient
+	AttributeValueCategory = types.AttributeValueCategory
 )
 
 type (
 	Keeper                    = keeper.Keeper
 	MsgCreateClient           = types.MsgCreateClient
 	MsgUpdateClient           = types.MsgUpdateClient
-	MsgSubmitMisbehaviour     = types.MsgSubmitMisbehaviour
 	QueryClientStateParams    = types.QueryClientStateParams
 	QueryCommitmentRootParams = types.QueryCommitmentRootParams
 	State                     = types.State

x/ibc/02-client/client/cli/tx.go

@@ -126,47 +126,3 @@ $ %s tx ibc client update [client-id] [path/to/header.json] --from node0 --home
 	}
 	return cmd
 }
-
-// GetCmdSubmitMisbehaviour defines the command to submit a misbehaviour to invalidate
-// previous state roots and prevent future updates as defined in
-// https://github.com/cosmos/ics/tree/master/spec/ics-002-client-semantics#misbehaviour
-func GetCmdSubmitMisbehaviour(cdc *codec.Codec) *cobra.Command {
-	cmd := &cobra.Command{
-		Use:   "misbehaviour [client-it] [path/to/evidence.json]",
-		Short: "submit a client misbehaviour",
-		Long: strings.TrimSpace(fmt.Sprintf(`submit a client misbehaviour to invalidate to invalidate previous state roots and prevent future updates:
-
-Example:
-$ %s tx ibc client misbehaviour [client-id] [path/to/evidence.json] --from node0 --home ../node0/<app>cli --chain-id $CID
-		`, version.ClientName),
-		),
-		Args: cobra.ExactArgs(2),
-		RunE: func(cmd *cobra.Command, args []string) error {
-			txBldr := auth.NewTxBuilderFromCLI().WithTxEncoder(utils.GetTxEncoder(cdc))
-			cliCtx := context.NewCLIContext().WithCodec(cdc)
-
-			clientID := args[0]
-
-			var evidence exported.Evidence
-			if err := cdc.UnmarshalJSON([]byte(args[1]), &evidence); err != nil {
-				fmt.Fprintf(os.Stderr, "failed to unmarshall input into struct, checking for file...")
-
-				contents, err := ioutil.ReadFile(args[1])
-				if err != nil {
-					return fmt.Errorf("error opening proof file: %v", err)
-				}
-				if err := cdc.UnmarshalJSON(contents, &evidence); err != nil {
-					return fmt.Errorf("error unmarshalling evidence file: %v", err)
-				}
-			}
-
-			msg := types.NewMsgSubmitMisbehaviour(clientID, evidence, cliCtx.GetFromAddress())
-			if err := msg.ValidateBasic(); err != nil {
-				return err
-			}
-
-			return utils.GenerateOrBroadcastMsgs(cliCtx, txBldr, []sdk.Msg{msg})
-		},
-	}
-	return cmd
-}

x/ibc/02-client/exported/exported.go

@@ -4,10 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 
-	sdk "github.com/cosmos/cosmos-sdk/types"
-
-	cmn "github.com/tendermint/tendermint/libs/common"
-
+	evidenceexported "github.com/cosmos/cosmos-sdk/x/evidence/exported"
 	commitment "github.com/cosmos/cosmos-sdk/x/ibc/23-commitment"
 )
 
@@ -25,32 +22,10 @@ type ConsensusState interface {
 	CheckValidityAndUpdateState(Header) (ConsensusState, error)
 }
 
-// Evidence from ADR 009: Evidence Module
-// TODO: use evidence module interface once merged
-type Evidence interface {
-	Route() string
-	Type() string
-	String() string
-	Hash() cmn.HexBytes
-	ValidateBasic() sdk.Error
-
-	// The consensus address of the malicious validator at time of infraction
-	GetConsensusAddress() sdk.ConsAddress
-
-	// Height at which the infraction occurred
-	GetHeight() int64
-
-	// The total power of the malicious validator at time of infraction
-	GetValidatorPower() int64
-
-	// The total validator set power at time of infraction
-	GetTotalPower() int64
-}
-
 // Misbehaviour defines a specific consensus kind and an evidence
 type Misbehaviour interface {
 	ClientType() ClientType
-	Evidence() Evidence
+	GetEvidence() evidenceexported.Evidence
 }
 
 // Header is the consensus state update information

x/ibc/02-client/handler.go

@@ -1,8 +1,13 @@
 package client
 
 import (
+	"fmt"
+
 	sdk "github.com/cosmos/cosmos-sdk/types"
-	exported "github.com/cosmos/cosmos-sdk/x/ibc/02-client/exported"
+	"github.com/cosmos/cosmos-sdk/x/evidence"
+	evidenceexported "github.com/cosmos/cosmos-sdk/x/evidence/exported"
+	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/exported"
+	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/types/tendermint"
 )
 
 // HandleMsgCreateClient defines the sdk.Handler for MsgCreateClient
@@ -12,7 +17,6 @@ func HandleMsgCreateClient(ctx sdk.Context, k Keeper, msg MsgCreateClient) sdk.R
 		return sdk.ResultFromError(ErrInvalidClientType(DefaultCodespace, err.Error()))
 	}
 
-	// TODO: should we create an event with the new client state id ?
 	_, err = k.CreateClient(ctx, msg.ClientID, clientType, msg.ConsensusState)
 	if err != nil {
 		return sdk.ResultFromError(err)
@@ -55,24 +59,17 @@ func HandleMsgUpdateClient(ctx sdk.Context, k Keeper, msg MsgUpdateClient) sdk.R
 	return sdk.Result{Events: ctx.EventManager().Events()}
 }
 
-// HandleMsgSubmitMisbehaviour defines the sdk.Handler for MsgSubmitMisbehaviour
-func HandleMsgSubmitMisbehaviour(ctx sdk.Context, k Keeper, msg MsgSubmitMisbehaviour) sdk.Result {
-	err := k.CheckMisbehaviourAndUpdateState(ctx, msg.ClientID, msg.Evidence)
-	if err != nil {
-		return sdk.ResultFromError(err)
-	}
+// HandlerClientMisbehaviour defines the Evidence module handler for submitting a
+// light client misbehaviour.
+func HandlerClientMisbehaviour(k Keeper) evidence.Handler {
+	return func(ctx sdk.Context, evidence evidenceexported.Evidence) error {
+		switch e := evidence.(type) {
+		case tendermint.Misbehaviour:
+			return k.CheckMisbehaviourAndUpdateState(ctx, evidence)
 
-	ctx.EventManager().EmitEvents(sdk.Events{
-		sdk.NewEvent(
-			EventTypeSubmitMisbehaviour,
-			sdk.NewAttribute(AttributeKeyClientID, msg.ClientID),
-		),
-		sdk.NewEvent(
-			sdk.EventTypeMessage,
-			sdk.NewAttribute(sdk.AttributeKeyModule, AttributeValueCategory),
-			sdk.NewAttribute(sdk.AttributeKeySender, msg.Signer.String()),
-		),
-	})
-
-	return sdk.Result{Events: ctx.EventManager().Events()}
+		default:
+			errMsg := fmt.Sprintf("unrecognized IBC client evidence type: %T", e)
+			return sdk.ErrUnknownRequest(errMsg)
+		}
+	}
 }

x/ibc/02-client/keeper/client.go

@@ -5,9 +5,11 @@ import (
 
 	sdk "github.com/cosmos/cosmos-sdk/types"
 	sdkerrors "github.com/cosmos/cosmos-sdk/types/errors"
+	evidenceexported "github.com/cosmos/cosmos-sdk/x/evidence/exported"
 	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/exported"
 	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/types"
 	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/types/errors"
+	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/types/tendermint"
 )
 
 // CreateClient creates a new client state and populates it with a given consensus
@@ -73,23 +75,38 @@ func (k Keeper) UpdateClient(ctx sdk.Context, clientID string, header exported.H
 
 // CheckMisbehaviourAndUpdateState checks for client misbehaviour and freezes the
 // client if so.
-func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, clientID string, evidence exported.Evidence) error {
-	clientState, found := k.GetClientState(ctx, clientID)
+//
+// NOTE: In the first implementation, only Tendermint misbehaviour evidence is
+// supported.
+func (k Keeper) CheckMisbehaviourAndUpdateState(ctx sdk.Context, evidence evidenceexported.Evidence) error {
+	misbehaviour, ok := evidence.(tendermint.Misbehaviour)
+	if !ok {
+		return errors.ErrInvalidClientType(k.codespace, "consensus type is not Tendermint")
+	}
+
+	clientState, found := k.GetClientState(ctx, misbehaviour.ClientID)
 	if !found {
-		sdk.ResultFromError(errors.ErrClientNotFound(k.codespace, clientID))
+		sdk.ResultFromError(errors.ErrClientNotFound(k.codespace, misbehaviour.ClientID))
 	}
 
-	err := k.checkMisbehaviour(ctx, evidence)
-	if err != nil {
-		return err
+	if err := tendermint.CheckMisbehaviour(misbehaviour); err != nil {
+		return errors.ErrInvalidEvidence(k.codespace, err.Error())
 	}
 
-	clientState, err = k.freeze(ctx, clientState)
+	clientState, err := k.freeze(ctx, clientState)
 	if err != nil {
 		return err
 	}
 
 	k.SetClientState(ctx, clientState)
-	k.Logger(ctx).Info(fmt.Sprintf("client %s frozen due to misbehaviour", clientID))
+	k.Logger(ctx).Info(fmt.Sprintf("client %s frozen due to misbehaviour", misbehaviour.ClientID))
+
+	ctx.EventManager().EmitEvent(
+		sdk.NewEvent(
+			types.EventTypeSubmitMisbehaviour,
+			sdk.NewAttribute(types.AttributeKeyClientID, misbehaviour.ClientID),
+		),
+	)
+
 	return nil
 }

x/ibc/02-client/keeper/keeper.go

@@ -12,7 +12,6 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/exported"
 	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/types"
 	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/types/errors"
-	"github.com/cosmos/cosmos-sdk/x/ibc/02-client/types/tendermint"
 	commitment "github.com/cosmos/cosmos-sdk/x/ibc/23-commitment"
 	ibctypes "github.com/cosmos/cosmos-sdk/x/ibc/types"
 )
@@ -127,24 +126,6 @@ func (k Keeper) initialize(ctx sdk.Context, clientID string, consensusState expo
 	return clientState
 }
 
-func (k Keeper) checkMisbehaviour(ctx sdk.Context, evidence exported.Evidence) error {
-	switch evidence.Type() {
-	case exported.ClientTypeTendermint:
-		var tmEvidence tendermint.Evidence
-		_, ok := evidence.(tendermint.Evidence)
-		if !ok {
-			return errors.ErrInvalidClientType(k.codespace, "consensus type is not Tendermint")
-		}
-		err := tendermint.CheckMisbehaviour(tmEvidence)
-		if err != nil {
-			return errors.ErrInvalidEvidence(k.codespace, err.Error())
-		}
-	default:
-		panic(fmt.Sprintf("unregistered evidence type: %s", evidence.Type()))
-	}
-	return nil
-}
-
 // freeze updates the state of the client in the event of a misbehaviour
 func (k Keeper) freeze(ctx sdk.Context, clientState types.State) (types.State, error) {
 	if clientState.Frozen {
@@ -164,12 +145,14 @@ func (k Keeper) VerifyMembership(
 	path commitment.PathI,
 	value []byte,
 ) bool {
-	// XXX: commented out for demo
-	/*
-		if clientState.Frozen {
-			return false
-		}
-	*/
+	clientState, found := k.GetClientState(ctx, clientID)
+	if !found {
+		return false
+	}
+
+	if clientState.Frozen {
+		return false
+	}
 
 	root, found := k.GetVerifiedRoot(ctx, clientID, height)
 	if !found {
@@ -187,12 +170,15 @@ func (k Keeper) VerifyNonMembership(
 	proof commitment.ProofI,
 	path commitment.PathI,
 ) bool {
-	// XXX: commented out for demo
-	/*
-		if clientState.Frozen {
-			return false
-		}
-	*/
+	clientState, found := k.GetClientState(ctx, clientID)
+	if !found {
+		return false
+	}
+
+	if clientState.Frozen {
+		return false
+	}
+
 	root, found := k.GetVerifiedRoot(ctx, clientID, height)
 	if !found {
 		return false

x/ibc/02-client/types/codec.go

@@ -12,7 +12,6 @@ var SubModuleCdc *codec.Codec
 // RegisterCodec registers the IBC client interfaces and types
 func RegisterCodec(cdc *codec.Codec) {
 	cdc.RegisterInterface((*exported.ConsensusState)(nil), nil)
-	cdc.RegisterInterface((*exported.Evidence)(nil), nil)
 	cdc.RegisterInterface((*exported.Header)(nil), nil)
 	cdc.RegisterInterface((*exported.Misbehaviour)(nil), nil)
 

x/ibc/02-client/types/events.go

@@ -13,9 +13,9 @@ const (
 
 // IBC client events vars
 var (
-	EventTypeCreateClient       = MsgCreateClient{}.Type()
-	EventTypeUpdateClient       = MsgUpdateClient{}.Type()
-	EventTypeSubmitMisbehaviour = MsgSubmitMisbehaviour{}.Type()
+	EventTypeCreateClient       = TypeMsgCreateClient
+	EventTypeUpdateClient       = TypeMsgUpdateClient
+	EventTypeSubmitMisbehaviour = TypeClientMisbehaviour
 
 	AttributeValueCategory = fmt.Sprintf("%s_%s", ibctypes.ModuleName, SubModuleName)
 )

x/ibc/02-client/types/keys.go

@@ -6,16 +6,16 @@ import (
 
 const (
 	// SubModuleName defines the IBC client name
-	SubModuleName = "client"
+	SubModuleName string = "client"
 
 	// StoreKey is the store key string for IBC client
-	StoreKey = SubModuleName
+	StoreKey string = SubModuleName
 
 	// RouterKey is the message route for IBC client
-	RouterKey = SubModuleName
+	RouterKey string = SubModuleName
 
 	// QuerierRoute is the querier route for IBC client
-	QuerierRoute = SubModuleName
+	QuerierRoute string = SubModuleName
 )
 
 // KVStore key prefixes