Implement Fee Recipient: CLI flags and Calling Beacon API (#10312)

* send proposer data to config

* wip implementation with file and url based config import

* improving logic on get validator index

* fix function

* optimizing function for map and address bug

* fixing log

* update cache if it doesn't exist

* updating flags

* initial unit test scaffold

* fixing validator to call rpc call, removed temporary dependency

* adding the API calls for the runner

* fixing broken build

* fixing deepsource

* fixing interface

* fixing fatal

* fixing more deepsource issues

* adding test placeholders

* updating proposer config to add validation

* changing how if statement throws error

* removing unneeded validation, validating in a different way

* wip improving tests

* more unit test work

* fixing unit test

* fixing unit tests and edge cases

* adding unit tests and adjusting how the config is created

* fixing bazel builds

* fixing proto generation

* fixing imports

* fixing unit tests

* Update cmd/validator/flags/flags.go

Co-authored-by: Raul Jordan <[email protected]>

* updating flags based on comments, fixing unit tests

* fixing bazel

* removing unneeded function

* fixing unit tests

* refactors and unit test fixes based on comments

* fixing bazel build

* refactor the cache out fo the fee recipient function

* adding usecase for multiple fee recipient

* refactor burn name

* Update validator/client/validator.go

Co-authored-by: Raul Jordan <[email protected]>

* Update validator/client/validator.go

Co-authored-by: Raul Jordan <[email protected]>

* Update validator/client/validator.go

Co-authored-by: Raul Jordan <[email protected]>

* fixing bug with validator index based on code review

* edited flag descriptions to better communicate usage

* fixing manual reference to flag name

* fixing code review comments

* fixing linting

* Update validator/client/validator.go

Co-authored-by: Raul Jordan <[email protected]>

* addressing comments and renaming functions

* fixing linting

* Update cmd/validator/flags/flags.go

* Update cmd/validator/flags/flags.go

* Update cmd/validator/flags/flags.go

* improving comments

Co-authored-by: Raul Jordan <[email protected]>

cmd/validator/flags/BUILD.bazel

@@ -13,6 +13,7 @@ go_library(
         "//validator:__subpackages__",
     ],
     deps = [
+        "//config/fieldparams:go_default_library",
         "//io/file:go_default_library",
         "@com_github_urfave_cli_v2//:go_default_library",
     ],

cmd/validator/flags/flags.go

@@ -7,6 +7,7 @@ import (
 	"runtime"
 	"time"
 
+	field_params "github.com/prysmaticlabs/prysm/config/fieldparams"
 	"github.com/prysmaticlabs/prysm/io/file"
 	"github.com/urfave/cli/v2"
 )
@@ -322,6 +323,26 @@ var (
 		Usage: "Enables more verbose logging for counting down to duty",
 		Value: false,
 	}
+
+	// FeeRecipientConfigFileFlag defines the path or URL to a file with proposer config.
+	FeeRecipientConfigFileFlag = &cli.StringFlag{
+		Name:  "fee-recipient-config-file",
+		Usage: "Set path to a JSON file containing validator mappings to ETH addresses for receiving transaction fees when proposing blocks (i.e. --fee-recipient-config-file=/path/to/proposer.json). File format found in docs",
+		Value: "",
+	}
+	// FeeRecipientConfigURLFlag defines the path or URL to a file with proposer config.
+	FeeRecipientConfigURLFlag = &cli.StringFlag{
+		Name:  "fee-recipient-config-url",
+		Usage: "Set URL to a REST endpoint containing validator mappings to ETH addresses for receiving transaction fees when proposing blocks (i.e. --fee-recipient-config-url=https://example.com/api/getConfig). File format found in docs",
+		Value: "",
+	}
+
+	// SuggestedFeeRecipientFlag defines the address of the fee recipient.
+	SuggestedFeeRecipientFlag = &cli.StringFlag{
+		Name:  "suggested-fee-recipient",
+		Usage: "Sets ALL validators' mapping to a suggested an eth address to receive gas fees when proposing a block. Overrides the --fee-recipient-config-file flag if set",
+		Value: field_params.EthBurnAddressHex,
+	}
 )
 
 // DefaultValidatorDir returns OS-specific default validator directory.

