Implement admin_addTrustedPeer rpc endpoint

[richardgreg]

Fixes #7811

Changes

1. 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.

2. 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.

3. 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.

4. 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.

5. 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.

6. 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.

1. 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.

[richardgreg]

Merge conflicts fixed 🙂

[richardgreg]

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

[LukaszRozmej]

Few more details, but really close!

[LukaszRozmej]

Can you put constructor next to the other?

[flcl42]

Should we have admin_removeTrustedPeer? Not necessary in this pr.

[LukaszRozmej]

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

[LukaszRozmej]

some tests are failing

[flcl42]

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

[richardgreg]

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

[LukaszRozmej]

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]

Also please update to newest master and resolve conflicts

[LukaszRozmej]

Caused regression, that was fixed in #8211

[richardgreg]

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 🙏