Deprecate script::read_uint
#1559
Merged
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
|
Note to merger, may need to close #1547 manually . |
|
Damn, looks like we have to solve this ASAN problem. |
|
Can you rebase since ASAN is fixed? |
tcharding
force-pushed
the
01-19-deprecate-read_uint
branch
from
36ed20d
to
baa4a07
Compare
|
Rebased to pick up CI fix, no changes. |
apoelstra
previously approved these changes
Jan 24, 2023
There is no current usage for reading an unsigned script integer, seems like this is kruft from days gone past.
The URL is wrong (section `#Push_operators` should be `#push-operators`), also should use angle brackets not back ticks.
Our `Builder::push_int` method is the same as Bitcoin Core `CScript` `push_int64` method. We currently use `OP_FALSE` (equivalent to `OP_0`) but recently we added `OP_0`, lets use it to make our code better mimic Core (also saves devs checking that `OP_FALSE` is the same as `OP_0`).
We only support reads of upto 4 bytes where as Bitcoin Core allows reading a `CScriptNum` with more bytes than that. Add a rustdoc comment (incl. link to Bitcoin Core) mentioning that.
Our `script::read_scriptint` function is based on the constructor code (incl. call to `set_vch`) code from Bitcoin Core. Add rustdoc comment saying so, emit a link because there are already multiple links to `script.h` in this file (one just right below the added comment).
tcharding
force-pushed
the
01-19-deprecate-read_uint
branch
from
baa4a07
to
a7117bf
Compare
|
"rebased" manually (re-did the whole thing) and re-wrote PR description. |
Kixunil
approved these changes
Feb 10, 2023
| @@ -167,6 +167,7 @@ pub fn read_scriptbool(v: &[u8]) -> bool { | |||
| /// Note that this does **not** return an error for `size` between `core::size_of::<usize>()` | |||
| /// and `u16::max_value / 8` if there's no overflow. | |||
| #[inline] | |||
| #[deprecated(since = "0.30.0", note = "bitcoin integers are signed 32 bits, use read_scriptint")] | |||
There was a problem hiding this comment.
IIUC this was meant only for reading push data length and got published by accident.
| @@ -115,6 +115,8 @@ pub fn write_scriptint(out: &mut [u8; 8], n: i64) -> usize { | |||
| /// don't fit in 64 bits (for efficiency on modern processors) so we | |||
| /// simply say, anything in excess of 32 bits is no longer a number. | |||
| /// This is basically a ranged type implementation. | |||
| /// | |||
| /// This code is based on the `CScriptNum` constructor in Bitcoin Core (see `script.h`). | |||
There was a problem hiding this comment.
That's an implementation detail. I wouldn't use doc comment.
There was a problem hiding this comment.
Agreed, but I'm not going to block the PR on it.
apoelstra
approved these changes
Feb 10, 2023
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.
Patch one does the deprecation, the rest of the PR is made up of tiny improvements to the code around reading/writing 'scriptint's (conceptually
CScriptNums). I did all this while trying to decipher the discussion on #1547.Note Please
There are many more changes in the pipeline for all this read/write "script int" stuff. This PR was done ages ago and I believe it stall adds value.
I re-did the whole PR manually because of the recent
scriptmodule changes. I hope no one else has to do that - if you do please feel free to holla and I'll "rebase" your PR for you.