chore: address naming suggestions CriptoSigner -> Signer, KeyringCrip…

…toSigner -> KeyringSigner, NewLocalKeyringCriptoSigner -> NewKeyringSigner
babylonlabs-io · Oct 10, 2024 · 539dfd5 · 539dfd5
1 parent 16fe1e6
commit 539dfd5
Show file tree

Hide file tree

Showing 6 changed files with 18 additions and 18 deletions.
diff --git a/cmd/covd/start.go b/cmd/covd/start.go
@@ -84,6 +84,6 @@ func start(ctx *cli.Context) error {
 	return srv.RunUntilShutdown()
 }
 
-func NewSignerFromConfig(cfg *covcfg.Config, passphrase string) (*keyring.KeyringCriptoSigner, error) {
-	return keyring.NewLocalKeyringCriptoSigner(cfg.BabylonConfig.ChainID, cfg.BabylonConfig.Key, cfg.BabylonConfig.KeyDirectory, cfg.BabylonConfig.KeyringBackend, passphrase)
+func NewSignerFromConfig(cfg *covcfg.Config, passphrase string) (*keyring.KeyringSigner, error) {
+	return keyring.NewKeyringSigner(cfg.BabylonConfig.ChainID, cfg.BabylonConfig.Key, cfg.BabylonConfig.KeyDirectory, cfg.BabylonConfig.KeyringBackend, passphrase)
 }
diff --git a/covenant/covenant.go b/covenant/covenant.go
@@ -40,7 +40,7 @@ type CovenantEmulator struct {
 
 	pk *btcec.PublicKey
 
-	signer CriptoSigner
+	signer Signer
 	cc     clientcontroller.ClientController
 
 	config *covcfg.Config
@@ -52,7 +52,7 @@ func NewCovenantEmulator(
 	cc clientcontroller.ClientController,
 	passphrase string,
 	logger *zap.Logger,
-	signer CriptoSigner,
+	signer Signer,
 ) (*CovenantEmulator, error) {
 	pk, err := signer.PubKey()
 	if err != nil {
@@ -253,7 +253,7 @@ func signSlashUnbondingSignatures(
 	del *types.Delegation,
 	unbondingTx *wire.MsgTx,
 	slashUnbondingTx *wire.MsgTx,
-	signer CriptoSigner,
+	signer Signer,
 	params *types.StakingParams,
 	btcNet *chaincfg.Params,
 ) ([][]byte, error) {
@@ -302,7 +302,7 @@ func signSlashAndUnbondSignatures(
 	stakingTx *wire.MsgTx,
 	slashingTx *wire.MsgTx,
 	unbondingTx *wire.MsgTx,
-	signer CriptoSigner,
+	signer Signer,
 	params *types.StakingParams,
 	btcNet *chaincfg.Params,
 ) ([][]byte, *schnorr.Signature, error) {

diff --git a/covenant/covenant_test.go b/covenant/covenant_test.go
@@ -50,7 +50,7 @@ func FuzzAddCovenantSig(f *testing.F) {
 		)
 		require.NoError(t, err)
 
-		signer, err := keyring.NewLocalKeyringCriptoSigner(covenantConfig.BabylonConfig.ChainID, covenantConfig.BabylonConfig.Key, covenantConfig.BabylonConfig.KeyDirectory, covenantConfig.BabylonConfig.KeyringBackend, passphrase)
+		signer, err := keyring.NewKeyringSigner(covenantConfig.BabylonConfig.ChainID, covenantConfig.BabylonConfig.Key, covenantConfig.BabylonConfig.KeyDirectory, covenantConfig.BabylonConfig.KeyringBackend, passphrase)
 		require.NoError(t, err)
 
 		// create and start covenant emulator

diff --git a/covenant/expected_interfaces.go b/covenant/expected_interfaces.go
@@ -7,8 +7,8 @@ import (
 	secp "github.com/decred/dcrd/dcrec/secp256k1/v4"
 )
 
-// CriptoSigner wrapper interface to sign messages
-type CriptoSigner interface {
+// Signer wrapper interface to sign messages
+type Signer interface {
 	// PubKey returns the current secp256k1 public key
 	PubKey() (*secp.PublicKey, error)
 	// EncSignTxWithOneScriptSpendInputStrict is encrypted version of

diff --git a/itest/test_manager.go b/itest/test_manager.go
@@ -94,7 +94,7 @@ func StartManager(t *testing.T) *TestManager {
 	covbc, err := covcc.NewBabylonController(bbnCfg, &covenantConfig.BTCNetParams, logger)
 	require.NoError(t, err)
 
-	signer, err := covdkeyring.NewLocalKeyringCriptoSigner(covenantConfig.BabylonConfig.ChainID, covenantConfig.BabylonConfig.Key, covenantConfig.BabylonConfig.KeyDirectory, covenantConfig.BabylonConfig.KeyringBackend, passphrase)
+	signer, err := covdkeyring.NewKeyringSigner(covenantConfig.BabylonConfig.ChainID, covenantConfig.BabylonConfig.Key, covenantConfig.BabylonConfig.KeyDirectory, covenantConfig.BabylonConfig.KeyringBackend, passphrase)
 	require.NoError(t, err)
 
 	ce, err := covenant.NewCovenantEmulator(covenantConfig, covbc, passphrase, logger, signer)

diff --git a/keyring/signer.go b/keyring/signer.go
@@ -14,14 +14,14 @@ import (
 	secp "github.com/decred/dcrd/dcrec/secp256k1/v4"
 )
 
-var _ covenant.CriptoSigner = KeyringCriptoSigner{}
+var _ covenant.Signer = KeyringSigner{}
 
-type KeyringCriptoSigner struct {
+type KeyringSigner struct {
 	kc         *ChainKeyringController
 	passphrase string
 }
 
-func NewLocalKeyringCriptoSigner(chainId, keyName, keyringDir, keyringBackend, passphrase string) (*KeyringCriptoSigner, error) {
+func NewKeyringSigner(chainId, keyName, keyringDir, keyringBackend, passphrase string) (*KeyringSigner, error) {
 	input := strings.NewReader("")
 	kr, err := CreateKeyring(keyringDir, chainId, keyringBackend, input)
 	if err != nil {
@@ -33,13 +33,13 @@ func NewLocalKeyringCriptoSigner(chainId, keyName, keyringDir, keyringBackend, p
 		return nil, err
 	}
 
-	return &KeyringCriptoSigner{
+	return &KeyringSigner{
 		kc:         kc,
 		passphrase: passphrase,
 	}, nil
 }
 
-func (kcs KeyringCriptoSigner) PubKey() (*secp.PublicKey, error) {
+func (kcs KeyringSigner) PubKey() (*secp.PublicKey, error) {
 	record, err := kcs.kc.KeyRecord()
 	if err != nil {
 		return nil, err
@@ -56,7 +56,7 @@ func (kcs KeyringCriptoSigner) PubKey() (*secp.PublicKey, error) {
 // getPrivKey returns the keyring private key
 // TODO: update btcstaking functions to avoid receiving private key as parameter
 // and only sign it using the kcs.kc.GetKeyring().Sign()
-func (kcs KeyringCriptoSigner) getPrivKey() (*btcec.PrivateKey, error) {
+func (kcs KeyringSigner) getPrivKey() (*btcec.PrivateKey, error) {
 	sdkPrivKey, err := kcs.kc.GetChainPrivKey(kcs.passphrase)
 	if err != nil {
 		return nil, err
@@ -69,7 +69,7 @@ func (kcs KeyringCriptoSigner) getPrivKey() (*btcec.PrivateKey, error) {
 // EncSignTxWithOneScriptSpendInputStrict is encrypted version of
 // SignTxWithOneScriptSpendInputStrict with the output to be encrypted
 // by an encryption key (adaptor signature)
-func (kcs KeyringCriptoSigner) EncSignTxWithOneScriptSpendInputStrict(
+func (kcs KeyringSigner) EncSignTxWithOneScriptSpendInputStrict(
 	txToSign *wire.MsgTx,
 	fundingTx *wire.MsgTx,
 	fundingOutputIdx uint32,
@@ -99,7 +99,7 @@ func (kcs KeyringCriptoSigner) EncSignTxWithOneScriptSpendInputStrict(
 // - fundingTx is not nil
 // - fundingTx has one output committing to the provided script
 // - txToSign input is pointing to the correct output in fundingTx
-func (kcs KeyringCriptoSigner) SignTxWithOneScriptSpendInputStrict(
+func (kcs KeyringSigner) SignTxWithOneScriptSpendInputStrict(
 	txToSign *wire.MsgTx,
 	fundingTx *wire.MsgTx,
 	fundingOutputIdx uint32,