From d373dc32bfff52613e437c82faaa45963e97e6fc Mon Sep 17 00:00:00 2001 From: Victor Allombert Date: Fri, 15 Mar 2024 14:20:08 +0100 Subject: [PATCH 1/2] Node: remove deprecated local-listen-addrs config field --- src/bin_node/node_run_command.ml | 11 ++------ src/lib_node_config/config_file.ml | 33 +++--------------------- src/lib_node_config/config_file.mli | 2 -- src/lib_node_config/config_validation.ml | 19 +------------- 4 files changed, 7 insertions(+), 58 deletions(-) diff --git a/src/bin_node/node_run_command.ml b/src/bin_node/node_run_command.ml index 2066b5f98d87..58215744f41c 100644 --- a/src/bin_node/node_run_command.ml +++ b/src/bin_node/node_run_command.ml @@ -503,10 +503,7 @@ let init_local_rpc_server (config : Config_file.t) dir = in launch_rpc_server config dir (Local (mode, port)) addr) addrs) - (* For backward compatibility, and as the default behaviour is - the local RPC server, we merge the listen_addrs and - local_listen_addrs arguments. *) - (config.rpc.listen_addrs @ config.rpc.local_listen_addrs) + config.rpc.listen_addrs in return (Local_rpc_server servers) @@ -645,11 +642,7 @@ let init_rpc (config : Config_file.t) (node : Node.t) internal_events = Tezos_rpc.Service.description_service in let* local_rpc_server = - (* For backward compatibility, and as the default behaviour is the - local RPC server, we merge the listen_addrs and - local_listen_addrs arguments. *) - if config.rpc.listen_addrs @ config.rpc.local_listen_addrs = [] then - return No_server + if config.rpc.listen_addrs = [] then return No_server else init_local_rpc_server config dir in (* Start RPC process only when at least one listen addr is given. *) diff --git a/src/lib_node_config/config_file.ml b/src/lib_node_config/config_file.ml index 76e6f00870a3..50ad874f4589 100644 --- a/src/lib_node_config/config_file.ml +++ b/src/lib_node_config/config_file.ml @@ -357,7 +357,6 @@ and p2p = { and rpc = { listen_addrs : string list; - local_listen_addrs : string list; external_listen_addrs : string list; cors_origins : string list; cors_headers : string list; @@ -387,7 +386,6 @@ let default_p2p = let default_rpc = { listen_addrs = []; - local_listen_addrs = []; external_listen_addrs = []; cors_origins = []; cors_headers = []; @@ -561,7 +559,6 @@ let rpc : rpc Data_encoding.t = cors_origins; cors_headers; listen_addrs; - local_listen_addrs; external_listen_addrs; tls; acl; @@ -573,21 +570,13 @@ let rpc : rpc Data_encoding.t = | None -> (None, None) | Some {cert; key} -> (Some cert, Some key) in - let local_listen_addrs = - match local_listen_addrs with [] -> None | v -> Some v - in let external_listen_addrs = match external_listen_addrs with [] -> None | v -> Some v in - ( ( Some listen_addrs, - local_listen_addrs, - external_listen_addrs, - None, - cors_origins ), + ( (Some listen_addrs, external_listen_addrs, None, cors_origins), (cors_headers, cert, key, acl, media_type, max_active_rpc_connections) )) (fun ( ( listen_addrs, - local_listen_addrs, external_listen_addrs, legacy_listen_addr, cors_origins ), @@ -613,12 +602,8 @@ let rpc : rpc Data_encoding.t = external_listen_addrs ~default:default_rpc.external_listen_addrs in - let local_listen_addrs = - Option.value local_listen_addrs ~default:default_rpc.local_listen_addrs - in { listen_addrs; - local_listen_addrs; external_listen_addrs; cors_origins; cors_headers; @@ -628,21 +613,13 @@ let rpc : rpc Data_encoding.t = max_active_rpc_connections; }) (merge_objs - (obj5 + (obj4 (opt "listen-addrs" ~description: "Hosts to listen to. If the port is not specified, the default \ port 8732 will be assumed." (list string)) - ((*FIXME: https://gitlab.com/tezos/tezos/-/issues/6925 - Remove this deprecated config field. *) - opt - "local-listen-addrs" - ~description: - "DEPRECATED: Hosts to listen to. If the port is not specified, \ - the default port 8732 will be assumed." - (list string)) (opt "external-listen-addrs" ~description: @@ -878,8 +855,8 @@ let update ?(disable_config_validation = false) ?data_dir ?min_connections ?expected_connections ?max_connections ?max_download_speed ?max_upload_speed ?binary_chunks_size ?peer_table_size ?expected_pow ?bootstrap_peers ?listen_addr ?advertised_net_port ?discovery_addr ?(rpc_listen_addrs = []) - ?(local_rpc_listen_addrs = []) ?(external_rpc_listen_addrs = []) - ?(allow_all_rpc = []) ?(media_type = Media_type.Command_line.Any) + ?(external_rpc_listen_addrs = []) ?(allow_all_rpc = []) + ?(media_type = Media_type.Command_line.Any) ?(max_active_rpc_connections = default_rpc.max_active_rpc_connections) ?(metrics_addr = []) ?operation_metadata_size_limit ?(private_mode = default_p2p.private_mode) @@ -962,8 +939,6 @@ let update ?(disable_config_validation = false) ?data_dir ?min_connections and rpc : rpc = { listen_addrs = unopt_list ~default:cfg.rpc.listen_addrs rpc_listen_addrs; - local_listen_addrs = - unopt_list ~default:cfg.rpc.local_listen_addrs local_rpc_listen_addrs; external_listen_addrs = unopt_list ~default:cfg.rpc.external_listen_addrs diff --git a/src/lib_node_config/config_file.mli b/src/lib_node_config/config_file.mli index 3dec3ee4ddf2..06272c234991 100644 --- a/src/lib_node_config/config_file.mli +++ b/src/lib_node_config/config_file.mli @@ -75,7 +75,6 @@ and p2p = { and rpc = { listen_addrs : string list; - local_listen_addrs : string list; external_listen_addrs : string list; cors_origins : string list; cors_headers : string list; @@ -121,7 +120,6 @@ val update : ?advertised_net_port:int -> ?discovery_addr:string -> ?rpc_listen_addrs:string list -> - ?local_rpc_listen_addrs:string list -> ?external_rpc_listen_addrs:string list -> ?allow_all_rpc:P2p_point.Id.addr_port_id list -> ?media_type:Media_type.Command_line.t -> diff --git a/src/lib_node_config/config_validation.ml b/src/lib_node_config/config_validation.ml index a630402af7ad..8ea87680873b 100644 --- a/src/lib_node_config/config_validation.ml +++ b/src/lib_node_config/config_validation.ml @@ -477,26 +477,10 @@ let testchain_is_deprecated = ~msg:"The option `p2p.enable_testchain` is deprecated." () -let local_listen_addrs_is_deprecated = - E.declare_0 - ~level:Warning - ~name:"local_listen_addrs_is_deprecated_in_configuration_file" - ~msg: - "The option `rpc.local_listen_addrs` is deprecated. Use `listen_addrs` \ - instead and remove `local_listen_addrs` from your config file." - () - let warn_deprecated_testchain (config : Config_file.t) = when_ config.p2p.enable_testchain ~event:testchain_is_deprecated ~payload:() |> Lwt_result.return -let warn_deprecated_local_listen_addrs (config : Config_file.t) = - when_ - (not (config.rpc.local_listen_addrs = [])) - ~event:local_listen_addrs_is_deprecated - ~payload:() - |> Lwt_result.return - (* Main validation passes. *) let validation_passes ignore_testchain_warning = @@ -506,8 +490,7 @@ let validation_passes ignore_testchain_warning = validate_connections; warn_maintenance_deactivated; ] - @ (if ignore_testchain_warning then [] else [warn_deprecated_testchain]) - @ [warn_deprecated_local_listen_addrs] + @ if ignore_testchain_warning then [] else [warn_deprecated_testchain] let validate_passes ?(ignore_testchain_warning = false) config = List.concat_map_es -- GitLab From 3363f4edc6fd8f170dd9b4a6d943d5d988a0c8fe Mon Sep 17 00:00:00 2001 From: Victor Allombert Date: Fri, 15 Mar 2024 14:29:42 +0100 Subject: [PATCH 2/2] Changelog: remove deprecated local-listen-addrs config field --- CHANGES.rst | 3 +++ 1 file changed, 3 insertions(+) diff --git a/CHANGES.rst b/CHANGES.rst index 7076e8aa1dff..be943b11e507 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -87,6 +87,9 @@ Node whether or node the node is fully initialized and ready to answer to RPC requests (MR :gl:`!6820`). +- Removed the deprecated ``local-listen-addrs`` configuration file + field. Use ``listen-addrs`` instead. + Client ------ -- GitLab