README
¶
generate_consolidations Task
Description
The generate_consolidations task is designed to create and send consolidation transactions to the Ethereum network. Consolidations are specialized transactions used for consolidating multiple validator balances into a single validator, optimizing the management and operation of validators within the network.
The source validators can be specified in two ways:
- By providing
sourceMnemonic,sourceStartIndex&sourceIndexCountto select the source validators by the pubkeys derived from the mnemonic & key range - By providing
sourceStartValidatorIndex&sourceIndexCountto select the source validators by their validator index
Configuration Parameters
-
limitPerSlot: Specifies the maximum number of consolidation transactions allowed per slot. -
limitTotal: Sets the total allowable number of consolidation transactions that the task can generate. -
limitPending: Defines the maximum number of pending consolidation transactions allowed at any given time. -
sourceMnemonic: The mnemonic used to derive source validator keys; these validators are getting consolidated into the target validator. -
sourceStartIndex: The starting index for key derivation from the source mnemonic, identifying the first source validator in the consolidation process. -
sourceStartValidatorIndex: The exact starting validator index from which to begin consolidation, providing precise control over the selection of source validators. -
sourceIndexCount: The number of validators to include in the consolidation process from the source mnemonic. -
targetPublicKey: The public key of the target validator to which all consolidated funds will be transferred. -
targetValidatorIndex: The index of the target validator to which all consolidated funds will be transferred. (alternative to targetPublicKey) -
consolidationEpoch: The specific blockchain epoch during which the consolidations are to be executed, aligning the transactions with defined blockchain timings. -
walletPrivkey: The private key of the wallet initiating the consolidation transactions, necessary for transaction authorization. This wallet must be set as withdrawal address for the source & target validator for successful consolidation. -
consolidationContract: The address of the contract on the blockchain that handles the consolidation operations. -
txAmount: The amount of ETH to be sent to the consolidation contract in each transaction (for consolidation fees). -
txFeeCap: The maximum fee cap for each transaction, controlling the cost associated with the consolidation. -
txTipCap: The tip cap for each transaction, influencing transaction priority. -
txGasLimit: The gas limit for each transaction, ensuring transactions are executed within the cost constraints. -
clientPattern: A regex pattern to select specific clients for sending the transactions, targeting appropriate network nodes. -
excludeClientPattern: A regex pattern to exclude certain clients from sending transactions, optimizing network interactions. -
awaitReceipt: When enabled, the task waits for a receipt for each transaction, confirming execution on the network. -
failOnReject: Determines if the task should fail upon transaction rejection, enhancing error handling.
Defaults
Default settings for the generate_consolidations task:
- name: generate_consolidations
config:
limitPerSlot: 0
limitTotal: 0
limitPending: 0
sourceMnemonic: ""
sourceStartIndex: 0
sourceStartValidatorIndex: null
sourceIndexCount: 0
targetValidatorIndex: null
targetPublicKey: ""
consolidationEpoch: null
walletPrivkey: ""
consolidationContract: "0x0000BBdDc7CE488642fb579F8B00f3a590007251"
txAmount: "500000000000000000"
txFeeCap: "100000000000"
txTipCap: "1000000000"
txGasLimit: 100000
clientPattern: ""
excludeClientPattern: ""
awaitReceipt: false
failOnReject: false
consolidationTransactionsResultVar: ""
consolidationReceiptsResultVar: ""
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TaskName = "generate_consolidations" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Generates consolidations and sends them to the network", Category: "validator", Config: DefaultConfig(), Outputs: []types.TaskOutputDefinition{ { Name: "transactionHashes", Type: "array", Description: "Array of consolidation transaction hashes.", }, { Name: "transactionReceipts", Type: "array", Description: "Array of consolidation transaction receipts.", }, }, NewTask: NewTask, } )
Functions ¶
func NewTask ¶
func NewTask(ctx *types.TaskContext, options *types.TaskOptions) (types.Task, error)
Types ¶
type Config ¶
type Config struct {
LimitPerSlot int `yaml:"limitPerSlot" json:"limitPerSlot" desc:"Maximum number of consolidation requests to generate per slot."`
LimitTotal int `yaml:"limitTotal" json:"limitTotal" require:"A.1" desc:"Total limit on the number of consolidation requests to generate."`
LimitPending int `yaml:"limitPending" json:"limitPending" desc:"Maximum number of pending consolidation requests to allow before waiting."`
SourceMnemonic string `yaml:"sourceMnemonic" json:"sourceMnemonic" require:"B.1" desc:"Mnemonic phrase to derive source validator keys."`
SourceStartIndex int `` /* 136-byte string literal not displayed */
SourceStartValidatorIndex *uint64 `` /* 134-byte string literal not displayed */
SourceIndexCount int `yaml:"sourceIndexCount" json:"sourceIndexCount" require:"A.2" desc:"Number of source validators to consolidate."`
TargetPublicKey string `yaml:"targetPublicKey" json:"targetPublicKey" require:"C.1" desc:"Public key of the target validator to consolidate into."`
TargetValidatorIndex *uint64 `` /* 137-byte string literal not displayed */
ConsolidationEpoch *uint64 `yaml:"consolidationEpoch" json:"consolidationEpoch" desc:"Epoch at which consolidation should occur."`
WalletPrivkey string `yaml:"walletPrivkey" json:"walletPrivkey" desc:"Private key of the wallet used to send consolidation request transactions."`
ConsolidationContract string `yaml:"consolidationContract" json:"consolidationContract" desc:"Address of the consolidation request contract."`
TxAmount *big.Int `yaml:"txAmount" json:"txAmount" desc:"Amount of ETH to send with the consolidation request transaction."`
TxFeeCap *big.Int `yaml:"txFeeCap" json:"txFeeCap" desc:"Maximum fee cap (in wei) for consolidation request transactions."`
TxTipCap *big.Int `yaml:"txTipCap" json:"txTipCap" desc:"Maximum priority tip (in wei) for consolidation request transactions."`
TxGasLimit uint64 `yaml:"txGasLimit" json:"txGasLimit" desc:"Gas limit for consolidation request transactions."`
ClientPattern string `` /* 127-byte string literal not displayed */
ExcludeClientPattern string `yaml:"excludeClientPattern" json:"excludeClientPattern" desc:"Regex pattern to exclude certain client endpoints."`
AwaitReceipt bool `yaml:"awaitReceipt" json:"awaitReceipt" desc:"Wait for transaction receipts before completing."`
FailOnReject bool `yaml:"failOnReject" json:"failOnReject" desc:"Fail the task if any transaction is rejected."`
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Source Files