Skip to content

Commit

Permalink
feat(blockchainnodeengine)!: update the API
Browse files Browse the repository at this point in the history
BREAKING CHANGE: This release has breaking changes.

#### blockchainnodeengine:v1

The following keys were deleted:
- schemas.EthereumDetails.properties.beaconFeeRecipient.deprecated
- schemas.EthereumDetails.properties.beaconFeeRecipient.description
- schemas.EthereumDetails.properties.beaconFeeRecipient.type

The following keys were added:
- schemas.ValidatorConfig.properties.managedValidatorClient.description
- schemas.ValidatorConfig.properties.managedValidatorClient.type

The following keys were changed:
- schemas.BlockchainNode.properties.privateServiceConnectEnabled.description
  • Loading branch information
yoshi-automation authored and bcoe committed Feb 2, 2024
1 parent e242588 commit ec5ff13
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 12 deletions.
13 changes: 6 additions & 7 deletions discovery/blockchainnodeengine-v1.json
Original file line number Diff line number Diff line change
Expand Up @@ -487,7 +487,7 @@
}
}
},
"revision": "20231206",
"revision": "20240124",
"rootUrl": "https://blockchainnodeengine.googleapis.com/",
"schemas": {
"BlockchainNode": {
Expand Down Expand Up @@ -534,7 +534,7 @@
"type": "string"
},
"privateServiceConnectEnabled": {
"description": "Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. See https://cloud.google.com/vpc/docs/private-service-connect.",
"description": "Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: Private Service Connect enabled nodes may require a manual migration effort to remain compatible with future versions of the product. If this feature is enabled, you will be notified of these changes along with any required action to avoid disruption. See https://cloud.google.com/vpc/docs/private-service-connect.",
"type": "boolean"
},
"state": {
Expand Down Expand Up @@ -628,11 +628,6 @@
"description": "Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.",
"type": "boolean"
},
"beaconFeeRecipient": {
"deprecated": true,
"description": "Deprecated: Use the same field in the ValidatorConfig message as replacement. An Ethereum address which the beacon client will send fee rewards to if no recipient is configured in the validator client. See https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or https://docs.prylabs.network/docs/execution-node/fee-recipient for examples of how this is used. Note that while this is often described as \"suggested\", as we run the execution node we can trust the execution node, and therefore this is considered enforced.",
"type": "string"
},
"consensusClient": {
"description": "Immutable. The consensus client.",
"enum": [
Expand Down Expand Up @@ -965,6 +960,10 @@
"description": "Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client.",
"id": "ValidatorConfig",
"properties": {
"managedValidatorClient": {
"description": "Immutable. When true, deploys a GCP-managed validator client alongside the beacon client.",
"type": "boolean"
},
"mevRelayUrls": {
"description": "URLs for MEV-relay services to use for block building. When set, a GCP-managed MEV-boost service is configured on the beacon client.",
"items": {
Expand Down
10 changes: 5 additions & 5 deletions src/apis/blockchainnodeengine/v1.ts
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ export namespace blockchainnodeengine_v1 {
*/
name?: string | null;
/**
* Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. See https://cloud.google.com/vpc/docs/private-service-connect.
* Optional. When true, the node is only accessible via Private Service Connect; no public endpoints are exposed. Otherwise, the node is only accessible via public endpoints. Warning: Private Service Connect enabled nodes may require a manual migration effort to remain compatible with future versions of the product. If this feature is enabled, you will be notified of these changes along with any required action to avoid disruption. See https://cloud.google.com/vpc/docs/private-service-connect.
*/
privateServiceConnectEnabled?: boolean | null;
/**
Expand Down Expand Up @@ -211,10 +211,6 @@ export namespace blockchainnodeengine_v1 {
* Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.
*/
apiEnableDebug?: boolean | null;
/**
* Deprecated: Use the same field in the ValidatorConfig message as replacement. An Ethereum address which the beacon client will send fee rewards to if no recipient is configured in the validator client. See https://lighthouse-book.sigmaprime.io/suggested-fee-recipient.html or https://docs.prylabs.network/docs/execution-node/fee-recipient for examples of how this is used. Note that while this is often described as "suggested", as we run the execution node we can trust the execution node, and therefore this is considered enforced.
*/
beaconFeeRecipient?: string | null;
/**
* Immutable. The consensus client.
*/
Expand Down Expand Up @@ -417,6 +413,10 @@ export namespace blockchainnodeengine_v1 {
* Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client.
*/
export interface Schema$ValidatorConfig {
/**
* Immutable. When true, deploys a GCP-managed validator client alongside the beacon client.
*/
managedValidatorClient?: boolean | null;
/**
* URLs for MEV-relay services to use for block building. When set, a GCP-managed MEV-boost service is configured on the beacon client.
*/
Expand Down

0 comments on commit ec5ff13

Please sign in to comment.