utreexo icon indicating copy to clipboard operation
utreexo copied to clipboard

README indicates errant default behavior

Open UsmannK opened this issue 4 years ago • 3 comments

README.md reads "To try utreexo you do not need to run a server as we have a server set up for testing purposes which the client connects to by default." However, the client attempts to connect to 127.0.0.1:8338 on startup.

The code responsible is in csn/config.go: https://github.com/mit-dci/utreexo/blob/259fc1a7bf87a6931de63dde1ab4b66fbd1ea6b4/csn/config.go#L103-L111

Should the README be changed, or the code?

Thanks!

UsmannK avatar Mar 09 '21 18:03 UsmannK

Hello!

It's the readme that should be changed. I think the line

"To try utreexo you do not need to run a server as we have a server set up for testing purposes which the client connects to by default."

was written back when we did the utreexo v1 release. Since then, there have been breaking changes so the code was changed to default to the local server.

The v1 client (found in the tags section of the repo) should still work properly.

kcalvinalvin avatar Mar 09 '21 18:03 kcalvinalvin

Can I make this change in the ReadMe

DiptoChakrabarty avatar Sep 07 '21 07:09 DiptoChakrabarty

Can I make this change in the ReadMe

Yes. No need to ask permissions :)

kcalvinalvin avatar Sep 07 '21 07:09 kcalvinalvin