Skip to content

Suggest supplementing the announced_node_name field and its description in the examples for config/testnet/config.yml and mainnet. #1212

@15168316096

Description

@15168316096

The official example configuration files for config/testnet/config.yml and config/mainnet/config.yml are missing the announced_node_name field and related explanatory comments.
This makes it easy for operators deploying new nodes to overlook this configuration, resulting in:
The node_name returned by the node_info RPC being always null
The TUI (fnn-cli --tui) header displaying (unnamed) instead of a custom name
The node appearing as (unnamed) in the network graph, which is detrimental to operations and observability
Source Code Support
The FiberConfig struct already supports this field (see crates/fiber-lib/src/fiber/config.rs):

#[arg(
    name = "FIBER_ANNOUNCED_NODE_NAME",
    long = "fiber-announced-node-name",
    env
)]
pub(crate) announced_node_name: Option<AnnouncedNodeName>,

The test script tests/deploy/udt-init/src/main.rs also automatically generates a name for each node:

config["fiber"]["announced_node_name"] =
    serde_yaml::Value::String(format!("fiber-{}", node_index));

However, this field is not present in the official testnet/mainnet configuration templates, leading to frequent omissions during deployment.

Proposed Changes
Add the field and explanation under the fiber: section in both config/testnet/config.yml and config/mainnet/config.yml:

fiber:
  listening_addr: "/ip4/0.0.0.0/tcp/8228"
  # Node name announced to the Fiber network, displayed in TUI, network explorer, etc.
  # announced_node_name: "my-fiber-node"
  announce_listening_addr: true
  ...

This will allow new users to easily configure it from the template and improve the overall user experience.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions