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

SyncResult should not have "Result" in the name #1647

Closed
LLFourn opened this issue Oct 15, 2024 · 1 comment · Fixed by #1732
Closed

SyncResult should not have "Result" in the name #1647

LLFourn opened this issue Oct 15, 2024 · 1 comment · Fixed by #1732
Labels
api A breaking API change module-blockchain
Milestone

Comments

@LLFourn
Copy link
Contributor

LLFourn commented Oct 15, 2024

A "Result" type in rust is conventionally always meant to be a enum with an error variant.

This should be called SyncResponse since it is what you get after sending a SyncRequest.

The present name should be deprecated and type alias to SyncRequest.

@notmandatory notmandatory added this to BDK Nov 14, 2024
@notmandatory notmandatory added module-blockchain api A breaking API change labels Nov 15, 2024
@notmandatory notmandatory moved this to Todo in BDK Nov 15, 2024
@notmandatory
Copy link
Member

This is only a low-risk rename so I'd like to get it in with 1.0 rather than creating the type alias.

@notmandatory notmandatory added this to the 1.0.0-beta milestone Nov 15, 2024
@github-project-automation github-project-automation bot moved this from Needs Review to Done in BDK Nov 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api A breaking API change module-blockchain
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants