README
¶
generate_bls_changes Task
Description
The generate_bls_changes task is responsible for generating BLS changes and sending these operations to the network. This task is vital for testing the network's ability to handle changes in withdrawal credentials.
Configuration Parameters
-
limitPerSlot:
The maximum number of BLS change operations to generate for each slot. A slot is a specific time interval in blockchain technology. -
limitTotal:
The total limit on the number of BLS change operations to be generated by this task. -
mnemonic:
A mnemonic phrase used to generate validator keys. This is the starting point for creating BLS key changes. -
startIndex:
The index within the mnemonic from which to start generating validator keys. This determines the starting point for key generation. -
indexCount:
The number of validator keys to generate from the mnemonic. This sets how many different validators will have their keys changed. -
targetAddress:
The address to which the validators' withdrawal credentials will be set. This defines the new target for the validators' funds after the BLS key change. -
clientPattern:
A regex pattern for selecting specific client endpoints to send the BLS change operations. If unspecified, any available endpoint is used. -
excludeClientPattern:
A regex pattern to exclude certain client endpoints from being utilized for BLS change operations. This parameter allows for excluding specific clients from the task, offering finer control over client selection. -
awaitInclusion:
If set totrue, the task waits for all submitted BLS changes to be included in beacon blocks before completing. The task monitors new blocks and checks for the presence of the submitted operations.
Outputs
-
blsChanges:
Array of generated BLS change operations. -
latestBlsChange:
The most recently generated BLS change operation. -
includedBlsChanges:
Number of BLS changes confirmed on-chain (only populated whenawaitInclusionis enabled).
Defaults
Default settings for the generate_bls_changes task:
- name: generate_bls_changes
config:
limitPerSlot: 0
limitTotal: 0
mnemonic: ""
startIndex: 0
indexCount: 0
targetAddress: ""
clientPattern: ""
excludeClientPattern: ""
awaitInclusion: false
Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
var ( TaskName = "generate_bls_changes" TaskDescriptor = &types.TaskDescriptor{ Name: TaskName, Description: "Generates bls changes and sends them to the network", Category: "validator", Config: DefaultConfig(), Outputs: []types.TaskOutputDefinition{ { Name: "blsChanges", Type: "array", Description: "Array of generated BLS change operations.", }, { Name: "latestBlsChange", Type: "object", Description: "The most recently generated BLS change operation.", }, { Name: "includedBlsChanges", Type: "number", Description: "Number of BLS changes included on-chain (when awaitInclusion is enabled).", }, }, 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" require:"A.1" desc:"Maximum number of BLS change operations to generate per slot."`
LimitTotal int `yaml:"limitTotal" json:"limitTotal" require:"A.2" desc:"Total limit on the number of BLS change operations to generate."`
Mnemonic string `yaml:"mnemonic" json:"mnemonic" require:"B" desc:"Mnemonic phrase used to generate validator keys."`
StartIndex int `yaml:"startIndex" json:"startIndex" desc:"Index within the mnemonic from which to start generating validator keys."`
IndexCount int `yaml:"indexCount" json:"indexCount" require:"A.3" desc:"Number of validator keys to generate from the mnemonic."`
TargetAddress string `yaml:"targetAddress" json:"targetAddress" require:"C" desc:"Execution layer address to set as withdrawal credentials."`
ClientPattern string `yaml:"clientPattern" json:"clientPattern" desc:"Regex pattern to select specific client endpoints for submitting operations."`
ExcludeClientPattern string `yaml:"excludeClientPattern" json:"excludeClientPattern" desc:"Regex pattern to exclude certain client endpoints."`
AwaitInclusion bool `yaml:"awaitInclusion" json:"awaitInclusion" desc:"Wait for BLS changes to be included in beacon blocks before completing."`
}
func DefaultConfig ¶
func DefaultConfig() Config
type Task ¶
type Task struct {
// contains filtered or unexported fields
}
Source Files