-
Notifications
You must be signed in to change notification settings - Fork 295
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
Improving the documentation for TxBuilder #856
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
module-wallet
Milestone
Comments
See also discussion in #823 |
3 tasks
3 tasks
Can someone please review this #957 |
3 tasks
danielabrozzoni
added a commit
that referenced
this issue
May 28, 2023
10b4b6c Documentations regarding absolute_fee and fee_rate updated (TATHAGATA ROY) Pull request description: ### Description This pr solves this issue #856 Updated the documentation for absolute fee and fee rate in BDK docs #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) #### Bugfixes: * [x] I'm linking the issue being fixed by this PR ACKs for top commit: danielabrozzoni: ACK 10b4b6c Tree-SHA512: 5b5f360b742313443368dc0b75275c38888cb358545661f7d9c78f3290789c50ffa9830e18473055d8e3da544c7d9527b023a1acdb28eaf862b24c892b23e9c4
danielabrozzoni
added a commit
that referenced
this issue
Sep 19, 2023
…s in tx_builder.rs e6519e3 Enhance the documentation for the fee_rate and fee_absolute methods. (Jon Marrs) Pull request description: ### Description This pr helps solve this issue: #856 I added documentation to the fee_rate() method to describe the units as either satoshis/vbyte (sats/vbyte) or satoshis/kwu (sats/kwu), depending on the FeeRate type. I also added documentation to the fee_absolute() method to clarify that the fee is determined by whichever method (fee_rate or fee_absolute) was called last, as the FeePolicy is an enum, and FeeRate/FeeAmount are mutually exclusive. ### Notes to the reviewers I thought it would be helpful to provide documentation to alleviate confusion over the fee_rate method and the fee_absolute method. ### Checklists #### All Submissions: * [x] I've signed all my commits * [x] I followed the [contribution guidelines](https://github.com/bitcoindevkit/bdk/blob/master/CONTRIBUTING.md) #### Bugfixes: * [x] I'm linking the issue being fixed by this PR ACKs for top commit: danielabrozzoni: ACK e6519e3 Tree-SHA512: 59f62d1d1f8355e6353c6a2550e464732975c86c767648adc9143f2b3a9b894a90536a30a33e9de7efbe53f16392ec2e19008d884fb65ef037edae64a3cb6970
Is it appropriate to close this issue as IMO all of its tasks are completed. |
#1159 still needs to be merged, but CI is broken |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Labels
documentation
Improvements or additions to documentation
good first issue
Good for newcomers
module-wallet
Describe the enhancement
Documentation regarding absolute fee and fee rate is little unclear in BDK docs. Common concerns are:
Use case
This documentation will help users in better understanding of Tx object and can optimise their transaction fees.
The text was updated successfully, but these errors were encountered: