imjasonh/gcloud-help
1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-09 10:56:49 +00:00
Code Activity
gcloud-help/gcloud/alpha/blockchain-validator/blockchain-validator-configs/create
Automated a3842bba95 gcloud: Wed Sep 11 09:52:17 UTC 2024
2024-09-11 09:52:17 +00:00

306 lines
14 KiB
Text
Raw Blame History

NAME
gcloud alpha blockchain-validator blockchain-validator-configs create -
create a blockchain validator configuration
SYNOPSIS
gcloud alpha blockchain-validator blockchain-validator-configs create
BLOCKCHAIN_VALIDATOR_CONFIG --blockchain-type=BLOCKCHAIN_TYPE
--key-source=KEY_SOURCE --[no-]validation-work-enabled [--async]
[--blockchain-node-id=BLOCKCHAIN_NODE_ID] [--labels=[LABELS,...]]
[--location=LOCATION] [--request-id=REQUEST_ID]
[--ethereum-protocol-details-gas-limit=ETHEREUM_PROTOCOL_DETAILS_GAS_LIMIT --ethereum-protocol-details-graffiti=ETHEREUM_PROTOCOL_DETAILS_GRAFFITI --ethereum-protocol-details-suggested-fee-recipient=ETHEREUM_PROTOCOL_DETAILS_SUGGESTED_FEE_RECIPIENT --ethereum-protocol-details-use-block-builder-proposals]
[[--existing-seed-phrase-reference-secret=EXISTING_SEED_PHRASE_REFERENCE_SECRET : --existing-seed-phrase-reference-derivation-index=EXISTING_SEED_PHRASE_REFERENCE_DERIVATION_INDEX] | [--remote-web3-signer-voting-public-key=REMOTE_WEB3_SIGNER_VOTING_PUBLIC_KEY --remote-web3-signer-web3signer-uri=REMOTE_WEB3_SIGNER_WEB3SIGNER_URI : --remote-web3-signer-timeout-duration=REMOTE_WEB3_SIGNER_TIMEOUT_DURATION] | [--seed-phrase-reference-secret=SEED_PHRASE_REFERENCE_SECRET : --seed-phrase-reference-export]]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(ALPHA) Create a blockchain validator configuration on a blockchain node
managed by Blockchain Node Engine.
EXAMPLES
To create an Ethereum validator configuration my-validator in the project
my-project and location us-central1, using a new seed phrase which is
exported to Secret Manager, and deploy it to the blockchain node my-node,
run:
$ gcloud alpha blockchain-validator blockchain-validator-configs \ create my-validator --location=us-central1 \
--project=my-project --validation-work-enabled=false \
--blockchain-type=ETHEREUM --key-source=SEED_PHRASE_REFERENCE \
--seed-phrase-reference-secret=projects/my-project/secrets/\
my-seed-phrase --seed-phrase-reference-export=true \
--blockchain-node-id=projects/my-project/locations/us-central1/\
blockchainNodes/my-node
POSITIONAL ARGUMENTS
BlockchainValidatorConfig resource - Blockchain Validator Config Name The
name of the Blockchain Validator Config. The fully specified name must
have the format
projects/{project}/locations/{location}/blockchainValidatorConfigs/{validator}.
This represents a Cloud resource. (NOTE) Some attributes are not given
arguments in this group but can be set in other ways.
To set the project attribute:
◆ provide the argument blockchain_validator_config on the command line
with a fully specified name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
To set the location attribute:
◆ provide the argument blockchain_validator_config on the command line
with a fully specified name;
◆ provide the argument --location on the command line.
This must be specified.
BLOCKCHAIN_VALIDATOR_CONFIG
ID of the blockchainValidatorConfig or fully qualified identifier for
the blockchainValidatorConfig.
To set the blockchain_validator_config attribute:
▸ provide the argument blockchain_validator_config on the command
line.
REQUIRED FLAGS
--blockchain-type=BLOCKCHAIN_TYPE
The blockchain type of the validator. BLOCKCHAIN_TYPE must be (only one
value is supported):
ethereum
The blockchain type is Ethereum.
--key-source=KEY_SOURCE
The source of the voting key for the blockchain validator. KEY_SOURCE
must be one of:
existing-seed-phrase-reference
Derive voting keys from existing seed material.
remote-web3-signer
The voting key is stored in a remote signing service (Web3Signer)
and signing requests are delegated.
seed-phrase-reference
Derive voting keys from new seed material.
--[no-]validation-work-enabled
True if the blockchain node requests and signs attestations and blocks
on behalf of this validator, false if not. This does NOT define whether
the blockchain expects work to occur, only whether the blockchain node
specified above is carrying out validation tasks. This should be
enabled under normal conditions, but may be useful when migrating
validators to/from Blockchain Node Engine, where the validator may be
paused during the migration. Use --validation-work-enabled to enable
and --no-validation-work-enabled to disable.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to
complete.
Arguments for the blockchain node.
--blockchain-node-id=BLOCKCHAIN_NODE_ID
The fully qualified name of the blockchain node which carries out
work on behalf of the validator. If not set, the validator must
either be operated outside of Blockchain Validator Manager, or it
will be offline (no attestations or blocks will be produced). If this
node is offline or deleted, the validator will be offline.
--labels=[LABELS,...]
Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only hyphens
(-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase
characters, and numbers.
Shorthand Example:
--labels=string=string
JSON Example:
--labels='{"string": "string"}'
File Example:
--labels=path_to_file.(yaml|json)
--location=LOCATION
For resources [blockchainValidatorConfig, secret], provides fallback
value for resource location attribute. When the resource's full URI
path is not provided, location will fallback to this flag value.
--request-id=REQUEST_ID
An optional request ID to identify requests. Specify a unique request
ID so that if you must retry your request, the server will know to
ignore the request if it has already been completed. The server will
guarantee that for at least 60 minutes since the first request.
For example, consider a situation where you make an initial request and
the request times out. If you make the request again with the same
request ID, the server can check if original operation with the same
request ID was received, and if so, will ignore the second request.
This prevents clients from accidentally creating duplicate commitments.
The request ID must be a valid UUID with the exception that zero UUID
is not supported (00000000-0000-0000-0000-000000000000).
Arguments for the blockchain type details.
Blockchain validator configuration unique to Ethereum blockchains.
Arguments for the gas limit.
--ethereum-protocol-details-gas-limit=ETHEREUM_PROTOCOL_DETAILS_GAS_LIMIT
Optionally requested (not enforced) maximum gas per block. This
is sent to the block builder service, however whether it is
followed depends on the service. This field is only read if the
field use_block_builder_proposals is set to true. If not
specified, the validator client will use a default value.
Arguments for the graffiti.
--ethereum-protocol-details-graffiti=ETHEREUM_PROTOCOL_DETAILS_GRAFFITI
Graffiti is a custom string published in blocks proposed by the
validator. This can only be written, as the current value cannot
be read back from the validator client API. See
https://lighthouse-book.sigmaprime.io/graffiti.html for an
example of how this is used. If not set, the validator client's
default is used. If no blockchain node is specified, this has no
effect as no validator client is run.
--ethereum-protocol-details-suggested-fee-recipient=ETHEREUM_PROTOCOL_DETAILS_SUGGESTED_FEE_RECIPIENT
The Ethereum address to which fee rewards should be sent. This can
only be set when creating the validator. If no blockchain node is
specified for the validator, this has no effect as no validator
client is run. See also
https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html
for more context.
Arguments for the use block builder proposals.
--ethereum-protocol-details-use-block-builder-proposals
Enable use of the external block building services (MEV).
Arguments for the key source config.
At most one of these can be specified:
Location of existing seed material, and derivation path used to generate
the voting key.
Secret resource - Reference into Secret Manager for where the seed
phrase is stored. This represents a Cloud resource. (NOTE) Some
attributes are not given arguments in this group but can be set in
other ways.
To set the project attribute:
▫ provide the argument --existing-seed-phrase-reference-secret on
the command line with a fully specified name;
▫ provide the argument --project on the command line;
▫ set the property core/project.
To set the location attribute:
▫ provide the argument --existing-seed-phrase-reference-secret on
the command line with a fully specified name;
▫ provide the argument --location on the command line. This
resource can be one of the following types:
[blockchainvalidatormanager.projects.locations.secrets,
blockchainvalidatormanager.projects.secrets].
This must be specified.
--existing-seed-phrase-reference-secret=EXISTING_SEED_PHRASE_REFERENCE_SECRET
ID of the secret or fully qualified identifier for the secret.
To set the secret attribute:
◇ provide the argument --existing-seed-phrase-reference-secret
on the command line.
--existing-seed-phrase-reference-derivation-index=EXISTING_SEED_PHRASE_REFERENCE_DERIVATION_INDEX
The index to derive the voting key at, used as part of a derivation
path. The derivation path is built from this as
"m/12381/3600/<derivation_index>/0/0" See also
https://eips.ethereum.org/EIPS/eip-2334#eth2-specific-parameters
Configuration to use an external key signing service, such as the
service endpoint. The external key signer is expected to be managed
entirely by the customer. For reference see
https://docs.web3signer.consensys.net/ for details on Web3Signer and
https://docs.web3signer.consensys.net/reference/api/json-rpc for the API
exposed by the external service.
--remote-web3-signer-voting-public-key=REMOTE_WEB3_SIGNER_VOTING_PUBLIC_KEY
The public key of the validator, as a hexadecimal string prefixed
with "0x". This is used as the identifier for the key when sending
requests to the Web3Signer service.
This flag argument must be specified if any of the other arguments
in this group are specified.
--remote-web3-signer-web3signer-uri=REMOTE_WEB3_SIGNER_WEB3SIGNER_URI
URI of the Web3Signer service the validator client connects to, to
request signing of attestations, blocks, etc.
This flag argument must be specified if any of the other arguments
in this group are specified.
Arguments for the timeout duration.
--remote-web3-signer-timeout-duration=REMOTE_WEB3_SIGNER_TIMEOUT_DURATION
Timeout for requests to the Web3Signer service.
Derivation path used to generate the voting key, and optionally Secret
Manager secret to backup the seed phrase to.
Secret resource - Reference into Secret Manager for where the seed
phrase is stored. This represents a Cloud resource. (NOTE) Some
attributes are not given arguments in this group but can be set in
other ways.
To set the project attribute:
▫ provide the argument --seed-phrase-reference-secret on the
command line with a fully specified name;
▫ provide the argument --project on the command line;
▫ set the property core/project.
To set the location attribute:
▫ provide the argument --seed-phrase-reference-secret on the
command line with a fully specified name;
▫ provide the argument --location on the command line. This
resource can be one of the following types:
[blockchainvalidatormanager.projects.locations.secrets,
blockchainvalidatormanager.projects.secrets].
This must be specified.
--seed-phrase-reference-secret=SEED_PHRASE_REFERENCE_SECRET
ID of the secret or fully qualified identifier for the secret.
To set the secret attribute:
◇ provide the argument --seed-phrase-reference-secret on the
command line.
--seed-phrase-reference-export
True to export the seed phrase to Secret Manager.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
API REFERENCE
This command uses the blockchainvalidatormanager/v1 API. The full
documentation for this API can be found at:
https://cloud.google.com/blockchain-node-engine/docs/create-node-ethereum#validator_configuration
NOTES
This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct
project, you might be trying to access an API with an invitation-only early
access allowlist.
View git blame Copy permalink