cmd/validator/main.go

@@ -75,6 +75,9 @@ var appFlags = []cli.Flag{
 	// Consensys' Web3Signer flags
 	flags.Web3SignerURLFlag,
 	flags.Web3SignerPublicValidatorKeysFlag,
+	flags.FeeRecipientConfigFileFlag,
+	flags.FeeRecipientConfigURLFlag,
+	flags.SuggestedFeeRecipientFlag,
 	////////////////////
 	cmd.DisableMonitoringFlag,
 	cmd.MonitoringHostFlag,

cmd/validator/usage.go

@@ -109,6 +109,9 @@ var appHelpFlagGroups = []flagGroup{
 			flags.EnableDutyCountDown,
 			flags.Web3SignerURLFlag,
 			flags.Web3SignerPublicValidatorKeysFlag,
+			flags.FeeRecipientConfigFileFlag,
+			flags.FeeRecipientConfigURLFlag,
+			flags.SuggestedFeeRecipientFlag,
 		},
 	},
 	{

config/fieldparams/mainnet.go

@@ -5,21 +5,22 @@ package field_params
 
 const (
 	Preset                          = "mainnet"
-	BlockRootsLength                = 8192          // SLOTS_PER_HISTORICAL_ROOT
-	StateRootsLength                = 8192          // SLOTS_PER_HISTORICAL_ROOT
-	RandaoMixesLength               = 65536         // EPOCHS_PER_HISTORICAL_VECTOR
-	HistoricalRootsLength           = 16777216      // HISTORICAL_ROOTS_LIMIT
-	ValidatorRegistryLimit          = 1099511627776 // VALIDATOR_REGISTRY_LIMIT
-	Eth1DataVotesLength             = 2048          // SLOTS_PER_ETH1_VOTING_PERIOD
-	PreviousEpochAttestationsLength = 4096          // MAX_ATTESTATIONS * SLOTS_PER_EPOCH
-	CurrentEpochAttestationsLength  = 4096          // MAX_ATTESTATIONS * SLOTS_PER_EPOCH
-	SlashingsLength                 = 8192          // EPOCHS_PER_SLASHINGS_VECTOR
-	SyncCommitteeLength             = 512           // SYNC_COMMITTEE_SIZE
-	RootLength                      = 32            // RootLength defines the byte length of a Merkle root.
-	BLSSignatureLength              = 96            // BLSSignatureLength defines the byte length of a BLSSignature.
-	BLSPubkeyLength                 = 48            // BLSPubkeyLength defines the byte length of a BLSSignature.
-	MaxTxsPerPayloadLength          = 1048576       // MaxTxsPerPayloadLength defines the maximum number of transactions that can be included in a payload.
-	MaxBytesPerTxLength             = 1073741824    // MaxBytesPerTxLength defines the maximum number of bytes that can be included in a transaction.
-	FeeRecipientLength              = 20            // FeeRecipientLength defines the byte length of a fee recipient.
-	LogsBloomLength                 = 256           // LogsBloomLength defines the byte length of a logs bloom.
+	BlockRootsLength                = 8192                                         // SLOTS_PER_HISTORICAL_ROOT
+	StateRootsLength                = 8192                                         // SLOTS_PER_HISTORICAL_ROOT
+	RandaoMixesLength               = 65536                                        // EPOCHS_PER_HISTORICAL_VECTOR
+	HistoricalRootsLength           = 16777216                                     // HISTORICAL_ROOTS_LIMIT
+	ValidatorRegistryLimit          = 1099511627776                                // VALIDATOR_REGISTRY_LIMIT
+	Eth1DataVotesLength             = 2048                                         // SLOTS_PER_ETH1_VOTING_PERIOD
+	PreviousEpochAttestationsLength = 4096                                         // MAX_ATTESTATIONS * SLOTS_PER_EPOCH
+	CurrentEpochAttestationsLength  = 4096                                         // MAX_ATTESTATIONS * SLOTS_PER_EPOCH
+	SlashingsLength                 = 8192                                         // EPOCHS_PER_SLASHINGS_VECTOR
+	SyncCommitteeLength             = 512                                          // SYNC_COMMITTEE_SIZE
+	RootLength                      = 32                                           // RootLength defines the byte length of a Merkle root.
+	BLSSignatureLength              = 96                                           // BLSSignatureLength defines the byte length of a BLSSignature.
+	BLSPubkeyLength                 = 48                                           // BLSPubkeyLength defines the byte length of a BLSSignature.
+	MaxTxsPerPayloadLength          = 1048576                                      // MaxTxsPerPayloadLength defines the maximum number of transactions that can be included in a payload.
+	MaxBytesPerTxLength             = 1073741824                                   // MaxBytesPerTxLength defines the maximum number of bytes that can be included in a transaction.
+	FeeRecipientLength              = 20                                           // FeeRecipientLength defines the byte length of a fee recipient.
+	LogsBloomLength                 = 256                                          // LogsBloomLength defines the byte length of a logs bloom.
+	EthBurnAddressHex               = "0x0000000000000000000000000000000000000000" // EthBurnAddressHex defines the hex encoded address of the eth1.0 burn contract.
 )

config/fieldparams/minimal.go

@@ -5,21 +5,22 @@ package field_params
 
 const (
 	Preset                          = "minimal"
-	BlockRootsLength                = 64            // SLOTS_PER_HISTORICAL_ROOT
-	StateRootsLength                = 64            // SLOTS_PER_HISTORICAL_ROOT
-	RandaoMixesLength               = 64            // EPOCHS_PER_HISTORICAL_VECTOR
-	HistoricalRootsLength           = 16777216      // HISTORICAL_ROOTS_LIMIT
-	ValidatorRegistryLimit          = 1099511627776 // VALIDATOR_REGISTRY_LIMIT
-	Eth1DataVotesLength             = 32            // SLOTS_PER_ETH1_VOTING_PERIOD
-	PreviousEpochAttestationsLength = 1024          // MAX_ATTESTATIONS * SLOTS_PER_EPOCH
-	CurrentEpochAttestationsLength  = 1024          // MAX_ATTESTATIONS * SLOTS_PER_EPOCH
-	SlashingsLength                 = 64            // EPOCHS_PER_SLASHINGS_VECTOR
-	SyncCommitteeLength             = 32            // SYNC_COMMITTEE_SIZE
-	RootLength                      = 32            // RootLength defines the byte length of a Merkle root.
-	BLSSignatureLength              = 96            // BLSSignatureLength defines the byte length of a BLSSignature.
-	BLSPubkeyLength                 = 48            // BLSPubkeyLength defines the byte length of a BLSSignature.
-	MaxTxsPerPayloadLength          = 1048576       // MaxTxsPerPayloadLength defines the maximum number of transactions that can be included in a payload.
-	MaxBytesPerTxLength             = 1073741824    // MaxBytesPerTxLength defines the maximum number of bytes that can be included in a transaction.
-	FeeRecipientLength              = 20            // FeeRecipientLength defines the byte length of a fee recipient.
-	LogsBloomLength                 = 256           // LogsBloomLength defines the byte length of a logs bloom.
+	BlockRootsLength                = 64                                           // SLOTS_PER_HISTORICAL_ROOT
+	StateRootsLength                = 64                                           // SLOTS_PER_HISTORICAL_ROOT
+	RandaoMixesLength               = 64                                           // EPOCHS_PER_HISTORICAL_VECTOR
+	HistoricalRootsLength           = 16777216                                     // HISTORICAL_ROOTS_LIMIT
+	ValidatorRegistryLimit          = 1099511627776                                // VALIDATOR_REGISTRY_LIMIT
+	Eth1DataVotesLength             = 32                                           // SLOTS_PER_ETH1_VOTING_PERIOD
+	PreviousEpochAttestationsLength = 1024                                         // MAX_ATTESTATIONS * SLOTS_PER_EPOCH
+	CurrentEpochAttestationsLength  = 1024                                         // MAX_ATTESTATIONS * SLOTS_PER_EPOCH
+	SlashingsLength                 = 64                                           // EPOCHS_PER_SLASHINGS_VECTOR
+	SyncCommitteeLength             = 32                                           // SYNC_COMMITTEE_SIZE
+	RootLength                      = 32                                           // RootLength defines the byte length of a Merkle root.
+	BLSSignatureLength              = 96                                           // BLSSignatureLength defines the byte length of a BLSSignature.
+	BLSPubkeyLength                 = 48                                           // BLSPubkeyLength defines the byte length of a BLSSignature.
+	MaxTxsPerPayloadLength          = 1048576                                      // MaxTxsPerPayloadLength defines the maximum number of transactions that can be included in a payload.
+	MaxBytesPerTxLength             = 1073741824                                   // MaxBytesPerTxLength defines the maximum number of bytes that can be included in a transaction.
+	FeeRecipientLength              = 20                                           // FeeRecipientLength defines the byte length of a fee recipient.
+	LogsBloomLength                 = 256                                          // LogsBloomLength defines the byte length of a logs bloom.
+	EthBurnAddressHex               = "0x0000000000000000000000000000000000000000" // EthBurnAddressHex defines the hex encoded address of the eth1.0 burn contract.
 )

config/validator/service/BUILD.bazel

@@ -0,0 +1,12 @@
+load("@prysm//tools/go:def.bzl", "go_library")
+
+go_library(
+    name = "go_default_library",
+    srcs = ["fee-recipient-config.go"],
+    importpath = "github.com/prysmaticlabs/prysm/config/validator/service",
+    visibility = ["//visibility:public"],
+    deps = [
+        "//config/fieldparams:go_default_library",
+        "@com_github_ethereum_go_ethereum//common:go_default_library",
+    ],
+)

config/validator/service/fee-recipient-config.go

@@ -0,0 +1,32 @@
+package validator_service_config
+
+import (
+	"github.com/ethereum/go-ethereum/common"
+	field_params "github.com/prysmaticlabs/prysm/config/fieldparams"
+)
+
+// FeeRecipientFileConfig is the struct representation of the JSON config file set in the validator through the CLI.
+// ProposeConfig is the map of validator address to fee recipient options all in hex format.
+// DefaultConfig is the default fee recipient address for all validators unless otherwise specified in the propose config.required.
+type FeeRecipientFileConfig struct {
+	ProposeConfig map[string]*FeeRecipientFileOptions `json:"proposer_config"`
+	DefaultConfig *FeeRecipientFileOptions            `json:"default_config"`
+}
+
+// FeeRecipientFileOptions is the struct representation of the JSON config file set in the validator through the CLI.
+// FeeRecipient is set to an eth address in hex string format with 0x prefix.
+type FeeRecipientFileOptions struct {
+	FeeRecipient string `json:"fee_recipient"`
+}
+
+// FeeRecipientConfig is a Prysm internal representation of the fee recipient config on the validator client.
+// FeeRecipientFileConfig maps to FeeRecipientConfig on import through the CLI.
+type FeeRecipientConfig struct {
+	ProposeConfig map[[field_params.BLSPubkeyLength]byte]*FeeRecipientOptions
+	DefaultConfig *FeeRecipientOptions
+}
+
+// FeeRecipientOptions is a Prysm internal representation of the FeeRecipientFileOptions on the validator client in bytes format instead of hex.
+type FeeRecipientOptions struct {
+	FeeRecipient common.Address
+}