implement solo machine client

proto/ibc/light-clients/solomachine/v1/solomachine.proto

@@ -0,0 +1,95 @@
+syntax = "proto3";
+package ibc.lightclients.v1.solomachine;
+
+option go_package = "github.com/cosmos/cosmos-sdk/x/ibc/light-clients/solomachine/types";
+
+import "cosmos/base/crypto/v1beta1/crypto.proto";
+import "gogoproto/gogo.proto";
+
+// ClientState defines a solo machine client that tracks the current consensus
+// state and if the client is frozen.
+message ClientState {
+  option (gogoproto.goproto_getters) = false;
+  // client ID
+  string id = 1;
+  // chainID for the connected solo machine
+  string chain_id = 2 [(gogoproto.moretags) = "yaml:\"chain_id\""];
+  // frozen height of the solo machine
+  uint64 frozen_height = 3 [(gogoproto.moretags) = "yaml:\"frozen_height\""];
+  ConsensusState consensus_state = 4
+      [(gogoproto.moretags) = "yaml:\"consensus_state\""];
+}
+
+// ConsensusState defines a solo machine consensus state
+message ConsensusState {
+  option (gogoproto.goproto_getters) = false;
+  // current sequence of the consensus state
+  uint64 sequence = 1;
+  // public key of the solo machine
+  cosmos.base.crypto.v1beta1.PublicKey public_key = 2
+      [(gogoproto.moretags) = "yaml:\"public_key\""];
+  uint64 timestamp = 3;
+}
+
+// Header defines a solo machine consensus header
+message Header {
+  option (gogoproto.goproto_getters) = false;
+  // sequence to update solo machine public key at
+  uint64                               sequence       = 1;
+  bytes                                signature      = 2;
+  cosmos.base.crypto.v1beta1.PublicKey new_public_key = 3
+      [(gogoproto.moretags) = "yaml:\"new_public_key\""];
+}
+
+// Evidence defines evidence of misbehaviour for a solo machine which consists
+// of a sequence and two signatures over different messages at that sequence.
+message Evidence {
+  option (gogoproto.goproto_getters)  = false;
+  option (gogoproto.goproto_stringer) = false;
+  string           client_id = 1 [(gogoproto.moretags) = "yaml:\"client_id\""];
+  uint64           sequence  = 2;
+  SignatureAndData signature_one = 3
+      [(gogoproto.moretags) = "yaml:\"signature_one\""];
+  SignatureAndData signature_two = 4
+      [(gogoproto.moretags) = "yaml:\"signature_two\""];
+}
+
+// SignatureAndData contains a signature and the data signed over to create that
+// signature.
+message SignatureAndData {
+  option (gogoproto.goproto_getters) = false;
+  bytes signature                    = 1;
+  bytes data                         = 2;
+}
+
+// Signature contains the signature and the timestamp of the signature.
+message Signature {
+  option (gogoproto.goproto_getters) = false;
+  bytes  signature                   = 1;
+  uint64 timestamp                   = 2;
+}
+// MsgCreateClient defines a message to create an IBC client
+message MsgCreateClient {
+  option (gogoproto.goproto_getters) = false;
+  string         client_id = 1 [(gogoproto.moretags) = "yaml:\"client_id\""];
+  string         chain_id  = 2 [(gogoproto.moretags) = "yaml:\"chain_id\""];
+  ConsensusState consensus_state = 3
+      [(gogoproto.moretags) = "yaml:\"consensus_state\""];
+}
+
+// MsgUpdateClient defines a message to update an IBC client
+message MsgUpdateClient {
+  option (gogoproto.goproto_getters) = false;
+  string client_id = 1 [(gogoproto.moretags) = "yaml:\"client_id\""];
+  Header header    = 2 [(gogoproto.nullable) = false];
+}
+
+// MsgSubmitClientMisbehaviour defines an sdk.Msg type that supports submitting
+// arbitrary Evidence.
+message MsgSubmitClientMisbehaviour {
+  option (gogoproto.goproto_getters) = false;
+  bytes submitter                    = 1
+      [(gogoproto.casttype) = "github.com/cosmos/cosmos-sdk/types.AccAddress"];
+  Evidence evidence = 2 [(gogoproto.nullable) = false];
+}
+

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

@@ -146,6 +146,13 @@ type Header interface {
 	GetHeight() uint64
 }
 
