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

Better names for methods #1249

Closed
Ademan opened this issue Dec 27, 2023 · 5 comments
Closed

Better names for methods #1249

Ademan opened this issue Dec 27, 2023 · 5 comments
Labels
api A breaking API change discussion There's still a discussion ongoing module-wallet
Milestone

Comments

@Ademan
Copy link

Ademan commented Dec 27, 2023

It looks like LocalUtxo was renamed to LocalOutput in master, which seems like a great improvement in clarity. I came across #665 trying to determine whether or not Wallet::get_utxo actually returns unspent outputs or not. I'd propose renaming the rest of the wallet API (and database API) to reflect this type change in 1.x

@Ademan Ademan added the new feature New feature or request label Dec 27, 2023
@Ademan
Copy link
Author

Ademan commented Dec 27, 2023

Maybe this is better labeled as a discussion.

@notmandatory notmandatory added the discussion There's still a discussion ongoing label Dec 27, 2023
@notmandatory notmandatory added this to BDK Dec 27, 2023
@notmandatory notmandatory moved this to Todo in BDK Dec 27, 2023
@notmandatory notmandatory added this to the 1.0.0-alpha.4 milestone Dec 27, 2023
@notmandatory notmandatory removed the new feature New feature or request label Dec 27, 2023
@notmandatory
Copy link
Member

Is the proposal here to find places in the new 1.0 APIs where we return LocalOutput and make sure the function names and docs are updated to not use the terms unspent ? I found a couple cases of this in the bdk crate:

  • LocalOutput struct docs
  • Utxo enum docs ? I'm not 100% sure this one is wrong

Are there other places that need fixing?

@nondiremanuel nondiremanuel modified the milestones: 1.0.0-alpha.4, 1.0.0 Jan 6, 2024
@evanlinjin evanlinjin moved this from Todo to Discussion in BDK Jan 25, 2024
@ValuedMammal
Copy link
Contributor

Feel free to leave suggestions on #1221 as well, where the idea is to come up with more idiomatic names

@notmandatory
Copy link
Member

A small change but I think we should push to 2.0 milestone.

@nondiremanuel
Copy link

get_utxos seems in fact getting utxos

@github-project-automation github-project-automation bot moved this from Discussion to Done in BDK Mar 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 discussion There's still a discussion ongoing module-wallet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

5 participants