Implement admin_addTrustedPeer rpc endpoint by richardgreg · Pull Request #7891 · NethermindEth/nethermind

richardgreg · 2024-12-11T08:15:02Z

Changes

Added ITrustedNodesManager Interface:
Created a new ITrustedNodesManager interface to handle trusted nodes. This interface is similar to IStaticNodesManager but for trusted nodes. It provides methods InitAsync(), AddAsync(), RemoveAsync(), IsTrusted(), and exposes Nodes.
Implemented TrustedNodesManager Class:
Implemented TrustedNodesManager, which reads/writes a trusted nodes file and manages a list of trusted nodes. It also implements INodeSource (or inherits from ITrustedNodesManager : INodeSource) so it can be used by CompositeNodeSource.
Added IsTrusted Property to Node:
Modified the Node class used by the networking code to include a public bool IsTrusted { get; set; } property. This allows peers to reflect if they originate from trusted nodes.
Integrated TrustedNodesManager into PeerPool:
Passed an ITrustedNodesManager instance into the PeerPool constructor and updated the peer creation logic (CreateNew methods) to mark nodes as trusted if they come from the trusted nodes manager.
Updated InitializeNetwork to Include TrustedNodesManager:
Created and initialized TrustedNodesManager inside InitializeNetwork.cs, added it to CompositeNodeSource so that trusted nodes are considered in the node discovery pipeline, and passed it to PeerPool.
Updated IApiWithNetwork and IInitConfig:

Extended IApiWithNetwork interface to have a ITrustedNodesManager? TrustedNodesManager { get; set; } property (if needed).
Added a TrustedNodesPath property to IInitConfig and InitConfig to define the file path for trusted nodes.
Modified AdminRpcModule Constructor:
Updated the AdminRpcModule constructor to require an ITrustedNodesManager and implemented the admin_addTrustedPeer method using the trusted nodes manager and peer pool.

Updated Tests:
Adjusted existing tests to provide an ITrustedNodesManager mock where needed. Added a new test (Test_admin_addTrustedPeer) to ensure admin_addTrustedPeer works correctly.

Types of changes

What types of changes does your code introduce?

Bugfix (a non-breaking change that fixes an issue)
New feature (a non-breaking change that adds functionality)
Breaking change (a change that causes existing functionality not to work as expected)
Optimization
Refactoring
Documentation update
Build-related changes
Other: Description

Testing

Requires testing

Yes
No

If yes, did you write tests?

Yes
No

Documentation

Requires documentation update

Yes
No

If yes, link the PR to the docs update or the issue with the details labeled docs. Remove if not applicable.

Requires explanation in Release Notes

Yes
No

If yes, fill in the details here. Remove if not applicable.

Remarks

Optional. Remove if not applicable.

LukaszRozmej

Very good starting point. I do have some questions and comments before we finalize it.

src/Nethermind/Nethermind.Network/iTrustedNodesManager.cs

src/Nethermind/Nethermind.Network/PeerPool.cs

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

src/Nethermind/Nethermind.Network/iTrustedNodesManager.cs

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

richardgreg · 2025-01-10T10:23:17Z

Merge conflicts fixed 🙂

richardgreg · 2025-01-28T11:39:23Z

A gentle reminder @LukaszRozmej. If there are no more notes, I can resolve the conflict, and it should be ready to be merged

LukaszRozmej

Sorry, missed it, still few things to polish

src/Nethermind/Nethermind.Network/ITrustedNodesManager.cs

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

src/Nethermind/Nethermind.Network/PeerPool.cs

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

LukaszRozmej

Few more details, but really close!

src/Nethermind/Nethermind.Config/NetworkNode.cs

src/Nethermind/Nethermind.JsonRpc/Modules/Admin/AdminRpcModule.cs

src/Nethermind/Nethermind.Network/PeerPool.cs

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

LukaszRozmej · 2025-02-06T12:24:59Z

src/Nethermind/Nethermind.Config/NetworkNode.cs

+        public NetworkNode(Enode enode)
+        {
+          _enode = enode;
+        }


Can you put constructor next to the other?

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

src/Nethermind/Nethermind.Config/NetworkNode.cs

flcl42 · 2025-02-06T13:09:20Z

Should we have admin_removeTrustedPeer? Not necessary in this pr.

LukaszRozmej · 2025-02-07T07:53:01Z

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

        private ConcurrentDictionary<PublicKey, NetworkNode> _nodes = new();
        private readonly string _trustedNodesPath;
        private readonly ILogger _logger;
+        private readonly Channel<Node> _nodeChannel = Channel.CreateUnbounded<Node>();


I think we need bounded channel, otherwise potential spam could take down the node? 2^16 limit looks ok to me.

LukaszRozmej · 2025-02-07T10:35:35Z

some tests are failing

flcl42 · 2025-02-07T22:30:08Z

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

+            }
+
+            // continuously yield new nodes as they are added via the channel.
+            while (await _nodeChannel.Reader.WaitToReadAsync(cancellationToken))


Instead of doing two whiles, could you just _nodeChannel.Reader.ReadAllAsync in one await foreach

richardgreg · 2025-02-12T01:09:57Z

Hi, @LukaszRozmej, could you please give me pointers on tackling the failing tests? 😅

LukaszRozmej · 2025-02-12T10:16:49Z

Hi, @LukaszRozmej, could you please give me pointers on tackling the failing tests? 😅

  Failed Proof_module_is_registered_if_configured [945 ms]
  Error Message:
   Nethermind.Init.Steps.StepDependencyException : _api.TrustedNodesManager
  Stack Trace:
     at Nethermind.Init.Steps.StepDependencyException.ThrowIfNull(Object argument, String paramName) in /_/src/Nethermind/Nethermind.Init/Steps/StepInitializationException.cs:line 23
   at Nethermind.Init.Steps.RegisterRpcModules.Execute(CancellationToken cancellationToken) in /_/src/Nethermind/Nethermind.Init/Steps/RegisterRpcModules.cs:line 123
   at Nethermind.Runner.Test.Ethereum.Steps.RegisterRpcModulesTests.Proof_module_is_registered_if_configured() in /_/src/Nethermind/Nethermind.Runner.Test/Ethereum/Steps/RegisterRpcModulesTests.cs:line 31
   at NUnit.Framework.Internal.TaskAwaitAdapter.GenericAdapter`1.GetResult()
   at NUnit.Framework.Internal.AsyncToSyncAdapter.Await[TResult](TestExecutionContext context, Func`1 invoke)
   at NUnit.Framework.Internal.AsyncToSyncAdapter.Await(TestExecutionContext context, Func`1 invoke)
   at NUnit.Framework.Internal.Commands.TestMethodCommand.RunTestMethod(TestExecutionContext context)
   at NUnit.Framework.Internal.Commands.TestMethodCommand.Execute(TestExecutionContext context)
   at NUnit.Framework.Internal.Execution.SimpleWorkItem.<>c__DisplayClass3_0.<PerformWork>b__0()
   at NUnit.Framework.Internal.ContextUtils.<>c__DisplayClass1_0`1.<DoIsolated>b__0(Object _)
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)
--- End of stack trace from previous location ---
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)
   at NUnit.Framework.Internal.ContextUtils.DoIsolated(ContextCallback callback, Object state)
   at NUnit.Framework.Internal.ContextUtils.DoIsolated[T](Func`1 func)
   at NUnit.Framework.Internal.Execution.SimpleWorkItem.PerformWork()

That one is definitely about incorrect setup in test.

  Failed TestDiscovery [770 ms]
  Error Message:
   Autofac.Core.DependencyResolutionException : An exception was thrown while activating Nethermind.Network.PeerPool.
Data:
  ActivatorChain: Nethermind.Network.PeerPool
  ----> Autofac.Core.DependencyResolutionException : None of the constructors found on type 'Nethermind.Network.PeerPool' can be invoked with the available services and parameters:
Cannot resolve parameter 'Nethermind.Network.ITrustedNodesManager trustedNodesManager' of constructor 'Void .ctor(Nethermind.Network.INodeSource, Nethermind.Stats.INodeStatsManager, Nethermind.Network.INetworkStorage, Nethermind.Network.Config.INetworkConfig, Nethermind.Logging.ILogManager, Nethermind.Network.ITrustedNodesManager)'.

See https://autofac.rtfd.io/help/no-constructors-bindable for more info.
  Stack Trace:
     at Autofac.Core.Resolving.Middleware.ActivatorErrorHandlingMiddleware.Execute(ResolveRequestContext context, Action`1 next)
   at Autofac.Core.Resolving.Pipeline.ResolvePipelineBuilder.<>c__DisplayClass14_0.<BuildPipeline>b__1(ResolveRequestContext context)
   at Autofac.Core.Pipeline.ResolvePipeline.Invoke(ResolveRequestContext context)
   at Autofac.Core.Resolving.Middleware.RegistrationPipelineInvokeMiddleware.Execute(ResolveRequestContext context, Action`1 next)
   at Autofac.Core.Resolving.Pipeline.ResolvePipelineBuilder.<>c__DisplayClass14_0.<BuildPipeline>b__1(ResolveRequestContext context)
   at Autofac.Core.Resolving.Middleware.SharingMiddleware.<>c__DisplayClass5_0.<Execute>b__0()
   at Autofac.Core.Lifetime.LifetimeScope.CreateSharedInstance(Guid id, Func`1 creator)
   at Autofac.Core.Lifetime.LifetimeScope.CreateSharedInstance(Guid primaryId, Nullable`1 qualifyingId, Func`1 creator)
   at Autofac.Core.Resolving.Middleware.SharingMiddleware.Execute(ResolveRequestContext context, Action`1 next)
   at Autofac.Core.Resolving.Pipeline.ResolvePipelineBuilder.<>c__DisplayClass14_0.<BuildPipeline>b__1(ResolveRequestContext context)
   at Autofac.Core.Resolving.Pipeline.ResolvePipelineBuilder.<>c__DisplayClass14_0.<BuildPipeline>b__1(ResolveRequestContext context)
   at Autofac.Core.Resolving.Middleware.CircularDependencyDetectorMiddleware.Execute(ResolveRequestContext context, Action`1 next)
   at Autofac.Core.Resolving.Pipeline.ResolvePipelineBuilder.<>c__DisplayClass14_0.<BuildPipeline>b__1(ResolveRequestContext context)
   at Autofac.Core.Pipeline.ResolvePipeline.Invoke(ResolveRequestContext context)
   at Autofac.Core.Resolving.ResolveOperation.GetOrCreateInstance(ISharingLifetimeScope currentOperationScope, ResolveRequest& request)
   at Autofac.Core.Resolving.ResolveOperation.ExecuteOperation(ResolveRequest& request)
   at Autofac.Core.Resolving.ResolveOperation.Execute(ResolveRequest& request)
   at Autofac.Core.Lifetime.LifetimeScope.ResolveComponent(ResolveRequest& request)
   at Autofac.Core.Lifetime.LifetimeScope.Autofac.IComponentContext.ResolveComponent(ResolveRequest& request)
   at Autofac.ResolutionExtensions.TryResolveService(IComponentContext context, Service service, IEnumerable`1 parameters, Object& instance)
   at Autofac.ResolutionExtensions.ResolveService(IComponentContext context, Service service, IEnumerable`1 parameters)
   at Autofac.ResolutionExtensions.Resolve(IComponentContext context, Type serviceType, IEnumerable`1 parameters)
   at Autofac.ResolutionExtensions.Resolve[TService](IComponentContext context, IEnumerable`1 parameters)
   at Autofac.ResolutionExtensions.Resolve[TService](IComponentContext context)
   at Nethermind.Core.Test.Modules.PseudoNethermindRunner.StartDiscovery(CancellationToken cancellationToken) in /_/src/Nethermind/Nethermind.Core.Test/Modules/PseudoNethermindRunner.cs:line 100
   at Nethermind.Network.Discovery.Test.E2EDiscoveryTests.TestDiscovery() in /_/src/Nethermind/Nethermind.Network.Discovery.Test/E2EDiscoveryTests.cs:line 83
   at Nethermind.Network.Discovery.Test.E2EDiscoveryTests.TestDiscovery() in /_/src/Nethermind/Nethermind.Network.Discovery.Test/E2EDiscoveryTests.cs:line 86
   at Nethermind.Network.Discovery.Test.E2EDiscoveryTests.TestDiscovery() in /_/src/Nethermind/Nethermind.Network.Discovery.Test/E2EDiscoveryTests.cs:line 86
   at Nethermind.Network.Discovery.Test.E2EDiscoveryTests.TestDiscovery() in /_/src/Nethermind/Nethermind.Network.Discovery.Test/E2EDiscoveryTests.cs:line 86
   at Nethermind.Network.Discovery.Test.E2EDiscoveryTests.TestDiscovery() in /_/src/Nethermind/Nethermind.Network.Discovery.Test/E2EDiscoveryTests.cs:line 86
   at Nethermind.Network.Discovery.Test.E2EDiscoveryTests.TestDiscovery() in /_/src/Nethermind/Nethermind.Network.Discovery.Test/E2EDiscoveryTests.cs:line 86
   at NUnit.Framework.Internal.TaskAwaitAdapter.GenericAdapter`1.BlockUntilCompleted()
   at NUnit.Framework.Internal.MessagePumpStrategy.NoMessagePumpStrategy.WaitForCompletion(AwaitAdapter awaiter)
   at NUnit.Framework.Internal.AsyncToSyncAdapter.Await[TResult](TestExecutionContext context, Func`1 invoke)
   at NUnit.Framework.Internal.AsyncToSyncAdapter.Await(TestExecutionContext context, Func`1 invoke)
   at NUnit.Framework.Internal.Commands.TestMethodCommand.RunTestMethod(TestExecutionContext context)
   at NUnit.Framework.Internal.Commands.TestMethodCommand.Execute(TestExecutionContext context)
   at NUnit.Framework.Internal.Execution.SimpleWorkItem.<>c__DisplayClass3_0.<PerformWork>b__0()
   at NUnit.Framework.Internal.ContextUtils.<>c__DisplayClass1_0`1.<DoIsolated>b__0(Object _)
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)
--- End of stack trace from previous location ---
   at System.Threading.ExecutionContext.RunInternal(ExecutionContext executionContext, ContextCallback callback, Object state)
   at NUnit.Framework.Internal.ContextUtils.DoIsolated(ContextCallback callback, Object state)
   at NUnit.Framework.Internal.ContextUtils.DoIsolated[T](Func`1 func)
   at NUnit.Framework.Internal.Execution.SimpleWorkItem.PerformWork()
--DependencyResolutionException
   at Autofac.Core.Activators.Reflection.ReflectionActivator.<>c__DisplayClass14_0.<UseSingleConstructorActivation>b__0(ResolveRequestContext context, Action`1 next)
   at Autofac.Core.Resolving.Middleware.DelegateMiddleware.Execute(ResolveRequestContext context, Action`1 next)
   at Autofac.Core.Resolving.Pipeline.ResolvePipelineBuilder.<>c__DisplayClass14_0.<BuildPipeline>b__1(ResolveRequestContext context)
   at Autofac.Core.Resolving.Middleware.DisposalTrackingMiddleware.Execute(ResolveRequestContext context, Action`1 next)
   at Autofac.Core.Resolving.Pipeline.ResolvePipelineBuilder.<>c__DisplayClass14_0.<BuildPipeline>b__1(ResolveRequestContext context)
   at Autofac.Core.Resolving.Middleware.ActivatorErrorHandlingMiddleware.Execute(ResolveRequestContext context, Action`1 next)

This is similar, probably need some changes on the autofac module (dependency injection).

LukaszRozmej · 2025-02-12T10:20:58Z

Also please update to newest master and resolve conflicts

…ectly into file

…t and Port

…minEraService

…pcModule

LukaszRozmej · 2025-02-16T08:35:18Z

Caused regression, that was fixed in #8211

richardgreg · 2025-02-16T08:43:47Z

I'm a little sad that my implementation wasn't impeccable. I am glad the error was quickly caught and fixed. I'll learn from it 🙏

rubo · 2025-10-15T15:11:48Z

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

+
+            var nodes = new ConcurrentDictionary<PublicKey, NetworkNode>();
+
+            await foreach (string line in File.ReadLinesAsync(_trustedNodesPath))


Here, it reads the file line by line like a new-line-delimited file, but later it writes a JSON array below in SaveFileAsync. How is it supposed to work? It fails to read the data written by its own. Am I missing something?

rubo · 2025-10-15T15:12:47Z

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs

+                    NetworkNode node = new NetworkNode(line);
+                    nodes.TryAdd(node.NodeId, node);
+                }
+                catch (Exception ex) when (ex is ArgumentException or SocketException)


SocketException looks irrelevant here

richardgreg requested a review from rubo as a code owner December 11, 2024 08:15

LukaszRozmej requested review from asdacap and flcl42 December 11, 2024 10:25

LukaszRozmej reviewed Dec 11, 2024

View reviewed changes

richardgreg requested a review from LukaszRozmej December 20, 2024 16:51

richardgreg mentioned this pull request Dec 25, 2024

Nethermind should keep track of **Trusted Peers** in peer pool #7810

Closed

LukaszRozmej reviewed Dec 30, 2024

View reviewed changes

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs Outdated Show resolved Hide resolved

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs Outdated Show resolved Hide resolved

richardgreg requested a review from LukaszRozmej January 2, 2025 13:03

richardgreg force-pushed the feature-7811-admin_addTrustedPeer-rpc branch from ae99897 to 6423863 Compare January 10, 2025 10:18

LukaszRozmej requested changes Jan 28, 2025

View reviewed changes

richardgreg requested a review from LukaszRozmej February 4, 2025 07:38

LukaszRozmej requested changes Feb 4, 2025

View reviewed changes

richardgreg force-pushed the feature-7811-admin_addTrustedPeer-rpc branch 2 times, most recently from 7aaf7b1 to fe2ed13 Compare February 6, 2025 08:14

richardgreg requested a review from LukaszRozmej February 6, 2025 08:15

LukaszRozmej approved these changes Feb 6, 2025

View reviewed changes

flcl42 reviewed Feb 6, 2025

View reviewed changes

src/Nethermind/Nethermind.Network/TrustedNodes/TrustedNodesManager.cs Show resolved Hide resolved

flcl42 reviewed Feb 6, 2025

View reviewed changes

src/Nethermind/Nethermind.Config/NetworkNode.cs Outdated Show resolved Hide resolved

richardgreg requested review from LukaszRozmej and flcl42 February 6, 2025 21:27

LukaszRozmej reviewed Feb 7, 2025

View reviewed changes

richardgreg force-pushed the feature-7811-admin_addTrustedPeer-rpc branch from 6755983 to b1515f9 Compare February 7, 2025 08:06

richardgreg requested a review from LukaszRozmej February 7, 2025 08:07

richardgreg force-pushed the feature-7811-admin_addTrustedPeer-rpc branch from b1515f9 to 7b7650c Compare February 7, 2025 08:19

LukaszRozmej approved these changes Feb 7, 2025

View reviewed changes

flcl42 reviewed Feb 7, 2025

View reviewed changes

richardgreg added 15 commits February 13, 2025 13:18

Implement admin_addTrustedPeer rpc endpoint

5d206a3

Add test for admin_addTrustedPeer

2082985

Add review notes to admin_addTrustedPeer implementation

06e94c1

Temporarily rename file to change case

5d2a751

Rename file to ITrustedNodesManager with correct case

be0e6eb

Remove unneeded channel in TrustedNodesManager

7a0e6c5

Add latest parameters to Test_admin_addTrustedPeer

5d11de3

Config trusted nodes manager to open file as stream and serialize dir…

23dcf7b

…ectly into file

Remove unnecessary intermediate collections in InitAsync

b9f5038

Configure admin_addTrustedPeer to check other parts of Enode like Hos…

f3abc67

…t and Port

Expose Enode property and minor refactoring

ae08cd8

Update Test_admin_addTrustedPeer to accept IVerifyTrieStarter and IAd…

0506234

…minEraService

Add a channel to node discovery

1b4c4f4

Fix failing Autofac and context with mocks test

92988d6

fix: Resolve null reference and constructor argument errors in AdminR…

251c554

…pcModule

richardgreg force-pushed the feature-7811-admin_addTrustedPeer-rpc branch from 6fdca67 to 251c554 Compare February 13, 2025 21:37

richardgreg requested review from LukaszRozmej and flcl42 February 13, 2025 21:40

LukaszRozmej approved these changes Feb 14, 2025

View reviewed changes

flcl42 approved these changes Feb 14, 2025

View reviewed changes

LukaszRozmej merged commit d2089f3 into NethermindEth:master Feb 14, 2025

rubo reviewed Oct 15, 2025

View reviewed changes

rubo mentioned this pull request Oct 15, 2025

Move static/trusted nodes file to the data dir #9477

Merged

16 tasks


		var nodes = new ConcurrentDictionary<PublicKey, NetworkNode>();

		await foreach (string line in File.ReadLinesAsync(_trustedNodesPath))

Conversation

richardgreg commented Dec 11, 2024

Changes

Types of changes

What types of changes does your code introduce?

Testing

Requires testing

If yes, did you write tests?

Documentation

Requires documentation update

Requires explanation in Release Notes

Remarks

Uh oh!

LukaszRozmej left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

richardgreg commented Jan 10, 2025

Uh oh!

richardgreg commented Jan 28, 2025

Uh oh!

LukaszRozmej left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LukaszRozmej left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

LukaszRozmej Feb 6, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

flcl42 commented Feb 6, 2025

Uh oh!

LukaszRozmej Feb 7, 2025

Choose a reason for hiding this comment

Uh oh!

LukaszRozmej commented Feb 7, 2025

Uh oh!

flcl42 Feb 7, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

richardgreg commented Feb 12, 2025

Uh oh!

LukaszRozmej commented Feb 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

LukaszRozmej commented Feb 12, 2025

Uh oh!

LukaszRozmej commented Feb 16, 2025

Uh oh!

richardgreg commented Feb 16, 2025

Uh oh!

rubo Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

rubo Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

flcl42 Feb 7, 2025 •

edited

Loading

LukaszRozmej commented Feb 12, 2025 •

edited

Loading