Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

cli/net_params: Warn on empty public-addr when starting a validator node #5240

Merged
merged 6 commits into from
Aug 7, 2024
Merged

cli/net_params: Warn on empty public-addr when starting a validator node #5240

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
2144701
net_params: Request for public-addr when starting a validator node
lexnv Aug 5, 2024
dc5f96d
Add prdoc
lexnv Aug 5, 2024
c02d7b3
cli: Place warns after logger init
lexnv Aug 5, 2024
5b0295f
Update prdoc location
lexnv Aug 5, 2024
2c34fb4
cli: Fix clippy
lexnv Aug 6, 2024
4f801e9
cli: Link github issue
lexnv Aug 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions prdoc/pr_5240.prdoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
title: Warn on empty public-addr when starting a validator node

doc:
- audience: Node Operator
description: |
This PR shows a warning when the `--public-addr` CLI parameter is missing for validators.
In the future, we'll transform this warning into a hard failure.
Validators are encouraged to provide this parameter for better availability over the network.

crates:
- name: sc-cli
bump: patch
17 changes: 15 additions & 2 deletions substrate/client/cli/src/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ pub trait CliConfiguration<DCV: DefaultConfigurationValues = ()>: Sized {
node_key: NodeKeyConfig,
default_listen_port: u16,
) -> Result<NetworkConfiguration> {
Ok(if let Some(network_params) = self.network_params() {
let network_config = if let Some(network_params) = self.network_params() {
network_params.network_config(
chain_spec,
is_dev,
Expand All @@ -185,7 +185,12 @@ pub trait CliConfiguration<DCV: DefaultConfigurationValues = ()>: Sized {
)
} else {
NetworkConfiguration::new(node_name, client_id, node_key, Some(net_config_dir))
})
};

// TODO: Return error here in the next release.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should have an issue for this and link the place where to add IMO. Already too many dead TODOs in the code 😬

// if is_validator && network_config.public_addresses.is_empty() {}

Ok(network_config)
}

/// Get the keystore configuration.
Expand Down Expand Up @@ -638,6 +643,14 @@ pub trait CliConfiguration<DCV: DefaultConfigurationValues = ()>: Sized {

logger.init()?;

if config.role.is_authority() && config.network.public_addresses.is_empty() {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Did you check parachain collators(is_authorithy returns true) won't get this warning?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#6280

warn!(
"WARNING: No public address specified, validator node may not be reachable.
Consider setting `--public-addr` to the public IP address of this node.
This will become a hard requirement in future versions."
);
}

match fdlimit::raise_fd_limit() {
Ok(fdlimit::Outcome::LimitRaised { to, .. }) =>
if to < RECOMMENDED_OPEN_FILE_DESCRIPTOR_LIMIT {
Expand Down
Loading