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

Rename OutputStatus to OutSpendStatus #38

Open
evanlinjin opened this issue Feb 24, 2023 · 2 comments
Open

Rename OutputStatus to OutSpendStatus #38

evanlinjin opened this issue Feb 24, 2023 · 2 comments
Labels
good first issue Good for newcomers

Comments

@evanlinjin
Copy link
Member

OutputStatus is the wrong name. It is really the status of the output's spend.

@vladimirfomene vladimirfomene added the good first issue Good for newcomers label Feb 24, 2023
@tnull
Copy link
Contributor

tnull commented Feb 27, 2023

Not sure? It has a spent: bool field, so it's really describing the status of the output itself? What would be missing to make it a real OutputStatus?

However, if someone touches it already, the status field probably should be renamed too, as it would be less confusing to name it spending_tx_status, tx_status or similar.

@MaxFangX
Copy link
Contributor

The Esplora API docs describes the endpoint as "Returns the spending status of a transaction output." I noticed the difference in names when touching this area, but like BDK's current name of OutputStatus which I think is more accurate. Furthermore, I think the difference between outspend and output is small enough that people won't have trouble recognizing it if they end up reading the Esplora api docs.

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

No branches or pull requests

4 participants