+// message types for the IBC client
+const (
+	TypeMsgCreateClient             string = "create_client"
+	TypeMsgUpdateClient             string = "update_client"
+	TypeMsgSubmitClientMisbehaviour string = "submit_client_misbehaviour"
+)
+
 // MsgCreateClient defines the msg interface that the
 // CreateClient Handler expects
 type MsgCreateClient interface {
@@ -169,14 +176,16 @@ type ClientType byte
 
 // available client types
 const (
-	Tendermint ClientType = iota + 1 // 1
-	Localhost
+	SoloMachine ClientType = 6
+	Tendermint  ClientType = 7
+	Localhost   ClientType = 9
 )
 
 // string representation of the client types
 const (
-	ClientTypeTendermint string = "tendermint"
-	ClientTypeLocalHost  string = "localhost"
+	ClientTypeSoloMachine string = "solomachine"
+	ClientTypeTendermint  string = "tendermint"
+	ClientTypeLocalHost   string = "localhost"
 )
 
 func (ct ClientType) String() string {

x/ibc/07-tendermint/client/cli/cli.go

@@ -6,7 +6,7 @@ import (
 	"github.com/cosmos/cosmos-sdk/x/ibc/07-tendermint/types"
 )
 
-// NewTxCmd returns a root CLI command handler for all x/bank transaction commands.
+// NewTxCmd returns a root CLI command handler for all x/ibc/07-tendermint transaction commands.
 func NewTxCmd() *cobra.Command {
 	txCmd := &cobra.Command{
 		Use:                        types.SubModuleName,

x/ibc/07-tendermint/types/msgs.go

@@ -15,13 +15,6 @@ import (
 	host "github.com/cosmos/cosmos-sdk/x/ibc/24-host"
 )
 
-// Message types for the IBC client
-const (
-	TypeMsgCreateClient             string = "create_client"
-	TypeMsgUpdateClient             string = "update_client"
-	TypeMsgSubmitClientMisbehaviour string = "submit_client_misbehaviour"
-)
-
 var (
 	_ clientexported.MsgCreateClient     = (*MsgCreateClient)(nil)
 	_ clientexported.MsgUpdateClient     = (*MsgUpdateClient)(nil)
@@ -74,7 +67,7 @@ func (msg MsgCreateClient) Route() string {
 
 // Type implements sdk.Msg
 func (msg MsgCreateClient) Type() string {
-	return TypeMsgCreateClient
+	return clientexported.TypeMsgCreateClient
 }
 
 // ValidateBasic implements sdk.Msg
@@ -184,7 +177,7 @@ func (msg MsgUpdateClient) Route() string {
 
 // Type implements sdk.Msg
 func (msg MsgUpdateClient) Type() string {
-	return TypeMsgUpdateClient
+	return clientexported.TypeMsgUpdateClient
 }
 
 // ValidateBasic implements sdk.Msg
@@ -238,7 +231,7 @@ func (msg MsgSubmitClientMisbehaviour) Route() string { return host.RouterKey }
 
 // Type returns the MsgSubmitClientMisbehaviour's type.
 func (msg MsgSubmitClientMisbehaviour) Type() string {
-	return TypeMsgSubmitClientMisbehaviour
+	return clientexported.TypeMsgSubmitClientMisbehaviour
 }
 
 // ValidateBasic performs basic (non-state-dependant) validation on a MsgSubmitClientMisbehaviour.

x/ibc/09-localhost/types/msgs.go

@@ -7,11 +7,6 @@ import (
 	host "github.com/cosmos/cosmos-sdk/x/ibc/24-host"
 )
 
-// Message types for the IBC client
-const (
-	TypeMsgCreateClient string = "create_client"
-)
-
 var (
 	_ clientexported.MsgCreateClient = (*MsgCreateClient)(nil)
 )
@@ -30,7 +25,7 @@ func (msg MsgCreateClient) Route() string {
 
 // Type implements sdk.Msg
 func (msg MsgCreateClient) Type() string {
-	return TypeMsgCreateClient
+	return clientexported.TypeMsgCreateClient
 }
 
 // ValidateBasic implements sdk.Msg

x/ibc/light-clients/solomachine/client/cli/cli.go

@@ -0,0 +1,27 @@
+package cli
+
+import (
+	"github.com/spf13/cobra"
+
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/x/ibc/light-clients/solomachine/types"
+)
+
+// NewTxCmd returns a root CLI command handler for all solo machine transaction commands.
+func NewTxCmd() *cobra.Command {
+	txCmd := &cobra.Command{
+		Use:                        types.SubModuleName,
+		Short:                      "Solo Machine transaction subcommands",
+		DisableFlagParsing:         true,
+		SuggestionsMinimumDistance: 2,
+		RunE:                       client.ValidateCmd,
+	}
+
+	txCmd.AddCommand(
+		NewCreateClientCmd(),
+		NewUpdateClientCmd(),
+		NewSubmitMisbehaviourCmd(),
+	)
+
+	return txCmd
+}

x/ibc/light-clients/solomachine/client/cli/tx.go

@@ -0,0 +1,139 @@
+package cli
+
+import (
+	"fmt"
+	"io/ioutil"
+
+	"github.com/pkg/errors"
+
+	"github.com/spf13/cobra"
+
+	"github.com/cosmos/cosmos-sdk/client"
+	"github.com/cosmos/cosmos-sdk/client/tx"
+	"github.com/cosmos/cosmos-sdk/codec"
+	"github.com/cosmos/cosmos-sdk/version"
+	"github.com/cosmos/cosmos-sdk/x/ibc/light-clients/solomachine/types"
+)
+
+// NewCreateClientCmd defines the command to create a new solo machine client.
+func NewCreateClientCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:     "create [client-id] [path/to/consensus_state.json]",
+		Short:   "create new solo machine client",
+		Long:    "create a new solo machine client with the specified identifier and consensus state",
+		Example: fmt.Sprintf("%s tx ibc %s create [client-id] [path/to/consensus_state.json] --from node0 --home ../node0/<app>cli --chain-id $CID", version.AppName, types.SubModuleName),
+		Args:    cobra.ExactArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			clientCtx, err := client.ReadTxCommandFlags(clientCtx, cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			clientID := args[0]
+
+			cdc := codec.NewProtoCodec(clientCtx.InterfaceRegistry)
+
+			var consensusState *types.ConsensusState
+			if err := cdc.UnmarshalJSON([]byte(args[1]), &consensusState); err != nil {
+				// check for file path if JSON input is not provided
+				contents, err := ioutil.ReadFile(args[1])
+				if err != nil {
+					return errors.New("neither JSON input nor path to .json file were provided")
+				}
+				if err := cdc.UnmarshalJSON(contents, &consensusState); err != nil {
+					return errors.Wrap(err, "error unmarshalling consensus state file")
+				}
+			}
+
+			msg := types.NewMsgCreateClient(clientID, consensusState)
+
+			if err := msg.ValidateBasic(); err != nil {
+				return err
+			}
+
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
+		},
+	}
+}
+
+// NewUpdateClientCmd defines the command to update a solo machine client.
+func NewUpdateClientCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:     "update [client-id] [path/to/header.json]",
+		Short:   "update existing client with a header",
+		Long:    "update existing client with a solo machine header",
+		Example: fmt.Sprintf("%s tx ibc %s update [client-id] [path/to/header.json] --from node0 --home ../node0/<app>cli --chain-id $CID", version.AppName, types.SubModuleName),
+		Args:    cobra.ExactArgs(2),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			clientCtx, err := client.ReadTxCommandFlags(clientCtx, cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			clientID := args[0]
+
+			cdc := codec.NewProtoCodec(clientCtx.InterfaceRegistry)
+
+			var header types.Header
+			if err := cdc.UnmarshalJSON([]byte(args[1]), &header); err != nil {
+				// check for file path if JSON input is not provided
+				contents, err := ioutil.ReadFile(args[1])
+				if err != nil {
+					return errors.New("neither JSON input nor path to .json file were provided")
+				}
+				if err := cdc.UnmarshalJSON(contents, &header); err != nil {
+					return errors.Wrap(err, "error unmarshalling header file")
+				}
+			}
+
+			msg := types.NewMsgUpdateClient(clientID, header)
+			if err := msg.ValidateBasic(); err != nil {
+				return err
+			}
+
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
+		},
+	}
+}
+
+// NewSubmitMisbehaviourCmd defines the command to submit a misbehaviour to prevent
+// future updates.
+func NewSubmitMisbehaviourCmd() *cobra.Command {
+	return &cobra.Command{
+		Use:     "misbehaviour [path/to/evidence.json]",
+		Short:   "submit a client misbehaviour",
+		Long:    "submit a client misbehaviour to prevent future updates",
+		Example: fmt.Sprintf("%s tx ibc %s misbehaviour [path/to/evidence.json] --from node0 --home ../node0/<app>cli --chain-id $CID", version.AppName, types.SubModuleName),
+		Args:    cobra.ExactArgs(1),
+		RunE: func(cmd *cobra.Command, args []string) error {
+			clientCtx := client.GetClientContextFromCmd(cmd)
+			clientCtx, err := client.ReadTxCommandFlags(clientCtx, cmd.Flags())
+			if err != nil {
+				return err
+			}
+
+			cdc := codec.NewProtoCodec(clientCtx.InterfaceRegistry)
+
+			var ev types.Evidence
+			if err := cdc.UnmarshalJSON([]byte(args[0]), &ev); err != nil {
+				// check for file path if JSON input is not provided
+				contents, err := ioutil.ReadFile(args[0])
+				if err != nil {
+					return errors.New("neither JSON input nor path to .json file were provided")
+				}
+				if err := cdc.UnmarshalJSON(contents, &ev); err != nil {
+					return errors.Wrap(err, "error unmarshalling evidence file")
+				}
+			}
+
+			msg := types.NewMsgSubmitClientMisbehaviour(ev, clientCtx.GetFromAddress())
+			if err := msg.ValidateBasic(); err != nil {
+				return err
+			}
+
+			return tx.GenerateOrBroadcastTxCLI(clientCtx, cmd.Flags(), msg)
+		},
+	}
+}

x/ibc/light-clients/solomachine/doc.go

@@ -0,0 +1,7 @@
+/*
+Package solomachine implements a concrete `ConsensusState`, `Header`,
+`Misbehaviour` and `Equivocation` types for the Solo Machine light client.
+This implementation is based off the ICS 06 specification:
+https://github.com/cosmos/ics/tree/master/spec/ics-006-solo-machine-client
+*/
+package solomachine