Clean code, better documentation and comments #439
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mmtftr
requested changes
Jan 20, 2025
ekrembal
approved these changes
Jan 21, 2025
|
I will merge this PR as it is now, and distribute the remaining tasks accordingly. |
ceyhunsen
approved these changes
Jan 21, 2025
| /// ≤ (`# of blocks mined after UTXO appears on the chain`). However, this is not mandatory. | ||
| /// One can spend an output delayed for some number of blocks just by using the nSequence field | ||
| /// of the input inside the transaction. For more, see: | ||
| /// https://github.com/bitcoin/bips/blob/master/bip-0068.mediawiki and |
| pub fn generate_relative_timelock_script( | ||
| actor_taproot_xonly_pk: XOnlyPublicKey, // This is the tweaked XonlyPublicKey, which appears in the script_pubkey of the address | ||
| block_count: i64, | ||
| actor_taproot_xonly_pk: XOnlyPublicKey, // This is the tweaked XonlyPublicKey, which appears in the script_pubkey of the address. The tweaked signature will be given accordingly. |
There was a problem hiding this comment.
i think this should be in the function comment so that everyone can see this comment without locating the code
| 0, | ||
| Some(bitcoin::sighash::TapSighashType::SinglePlusAnyoneCanPay) | ||
| )?; | ||
|
|
||
| // Creates the start_happy_reimburse_tx handler. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR introduces better documentation and code comments. Also cleans the code.
Linked Issues
#410
#431
Testing
None
Docs
This whole PR is about the docs.