github.com/ChainSafe/chainbridge-core@v1.4.2/chains/evm/cli/deploy/deploy.go

package deploy

import (
	"errors"
	"fmt"
	"math/big"

	"github.com/ChainSafe/chainbridge-core/chains/evm/calls"
	"github.com/ChainSafe/chainbridge-core/chains/evm/calls/contracts/bridge"
	"github.com/ChainSafe/chainbridge-core/chains/evm/calls/contracts/erc20"
	"github.com/ChainSafe/chainbridge-core/chains/evm/calls/contracts/erc721"
	"github.com/ChainSafe/chainbridge-core/chains/evm/calls/contracts/generic"
	"github.com/ChainSafe/chainbridge-core/chains/evm/calls/evmclient"
	evmgaspricer "github.com/ChainSafe/chainbridge-core/chains/evm/calls/evmgaspricer"
	"github.com/ChainSafe/chainbridge-core/chains/evm/calls/evmtransaction"
	"github.com/ChainSafe/chainbridge-core/chains/evm/calls/transactor/signAndSend"

	"github.com/ChainSafe/chainbridge-core/chains/evm/cli/flags"
	"github.com/ChainSafe/chainbridge-core/chains/evm/cli/logger"
	"github.com/ChainSafe/chainbridge-core/chains/evm/cli/utils"
	"github.com/ethereum/go-ethereum/common"
	"github.com/rs/zerolog/log"
	"github.com/spf13/cobra"
)

var ErrNoDeploymentFlagsProvided = errors.New("provide at least one deployment flag. For help use --help")

var DeployEVM = &cobra.Command{
	Use:   "deploy",
	Short: "Deploy smart contracts",
	Long:  "This command can be used to deploy all or some of the contracts required for bridging. Selection of contracts can be made by either specifying --all or a subset of flags",
	PreRun: func(cmd *cobra.Command, args []string) {
		logger.LoggerMetadata(cmd.Name(), cmd.Flags())
	},
	RunE: CallDeployCLI,
	Args: func(cmd *cobra.Command, args []string) error {
		err := ValidateDeployFlags(cmd, args)
		if err != nil {
			return err
		}
		err = ProcessDeployFlags(cmd, args)
		return err
	},
}

const (
	TwoDaysTermInBlocks int64 = 6200
)

var (
	// Flags for all EVM Deploy CLI commands
	Bridge           bool
	BridgeAddress    string
	DeployAll        bool
	DomainId         uint8
	GenericHandler   bool
	Erc20            bool
	Erc20Handler     bool
	Erc20Name        string
	Erc20Symbol      string
	Erc721           bool
	Erc721Handler    bool
	Erc721Name       string
	Erc721Symbol     string
	Erc721BaseURI    string
	Fee              uint64
	RelayerThreshold uint64
	Relayers         []string
)

func BindDeployEVMFlags(cmd *cobra.Command) {
	cmd.Flags().BoolVar(&Bridge, "bridge", false, "Deploy bridge")
	cmd.Flags().StringVar(&BridgeAddress, "bridge-address", "", "Bridge contract address. Should be provided if handlers are deployed separately")
	cmd.Flags().BoolVar(&DeployAll, "all", false, "Deploy all")
	cmd.Flags().Uint8Var(&DomainId, "domain", 1, "Domain ID for the instance")
	cmd.Flags().BoolVar(&Erc20, "erc20", false, "Deploy ERC20")
	cmd.Flags().BoolVar(&Erc20Handler, "erc20-handler", false, "Deploy ERC20 handler")
	cmd.Flags().StringVar(&Erc20Name, "erc20-name", "", "ERC20 contract name")
	cmd.Flags().StringVar(&Erc20Symbol, "erc20-symbol", "", "ERC20 contract symbol")
	cmd.Flags().BoolVar(&Erc721, "erc721", false, "Deploy ERC721")
	cmd.Flags().BoolVar(&Erc721Handler, "erc721-handler", false, "Deploy ERC721 handler")
	cmd.Flags().StringVar(&Erc721Name, "erc721-name", "", "ERC721 contract name")
	cmd.Flags().StringVar(&Erc721Symbol, "erc721-symbol", "", "ERC721 contract symbol")
	cmd.Flags().StringVar(&Erc721BaseURI, "erc721-base-uri", "", "ERC721 base URI")
	cmd.Flags().BoolVar(&GenericHandler, "generic-handler", false, "Deploy generic handler")
	cmd.Flags().Uint64Var(&Fee, "fee", 0, "Fee to be taken when making a deposit (in ETH, decimals are allowed)")
	cmd.Flags().StringSliceVar(&Relayers, "relayers", []string{}, "List of initial relayers")
	cmd.Flags().Uint64Var(&RelayerThreshold, "relayer-threshold", 1, "Number of votes required for a proposal to pass")
}

func init() {
	BindDeployEVMFlags(DeployEVM)
}

func ValidateDeployFlags(cmd *cobra.Command, args []string) error {
	Deployments = make([]string, 0)
	if DeployAll {
		flags.MarkFlagsAsRequired(cmd, "relayer-threshold", "domain", "fee", "erc20-symbol", "erc20-name")
		Deployments = append(Deployments, []string{"bridge", "erc20-handler", "erc721-handler", "generic-handler", "erc20", "erc721"}...)
	} else {
		if Bridge {
			flags.MarkFlagsAsRequired(cmd, "relayer-threshold", "domain", "fee")
			Deployments = append(Deployments, "bridge")
		}
		if Erc20Handler {
			if !Bridge {
				flags.MarkFlagsAsRequired(cmd, "bridge-address")
			}
			Deployments = append(Deployments, "erc20-handler")
		}
		if Erc721Handler {
			if !Bridge {
				flags.MarkFlagsAsRequired(cmd, "bridge-address")
			}
			Deployments = append(Deployments, "erc721-handler")
		}
		if GenericHandler {
			if !Bridge {
				flags.MarkFlagsAsRequired(cmd, "bridge-address")
			}
			Deployments = append(Deployments, "generic-handler")
		}
		if Erc20 {
			flags.MarkFlagsAsRequired(cmd, "erc20-symbol", "erc20-name")
			Deployments = append(Deployments, "erc20")
		}
		if Erc721 {
			flags.MarkFlagsAsRequired(cmd, "erc721-name", "erc721-symbol", "erc721-base-uri")
			Deployments = append(Deployments, "erc721")
		}
	}

	if len(Deployments) == 0 {
		log.Error().Err(ErrNoDeploymentFlagsProvided)
		return ErrNoDeploymentFlagsProvided
	}

	return nil
}

var Deployments []string
var BridgeAddr common.Address
var RelayerAddresses []common.Address

func ProcessDeployFlags(cmd *cobra.Command, args []string) error {
	if common.IsHexAddress(BridgeAddress) {
		BridgeAddr = common.HexToAddress(BridgeAddress)
	}
	for _, addr := range Relayers {
		if !common.IsHexAddress(addr) {
			return fmt.Errorf("invalid relayer address %s", addr)
		}
		RelayerAddresses = append(RelayerAddresses, common.HexToAddress(addr))
	}
	return nil
}

func CallDeployCLI(cmd *cobra.Command, args []string) error {
	txFabric := evmtransaction.NewTransaction
	return DeployCLI(cmd, args, txFabric, &evmgaspricer.LondonGasPriceDeterminant{})
}

