Commit Graph

6628 Commits

Author SHA1 Message Date
findmyhappy 3dd538d04b chore: add missing backticks
Signed-off-by: findmyhappy <findhappy@sohu.com>
2025-06-04 14:51:10 +08:00
Tobin C. Harding a1e8fabbbe
Remove unnecessary closure
We can just pass the function directly. Found by clippy bizarrely after
running `rustfmt` (in bot-created PR #4586).

Internal change only, no logic change.
2025-06-04 07:36:52 +01:00
Tobin C. Harding dd3f3e44bc
Split into_derivation_path tests out
The test _still_ tests multiple things.

Move the `into_derivation_path` calls into a separate test.
2025-06-03 12:05:03 +01:00
Tobin C. Harding 0c9dd31f53
Test with m prefix
We have a single test case that tests for the m prefix while all the
others do not.

Move one test case into the loop and then test on each iteration the
path with m prefix added.
2025-06-03 12:03:06 +01:00
Tobin C. Harding c5073f4c51
Refactor simple valid path tests into a loop
The test is still doing a bunch of stuff.

Pull the simple test cases into a loop.
2025-06-03 11:51:48 +01:00
Tobin C. Harding 3e7fdad5fd
Split empty master test out
The valid derivation test is doing a whole bunch of things.

Split out the empty master path assertions into a separate test.
2025-06-03 11:37:12 +01:00
jamillambert ed36a980f8
Refactor invalid derivation path tests
Refactor the tests to have the invalid paths in a list, or string.
2025-06-03 11:20:28 +01:00
jamillambert 015fb1be3b
Split invalid derivation path test
The test tests two sperate things.

Split the test into invalid path and out of range.
2025-06-03 11:19:52 +01:00
jamillambert 76dd6100a2
Split derivation path test into valid and invalid
Make the tests separate to make tests smaller and easier to read.

There are no logic changes.
2025-06-03 11:18:44 +01:00
merge-script a419fc9aa6
Merge rust-bitcoin/rust-bitcoin#4565: Remove all `p2p` dependency from `network`
cbe04b00c6 Remove all `p2p` dependency from `network` (rustaceanrob)

Pull request description:

  Motivated by moving the `p2p` module to its own crate. `TryFrom` and `From` are already implement for converting to and from `Network`/`Magic`. The methods related to `Magic` are removed from `Network`, as well as any reference to `p2p` in the documentation, as `bitcoin` would no longer depend on `p2p`.

  The deser roundtrip test are relocated to `p2p/mod.rs`

ACKs for top commit:
  tcharding:
    ACK cbe04b00c6
  apoelstra:
    ACK cbe04b00c67eab896b7ec0535194771ec36cb68f; successfully ran local tests

Tree-SHA512: ac3aa2eef4d78efd719ccc032a4266827faff8c87997111fa0050765b732462e5e5811c8aa923aedba335cbaad9a374fd54dbbe0f4978a1111d0839a5942af7d
2025-06-01 18:23:15 +00:00
Tobin C. Harding 4621d2bde1
Modify locktime serde implemenations
The `units::locktime` types are used for two things:

- They are the inner types of `primitives` `LockTime`s
- They are used ephemerally for checking satisfaction

Neither of these use cases requires `serde` impls for the `units` types.
Since we are trying to release 1.0 with minimal amounts of code we
should remove them.

For `LockTime`s that need to be stored on disk or go over the wire we
can manually implement the `serde` traits. For `absolute::LockTime` this
is done already and there is no reason the `relative::LockTime` impl
cannot be the same [0]. This differs from the current `serde` trait impls
but we have already decided that in 0.33 we are going to accept breakage
and direct users to use 0.32 to handle it.

- Remove `serde` stuff from `units::locktime`
- Manually implement `serde` traits on `relative::LockTime`
- Fix the regression test to use the new format

While we are at it use a uniform terse call in `serialize`.

[0] This is because there is an unambiguous encoding for the whole set
of locktimes - consensus encoding.
2025-06-01 14:07:33 +01:00
Tobin C. Harding 200c276315
bitcoin: Make test code spacing uniform
Make test code use uniform spacing - twitch averted.

Whitespace only, no logic change.
2025-06-01 14:07:28 +01:00
merge-script 7ff1823073
Merge rust-bitcoin/rust-bitcoin#4572: Introduce empty p2p messages crate
de320714fb Introduce empty p2p messages crate (rustaceanrob)

Pull request description:

  Peer to peer messages change on occasion, and we would like to add messages as they are released from Bitcoin Core. Add an empty crate to take the crate name.

ACKs for top commit:
  tcharding:
    ACK de320714fb
  apoelstra:
    ACK de320714fbe46e4fda858d5c1c07f5dd1cc842f0; successfully ran local tests

Tree-SHA512: 68c8080c524c30eb5ec0aca14e74c8196a7cfffabe32d47773d56b8a64850617094b3c2088dfce20b4abfca31c82b19369703722d0a98aee636c383318953da7
2025-05-31 23:04:25 +00:00
merge-script 2113a32276
Merge rust-bitcoin/rust-bitcoin#4571: Move `p2p` encodings from `encode` and into `p2p`
20779bdbc8 Move `p2p` encodings out of `encode` (rustaceanrob)
94bcff28b1 p2p: Add wrappers for messages that use `Vec` (rustaceanrob)

Pull request description:

  To move `p2p` into a crate:
  1. All `Encodable` implementations for `p2p` must be defined in `p2p`. To accomplish this, and anything else in the future related to encoding, I added a `deser` module with the necessary macro to implement `Encodable` for `Vec<T> where T: Encodable`.
  2. Because the orphan rule would apply for implementing `Encodable`for `Vec` within `p2p`, three types defined within `p2p` are used to wrap the `Vec` and snake around the orphan rule.

ACKs for top commit:
  tcharding:
    ACK 20779bdbc8
  apoelstra:
    ACK 20779bdbc8ebcac2365d122e857c23b3d8e8d1e7; successfully ran local tests

Tree-SHA512: 7abfe5b853e84bb465579309f80a0687c325217f6f342651278bedf540c4d17ae16683ab02dea5e3d98d90790deb12c6bc7d572a92cec8e19ff94e395bc0d29c
2025-05-31 21:09:28 +00:00
merge-script 6d8299e8b8
Merge rust-bitcoin/rust-bitcoin#4468: Improve lock times - fix off-by-one bug
4ccecf5dec Fix stale Height type link (Tobin C. Harding)
caebb1bf73 units: relative: Do minor rustdocs fixes (Tobin C. Harding)
40bb177bc2 Put is_satisfied_by functions together (Tobin C. Harding)
480a2cd62a Favour new function `from_mtp` over deprecated (Tobin C. Harding)
f9d6453d5b Shorten locktime type term (Tobin C. Harding)
727047bd39 Fix off-by-one-bug in absolute locktime (Tobin C. Harding)
3ffdc54ca5 Fix off-by-one bug in relative locktime (Tobin C. Harding)
a2ff8ddbbb Improve relative::LockTime is_satisfied_by_{height, time} (Tobin C. Harding)

Pull request description:

  Make the APIs uniform in relative and absolute locktimes in relation to the `is_satisfied_by` functions. In doing so improve the API and fix an off-by-one bug when checking satisfaction of locks by height.

  Done in three patches but maybe should be squashed? Probably easiest to review by looking at all the `is_satisfied_by*` functions and convincing yourself we got it right.

  EDIT: Now has 5 cleanup patches also (mostly docs cleanups).

ACKs for top commit:
  apoelstra:
    ACK 4ccecf5decfead9818b74fbdee73115c349e2f3e; successfully ran local tests

Tree-SHA512: 9206cb464a06647510a35a7d564062823117e75df60251969be458616f4f5d04acf0aada53dbf7d493a2a2a72d26b3a300417a6499e45413d5f2a011538b7826
2025-05-31 15:48:29 +00:00
Tobin C. Harding 56516757ad
Add code comment to amount calculation
Its not immediately obvious that x - y cannot overflow. Add a code
comment to explain it.
2025-05-31 07:52:36 +01:00
Tobin C. Harding 8cf1dc39b5
Fix incorrect code comment 2025-05-31 07:52:36 +01:00
Tobin C. Harding 7c186e6081
Refactor fee functions
The `fee` functions are a bit convoluted because of the usage of
`const`. Refactor a couple of them to be easier to read.

Internal change only.
2025-05-31 07:52:35 +01:00
Tobin C. Harding bf0776e3dd
Remove panic using checked arithmetic
During dev I introduced a pancic, remove it.
2025-05-31 07:52:35 +01:00
Tobin C. Harding b65860067f
Make fee functions const
We temporarily removed `const` in the `fee` module to make patching and
reviewing easier. Now add it back in.
2025-05-31 07:52:35 +01:00
Tobin C. Harding 9b2fc021b2
Improve rustdocs on FeeRate
Remove the unit from associated consts and then make all the rustdocs on
the various consts use 'The'.
2025-05-31 07:52:34 +01:00
Tobin C. Harding 1bd1e89458
Re-introduce FeeRate encapsulate module
Now we have the `fee_rate` module clened up re-introduce the
`encapsulate` module using MvB.
2025-05-31 07:52:34 +01:00
Tobin C. Harding b27d8e5819
Change the internal representation of FeeRate
To get more precision use sats per million virtual bytes.

To make review easier keep most calls in tests using
`FeeRate::from_sats_per_kwu` and just unwrap. These can likely be
cleaned up later on if we want to.

For `serde` just change the module to `_floor` and leave it at that. The
serde stuff likely needs re-visiting before release anyways.
2025-05-31 07:52:31 +01:00
Tobin C. Harding 2e0b88ba76
bitcoin: Fix dust 'fee' identifiers
Currently we get the fee_rate per kwu then multiply it by 4. Instead
lets add a per_kvb function to `FeeRate`. We are about to change the
internal representation of `FeeRate` to use MvB so for now just panic on
ovelflow.

Also these are fee _rates_ - we already have suboptimal names from Core
in the consts in `policy`, no need to let them infect other identifiers.
2025-05-31 07:52:01 +01:00
Tobin C. Harding 399bca531c
Reduce the FeeRate::MAX value
In preparation for changing the internal representation of `FeeRate` to
use MvB reduce the max value by 4_000.

Done separately to make the change explicit.
2025-05-31 07:52:00 +01:00
Tobin C. Harding d174c06a4a
Saturate to_fee to Amount::MAX
The `FeeRate::checked_mul_by_weight` function currently returns a
`NumOpResult` but all other `checked_` functions return an `Option`.
This is surprising and adds no additional information.

Change `checked_mul_by_weight` to return `None` on overflow. But in
`to_fee` saturate to `Amount::MAX` because doing so makes a few APIs
better without any risk since a fee must be checked anyway so
`Amount::MAX` as a fee is equally descriptive in the error case.

This leads to removing the `NumOpResult` from `effective_value` also.

Note that sadly we remove the very nice docs on `NumOpResult::map`
because they no longer work.

Fix: #4497
2025-05-31 07:52:00 +01:00
Tobin C. Harding 64ac33754f
Add missing argument docs
We document the other to arguments already, add the missing one.
2025-05-31 07:52:00 +01:00
Tobin C. Harding fe0a448e78
Temporarily remove const from fee calc function
Code that works with `const` is annoying to use and hard to reason
about. Just remove all the consts for now so we can hack on `FeeRate`.

Introduces two lint warnings about manual implementation of `map` but
they will go away later.
2025-05-31 07:51:59 +01:00
Tobin C. Harding b929022d56
Add floor/ceil versions of to_sat_per_kwu
In preparation for changing the inner representation of `FeeRate` add
floor and ceil versions of the getter function `to_sat_per_kwu`.

For now both functions return the same thing but still call the
correct one so that when we change the representation we do not need
to re-visit them.
2025-05-31 07:51:59 +01:00
Tobin C. Harding 64098e4578
Remove encapsulate module from fee rate
This module is a PITA to work on, just remove it until the dust settles
on fee rate.

While we are at it make the rustdocs on the getter more terse.
2025-05-31 07:51:59 +01:00
merge-script b4f280b9e3
Merge rust-bitcoin/rust-bitcoin#4580: fix typo Porallel to Parallel crypto.rs
357ae4051a fix typo Porallel to Parallel crypto.rs (Fallengirl)

Pull request description:

  Hi devs! Found and fixed one typo in `hashes/src/ripemd160/crypto.rs`

  `Porallel` - `Parallel`

ACKs for top commit:
  tcharding:
    ACK 357ae4051a

Tree-SHA512: 67b166f8f0262cc9f4fdd9d4cbe74977ca86e0256d0129f645559aa4e75fd30d978d8995d503932c90f000eee4d87b47cc4dd5eac8405d5cd02124346ad35b3a
2025-05-30 21:31:06 +00:00
merge-script b0981fc21d
Merge rust-bitcoin/rust-bitcoin#4575: Fix typo
7b52b9c3a3 Fix typo (yancy)

Pull request description:

  Seems the comment has a stutter

ACKs for top commit:
  tcharding:
    ACK 7b52b9c3a3
  apoelstra:
    ACK 7b52b9c3a3c28afad41d9a246302ce95e4997ee5; successfully ran local tests

Tree-SHA512: 1cb11c03bb3043c19936dbe4c2ccfa1e8fa43e90c118c969da536d010d95762966cc86e257e3365d18d96cc6dfe4a63d94c4d16b1b766dde3882286ce9bb4925
2025-05-30 20:37:12 +00:00
merge-script b8c356613b
Merge rust-bitcoin/rust-bitcoin#4561: Do not derive `Default` on `CompactTarget`
e47836fb1e Do not derive Default on CompactTarget (Tobin C. Harding)

Pull request description:

  It is not immediately obvious what a zero value compact target is. Because of this and the fact that we are trying to release minimal code in `primitives 1.0` its best to remove the `Default` derive.

  This is an API breaking change.

ACKs for top commit:
  apoelstra:
    ACK e47836fb1e0c96936096efb2dfca4e2cbc9b9e5f; successfully ran local tests

Tree-SHA512: 7edb067a7ed66af8155b86b2391ee839b0a21b3d8d36b555123b14e93f1822b89c080328464b194e4ff47643440c56fa5afee929fe58b52d5f1cf84c9b96ca83
2025-05-30 18:29:43 +00:00
Fallengirl 357ae4051a
fix typo Porallel to Parallel crypto.rs 2025-05-30 11:31:56 +02:00
rustaceanrob cbe04b00c6
Remove all `p2p` dependency from `network`
Motivated by moving the `p2p` module to its own crate. `TryFrom` and
`From` are already implement for converting to and from
`Network`/`Magic`. The methods related to `Magic` are removed from
`Network`, as well as any reference to `p2p` in the documentation, as
`bitcoin` would no longer depend on `p2p`.

The deser roundtrip test are relocated to `p2p/mod.rs`
2025-05-29 15:20:10 +01:00
yancy 7b52b9c3a3 Fix typo 2025-05-28 20:06:31 -05:00
merge-script 6c228a3626
Merge rust-bitcoin/rust-bitcoin#4507: units: Move code out of wrapper macro
2a3e606d89 units: Move some things out of impl_u32_macro (Tobin C. Harding)

Pull request description:

  Recently we added a private `impl_u32_macro`. It included a bunch of associated consts and a pair of u32 constructor/getter functions.

  We overlooked the fact that the macro produces incorrect docs.

  Move the offending code out of the macro and into the already existent impl block for each type.

  Docs only, no other logic change.

ACKs for top commit:
  apoelstra:
    ACK 2a3e606d89d25ce54ff91b38b0aa29f7f733b9d9; successfully ran local tests

Tree-SHA512: ad4bdbb35bc674e9664e293841e14dc2374c8baddf3e795edb666c75860f02728e939ef5a93ede6f4c951e92c5dd5368d6a6b9662cf6d5b268f73ab5ac97e2cc
2025-05-28 15:24:55 +00:00
merge-script f0302f2ecd
Merge rust-bitcoin/rust-bitcoin#4570: fix(p2p): remove `AddrV2` <> `SocketAddr` conversions
6335c623f6 fix(p2p): remove `AddrV2` <> `SocketAddr` conversions (Luis Schwab)

Pull request description:

  This PR reverts #4521 due to loss/creation of port information during the conversion. Users should use the `AddrV2` <> `IpAddr` conversion instead.

  Closes #4566

ACKs for top commit:
  Kixunil:
    ACK 6335c623f6
  tcharding:
    ACK 6335c623f6

Tree-SHA512: f183756467ca17bb7e7078023a769ec33d3deb4146ab7ec63ef961107ab93ec975c9adffd9eeddc79250abfa1cee9eccbbcaef7466cf4c2c21205b69d8e9eb4f
2025-05-28 14:28:10 +00:00
merge-script 3c8eeeb42a
Merge rust-bitcoin/rust-bitcoin#4562: Remove redundant `ServiceFlags` test
9d956e8643 test: remove redundant `ServiceFlags` test (rustaceanrob)

Pull request description:

  The `ServiceFlags` type is already tested within p2p/mod.rs with a nearly identical test. This type also has nothing to do with `network`

  ref: https://github.com/rust-bitcoin/rust-bitcoin/blob/master/bitcoin/src/p2p/mod.rs#L400

ACKs for top commit:
  tcharding:
    ACK 9d956e8643
  apoelstra:
    ACK 9d956e8643214b3c1ad0e42cc630e2f35f7b7994; successfully ran local tests

Tree-SHA512: d113609070e3df6d44b1ed57c40c1bce251d59fa22eb1abbf6c576fd84e21464553bee7fa97eba000ad9c1b8ef98e2ba04aec7077486273de9b7e54341ba894b
2025-05-28 13:48:43 +00:00
rustaceanrob de320714fb
Introduce empty p2p messages crate
Peer to peer messages change on occasion, and we would like to add
messages as they are release from Bitcoin Core. Add an empty crate to
take the crate name.
2025-05-28 09:44:00 +01:00
merge-script 0064ad67a6
Merge rust-bitcoin/rust-bitcoin#4557: Move CheckedSum and add Weight
9dac4d69e0 Implement CheckedSum for Weight iterator (yancy)
0dbcd09bbc Move CheckedSum trait to crate root (yancy)

Pull request description:

  * Move CheckedSum to the crate root so that other types can be added
  * Add Weight to CheckedSum

ACKs for top commit:
  tcharding:
    ACK 9dac4d69e0
  apoelstra:
    ACK 9dac4d69e0f142e9a2dc4b61ea49365a8cae3f4b; successfully ran local tests

Tree-SHA512: 3e4b7f79074e23493ccd17a026542081f0d7a811f4f35edb7994ada95bf414a166531f142ad4986d27fcec448209b2ffa56813b495b5df6b6e8fcd589392e0c1
2025-05-28 04:09:12 +00:00
rustaceanrob 028a0d6558
Remove conversion impl macro for `Magic`/`Network`
Closes #4560

Handle the coversion of new networks directly in the `From` and
`TryFrom` implementations, as new networks are added infrequently.
2025-05-27 17:36:50 +01:00
rustaceanrob 20779bdbc8
Move `p2p` encodings out of `encode`
All of the `Encodable` implementations are defined within `p2p` with the
exception of `p2p` types that are a `Vec`. To fully decouple `p2p` from
`encode` we can define these in `p2p` like the others. This is the final
step in removing anything `p2p` related from the rest of `bitcoin`.
2025-05-27 14:41:03 +01:00
Luis Schwab 6335c623f6
fix(p2p): remove `AddrV2` <> `SocketAddr` conversions 2025-05-27 10:32:23 -03:00
rustaceanrob 94bcff28b1
p2p: Add wrappers for messages that use `Vec`
In preparation to move `p2p` to its own crate, any `Vec<T>` that satisfies
`T: Encodable` will not trivially implement `Encodable` because of the
orphan rule. A type defined within p2p may implement `Encodable`,
however, and the simplest possible type is one that simply wraps the
vector. Three types that will implement `Encodable` within `p2p` are
added here.
2025-05-27 13:55:21 +01:00
Jose Storopoli aa76108315
bitcoin: secp256k1 global-context feature re-export
Often we want to have the global-context feature in secp256k1 without
having to add manually the secp256k1 dependency and enabling the
global-context feature.

Having the ability to do that directly from bitcoin without having to
add secp256k1 and do the whole tango of tightly coupling the two
dependecy versions together, e.g. bitcoin 0.32.x and secp256k1 0.29.x
would be really nice and would also simplify a lot code maintainability
for anyone who depends on bitcoin.

This needs to be backported to 0.32.x, which I'll gladly do as well.
2025-05-27 08:25:40 -03:00
rustaceanrob 9d956e8643
test: remove redundant `ServiceFlags` test
The `ServiceFlags` type is already tested within p2p/mod.rs with a
nearly identical test. This type also has nothing to do with `network`
2025-05-27 10:09:44 +01:00
Tobin C. Harding 2a3e606d89
units: Move some things out of impl_u32_macro
Recently we added a private `impl_u32_macro`. It included a bunch of
associated consts and a pair of u32 constructor/getter functions.

We overlooked the fact that the macro produces incorrect docs.

Move the offending code out of the macro and into the already existent
impl block for each type.

Docs only, no other logic change.
2025-05-27 08:36:18 +01:00
Tobin C. Harding e47836fb1e
Do not derive Default on CompactTarget
It is not immediately obvious what a zero value compact target is.
Because of this and the fact that we are trying to release minimal code
in `primitives 1.0` its best to remove the `Default` derive.

This is an API breaking change.
2025-05-27 08:09:56 +01:00
yancy 9dac4d69e0 Implement CheckedSum for Weight iterator
Expose `checked_sum` method to sum an iterator of Weights checked.
2025-05-26 19:01:56 -05:00