1{
2 "auth": {
3 "oauth2": {
4 "scopes": {
5 "https://www.googleapis.com/auth/cloud-platform": {
6 "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
7 }
8 }
9 }
10 },
11 "basePath": "",
12 "baseUrl": "https://blockchainnodeengine.googleapis.com/",
13 "batchPath": "batch",
14 "canonicalName": "Blockchain Node Engine",
15 "description": "",
16 "discoveryVersion": "v1",
17 "documentationLink": "https://cloud.google.com/blockchain-node-engine",
18 "fullyEncodeReservedExpansion": true,
19 "icons": {
20 "x16": "http://www.google.com/images/icons/product/search-16.gif",
21 "x32": "http://www.google.com/images/icons/product/search-32.gif"
22 },
23 "id": "blockchainnodeengine:v1",
24 "kind": "discovery#restDescription",
25 "mtlsRootUrl": "https://blockchainnodeengine.mtls.googleapis.com/",
26 "name": "blockchainnodeengine",
27 "ownerDomain": "google.com",
28 "ownerName": "Google",
29 "parameters": {
30 "$.xgafv": {
31 "description": "V1 error format.",
32 "enum": [
33 "1",
34 "2"
35 ],
36 "enumDescriptions": [
37 "v1 error format",
38 "v2 error format"
39 ],
40 "location": "query",
41 "type": "string"
42 },
43 "access_token": {
44 "description": "OAuth access token.",
45 "location": "query",
46 "type": "string"
47 },
48 "alt": {
49 "default": "json",
50 "description": "Data format for response.",
51 "enum": [
52 "json",
53 "media",
54 "proto"
55 ],
56 "enumDescriptions": [
57 "Responses with Content-Type of application/json",
58 "Media download with context-dependent Content-Type",
59 "Responses with Content-Type of application/x-protobuf"
60 ],
61 "location": "query",
62 "type": "string"
63 },
64 "callback": {
65 "description": "JSONP",
66 "location": "query",
67 "type": "string"
68 },
69 "fields": {
70 "description": "Selector specifying which fields to include in a partial response.",
71 "location": "query",
72 "type": "string"
73 },
74 "key": {
75 "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
76 "location": "query",
77 "type": "string"
78 },
79 "oauth_token": {
80 "description": "OAuth 2.0 token for the current user.",
81 "location": "query",
82 "type": "string"
83 },
84 "prettyPrint": {
85 "default": "true",
86 "description": "Returns response with indentations and line breaks.",
87 "location": "query",
88 "type": "boolean"
89 },
90 "quotaUser": {
91 "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
92 "location": "query",
93 "type": "string"
94 },
95 "uploadType": {
96 "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
97 "location": "query",
98 "type": "string"
99 },
100 "upload_protocol": {
101 "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
102 "location": "query",
103 "type": "string"
104 }
105 },
106 "protocol": "rest",
107 "resources": {
108 "projects": {
109 "resources": {
110 "locations": {
111 "methods": {
112 "get": {
113 "description": "Gets information about a location.",
114 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
115 "httpMethod": "GET",
116 "id": "blockchainnodeengine.projects.locations.get",
117 "parameterOrder": [
118 "name"
119 ],
120 "parameters": {
121 "name": {
122 "description": "Resource name for the location.",
123 "location": "path",
124 "pattern": "^projects/[^/]+/locations/[^/]+$",
125 "required": true,
126 "type": "string"
127 }
128 },
129 "path": "v1/{+name}",
130 "response": {
131 "$ref": "Location"
132 },
133 "scopes": [
134 "https://www.googleapis.com/auth/cloud-platform"
135 ]
136 },
137 "list": {
138 "description": "Lists information about the supported locations for this service.",
139 "flatPath": "v1/projects/{projectsId}/locations",
140 "httpMethod": "GET",
141 "id": "blockchainnodeengine.projects.locations.list",
142 "parameterOrder": [
143 "name"
144 ],
145 "parameters": {
146 "filter": {
147 "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
148 "location": "query",
149 "type": "string"
150 },
151 "name": {
152 "description": "The resource that owns the locations collection, if applicable.",
153 "location": "path",
154 "pattern": "^projects/[^/]+$",
155 "required": true,
156 "type": "string"
157 },
158 "pageSize": {
159 "description": "The maximum number of results to return. If not set, the service selects a default.",
160 "format": "int32",
161 "location": "query",
162 "type": "integer"
163 },
164 "pageToken": {
165 "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
166 "location": "query",
167 "type": "string"
168 }
169 },
170 "path": "v1/{+name}/locations",
171 "response": {
172 "$ref": "ListLocationsResponse"
173 },
174 "scopes": [
175 "https://www.googleapis.com/auth/cloud-platform"
176 ]
177 }
178 },
179 "resources": {
180 "blockchainNodes": {
181 "methods": {
182 "create": {
183 "description": "Creates a new blockchain node in a given project and location.",
184 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes",
185 "httpMethod": "POST",
186 "id": "blockchainnodeengine.projects.locations.blockchainNodes.create",
187 "parameterOrder": [
188 "parent"
189 ],
190 "parameters": {
191 "blockchainNodeId": {
192 "description": "Required. ID of the requesting object.",
193 "location": "query",
194 "type": "string"
195 },
196 "parent": {
197 "description": "Required. Value for parent.",
198 "location": "path",
199 "pattern": "^projects/[^/]+/locations/[^/]+$",
200 "required": true,
201 "type": "string"
202 },
203 "requestId": {
204 "description": "Optional. 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).",
205 "location": "query",
206 "type": "string"
207 }
208 },
209 "path": "v1/{+parent}/blockchainNodes",
210 "request": {
211 "$ref": "BlockchainNode"
212 },
213 "response": {
214 "$ref": "Operation"
215 },
216 "scopes": [
217 "https://www.googleapis.com/auth/cloud-platform"
218 ]
219 },
220 "delete": {
221 "description": "Deletes a single blockchain node.",
222 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}",
223 "httpMethod": "DELETE",
224 "id": "blockchainnodeengine.projects.locations.blockchainNodes.delete",
225 "parameterOrder": [
226 "name"
227 ],
228 "parameters": {
229 "name": {
230 "description": "Required. The fully qualified name of the blockchain node to delete. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.",
231 "location": "path",
232 "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$",
233 "required": true,
234 "type": "string"
235 },
236 "requestId": {
237 "description": "Optional. 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 after 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).",
238 "location": "query",
239 "type": "string"
240 }
241 },
242 "path": "v1/{+name}",
243 "response": {
244 "$ref": "Operation"
245 },
246 "scopes": [
247 "https://www.googleapis.com/auth/cloud-platform"
248 ]
249 },
250 "get": {
251 "description": "Gets details of a single blockchain node.",
252 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}",
253 "httpMethod": "GET",
254 "id": "blockchainnodeengine.projects.locations.blockchainNodes.get",
255 "parameterOrder": [
256 "name"
257 ],
258 "parameters": {
259 "name": {
260 "description": "Required. The fully qualified name of the blockchain node to fetch. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.",
261 "location": "path",
262 "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$",
263 "required": true,
264 "type": "string"
265 }
266 },
267 "path": "v1/{+name}",
268 "response": {
269 "$ref": "BlockchainNode"
270 },
271 "scopes": [
272 "https://www.googleapis.com/auth/cloud-platform"
273 ]
274 },
275 "list": {
276 "description": "Lists blockchain nodes in a given project and location.",
277 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes",
278 "httpMethod": "GET",
279 "id": "blockchainnodeengine.projects.locations.blockchainNodes.list",
280 "parameterOrder": [
281 "parent"
282 ],
283 "parameters": {
284 "filter": {
285 "description": "Filtering results.",
286 "location": "query",
287 "type": "string"
288 },
289 "orderBy": {
290 "description": "Hint for how to order the results.",
291 "location": "query",
292 "type": "string"
293 },
294 "pageSize": {
295 "description": "Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.",
296 "format": "int32",
297 "location": "query",
298 "type": "integer"
299 },
300 "pageToken": {
301 "description": "A token identifying a page of results the server should return.",
302 "location": "query",
303 "type": "string"
304 },
305 "parent": {
306 "description": "Required. Parent value for `ListNodesRequest`.",
307 "location": "path",
308 "pattern": "^projects/[^/]+/locations/[^/]+$",
309 "required": true,
310 "type": "string"
311 }
312 },
313 "path": "v1/{+parent}/blockchainNodes",
314 "response": {
315 "$ref": "ListBlockchainNodesResponse"
316 },
317 "scopes": [
318 "https://www.googleapis.com/auth/cloud-platform"
319 ]
320 },
321 "patch": {
322 "description": "Updates the parameters of a single blockchain node.",
323 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/blockchainNodes/{blockchainNodesId}",
324 "httpMethod": "PATCH",
325 "id": "blockchainnodeengine.projects.locations.blockchainNodes.patch",
326 "parameterOrder": [
327 "name"
328 ],
329 "parameters": {
330 "name": {
331 "description": "Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.",
332 "location": "path",
333 "pattern": "^projects/[^/]+/locations/[^/]+/blockchainNodes/[^/]+$",
334 "required": true,
335 "type": "string"
336 },
337 "requestId": {
338 "description": "Optional. 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).",
339 "location": "query",
340 "type": "string"
341 },
342 "updateMask": {
343 "description": "Required. Field mask is used to specify the fields to be overwritten in the Blockchain node resource by the update. The fields specified in the `update_mask` are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.",
344 "format": "google-fieldmask",
345 "location": "query",
346 "type": "string"
347 }
348 },
349 "path": "v1/{+name}",
350 "request": {
351 "$ref": "BlockchainNode"
352 },
353 "response": {
354 "$ref": "Operation"
355 },
356 "scopes": [
357 "https://www.googleapis.com/auth/cloud-platform"
358 ]
359 }
360 }
361 },
362 "operations": {
363 "methods": {
364 "cancel": {
365 "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
366 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel",
367 "httpMethod": "POST",
368 "id": "blockchainnodeengine.projects.locations.operations.cancel",
369 "parameterOrder": [
370 "name"
371 ],
372 "parameters": {
373 "name": {
374 "description": "The name of the operation resource to be cancelled.",
375 "location": "path",
376 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
377 "required": true,
378 "type": "string"
379 }
380 },
381 "path": "v1/{+name}:cancel",
382 "request": {
383 "$ref": "CancelOperationRequest"
384 },
385 "response": {
386 "$ref": "GoogleProtobufEmpty"
387 },
388 "scopes": [
389 "https://www.googleapis.com/auth/cloud-platform"
390 ]
391 },
392 "delete": {
393 "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.",
394 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
395 "httpMethod": "DELETE",
396 "id": "blockchainnodeengine.projects.locations.operations.delete",
397 "parameterOrder": [
398 "name"
399 ],
400 "parameters": {
401 "name": {
402 "description": "The name of the operation resource to be deleted.",
403 "location": "path",
404 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
405 "required": true,
406 "type": "string"
407 }
408 },
409 "path": "v1/{+name}",
410 "response": {
411 "$ref": "GoogleProtobufEmpty"
412 },
413 "scopes": [
414 "https://www.googleapis.com/auth/cloud-platform"
415 ]
416 },
417 "get": {
418 "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
419 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
420 "httpMethod": "GET",
421 "id": "blockchainnodeengine.projects.locations.operations.get",
422 "parameterOrder": [
423 "name"
424 ],
425 "parameters": {
426 "name": {
427 "description": "The name of the operation resource.",
428 "location": "path",
429 "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
430 "required": true,
431 "type": "string"
432 }
433 },
434 "path": "v1/{+name}",
435 "response": {
436 "$ref": "Operation"
437 },
438 "scopes": [
439 "https://www.googleapis.com/auth/cloud-platform"
440 ]
441 },
442 "list": {
443 "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
444 "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations",
445 "httpMethod": "GET",
446 "id": "blockchainnodeengine.projects.locations.operations.list",
447 "parameterOrder": [
448 "name"
449 ],
450 "parameters": {
451 "filter": {
452 "description": "The standard list filter.",
453 "location": "query",
454 "type": "string"
455 },
456 "name": {
457 "description": "The name of the operation's parent resource.",
458 "location": "path",
459 "pattern": "^projects/[^/]+/locations/[^/]+$",
460 "required": true,
461 "type": "string"
462 },
463 "pageSize": {
464 "description": "The standard list page size.",
465 "format": "int32",
466 "location": "query",
467 "type": "integer"
468 },
469 "pageToken": {
470 "description": "The standard list page token.",
471 "location": "query",
472 "type": "string"
473 }
474 },
475 "path": "v1/{+name}/operations",
476 "response": {
477 "$ref": "ListOperationsResponse"
478 },
479 "scopes": [
480 "https://www.googleapis.com/auth/cloud-platform"
481 ]
482 }
483 }
484 }
485 }
486 }
487 }
488 }
489 },
490 "revision": "20240504",
491 "rootUrl": "https://blockchainnodeengine.googleapis.com/",
492 "schemas": {
493 "BlockchainNode": {
494 "description": "A representation of a blockchain node.",
495 "id": "BlockchainNode",
496 "properties": {
497 "blockchainType": {
498 "description": "Immutable. The blockchain type of the node.",
499 "enum": [
500 "BLOCKCHAIN_TYPE_UNSPECIFIED",
501 "ETHEREUM"
502 ],
503 "enumDescriptions": [
504 "Blockchain type has not been specified, but should be.",
505 "The blockchain type is Ethereum."
506 ],
507 "type": "string"
508 },
509 "connectionInfo": {
510 "$ref": "ConnectionInfo",
511 "description": "Output only. The connection information used to interact with a blockchain node.",
512 "readOnly": true
513 },
514 "createTime": {
515 "description": "Output only. The timestamp at which the blockchain node was first created.",
516 "format": "google-datetime",
517 "readOnly": true,
518 "type": "string"
519 },
520 "ethereumDetails": {
521 "$ref": "EthereumDetails",
522 "description": "Ethereum-specific blockchain node details."
523 },
524 "labels": {
525 "additionalProperties": {
526 "type": "string"
527 },
528 "description": "User-provided key-value pairs.",
529 "type": "object"
530 },
531 "name": {
532 "description": "Output only. The fully qualified name of the blockchain node. e.g. `projects/my-project/locations/us-central1/blockchainNodes/my-node`.",
533 "readOnly": true,
534 "type": "string"
535 },
536 "privateServiceConnectEnabled": {
537 "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.",
538 "type": "boolean"
539 },
540 "state": {
541 "description": "Output only. A status representing the state of the node.",
542 "enum": [
543 "STATE_UNSPECIFIED",
544 "CREATING",
545 "DELETING",
546 "RUNNING",
547 "ERROR",
548 "UPDATING",
549 "REPAIRING",
550 "RECONCILING",
551 "SYNCING"
552 ],
553 "enumDescriptions": [
554 "The state has not been specified.",
555 "The node has been requested and is in the process of being created.",
556 "The existing node is undergoing deletion, but is not yet finished.",
557 "The node is running and ready for use.",
558 "The node is in an unexpected or errored state.",
559 "The node is currently being updated.",
560 "The node is currently being repaired.",
561 "The node is currently being reconciled.",
562 "The node is syncing, which is the process by which it obtains the latest block and current global state."
563 ],
564 "readOnly": true,
565 "type": "string"
566 },
567 "updateTime": {
568 "description": "Output only. The timestamp at which the blockchain node was last updated.",
569 "format": "google-datetime",
570 "readOnly": true,
571 "type": "string"
572 }
573 },
574 "type": "object"
575 },
576 "CancelOperationRequest": {
577 "description": "The request message for Operations.CancelOperation.",
578 "id": "CancelOperationRequest",
579 "properties": {},
580 "type": "object"
581 },
582 "ConnectionInfo": {
583 "description": "The connection information through which to interact with a blockchain node.",
584 "id": "ConnectionInfo",
585 "properties": {
586 "endpointInfo": {
587 "$ref": "EndpointInfo",
588 "description": "Output only. The endpoint information through which to interact with a blockchain node.",
589 "readOnly": true
590 },
591 "serviceAttachment": {
592 "description": "Output only. A service attachment that exposes a node, and has the following format: projects/{project}/regions/{region}/serviceAttachments/{service_attachment_name}",
593 "readOnly": true,
594 "type": "string"
595 }
596 },
597 "type": "object"
598 },
599 "EndpointInfo": {
600 "description": "Contains endpoint information through which to interact with a blockchain node.",
601 "id": "EndpointInfo",
602 "properties": {
603 "jsonRpcApiEndpoint": {
604 "description": "Output only. The assigned URL for the node JSON-RPC API endpoint.",
605 "readOnly": true,
606 "type": "string"
607 },
608 "websocketsApiEndpoint": {
609 "description": "Output only. The assigned URL for the node WebSockets API endpoint.",
610 "readOnly": true,
611 "type": "string"
612 }
613 },
614 "type": "object"
615 },
616 "EthereumDetails": {
617 "description": "Ethereum-specific blockchain node details.",
618 "id": "EthereumDetails",
619 "properties": {
620 "additionalEndpoints": {
621 "$ref": "EthereumEndpoints",
622 "description": "Output only. Ethereum-specific endpoint information.",
623 "readOnly": true
624 },
625 "apiEnableAdmin": {
626 "description": "Immutable. Enables JSON-RPC access to functions in the `admin` namespace. Defaults to `false`.",
627 "type": "boolean"
628 },
629 "apiEnableDebug": {
630 "description": "Immutable. Enables JSON-RPC access to functions in the `debug` namespace. Defaults to `false`.",
631 "type": "boolean"
632 },
633 "consensusClient": {
634 "description": "Immutable. The consensus client.",
635 "enum": [
636 "CONSENSUS_CLIENT_UNSPECIFIED",
637 "LIGHTHOUSE",
638 "ERIGON_EMBEDDED_CONSENSUS_LAYER"
639 ],
640 "enumDeprecated": [
641 false,
642 false,
643 true
644 ],
645 "enumDescriptions": [
646 "Consensus client has not been specified, but should be.",
647 "Consensus client implementation written in Rust, maintained by Sigma Prime. See [Lighthouse - Sigma Prime](https://lighthouse.sigmaprime.io/) for details.",
648 "Erigon's embedded consensus client embedded in the execution client. Note this option is not currently available when creating new blockchain nodes. See [Erigon on GitHub](https://github.com/ledgerwatch/erigon#embedded-consensus-layer) for details."
649 ],
650 "type": "string"
651 },
652 "executionClient": {
653 "description": "Immutable. The execution client",
654 "enum": [
655 "EXECUTION_CLIENT_UNSPECIFIED",
656 "GETH",
657 "ERIGON"
658 ],
659 "enumDescriptions": [
660 "Execution client has not been specified, but should be.",
661 "Official Go implementation of the Ethereum protocol. See [go-ethereum](https://geth.ethereum.org/) for details.",
662 "An implementation of Ethereum (execution client), on the efficiency frontier, written in Go. See [Erigon on GitHub](https://github.com/ledgerwatch/erigon) for details."
663 ],
664 "type": "string"
665 },
666 "gethDetails": {
667 "$ref": "GethDetails",
668 "description": "Details for the Geth execution client."
669 },
670 "network": {
671 "description": "Immutable. The Ethereum environment being accessed.",
672 "enum": [
673 "NETWORK_UNSPECIFIED",
674 "MAINNET",
675 "TESTNET_GOERLI_PRATER",
676 "TESTNET_SEPOLIA",
677 "TESTNET_HOLESKY"
678 ],
679 "enumDeprecated": [
680 false,
681 false,
682 true,
683 false,
684 false
685 ],
686 "enumDescriptions": [
687 "The network has not been specified, but should be.",
688 "The Ethereum Mainnet.",
689 "Deprecated: The Ethereum Testnet based on Goerli protocol. Please use another test network.",
690 "The Ethereum Testnet based on Sepolia/Bepolia protocol. See https://github.com/eth-clients/sepolia.",
691 "The Ethereum Testnet based on Holesky specification. See https://github.com/eth-clients/holesky."
692 ],
693 "type": "string"
694 },
695 "nodeType": {
696 "description": "Immutable. The type of Ethereum node.",
697 "enum": [
698 "NODE_TYPE_UNSPECIFIED",
699 "LIGHT",
700 "FULL",
701 "ARCHIVE"
702 ],
703 "enumDescriptions": [
704 "Node type has not been specified, but should be.",
705 "An Ethereum node that only downloads Ethereum block headers.",
706 "Keeps a complete copy of the blockchain data, and contributes to the network by receiving, validating, and forwarding transactions.",
707 "Holds the same data as full node as well as all of the blockchain's history state data dating back to the Genesis Block."
708 ],
709 "type": "string"
710 },
711 "validatorConfig": {
712 "$ref": "ValidatorConfig",
713 "description": "Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client."
714 }
715 },
716 "type": "object"
717 },
718 "EthereumEndpoints": {
719 "description": "Contains endpoint information specific to Ethereum nodes.",
720 "id": "EthereumEndpoints",
721 "properties": {
722 "beaconApiEndpoint": {
723 "description": "Output only. The assigned URL for the node's Beacon API endpoint.",
724 "readOnly": true,
725 "type": "string"
726 },
727 "beaconPrometheusMetricsApiEndpoint": {
728 "description": "Output only. The assigned URL for the node's Beacon Prometheus metrics endpoint. See [Prometheus Metrics](https://lighthouse-book.sigmaprime.io/advanced_metrics.html) for more details.",
729 "readOnly": true,
730 "type": "string"
731 },
732 "executionClientPrometheusMetricsApiEndpoint": {
733 "description": "Output only. The assigned URL for the node's execution client's Prometheus metrics endpoint.",
734 "readOnly": true,
735 "type": "string"
736 }
737 },
738 "type": "object"
739 },
740 "GethDetails": {
741 "description": "Options for the Geth execution client. See [Command-line Options](https://geth.ethereum.org/docs/fundamentals/command-line-options) for more details.",
742 "id": "GethDetails",
743 "properties": {
744 "garbageCollectionMode": {
745 "description": "Immutable. Blockchain garbage collection mode.",
746 "enum": [
747 "GARBAGE_COLLECTION_MODE_UNSPECIFIED",
748 "FULL",
749 "ARCHIVE"
750 ],
751 "enumDescriptions": [
752 "The garbage collection has not been specified.",
753 "Configures Geth's garbage collection so that older data not needed for a full node is deleted. This is the default mode when creating a full node.",
754 "Configures Geth's garbage collection so that old data is never deleted. This is the default mode when creating an archive node. This value can also be chosen when creating a full node in order to create a partial/recent archive node. See [Sync modes](https://geth.ethereum.org/docs/fundamentals/sync-modes) for more details."
755 ],
756 "type": "string"
757 }
758 },
759 "type": "object"
760 },
761 "GoogleProtobufEmpty": {
762 "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }",
763 "id": "GoogleProtobufEmpty",
764 "properties": {},
765 "type": "object"
766 },
767 "ListBlockchainNodesResponse": {
768 "description": "Message for response to listing blockchain nodes.",
769 "id": "ListBlockchainNodesResponse",
770 "properties": {
771 "blockchainNodes": {
772 "description": "The list of nodes",
773 "items": {
774 "$ref": "BlockchainNode"
775 },
776 "type": "array"
777 },
778 "nextPageToken": {
779 "description": "A token identifying a page of results the server should return.",
780 "type": "string"
781 },
782 "unreachable": {
783 "description": "Locations that could not be reached.",
784 "items": {
785 "type": "string"
786 },
787 "type": "array"
788 }
789 },
790 "type": "object"
791 },
792 "ListLocationsResponse": {
793 "description": "The response message for Locations.ListLocations.",
794 "id": "ListLocationsResponse",
795 "properties": {
796 "locations": {
797 "description": "A list of locations that matches the specified filter in the request.",
798 "items": {
799 "$ref": "Location"
800 },
801 "type": "array"
802 },
803 "nextPageToken": {
804 "description": "The standard List next-page token.",
805 "type": "string"
806 }
807 },
808 "type": "object"
809 },
810 "ListOperationsResponse": {
811 "description": "The response message for Operations.ListOperations.",
812 "id": "ListOperationsResponse",
813 "properties": {
814 "nextPageToken": {
815 "description": "The standard List next-page token.",
816 "type": "string"
817 },
818 "operations": {
819 "description": "A list of operations that matches the specified filter in the request.",
820 "items": {
821 "$ref": "Operation"
822 },
823 "type": "array"
824 }
825 },
826 "type": "object"
827 },
828 "Location": {
829 "description": "A resource that represents a Google Cloud location.",
830 "id": "Location",
831 "properties": {
832 "displayName": {
833 "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
834 "type": "string"
835 },
836 "labels": {
837 "additionalProperties": {
838 "type": "string"
839 },
840 "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
841 "type": "object"
842 },
843 "locationId": {
844 "description": "The canonical id for this location. For example: `\"us-east1\"`.",
845 "type": "string"
846 },
847 "metadata": {
848 "additionalProperties": {
849 "description": "Properties of the object. Contains field @type with type URL.",
850 "type": "any"
851 },
852 "description": "Service-specific metadata. For example the available capacity at the given location.",
853 "type": "object"
854 },
855 "name": {
856 "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
857 "type": "string"
858 }
859 },
860 "type": "object"
861 },
862 "Operation": {
863 "description": "This resource represents a long-running operation that is the result of a network API call.",
864 "id": "Operation",
865 "properties": {
866 "done": {
867 "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
868 "type": "boolean"
869 },
870 "error": {
871 "$ref": "Status",
872 "description": "The error result of the operation in case of failure or cancellation."
873 },
874 "metadata": {
875 "additionalProperties": {
876 "description": "Properties of the object. Contains field @type with type URL.",
877 "type": "any"
878 },
879 "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.",
880 "type": "object"
881 },
882 "name": {
883 "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
884 "type": "string"
885 },
886 "response": {
887 "additionalProperties": {
888 "description": "Properties of the object. Contains field @type with type URL.",
889 "type": "any"
890 },
891 "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
892 "type": "object"
893 }
894 },
895 "type": "object"
896 },
897 "OperationMetadata": {
898 "description": "Represents the metadata of the long-running operation.",
899 "id": "OperationMetadata",
900 "properties": {
901 "apiVersion": {
902 "description": "Output only. API version used to start the operation.",
903 "readOnly": true,
904 "type": "string"
905 },
906 "createTime": {
907 "description": "Output only. The time the operation was created.",
908 "format": "google-datetime",
909 "readOnly": true,
910 "type": "string"
911 },
912 "endTime": {
913 "description": "Output only. The time the operation finished running.",
914 "format": "google-datetime",
915 "readOnly": true,
916 "type": "string"
917 },
918 "requestedCancellation": {
919 "description": "Output only. Identifies whether the user has requested cancellation of the operation. Operations that have been cancelled successfully have `Operation.error` value with a `google.rpc.Status.code` of `1`, corresponding to `Code.CANCELLED`.",
920 "readOnly": true,
921 "type": "boolean"
922 },
923 "statusMessage": {
924 "description": "Output only. Human-readable status of the operation, if any.",
925 "readOnly": true,
926 "type": "string"
927 },
928 "target": {
929 "description": "Output only. Server-defined resource path for the target of the operation.",
930 "readOnly": true,
931 "type": "string"
932 },
933 "verb": {
934 "description": "Output only. Name of the verb executed by the operation.",
935 "readOnly": true,
936 "type": "string"
937 }
938 },
939 "type": "object"
940 },
941 "Status": {
942 "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).",
943 "id": "Status",
944 "properties": {
945 "code": {
946 "description": "The status code, which should be an enum value of google.rpc.Code.",
947 "format": "int32",
948 "type": "integer"
949 },
950 "details": {
951 "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
952 "items": {
953 "additionalProperties": {
954 "description": "Properties of the object. Contains field @type with type URL.",
955 "type": "any"
956 },
957 "type": "object"
958 },
959 "type": "array"
960 },
961 "message": {
962 "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.",
963 "type": "string"
964 }
965 },
966 "type": "object"
967 },
968 "ValidatorConfig": {
969 "description": "Configuration for validator-related parameters on the beacon client, and for any GCP-managed validator client.",
970 "id": "ValidatorConfig",
971 "properties": {
972 "beaconFeeRecipient": {
973 "description": "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.",
974 "type": "string"
975 },
976 "managedValidatorClient": {
977 "description": "Immutable. When true, deploys a GCP-managed validator client alongside the beacon client.",
978 "type": "boolean"
979 },
980 "mevRelayUrls": {
981 "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.",
982 "items": {
983 "type": "string"
984 },
985 "type": "array"
986 }
987 },
988 "type": "object"
989 }
990 },
991 "servicePath": "",
992 "title": "Blockchain Node Engine API",
993 "version": "v1",
994 "version_module": true
995}View as plain text