func DeployCLI(cmd *cobra.Command, args []string, txFabric calls.TxFabric, gasPricer utils.GasPricerWithPostConfig) error {
	// fetch global flag values
	url, gasLimit, gasPrice, senderKeyPair, _, err := flags.GlobalFlagValues(cmd)
	if err != nil {
		return err
	}

	log.Debug().Msgf("url: %s gas limit: %v gas price: %v", url, gasLimit, gasPrice)
	log.Debug().Msgf("SENDER Address %s", senderKeyPair.CommonAddress().Hex())

	ethClient, err := evmclient.NewEVMClient(url, senderKeyPair)
	if err != nil {
		log.Error().Err(fmt.Errorf("ethereum client error: %v", err)).Msg("error initializing new EVM client")
		return err
	}
	gasPricer.SetClient(ethClient)
	gasPricer.SetOpts(&evmgaspricer.GasPricerOpts{UpperLimitFeePerGas: gasPrice})
	log.Debug().Msgf("Relayers for deploy %+v", Relayers)
	log.Debug().Msgf("all bool: %v", DeployAll)

	t := signAndSend.NewSignAndSendTransactor(txFabric, gasPricer, ethClient)

	deployedContracts := make(map[string]string)
	for _, v := range Deployments {
		switch v {
		case "bridge":
			log.Debug().Msgf("deploying bridge..")
			bc := bridge.NewBridgeContract(ethClient, common.Address{}, t)
			BridgeAddr, err = bc.DeployContract(
				DomainId,
				RelayerAddresses,
				big.NewInt(0).SetUint64(RelayerThreshold),
				big.NewInt(0).SetUint64(Fee),
				big.NewInt(TwoDaysTermInBlocks), // _expiry is set to 48 hours by default
			)
			if err != nil {
				log.Error().Err(fmt.Errorf("bridge deploy failed: %w", err))
				return err
			}
			deployedContracts["bridge"] = BridgeAddr.String()
			log.Debug().Msgf("bridge address; %v", BridgeAddr.String())
		case "erc20":
			log.Debug().Msgf("deploying ERC20..")
			erc20Contract := erc20.NewERC20Contract(ethClient, common.Address{}, t)
			erc20Addr, err := erc20Contract.DeployContract(Erc20Name, Erc20Symbol)
			if err != nil {
				log.Error().Err(fmt.Errorf("erc 20 deploy failed: %w", err))
				return err
			}
			deployedContracts["erc20Token"] = erc20Addr.String()
		case "erc20-handler":
			log.Debug().Msgf("deploying ERC20 handler..")
			erc20HandlerContract := erc20.NewERC20HandlerContract(ethClient, common.Address{}, t)
			erc20HandlerAddr, err := erc20HandlerContract.DeployContract(BridgeAddr)
			if err != nil {
				log.Error().Err(fmt.Errorf("ERC20 handler deploy failed: %w", err))
				return err
			}
			deployedContracts["erc20Handler"] = erc20HandlerAddr.String()
		case "erc721":
			log.Debug().Msgf("deploying ERC721..")
			erc721Contract := erc721.NewErc721Contract(ethClient, common.Address{}, t)
			erc721Addr, err := erc721Contract.DeployContract(Erc721Name, Erc721Symbol, Erc721BaseURI)
			if err != nil {
				log.Error().Err(fmt.Errorf("ERC721 deploy failed: %w", err))
				return err
			}
			deployedContracts["erc721Token"] = erc721Addr.String()
		case "erc721-handler":
			log.Debug().Msgf("deploying ERC721 handler..")
			erc721HandlerContract := erc721.NewERC721HandlerContract(ethClient, common.Address{}, t)
			erc721HandlerAddr, err := erc721HandlerContract.DeployContract(BridgeAddr)
			if err != nil {
				log.Error().Err(fmt.Errorf("ERC721 handler deploy failed: %w", err))
				return err
			}
			deployedContracts["erc721Handler"] = erc721HandlerAddr.String()
		case "generic-handler":
			log.Debug().Msgf("deploying generic handler..")
			emptyAddr := common.Address{}
			if BridgeAddr == emptyAddr {
				log.Error().Err(errors.New("bridge flag or bridge-address param should be set for contracts Deployments"))
				return err
			}
			genericHandlerContract := generic.NewGenericHandlerContract(ethClient, common.Address{}, t)
			genericHandlerAddr, err := genericHandlerContract.DeployContract(BridgeAddr)
			if err != nil {
				log.Error().Err(fmt.Errorf("Generic handler deploy failed: %w", err))
				return err
			}
			deployedContracts["genericHandler"] = genericHandlerAddr.String()
		}
	}
	fmt.Printf(`
	Deployed contracts
=========================================================
Bridge: %s
---------------------------------------------------------
ERC20 Token: %s
---------------------------------------------------------
ERC20 Handler: %s
---------------------------------------------------------
ERC721 Token: %s
---------------------------------------------------------
ERC721 Handler: %s
---------------------------------------------------------
Generic Handler: %s
=========================================================
	`,
		deployedContracts["bridge"],
		deployedContracts["erc20Token"],
		deployedContracts["erc20Handler"],
		deployedContracts["erc721Token"],
		deployedContracts["erc721Handler"],
		deployedContracts["genericHandler"],
	)
	return nil
}