Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README indicates errant default behavior #259

Open
UsmannK opened this issue Mar 9, 2021 · 3 comments
Open

README indicates errant default behavior #259

UsmannK opened this issue Mar 9, 2021 · 3 comments

Comments

@UsmannK
Copy link

UsmannK commented Mar 9, 2021

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:

utreexo/csn/config.go

Lines 103 to 111 in 259fc1a

// if no host was given, default to localhost
if *remoteHost == "" {
cfg.remoteHost = "127.0.0.1:8338"
} else {
if !strings.ContainsRune(*remoteHost, ':') {
str := *remoteHost + ":8338"
cfg.remoteHost = str
}
}

Should the README be changed, or the code?

Thanks!

@kcalvinalvin
Copy link
Member

kcalvinalvin commented Mar 9, 2021

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.

@DiptoChakrabarty
Copy link
Contributor

Can I make this change in the ReadMe

@kcalvinalvin
Copy link
Member

Can I make this change in the ReadMe

Yes. No need to ask permissions :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants