Skip to content

Conversation

@oleonardolima
Copy link
Contributor

fixes #1647

Description

As mentioned in #1647 issue, the usage of Result in Rust is conventionally meant to be an enum type with error variant, and it's appropriate here.

It should be SyncResponse instead, as it's the most appropriate alongside the other types SyncRequest and SyncProgress already being used.

Notes to the reviewers

Changelog notice

  • Change bdk_core::spk_client's SyncResult to SyncResponse.

Checklists

All Submissions:

  • I've signed all my commits
  • I followed the contribution guidelines
  • I ran cargo fmt and cargo clippy before committing

New Features:

  • I've added tests for the new feature
  • I've added docs for the new feature

Bugfixes:

  • This pull request breaks the existing API
  • I've added tests to reproduce the issue which are now passing
  • I'm linking the issue being fixed by this PR

@oleonardolima oleonardolima force-pushed the chore/rename-sync-result-to-sync-response branch from 998fc61 to 1411cb8 Compare November 19, 2024 03:45
Copy link
Member

@notmandatory notmandatory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ACK 1411cb8

Looks good, all SyncResults renamed.

@ValuedMammal
Copy link
Collaborator

Would it make sense to apply the same reasoning to FullScanResult by renaming it to FullScanResponse?

@oleonardolima
Copy link
Contributor Author

Would it make sense to apply the same reasoning to FullScanResult by renaming it to FullScanResponse?

Good point! I think it does make sense, added a new commit with the changes so I can either squash it or drop it depending on other opinions.

Copy link
Member

@notmandatory notmandatory left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

reACK 3b03c7b

@notmandatory notmandatory merged commit d949fe4 into bitcoindevkit:master Nov 21, 2024
20 checks passed
@oleonardolima oleonardolima deleted the chore/rename-sync-result-to-sync-response branch December 2, 2024 22:01
@notmandatory notmandatory mentioned this pull request Dec 11, 2024
32 tasks
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 this pull request may close these issues.

SyncResult should not have "Result" in the name

3 participants