[Task] Remove disconnected nodes functionality (feature | tests | docs)

[zinoadidi]

Task

Contributors are able to complete this task and earn thenewboston coins. Check out the labels to learn how much you can earn for contributing by completing this task. Please make sure to be honest if you wish to contribute by saying you can't finish this and we can just un-assign you with no harm done! There is no point in delaying tasks from being completed for miscommunication!

Overview

Name of function	Class To add Function	Location in Account Manager	Function Description	Comments

clean	Confirmation Validator, Bank	src/renderer/hooks/useCleanSockets.tsx	Remove disconnected nodes from the network

Behavior

• Resolves: [Task] Investigate TNB account manager and submit a report on missing functionalities on TNB-JS that are implemented in account manager #73
• user should be able to remove disconnected nodes using the SDK
• changes to existing code should be backward compatible if possible
• tests should be provided for new methods / updated for old ones
• documentation should be provided for new method / updated for old ones

/* code examples are awesome */

Please ask for this task to be assigned to you and earn and its sweet reward 😉

Remember to include your account number in your PR description for us to pay you 💰

[tomijaga]

I'll take this too. This has the same lvl of difficulty as the crawl function

[zinoadidi]

@tomijaga can you help review #89
I had the impression docs are autogenerated using JS Docs;
If not then you owe me some more docs based on PR
also is this the implementation we are expecting for this situation, I was of the opinion we want to get the info a better way?

[tomijaga]

@zinoadidi I dont think the docs are auto generated.
What PR are you referring to?
Are we meant to document all the functions or just the ones that will be directly accessed by users?

[tomijaga]

@zinoadidi

also is this the implementation we are expecting for this situation, I was of the opinion we want to get the info a better way?

I was thinking that getBankPV() would return the PrimaryValidator with the url set to the url of the bank's pv.

[zinoadidi]

OK, now i know to be on the lookout for public docs as well;
would be nice if we could autogenerate them somehow from the comments in code as opposed to doing it twice for public methods

I do agree that we do not need in the public doc information about methods and classes which are not used for public interfaces. comment on top of method is sufficient