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

Fix bug in absolute timelock usage #419

Merged
merged 3 commits into from Jun 2, 2022

Conversation

tcharding
Copy link
Member

@tcharding tcharding commented May 25, 2022

Currently if we mix up height/time absolute timelocks when filtering policies the result is incorrect (to the best of my understanding).

Add a timelock module that includes a single public function for checking if absolute timelocks are the same unit. Use the new function to fix a bug in policy filtering.

  • Patch 1 is a docs bug fix
  • Patch 2 is the bug fix
  • Patch 3 is a unit test patch that fails if its moved before patch 2. Please review the unit test carefully to make sure I'm not confused.

Note

There is ongoing discussion around trying to design a suitable timelock API. This PR is an attempt to make some forward progress by taking baby steps and making objective improvements. I decided to do it here in miniscript because it will be easier to iterate on and more obvious when there are concrete usage examples along with each change.

cc dpc

We have mixed up relative/absolute on the trait methods for `from_after`
and `from_older`.
src/timelock.rs Outdated
/// Returns true if `a` and `b` are the same unit i.e., both are block heights or both are UNIX
/// timestamps. `a` and `b` are nLockTime values.
pub fn absolute_timelocks_are_same_unit(a: u32, b: u32) -> bool {
n_lock_time_is_block_height(a) && n_lock_time_is_block_height(b)
Copy link

Choose a reason for hiding this comment

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

I wonder if n_lock_time_is_block_height(a) == n_lock_time_is_block_height(b) is more readable to other people, or just me.

Copy link
Member Author

Choose a reason for hiding this comment

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

I like it!

Currently if we mix up height/time absolute timelocks when filtering
policies the result is incorrect.

Add a `timelock` module that includes a single public function for
checking if absolute timelocks are the same unit. Use the new function
to fix a bug in policy filtering.
Currently if we mix up height/time absolute timelocks when filtering
policies the result is incorrect.

Add a bunch of assertions that verify the bug.
@tcharding
Copy link
Member Author

Force push is cargo fmt and suggestion from @dpc.

@tcharding
Copy link
Member Author

Oh and I made the helper functions public because clippy warns otherwise, I think there is value in having both even though one is now not used. I specifically put the < and >= there, explicitly in front of everyone that sees it, instead of negating a function call in one to the other.

Copy link
Member

@apoelstra apoelstra left a comment

Choose a reason for hiding this comment

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

ACK 42e1216

@sanket1729
Copy link
Member

Thanks for this, will catch up the lock time discussions upstream this week

@sanket1729
Copy link
Member

Edited the description to remove the @ mention

Copy link
Member

@sanket1729 sanket1729 left a comment

Choose a reason for hiding this comment

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

ACK 42e1216.

This is clean improvement. A nice step towards #270

@sanket1729 sanket1729 merged commit 0ac479f into rust-bitcoin:master Jun 2, 2022
@tcharding tcharding deleted the 05-25-timelock-usage branch June 3, 2022 03:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants