minor factorising

.github/workflows/tests.yml

@@ -27,8 +27,8 @@ jobs:
         uses: actions/checkout@v3
 
       # make sure proto files are up to date
-      - name: generate fresh signer proto .go files
-        run: make signer-proto
+      - name: generate fresh pkg proto .go files
+        run: make pkg-proto
 
       # run tests
       - name: run horcrux tests
@@ -60,8 +60,8 @@ jobs:
         uses: actions/checkout@v3
 
       # make sure proto files are up to date
-      - name: generate fresh signer proto .go files
-        run: make signer-proto
+      - name: generate fresh pkg proto .go files
+        run: make pkg-proto
 
       # run test matrix
       - name: run test

Makefile

@@ -38,11 +38,11 @@ build-horcrux-docker:
 mkfile_path := $(abspath $(lastword $(MAKEFILE_LIST)))
 mkfile_dir := $(dir $(mkfile_path))
 
-signer-proto:
+pkg-proto:
 	docker run \
 	  --rm \
 	  -u $(shell id -u ${USER}):$(shell id -g ${USER}) \
-		--mount type=bind,source=$(mkfile_dir)/signer/proto,target=/horcrux/signer/proto \
+		--mount type=bind,source=$(mkfile_dir)/pkg/proto,target=/horcrux/pkg/proto \
 		--entrypoint protoc \
 		namely/protoc-all \
 		--go_out=/horcrux \

cmd/horcrux/cmd/address.go

@@ -6,11 +6,12 @@ import (
 	"fmt"
 	"strings"
 
+	"github.com/strangelove-ventures/horcrux/pkg/cosigner"
+
 	"github.com/cometbft/cometbft/crypto"
 	cometprivval "github.com/cometbft/cometbft/privval"
 	"github.com/cosmos/cosmos-sdk/types/bech32"
 	"github.com/spf13/cobra"
-	"github.com/strangelove-ventures/horcrux/signer"
 )
 
 type AddressCmdOutput struct {
@@ -34,24 +35,24 @@ func addressCmd() *cobra.Command {
 			chainID := args[0]
 
 			switch config.Config.SignMode {
-			case signer.SignModeThreshold:
+			case cosigner.SignModeThreshold:
 				err := config.Config.ValidateThresholdModeConfig()
 				if err != nil {
 					return err
 				}
 
-				keyFile, err := config.KeyFileExistsCosigner(chainID)
+				keyFile, err := config.KeyFileExistsCosign(chainID)
 				if err != nil {
 					return err
 				}
 
-				key, err := signer.LoadCosignerEd25519Key(keyFile)
+				key, err := cosigner.LoadCosignerEd25519Key(keyFile)
 				if err != nil {
 					return fmt.Errorf("error reading cosigner key: %w, check that key is present for chain ID: %s", err, chainID)
 				}
 
 				pubKey = key.PubKey
-			case signer.SignModeSingle:
+			case cosigner.SignModeSingle:
 				err := config.Config.ValidateSingleSignerConfig()
 				if err != nil {
 					return err
@@ -69,7 +70,7 @@ func addressCmd() *cobra.Command {
 
 			pubKeyAddress := pubKey.Address()
 
-			pubKeyJSON, err := signer.PubKey("", pubKey)
+			pubKeyJSON, err := cosigner.PubKey("", pubKey)
 			if err != nil {
 				return err
 			}
@@ -85,7 +86,7 @@ func addressCmd() *cobra.Command {
 					return err
 				}
 				output.ValConsAddress = bech32ValConsAddress
-				pubKeyBech32, err := signer.PubKey(args[1], pubKey)
+				pubKeyBech32, err := cosigner.PubKey(args[1], pubKey)
 				if err != nil {
 					return err
 				}

cmd/horcrux/cmd/config.go

@@ -4,8 +4,9 @@ import (
 	"fmt"
 	"os"
 
+	"github.com/strangelove-ventures/horcrux/pkg/cosigner"
+
 	"github.com/spf13/cobra"
-	"github.com/strangelove-ventures/horcrux/signer"
 )
 
 const (
@@ -23,7 +24,7 @@ const (
 func configCmd() *cobra.Command {
 	cmd := &cobra.Command{
 		Use:   "config",
-		Short: "Commands to configure the horcrux signer",
+		Short: "Commands to configure the horcrux pkg",
 	}
 
 	cmd.AddCommand(initCmd())
@@ -38,7 +39,7 @@ func initCmd() *cobra.Command {
 		Aliases: []string{"i"},
 		Short:   "initialize configuration file and home directory if one doesn't already exist",
 		Long: `initialize configuration file.
-for threshold signer mode, --cosigner flags and --threshold flag are required.
+for threshold pkg mode, --cosigner flags and --threshold flag are required.
 		`,
 		Args: cobra.NoArgs,
 		RunE: func(cmd *cobra.Command, args []string) (err error) {
@@ -47,7 +48,7 @@ for threshold signer mode, --cosigner flags and --threshold flag are required.
 			bare, _ := cmdFlags.GetBool(flagBare)
 			nodes, _ := cmdFlags.GetStringSlice(flagNode)
 
-			cn, err := signer.ChainNodesFromFlag(nodes)
+			cn, err := cosigner.ChainNodesFromFlag(nodes)
 			if err != nil {
 				return err
 			}
@@ -59,7 +60,7 @@ for threshold signer mode, --cosigner flags and --threshold flag are required.
 					config.ConfigFile)
 			}
 
-			var cfg signer.Config
+			var cfg cosigner.Config
 
 			signMode, _ := cmdFlags.GetString(flagSignMode)
 			keyDirFlag, _ := cmdFlags.GetString(flagKeyDir)
@@ -68,21 +69,21 @@ for threshold signer mode, --cosigner flags and --threshold flag are required.
 				keyDir = &keyDirFlag
 			}
 			debugAddr, _ := cmdFlags.GetString("debug-addr")
-			if signMode == string(signer.SignModeThreshold) {
+			if signMode == string(cosigner.SignModeThreshold) {
 				// Threshold Mode Config
 				cosignersFlag, _ := cmdFlags.GetStringSlice(flagCosigner)
 				threshold, _ := cmdFlags.GetInt(flagThreshold)
 				raftTimeout, _ := cmdFlags.GetString(flagRaftTimeout)
 				grpcTimeout, _ := cmdFlags.GetString(flagGRPCTimeout)
-				cosigners, err := signer.CosignersFromFlag(cosignersFlag)
+				cosigners, err := cosigner.CosignersFromFlag(cosignersFlag)
 				if err != nil {
 					return err
 				}
 
-				cfg = signer.Config{
-					SignMode:      signer.SignModeThreshold,
+				cfg = cosigner.Config{
+					SignMode:      cosigner.SignModeThreshold,
 					PrivValKeyDir: keyDir,
-					ThresholdModeConfig: &signer.ThresholdModeConfig{
+					ThresholdModeConfig: &cosigner.ThresholdModeConfig{
 						Threshold:   threshold,
 						Cosigners:   cosigners,
 						GRPCTimeout: grpcTimeout,
@@ -99,8 +100,8 @@ for threshold signer mode, --cosigner flags and --threshold flag are required.
 				}
 			} else {
 				// Single Signer Config
-				cfg = signer.Config{
-					SignMode:      signer.SignModeSingle,
+				cfg = cosigner.Config{
+					SignMode:      cosigner.SignModeSingle,
 					PrivValKeyDir: keyDir,
 					ChainNodes:    cn,
 					DebugAddr:     debugAddr,
@@ -131,7 +132,7 @@ for threshold signer mode, --cosigner flags and --threshold flag are required.
 	}
 
 	f := cmd.Flags()
-	f.StringP(flagSignMode, "m", string(signer.SignModeThreshold),
+	f.StringP(flagSignMode, "m", string(cosigner.SignModeThreshold),
 		`sign mode, "threshold" (recommended) or "single" (unsupported). threshold mode requires --cosigner (multiple) and --threshold`, //nolint
 	)
 	f.StringSliceP(flagNode, "n", []string{}, "chain nodes in format tcp://{node-addr}:{privval-port} \n"+

cmd/horcrux/cmd/leader_election.go

@@ -5,12 +5,13 @@ import (
 	"fmt"
 	"time"
 
+	"github.com/strangelove-ventures/horcrux/pkg/cosigner"
+
 	grpcretry "github.com/grpc-ecosystem/go-grpc-middleware/retry"
 	"github.com/spf13/cobra"
 	"github.com/strangelove-ventures/horcrux/client"
-	"github.com/strangelove-ventures/horcrux/signer"
-	"github.com/strangelove-ventures/horcrux/signer/multiresolver"
-	"github.com/strangelove-ventures/horcrux/signer/proto"
+	"github.com/strangelove-ventures/horcrux/pkg/multiresolver"
+	"github.com/strangelove-ventures/horcrux/pkg/proto"
 	"google.golang.org/grpc"
 	"google.golang.org/grpc/credentials/insecure"
 )
@@ -69,7 +70,7 @@ horcrux elect 2 # elect specific leader`,
 			ctx, cancelFunc := context.WithTimeout(context.Background(), 30*time.Second)
 			defer cancelFunc()
 
-			grpcClient := proto.NewCosignerGRPCClient(conn)
+			grpcClient := proto.NewICosignerGRPCClient(conn)
 			_, err = grpcClient.TransferLeadership(
 				ctx,
 				&proto.CosignerGRPCTransferLeadershipRequest{LeaderID: leaderID},
@@ -109,21 +110,21 @@ func getLeaderCmd() *cobra.Command {
 
 			var id int
 
-			keyFileECIES, err := config.KeyFileExistsCosignerECIES()
+			keyFileECIES, err := config.KeyFileExistsCosignECIES()
 			if err != nil {
-				keyFileRSA, err := config.KeyFileExistsCosignerRSA()
+				keyFileRSA, err := config.KeyFileExistsCosignRSA()
 				if err != nil {
 					return fmt.Errorf("cosigner encryption keys not found (%s) - (%s): %w", keyFileECIES, keyFileRSA, err)
 				}
 
-				key, err := signer.LoadCosignerRSAKey(keyFileRSA)
+				key, err := cosigner.LoadCosignRSAKey(keyFileRSA)
 				if err != nil {
 					return fmt.Errorf("error reading cosigner key (%s): %w", keyFileRSA, err)
 				}
 
 				id = key.ID
 			} else {
-				key, err := signer.LoadCosignerECIESKey(keyFileECIES)
+				key, err := cosigner.LoadCosignerECIESKey(keyFileECIES)
 				if err != nil {
 					return fmt.Errorf("error reading cosigner key (%s): %w", keyFileECIES, err)
 				}
@@ -166,7 +167,7 @@ func getLeaderCmd() *cobra.Command {
 			ctx, cancelFunc := context.WithTimeout(context.Background(), 30*time.Second)
 			defer cancelFunc()
 
-			grpcClient := proto.NewCosignerGRPCClient(conn)
+			grpcClient := proto.NewICosignerGRPCClient(conn)
 
 			res, err := grpcClient.GetLeader(ctx, &proto.CosignerGRPCGetLeaderRequest{})
 			if err != nil {

cmd/horcrux/cmd/migrate.go

@@ -8,12 +8,13 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/strangelove-ventures/horcrux/pkg/cosigner"
+
 	cometcrypto "github.com/cometbft/cometbft/crypto"
 	cometcryptoed25519 "github.com/cometbft/cometbft/crypto/ed25519"
 	cometcryptoencoding "github.com/cometbft/cometbft/crypto/encoding"
 	cometprotocrypto "github.com/cometbft/cometbft/proto/tendermint/crypto"
 	"github.com/spf13/cobra"
-	"github.com/strangelove-ventures/horcrux/signer"
 	amino "github.com/tendermint/go-amino"
 	"gopkg.in/yaml.v2"
 )
@@ -103,7 +104,7 @@ func (key *v2CosignerKey) UnmarshalJSON(data []byte) error {
 
 	// Prior to the tendermint protobuf migration, the public key bytes in key files
 	// were encoded using the go-amino libraries via
-	// cdc.MarshalBinaryBare(CosignerEd25519Key.PubKey)
+	// cdc.MarshalBinaryBare(CosignEd25519Key.PubKey)
 	//
 	// To support reading the public key bytes from these key files, we fallback to
 	// amino unmarshalling if the protobuf unmarshalling fails
@@ -218,7 +219,7 @@ func migrateCmd() *cobra.Command {
 				return err
 			}
 
-			newEd25519Key := signer.CosignerEd25519Key{
+			newEd25519Key := cosigner.CosignEd25519Key{
 				PubKey:       legacyCosignerKey.PubKey,
 				PrivateShard: legacyCosignerKey.ShareKey,
 				ID:           legacyCosignerKey.ID,
@@ -234,7 +235,7 @@ func migrateCmd() *cobra.Command {
 				return fmt.Errorf("failed to write new Ed25519 key to %s: %w", newEd25519Path, err)
 			}
 
-			newRSAKey := signer.CosignerRSAKey{
+			newRSAKey := cosigner.CosignRSAKey{
 				RSAKey:  legacyCosignerKey.RSAKey,
 				ID:      legacyCosignerKey.ID,
 				RSAPubs: legacyCosignerKey.RSAPubs,
@@ -252,42 +253,42 @@ func migrateCmd() *cobra.Command {
 
 			// only attempt config migration if legacy config exists
 			if legacyCfgErr == nil {
-				var migratedNodes signer.ChainNodes
+				var migratedNodes cosigner.ChainNodes
 
 				for _, n := range legacyCfg.ChainNodes {
-					migratedNodes = append(migratedNodes, signer.ChainNode{
+					migratedNodes = append(migratedNodes, cosigner.ChainNode{
 						PrivValAddr: n.PrivValAddr,
 					})
 				}
 
 				config.Config.ChainNodes = migratedNodes
 				config.Config.DebugAddr = legacyCfg.DebugAddr
 
-				signMode := signer.SignModeSingle
+				signMode := cosigner.SignModeSingle
 
 				if legacyCfg.Cosigner != nil {
-					signMode = signer.SignModeThreshold
+					signMode = cosigner.SignModeThreshold
 
-					var migratedCosigners signer.CosignersConfig
+					var migratedCosigners cosigner.CosignersConfig
 
 					if legacyCfg.Cosigner.P2PListen != "" {
 						migratedCosigners = append(
 							migratedCosigners,
-							signer.CosignerConfig{
+							cosigner.CosignConfig{
 								ShardID: legacyCosignerKey.ID,
 								P2PAddr: legacyCfg.Cosigner.P2PListen,
 							},
 						)
 					}
 
 					for _, c := range legacyCfg.Cosigner.Peers {
-						migratedCosigners = append(migratedCosigners, signer.CosignerConfig{
+						migratedCosigners = append(migratedCosigners, cosigner.CosignConfig{
 							ShardID: c.ShareID,
 							P2PAddr: c.P2PAddr,
 						})
 					}
 
-					config.Config.ThresholdModeConfig = &signer.ThresholdModeConfig{
+					config.Config.ThresholdModeConfig = &cosigner.ThresholdModeConfig{
 						Threshold:   legacyCfg.Cosigner.Threshold,
 						Cosigners:   migratedCosigners,
 						GRPCTimeout: legacyCfg.Cosigner.Timeout,

cmd/horcrux/cmd/root.go

@@ -5,14 +5,15 @@ import (
 	"os"
 	"path/filepath"
 
+	"github.com/strangelove-ventures/horcrux/pkg/cosigner"
+
 	homedir "github.com/mitchellh/go-homedir"
 	"github.com/spf13/cobra"
 	"github.com/spf13/viper"
-	"github.com/strangelove-ventures/horcrux/signer"
 	"gopkg.in/yaml.v2"
 )
 
-var config signer.RuntimeConfig
+var config cosigner.RuntimeConfig
 
 func rootCmd() *cobra.Command {
 	cmd := &cobra.Command{
@@ -74,7 +75,7 @@ func initConfig() {
 	} else {
 		home = config.HomeDir
 	}
-	config = signer.RuntimeConfig{
+	config = cosigner.RuntimeConfig{
 		HomeDir:    home,
 		ConfigFile: filepath.Join(home, "config.yaml"),
 		StateDir:   filepath.Join(home, "state"),