feat(cmd): edit finality provider description

CHANGELOG.md

@@ -36,3 +36,7 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 ## Unreleased
+
+### Improvements
+
+* [#90](https://github.com/babylonlabs-io/finality-provider/pull/90) CLI edit finality provider

clientcontroller/babylon.go

@@ -510,6 +510,66 @@ func (bc *BabylonController) QueryFinalityProviders() ([]*btcstakingtypes.Finali
 	return fps, nil
 }
 
+func (bc *BabylonController) QueryFinalityProvider(fpPk *btcec.PublicKey) (*btcstakingtypes.QueryFinalityProviderResponse, error) {
+	fpPubKey := bbntypes.NewBIP340PubKeyFromBTCPK(fpPk)
+	res, err := bc.bbnClient.QueryClient.FinalityProvider(fpPubKey.MarshalHex())
+	if err != nil {
+		return nil, fmt.Errorf("failed to query the finality provider %s: %v", fpPubKey.MarshalHex(), err)
+	}
+
+	return res, nil
+}
+
+func (bc *BabylonController) EditFinalityProviderDescription(fpPk *btcec.PublicKey,
+	reqDesc sttypes.Description) (*sttypes.Description, error) {
+
+	fpRes, err := bc.QueryFinalityProvider(fpPk)
+	if err != nil {
+		return nil, err
+	}
+	getValueOrDefault := func(reqValue, defaultValue string) string {
+		if reqValue != "" {
+			return reqValue
+		}
+		return defaultValue
+	}
+
+	resDesc := fpRes.FinalityProvider.Description
+
+	desc := &sttypes.Description{
+		Moniker:         getValueOrDefault(reqDesc.Moniker, resDesc.Moniker),
+		Identity:        getValueOrDefault(reqDesc.Identity, resDesc.Identity),
+		Website:         getValueOrDefault(reqDesc.Website, resDesc.Website),
+		SecurityContact: getValueOrDefault(reqDesc.SecurityContact, resDesc.SecurityContact),
+		Details:         getValueOrDefault(reqDesc.Details, resDesc.Details),
+	}
+
+	if err := bc.EditFinalityProvider(fpPk, fpRes.FinalityProvider.Commission, desc); err != nil {
+		return nil, err
+	}
+
+	return desc, nil
+}
+
+func (bc *BabylonController) EditFinalityProvider(fpPk *btcec.PublicKey,
+	rate *sdkmath.LegacyDec, description *sttypes.Description) error {
+	fpPubKey := bbntypes.NewBIP340PubKeyFromBTCPK(fpPk)
+
+	msg := &btcstakingtypes.MsgEditFinalityProvider{
+		Addr:        bc.mustGetTxSigner(),
+		BtcPk:       fpPubKey.MustMarshal(),
+		Description: description,
+		Commission:  rate,
+	}
+
+	_, err := bc.reliablySendMsg(msg, emptyErrs, emptyErrs)
+	if err != nil {
+		return fmt.Errorf("failed to query the finality provider %s: %v", fpPk.SerializeCompressed(), err)
+	}
+
+	return nil
+}
+
 func (bc *BabylonController) QueryBtcLightClientTip() (*btclctypes.BTCHeaderInfoResponse, error) {
 	res, err := bc.bbnClient.QueryClient.BTCHeaderChainTip()
 	if err != nil {

clientcontroller/interface.go

@@ -2,6 +2,7 @@ package clientcontroller
 
 import (
 	"fmt"
+	sttypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 
 	"cosmossdk.io/math"
 	"github.com/btcsuite/btcd/btcec/v2"
@@ -49,6 +50,9 @@ type ClientController interface {
 	// QueryFinalityProviderSlashedOrJailed queries if the finality provider is slashed or jailed
 	QueryFinalityProviderSlashedOrJailed(fpPk *btcec.PublicKey) (slashed bool, jailed bool, err error)
 
+	// EditFinalityProviderDescription edits description of the finality provider
+	EditFinalityProviderDescription(fpPk *btcec.PublicKey, reqDesc sttypes.Description) (*sttypes.Description, error)
+
 	// QueryLatestFinalizedBlocks returns the latest finalized blocks
 	QueryLatestFinalizedBlocks(count uint64) ([]*types.BlockInfo, error)
 

finality-provider/cmd/fpd/daemon/daemon_commands.go

@@ -5,20 +5,20 @@ import (
 	"encoding/hex"
 	"encoding/json"
 	"fmt"
+	"github.com/babylonlabs-io/finality-provider/finality-provider/proto"
 	"strconv"
 
 	"cosmossdk.io/math"
 	"github.com/babylonlabs-io/babylon/types"
 	bbntypes "github.com/babylonlabs-io/babylon/types"
+	fpcmd "github.com/babylonlabs-io/finality-provider/finality-provider/cmd"
+	fpcfg "github.com/babylonlabs-io/finality-provider/finality-provider/config"
+	dc "github.com/babylonlabs-io/finality-provider/finality-provider/service/client"
 	"github.com/cosmos/cosmos-sdk/client"
 	sdkflags "github.com/cosmos/cosmos-sdk/client/flags"
 	stakingtypes "github.com/cosmos/cosmos-sdk/x/staking/types"
 	"github.com/spf13/cobra"
 	"github.com/spf13/pflag"
-
-	fpcmd "github.com/babylonlabs-io/finality-provider/finality-provider/cmd"
-	fpcfg "github.com/babylonlabs-io/finality-provider/finality-provider/config"
-	dc "github.com/babylonlabs-io/finality-provider/finality-provider/service/client"
 )
 
 var (
@@ -446,6 +446,71 @@ func runCommandAddFinalitySig(cmd *cobra.Command, args []string) error {
 	return nil
 }
 
+// CommandEditFinalityDescription edits description of finality provider
+func CommandEditFinalityDescription() *cobra.Command {
+	var cmd = &cobra.Command{
+		Use:     "edit-finality-provider [btc_pk]",
+		Aliases: []string{"efp"},
+		Short:   "Edit finality provider",
+		Example: fmt.Sprintf(`fpd edit-finality-provider --daemon-address %s`, defaultFpdDaemonAddress),
+		Args:    cobra.ExactArgs(1),
+		RunE:    runCommandEditFinalityDescription,
+	}
+	cmd.Flags().String(fpdDaemonAddressFlag, defaultFpdDaemonAddress, "The RPC server address of fpd")
+	cmd.Flags().String(monikerFlag, "", "The finality provider's (optional) moniker")
+	cmd.Flags().String(websiteFlag, "", "The finality provider's (optional) website")
+	cmd.Flags().String(securityContactFlag, "", "The finality provider's (optional) security contact email")
+	cmd.Flags().String(detailsFlag, "", "The finality provider's (optional) details")
+	cmd.Flags().String(identityFlag, "", "The (optional) identity signature (ex. UPort or Keybase)")
+
+	return cmd
+}
+
+func runCommandEditFinalityDescription(cmd *cobra.Command, args []string) error {
+	fpPk, err := bbntypes.NewBIP340PubKeyFromHex(args[0])
+	if err != nil {
+		return err
+	}
+
+	flags := cmd.Flags()
+	daemonAddress, err := flags.GetString(fpdDaemonAddressFlag)
+	if err != nil {
+		return fmt.Errorf("failed to read flag %s: %w", fpdDaemonAddressFlag, err)
+	}
+
+	grpcClient, cleanUp, err := dc.NewFinalityProviderServiceGRpcClient(daemonAddress)
+	if err != nil {
+		return err
+	}
+	defer func() {
+		if err := cleanUp(); err != nil {
+			fmt.Printf("Failed to clean up grpc client: %v\n", err)
+		}
+	}()
+
+	moniker, _ := cmd.Flags().GetString(monikerFlag)
+	website, _ := cmd.Flags().GetString(websiteFlag)
+	securityContact, _ := cmd.Flags().GetString(securityContactFlag)
+	details, _ := cmd.Flags().GetString(detailsFlag)
+	identity, _ := cmd.Flags().GetString(identityFlag)
+
+	desc := &proto.Description{
+		Moniker:         moniker,
+		Identity:        identity,
+		Website:         website,
+		SecurityContact: securityContact,
+		Details:         details,
+	}
+
+	if err := grpcClient.EditFinalityProvider(cmd.Context(), fpPk, desc); err != nil {
+		return fmt.Errorf("failed to get finality provider %v err %v", fpPk.MarshalHex(), err)
+	}
+
+	// todo(lazar): if this is successful update local store also
+
+	return nil
+}
+
 func printRespJSON(resp interface{}) {
 	jsonBytes, err := json.MarshalIndent(resp, "", "    ")
 	if err != nil {

finality-provider/cmd/fpd/daemon/flags.go

@@ -18,5 +18,5 @@ const (
 	websiteFlag         = "website"
 	securityContactFlag = "security-contact"
 	detailsFlag         = "details"
-	commissionRateFlag  = "commission"
+	commissionRateFlag  = "commission-rate"
 )

finality-provider/cmd/fpd/main.go

@@ -34,6 +34,7 @@ func main() {
 		daemon.CommandGetDaemonInfo(), daemon.CommandCreateFP(), daemon.CommandLsFP(),
 		daemon.CommandInfoFP(), daemon.CommandRegisterFP(), daemon.CommandAddFinalitySig(),
 		daemon.CommandExportFP(), daemon.CommandTxs(), daemon.CommandUnjailFP(),
+		daemon.CommandEditFinalityDescription(),
 	)
 
 	if err := cmd.Execute(); err != nil {