mirror of https://github.com/hyperledger/besu
Simplifying BesuCommand step 1 (#7682)
Simplifying BesuCommand --------- Signed-off-by: Justin Florentine <justin+github@florentine.us>pull/7745/head
Justin Florentine
2 months ago
committed by
GitHub
parent
94099d18f5
commit
f4dc48d94d
@ -0,0 +1,36 @@ |
|||||||
|
/* |
||||||
|
* Copyright contributors to Hyperledger Besu. |
||||||
|
* |
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||||
|
* the License. You may obtain a copy of the License at |
||||||
|
* |
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
* |
||||||
|
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||||
|
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||||
|
* specific language governing permissions and limitations under the License. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: Apache-2.0 |
||||||
|
*/ |
||||||
|
package org.hyperledger.besu.cli.options.stable; |
||||||
|
|
||||||
|
import org.hyperledger.besu.cli.custom.JsonRPCAllowlistHostsProperty; |
||||||
|
|
||||||
|
import java.nio.file.Path; |
||||||
|
|
||||||
|
/** |
||||||
|
* Command line options for configuring Engine RPC on the node. |
||||||
|
* |
||||||
|
* @param overrideEngineRpcEnabled enable the engine api, even in the absence of merge-specific |
||||||
|
* configurations. |
||||||
|
* @param engineRpcPort Port to provide consensus client APIS on |
||||||
|
* @param engineJwtKeyFile Path to file containing shared secret key for JWT signature verification |
||||||
|
* @param isEngineAuthDisabled Disable authentication for Engine APIs |
||||||
|
* @param engineHostsAllowlist List of hosts to allowlist for Engine APIs |
||||||
|
*/ |
||||||
|
public record EngineRPCConfiguration( |
||||||
|
Boolean overrideEngineRpcEnabled, |
||||||
|
Integer engineRpcPort, |
||||||
|
Path engineJwtKeyFile, |
||||||
|
Boolean isEngineAuthDisabled, |
||||||
|
JsonRPCAllowlistHostsProperty engineHostsAllowlist) {} |
||||||
@ -0,0 +1,81 @@ |
|||||||
|
/* |
||||||
|
* Copyright contributors to Hyperledger Besu. |
||||||
|
* |
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||||
|
* the License. You may obtain a copy of the License at |
||||||
|
* |
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
* |
||||||
|
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||||
|
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||||
|
* specific language governing permissions and limitations under the License. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: Apache-2.0 |
||||||
|
*/ |
||||||
|
package org.hyperledger.besu.cli.options.stable; |
||||||
|
|
||||||
|
import static org.hyperledger.besu.ethereum.api.jsonrpc.JsonRpcConfiguration.DEFAULT_ENGINE_JSON_RPC_PORT; |
||||||
|
|
||||||
|
import org.hyperledger.besu.cli.DefaultCommandValues; |
||||||
|
import org.hyperledger.besu.cli.custom.JsonRPCAllowlistHostsProperty; |
||||||
|
import org.hyperledger.besu.cli.options.CLIOptions; |
||||||
|
import org.hyperledger.besu.cli.util.CommandLineUtils; |
||||||
|
|
||||||
|
import java.nio.file.Path; |
||||||
|
import java.util.List; |
||||||
|
|
||||||
|
import picocli.CommandLine; |
||||||
|
|
||||||
|
/** Command line options for configuring Engine RPC on the node. */ |
||||||
|
public class EngineRPCOptions implements CLIOptions<EngineRPCConfiguration> { |
||||||
|
|
||||||
|
/** Default constructor */ |
||||||
|
public EngineRPCOptions() {} |
||||||
|
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--engine-rpc-enabled"}, |
||||||
|
description = "enable the engine api, even in the absence of merge-specific configurations.") |
||||||
|
private final Boolean overrideEngineRpcEnabled = false; |
||||||
|
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--engine-rpc-port", "--engine-rpc-http-port"}, |
||||||
|
paramLabel = DefaultCommandValues.MANDATORY_PORT_FORMAT_HELP, |
||||||
|
description = "Port to provide consensus client APIS on (default: ${DEFAULT-VALUE})", |
||||||
|
arity = "1") |
||||||
|
private final Integer engineRpcPort = DEFAULT_ENGINE_JSON_RPC_PORT; |
||||||
|
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--engine-jwt-secret"}, |
||||||
|
paramLabel = DefaultCommandValues.MANDATORY_FILE_FORMAT_HELP, |
||||||
|
description = "Path to file containing shared secret key for JWT signature verification") |
||||||
|
private final Path engineJwtKeyFile = null; |
||||||
|
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--engine-jwt-disabled"}, |
||||||
|
description = "Disable authentication for Engine APIs (default: ${DEFAULT-VALUE})") |
||||||
|
private final Boolean isEngineAuthDisabled = false; |
||||||
|
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--engine-host-allowlist"}, |
||||||
|
paramLabel = "<hostname>[,<hostname>...]... or * or all", |
||||||
|
description = |
||||||
|
"Comma separated list of hostnames to allow for ENGINE API access (applies to both HTTP and websockets), or * to accept any host (default: ${DEFAULT-VALUE})", |
||||||
|
defaultValue = "localhost,127.0.0.1") |
||||||
|
private final JsonRPCAllowlistHostsProperty engineHostsAllowlist = |
||||||
|
new JsonRPCAllowlistHostsProperty(); |
||||||
|
|
||||||
|
@Override |
||||||
|
public EngineRPCConfiguration toDomainObject() { |
||||||
|
return new EngineRPCConfiguration( |
||||||
|
overrideEngineRpcEnabled, |
||||||
|
engineRpcPort, |
||||||
|
engineJwtKeyFile, |
||||||
|
isEngineAuthDisabled, |
||||||
|
engineHostsAllowlist); |
||||||
|
} |
||||||
|
|
||||||
|
@Override |
||||||
|
public List<String> getCLIOptions() { |
||||||
|
return CommandLineUtils.getCLIOptions(this, new EngineRPCOptions()); |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,238 @@ |
|||||||
|
/* |
||||||
|
* Copyright contributors to Hyperledger Besu. |
||||||
|
* |
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||||
|
* the License. You may obtain a copy of the License at |
||||||
|
* |
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
* |
||||||
|
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||||
|
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||||
|
* specific language governing permissions and limitations under the License. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: Apache-2.0 |
||||||
|
*/ |
||||||
|
package org.hyperledger.besu.cli.options.stable; |
||||||
|
|
||||||
|
import org.hyperledger.besu.cli.DefaultCommandValues; |
||||||
|
import org.hyperledger.besu.cli.converter.PercentageConverter; |
||||||
|
import org.hyperledger.besu.cli.converter.SubnetInfoConverter; |
||||||
|
import org.hyperledger.besu.cli.options.CLIOptions; |
||||||
|
import org.hyperledger.besu.cli.util.CommandLineUtils; |
||||||
|
import org.hyperledger.besu.ethereum.p2p.discovery.P2PDiscoveryConfiguration; |
||||||
|
import org.hyperledger.besu.ethereum.p2p.peers.EnodeURLImpl; |
||||||
|
import org.hyperledger.besu.util.NetworkUtility; |
||||||
|
import org.hyperledger.besu.util.number.Fraction; |
||||||
|
import org.hyperledger.besu.util.number.Percentage; |
||||||
|
|
||||||
|
import java.net.InetAddress; |
||||||
|
import java.util.ArrayList; |
||||||
|
import java.util.Collection; |
||||||
|
import java.util.List; |
||||||
|
import java.util.Optional; |
||||||
|
import java.util.stream.Collectors; |
||||||
|
|
||||||
|
import org.apache.commons.net.util.SubnetUtils; |
||||||
|
import org.apache.tuweni.bytes.Bytes; |
||||||
|
import picocli.CommandLine; |
||||||
|
|
||||||
|
/** Command line options for configuring P2P discovery on the node. */ |
||||||
|
public class P2PDiscoveryOptions implements CLIOptions<P2PDiscoveryConfiguration> { |
||||||
|
|
||||||
|
/** Default constructor */ |
||||||
|
public P2PDiscoveryOptions() {} |
||||||
|
|
||||||
|
// Public IP stored to prevent having to research it each time we need it.
|
||||||
|
private InetAddress autoDiscoveredDefaultIP = null; |
||||||
|
|
||||||
|
/** Completely disables P2P within Besu. */ |
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--p2p-enabled"}, |
||||||
|
description = "Enable P2P functionality (default: ${DEFAULT-VALUE})", |
||||||
|
arity = "1") |
||||||
|
public final Boolean p2pEnabled = true; |
||||||
|
|
||||||
|
/** |
||||||
|
* Boolean option to indicate if peers should NOT be discovered, default to false indicates that |
||||||
|
* the peers should be discovered by default. |
||||||
|
*/ |
||||||
|
//
|
||||||
|
// This negative option is required because of the nature of the option that is
|
||||||
|
// true when
|
||||||
|
// added on the command line. You can't do --option=false, so false is set as
|
||||||
|
// default
|
||||||
|
// and you have not to set the option at all if you want it false.
|
||||||
|
// This seems to be the only way it works with Picocli.
|
||||||
|
// Also many other software use the same negative option scheme for false
|
||||||
|
// defaults
|
||||||
|
// meaning that it's probably the right way to handle disabling options.
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--discovery-enabled"}, |
||||||
|
description = "Enable P2P discovery (default: ${DEFAULT-VALUE})", |
||||||
|
arity = "1") |
||||||
|
public final Boolean peerDiscoveryEnabled = true; |
||||||
|
|
||||||
|
/** |
||||||
|
* A list of bootstrap nodes can be passed and a hardcoded list will be used otherwise by the |
||||||
|
* Runner. |
||||||
|
*/ |
||||||
|
// NOTE: we have no control over default value here.
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--bootnodes"}, |
||||||
|
paramLabel = "<enode://id@host:port>", |
||||||
|
description = |
||||||
|
"Comma separated enode URLs for P2P discovery bootstrap. " |
||||||
|
+ "Default is a predefined list.", |
||||||
|
split = ",", |
||||||
|
arity = "0..*") |
||||||
|
public final List<String> bootNodes = null; |
||||||
|
|
||||||
|
/** The IP the node advertises to peers for P2P communication. */ |
||||||
|
@SuppressWarnings({"FieldCanBeFinal", "FieldMayBeFinal"}) // PicoCLI requires non-final Strings.
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--p2p-host"}, |
||||||
|
paramLabel = DefaultCommandValues.MANDATORY_HOST_FORMAT_HELP, |
||||||
|
description = "IP address this node advertises to its peers (default: ${DEFAULT-VALUE})", |
||||||
|
arity = "1") |
||||||
|
public String p2pHost = autoDiscoverDefaultIP().getHostAddress(); |
||||||
|
|
||||||
|
/** The network interface address on which this node listens for P2P communication. */ |
||||||
|
@SuppressWarnings({"FieldCanBeFinal", "FieldMayBeFinal"}) // PicoCLI requires non-final Strings.
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--p2p-interface"}, |
||||||
|
paramLabel = DefaultCommandValues.MANDATORY_HOST_FORMAT_HELP, |
||||||
|
description = |
||||||
|
"The network interface address on which this node listens for P2P communication (default: ${DEFAULT-VALUE})", |
||||||
|
arity = "1") |
||||||
|
public String p2pInterface = NetworkUtility.INADDR_ANY; |
||||||
|
|
||||||
|
/** The port on which this node listens for P2P communication. */ |
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--p2p-port"}, |
||||||
|
paramLabel = DefaultCommandValues.MANDATORY_PORT_FORMAT_HELP, |
||||||
|
description = "Port on which to listen for P2P communication (default: ${DEFAULT-VALUE})", |
||||||
|
arity = "1") |
||||||
|
public final Integer p2pPort = EnodeURLImpl.DEFAULT_LISTENING_PORT; |
||||||
|
|
||||||
|
/** The maximum number of peers this node can connect to. */ |
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--max-peers", "--p2p-peer-upper-bound"}, |
||||||
|
paramLabel = DefaultCommandValues.MANDATORY_INTEGER_FORMAT_HELP, |
||||||
|
description = "Maximum P2P connections that can be established (default: ${DEFAULT-VALUE})") |
||||||
|
public final Integer maxPeers = DefaultCommandValues.DEFAULT_MAX_PEERS; |
||||||
|
|
||||||
|
/** Boolean option to limit the number of P2P connections initiated remotely. */ |
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--remote-connections-limit-enabled"}, |
||||||
|
description = |
||||||
|
"Whether to limit the number of P2P connections initiated remotely. (default: ${DEFAULT-VALUE})") |
||||||
|
public final Boolean isLimitRemoteWireConnectionsEnabled = true; |
||||||
|
|
||||||
|
/** The maximum percentage of P2P connections that can be initiated remotely. */ |
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--remote-connections-max-percentage"}, |
||||||
|
paramLabel = DefaultCommandValues.MANDATORY_DOUBLE_FORMAT_HELP, |
||||||
|
description = |
||||||
|
"The maximum percentage of P2P connections that can be initiated remotely. Must be between 0 and 100 inclusive. (default: ${DEFAULT-VALUE})", |
||||||
|
arity = "1", |
||||||
|
converter = PercentageConverter.class) |
||||||
|
public final Percentage maxRemoteConnectionsPercentage = |
||||||
|
Fraction.fromFloat(DefaultCommandValues.DEFAULT_FRACTION_REMOTE_WIRE_CONNECTIONS_ALLOWED) |
||||||
|
.toPercentage(); |
||||||
|
|
||||||
|
/** The URL to use for DNS discovery. */ |
||||||
|
@SuppressWarnings({"FieldCanBeFinal", "FieldMayBeFinal"}) // PicoCLI requires non-final Strings.
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--discovery-dns-url"}, |
||||||
|
description = "Specifies the URL to use for DNS discovery") |
||||||
|
public String discoveryDnsUrl = null; |
||||||
|
|
||||||
|
/** Boolean option to allow for incoming connections to be prioritized randomly. */ |
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--random-peer-priority-enabled"}, |
||||||
|
description = |
||||||
|
"Allow for incoming connections to be prioritized randomly. This will prevent (typically small, stable) networks from forming impenetrable peer cliques. (default: ${DEFAULT-VALUE})") |
||||||
|
public final Boolean randomPeerPriority = Boolean.FALSE; |
||||||
|
|
||||||
|
/** A list of node IDs to ban from the P2P network. */ |
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--banned-node-ids", "--banned-node-id"}, |
||||||
|
paramLabel = DefaultCommandValues.MANDATORY_NODE_ID_FORMAT_HELP, |
||||||
|
description = "A list of node IDs to ban from the P2P network.", |
||||||
|
split = ",", |
||||||
|
arity = "1..*") |
||||||
|
void setBannedNodeIds(final List<String> values) { |
||||||
|
try { |
||||||
|
bannedNodeIds = |
||||||
|
values.stream() |
||||||
|
.filter(value -> !value.isEmpty()) |
||||||
|
.map(EnodeURLImpl::parseNodeId) |
||||||
|
.collect(Collectors.toList()); |
||||||
|
} catch (final IllegalArgumentException e) { |
||||||
|
throw new CommandLine.ParameterException( |
||||||
|
new CommandLine(this), "Invalid ids supplied to '--banned-node-ids'. " + e.getMessage()); |
||||||
|
} |
||||||
|
} |
||||||
|
|
||||||
|
// Boolean option to set that in a PoA network the bootnodes should always be queried during
|
||||||
|
// peer table refresh. If this flag is disabled bootnodes are only sent FINDN requests on first
|
||||||
|
// startup, meaning that an offline bootnode or network outage at the client can prevent it
|
||||||
|
// discovering any peers without a restart.
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--poa-discovery-retry-bootnodes"}, |
||||||
|
description = |
||||||
|
"Always use of bootnodes for discovery in PoA networks. Disabling this reverts " |
||||||
|
+ " to the same behaviour as non-PoA networks, where neighbours are only discovered from bootnodes on first startup." |
||||||
|
+ "(default: ${DEFAULT-VALUE})", |
||||||
|
arity = "1") |
||||||
|
private final Boolean poaDiscoveryRetryBootnodes = true; |
||||||
|
|
||||||
|
private Collection<Bytes> bannedNodeIds = new ArrayList<>(); |
||||||
|
|
||||||
|
/** |
||||||
|
* Auto-discovers the default IP of the client. |
||||||
|
* |
||||||
|
* @return machine loopback address |
||||||
|
*/ |
||||||
|
// Loopback IP is used by default as this is how smokeTests require it to be
|
||||||
|
// and it's probably a good security behaviour to default only on the localhost.
|
||||||
|
public InetAddress autoDiscoverDefaultIP() { |
||||||
|
autoDiscoveredDefaultIP = |
||||||
|
Optional.ofNullable(autoDiscoveredDefaultIP).orElseGet(InetAddress::getLoopbackAddress); |
||||||
|
|
||||||
|
return autoDiscoveredDefaultIP; |
||||||
|
} |
||||||
|
|
||||||
|
@CommandLine.Option( |
||||||
|
names = {"--net-restrict"}, |
||||||
|
arity = "1..*", |
||||||
|
split = ",", |
||||||
|
converter = SubnetInfoConverter.class, |
||||||
|
description = |
||||||
|
"Comma-separated list of allowed IP subnets (e.g., '192.168.1.0/24,10.0.0.0/8').") |
||||||
|
private List<SubnetUtils.SubnetInfo> allowedSubnets; |
||||||
|
|
||||||
|
@Override |
||||||
|
public P2PDiscoveryConfiguration toDomainObject() { |
||||||
|
return new P2PDiscoveryConfiguration( |
||||||
|
p2pEnabled, |
||||||
|
peerDiscoveryEnabled, |
||||||
|
p2pHost, |
||||||
|
p2pInterface, |
||||||
|
p2pPort, |
||||||
|
maxPeers, |
||||||
|
isLimitRemoteWireConnectionsEnabled, |
||||||
|
maxRemoteConnectionsPercentage, |
||||||
|
randomPeerPriority, |
||||||
|
bannedNodeIds, |
||||||
|
allowedSubnets, |
||||||
|
poaDiscoveryRetryBootnodes, |
||||||
|
bootNodes, |
||||||
|
discoveryDnsUrl); |
||||||
|
} |
||||||
|
|
||||||
|
@Override |
||||||
|
public List<String> getCLIOptions() { |
||||||
|
return CommandLineUtils.getCLIOptions(this, new P2PDiscoveryOptions()); |
||||||
|
} |
||||||
|
} |
||||||
@ -0,0 +1,39 @@ |
|||||||
|
/* |
||||||
|
* Copyright contributors to Hyperledger Besu. |
||||||
|
* |
||||||
|
* Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with |
||||||
|
* the License. You may obtain a copy of the License at |
||||||
|
* |
||||||
|
* http://www.apache.org/licenses/LICENSE-2.0
|
||||||
|
* |
||||||
|
* Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on |
||||||
|
* an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the |
||||||
|
* specific language governing permissions and limitations under the License. |
||||||
|
* |
||||||
|
* SPDX-License-Identifier: Apache-2.0 |
||||||
|
*/ |
||||||
|
package org.hyperledger.besu.ethereum.p2p.discovery; |
||||||
|
|
||||||
|
import org.hyperledger.besu.util.number.Percentage; |
||||||
|
|
||||||
|
import java.util.Collection; |
||||||
|
import java.util.List; |
||||||
|
|
||||||
|
import org.apache.commons.net.util.SubnetUtils; |
||||||
|
import org.apache.tuweni.bytes.Bytes; |
||||||
|
|
||||||
|
public record P2PDiscoveryConfiguration( |
||||||
|
Boolean p2pEnabled, |
||||||
|
Boolean peerDiscoveryEnabled, |
||||||
|
String p2pHost, |
||||||
|
String p2pInterface, |
||||||
|
Integer p2pPort, |
||||||
|
Integer maxPeers, |
||||||
|
Boolean isLimitRemoteWireConnectionsEnabled, |
||||||
|
Percentage maxRemoteConnectionsPercentage, |
||||||
|
Boolean randomPeerPriority, |
||||||
|
Collection<Bytes> bannedNodeIds, |
||||||
|
List<SubnetUtils.SubnetInfo> allowedSubnets, |
||||||
|
Boolean poaDiscoveryRetryBootnodes, |
||||||
|
List<String> bootNodes, |
||||||
|
String discoveryDnsUrl) {} |
||||||
Loading…
Reference in new issue