From d48ad9aafce222fa50cf7bd928f5a0c6ce718969 Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Mon, 8 Jun 2026 10:02:33 +0100 Subject: [PATCH 1/7] docs(tracker-core): update issue #1884 spec with license decision Document the Apache-2.0 license change for torrust-peer-id when migrating to torrust/torrust-bittorrent: drop the tracker-inherited AGPL-3.0 LICENSE, keep LICENSE-APACHE for upstream attribution, and inherit Apache-2.0 from the destination workspace. Add task T2b and acceptance criterion for the license change. --- ...69-19-move-bittorrent-peer-id-to-torrust-bittorrent.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md b/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md index 54091b015..4ef07b5cb 100644 --- a/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md +++ b/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md @@ -64,6 +64,12 @@ This issue is a subissue of EPIC #1669 (Overhaul: Packages). relevant history. - Update `repository` URL and crate metadata in `Cargo.toml` to point to `https://github.com/torrust/torrust-bittorrent`. +- **Change the license from AGPL-3.0 to Apache-2.0**: the tracker workspace inherits AGPL-3.0 + globally, but this was never an intentional choice for this standalone library crate. The + upstream source (`aquatic_peer_id`) is Apache-2.0, the existing `LICENSE-APACHE` file already + preserves that attribution, and all packages in `torrust/torrust-bittorrent` are uniformly + Apache-2.0. The AGPL-3.0 `LICENSE` file from the tracker workspace is dropped; the package + inherits `license = "Apache-2.0"` from the `torrust-bittorrent` workspace. - Ensure CI passes in the destination repository after migration. - Publish `torrust-peer-id` on crates.io from the destination repository. - Update the three consumers in the tracker workspace to depend on the published @@ -92,6 +98,7 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`. | --- | ------ | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | | T1 | TODO | Rename `name` in `packages/peer-id/Cargo.toml` to `torrust-peer-id` | `name = "torrust-peer-id"` | | T2 | TODO | Update `repository` URL in `packages/peer-id/Cargo.toml` and crate metadata | Point to `https://github.com/torrust/torrust-bittorrent` | +| T2b | TODO | Drop AGPL-3.0 `LICENSE` from the package; inherit Apache-2.0 from the destination workspace | `LICENSE` file removed; `license.workspace = true`; `LICENSE-APACHE` attribution kept | | T3 | TODO | Confirm destination workspace `torrust/torrust-bittorrent` migration path | Target path agreed: `packages/peer-id` | | T4 | TODO | Move/merge crate source into destination workspace, preserving history where practical | `packages/peer-id` added to `torrust/torrust-bittorrent` | | T5 | TODO | Set up/adjust CI in destination repository if needed | CI green after migration | @@ -138,6 +145,7 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`. - [ ] `cargo test --workspace` passes with zero failures. - [ ] `linter all` exits with code `0`. - [ ] `torrust-peer-id` is published and visible on crates.io. +- [ ] `torrust-peer-id` is published under the Apache-2.0 license; no AGPL-3.0 `LICENSE` file is present in the package. - [ ] Destination repository (`torrust/torrust-bittorrent`) has passing CI and a published release. - [ ] `packages/AGENTS.md`, `AGENTS.md`, and `docs/packages.md` no longer list `bittorrent-peer-id`. From 2d6315881f82f6b936ebef7bf42ea061c6aebdd2 Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Mon, 8 Jun 2026 11:39:48 +0100 Subject: [PATCH 2/7] refactor: migrate peer-id to published torrust-peer-id 0.1.0 Replace bittorrent-peer-id local path dep with published torrust-peer-id 0.1.0. - Update Cargo.toml deps in http-protocol, primitives, and udp-protocol to depend on torrust-peer-id = "0.1.0" from crates.io (with zerocopy feature retained for udp-protocol). - Rename all Rust use statements: bittorrent_peer_id -> torrust_peer_id. - Remove packages/primitives/src/peer_id.rs thin re-export module; lib.rs now directly re-exports from torrust_peer_id. - Delete the entire packages/peer-id/ directory. - Remove peer-id row from AGENTS.md package catalog. The crate was migrated to torrust/torrust-bittorrent as torrust-peer-id 0.1.0, published under Apache-2.0 (matching the upstream aquatic_peer_id license). Verification: cargo check --workspace - pass cargo test --tests --workspace --all-targets --all-features - pass cargo test --doc --workspace - pass linter all - pass cargo machete --with-metadata - pass --- AGENTS.md | 1 - Cargo.lock | 31 +- packages/http-protocol/Cargo.toml | 2 +- .../http-protocol/src/percent_encoding.rs | 6 +- .../http-protocol/src/v1/requests/announce.rs | 6 +- .../src/v1/responses/announce.rs | 4 +- packages/peer-id/Cargo.toml | 29 - packages/peer-id/LICENSE | 661 ------------------ packages/peer-id/LICENSE-APACHE | 202 ------ packages/peer-id/README.md | 38 - packages/peer-id/src/lib.rs | 9 - packages/peer-id/src/peer_client.rs | 244 ------- packages/peer-id/src/peer_id.rs | 53 -- packages/primitives/Cargo.toml | 2 +- packages/primitives/src/lib.rs | 3 +- packages/primitives/src/peer_id.rs | 3 - packages/udp-protocol/Cargo.toml | 2 +- packages/udp-protocol/src/lib.rs | 2 +- 18 files changed, 29 insertions(+), 1269 deletions(-) delete mode 100644 packages/peer-id/Cargo.toml delete mode 100644 packages/peer-id/LICENSE delete mode 100644 packages/peer-id/LICENSE-APACHE delete mode 100644 packages/peer-id/README.md delete mode 100644 packages/peer-id/src/lib.rs delete mode 100644 packages/peer-id/src/peer_client.rs delete mode 100644 packages/peer-id/src/peer_id.rs delete mode 100644 packages/primitives/src/peer_id.rs diff --git a/AGENTS.md b/AGENTS.md index 107ec4db5..56bb983f0 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -72,7 +72,6 @@ All packages live under `packages/`. The workspace version is `3.0.0-develop`. | `http-tracker-core` | `torrust-tracker-http-tracker-core` | `*-core` | HTTP-specific tracker domain logic | | `located-error` | `torrust-located-error` | utilities | Diagnostic errors with source locations | | `metrics` | `torrust-metrics` | domain | Prometheus metrics integration | -| `peer-id` | `bittorrent-peer-id` | domain | Peer ID parsing and formatting utilities | | `primitives` | `torrust-tracker-primitives` | domain | Core domain types (InfoHash, PeerId, ...) | | `rest-api-client` | `torrust-tracker-rest-api-client` | client tools | REST API client library | | `rest-api-core` | `torrust-tracker-rest-api-core` | client tools | REST API core logic | diff --git a/Cargo.lock b/Cargo.lock index 40494246f..be4049f54 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -457,18 +457,6 @@ dependencies = [ "serde_core", ] -[[package]] -name = "bittorrent-peer-id" -version = "3.0.0-develop" -dependencies = [ - "compact_str", - "hex", - "quickcheck", - "regex", - "serde", - "zerocopy", -] - [[package]] name = "bittorrent-primitives" version = "0.2.0" @@ -5018,6 +5006,19 @@ dependencies = [ "url", ] +[[package]] +name = "torrust-peer-id" +version = "0.1.0" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "4142a4d844d1197de9e32de18aa26c8422bad2194576d431b0fe9a091d33e6fd" +dependencies = [ + "compact_str", + "hex", + "regex", + "serde", + "zerocopy", +] + [[package]] name = "torrust-server-lib" version = "3.0.0-develop" @@ -5341,7 +5342,6 @@ dependencies = [ name = "torrust-tracker-http-tracker-protocol" version = "3.0.0-develop" dependencies = [ - "bittorrent-peer-id", "bittorrent-primitives", "derive_more 2.1.1", "multimap", @@ -5352,6 +5352,7 @@ dependencies = [ "torrust-bencode", "torrust-clock", "torrust-located-error", + "torrust-peer-id", ] [[package]] @@ -5376,7 +5377,6 @@ name = "torrust-tracker-primitives" version = "3.0.0-develop" dependencies = [ "binascii", - "bittorrent-peer-id", "bittorrent-primitives", "derive_more 2.1.1", "serde", @@ -5385,6 +5385,7 @@ dependencies = [ "thiserror 2.0.18", "torrust-clock", "torrust-net-primitives", + "torrust-peer-id", ] [[package]] @@ -5531,12 +5532,12 @@ dependencies = [ name = "torrust-tracker-udp-tracker-protocol" version = "3.0.0-develop" dependencies = [ - "bittorrent-peer-id", "byteorder", "either", "pretty_assertions", "quickcheck", "quickcheck_macros", + "torrust-peer-id", "zerocopy", ] diff --git a/packages/http-protocol/Cargo.toml b/packages/http-protocol/Cargo.toml index 71a99d5d1..e4e5a71c3 100644 --- a/packages/http-protocol/Cargo.toml +++ b/packages/http-protocol/Cargo.toml @@ -16,7 +16,7 @@ version.workspace = true [dependencies] bittorrent-primitives = "0.2.0" -bittorrent-peer-id = { version = "3.0.0-develop", path = "../peer-id" } +torrust-peer-id = "0.1.0" derive_more = { version = "2", features = [ "as_ref", "constructor", "from" ] } multimap = "0" percent-encoding = "2" diff --git a/packages/http-protocol/src/percent_encoding.rs b/packages/http-protocol/src/percent_encoding.rs index cee11bf08..813f5c4b3 100644 --- a/packages/http-protocol/src/percent_encoding.rs +++ b/packages/http-protocol/src/percent_encoding.rs @@ -15,8 +15,8 @@ //! - //! - //! - -use bittorrent_peer_id::PeerId; use bittorrent_primitives::info_hash::{self, InfoHash}; +use torrust_peer_id::PeerId; #[derive(thiserror::Error, Debug, Clone, PartialEq, Eq)] pub enum PeerIdConversionError { @@ -67,7 +67,7 @@ pub fn percent_decode_info_hash(raw_info_hash: &str) -> Result Result - Everyone is permitted to copy and distribute verbatim copies - of this license document, but changing it is not allowed. - - Preamble - - The GNU Affero General Public License is a free, copyleft license for -software and other kinds of works, specifically designed to ensure -cooperation with the community in the case of network server software. - - The licenses for most software and other practical works are designed -to take away your freedom to share and change the works. By contrast, -our General Public Licenses are intended to guarantee your freedom to -share and change all versions of a program--to make sure it remains free -software for all its users. - - When we speak of free software, we are referring to freedom, not -price. Our General Public Licenses are designed to make sure that you -have the freedom to distribute copies of free software (and charge for -them if you wish), that you receive source code or can get it if you -want it, that you can change the software or use pieces of it in new -free programs, and that you know you can do these things. - - Developers that use our General Public Licenses protect your rights -with two steps: (1) assert copyright on the software, and (2) offer -you this License which gives you legal permission to copy, distribute -and/or modify the software. - - A secondary benefit of defending all users' freedom is that -improvements made in alternate versions of the program, if they -receive widespread use, become available for other developers to -incorporate. Many developers of free software are heartened and -encouraged by the resulting cooperation. However, in the case of -software used on network servers, this result may fail to come about. -The GNU General Public License permits making a modified version and -letting the public access it on a server without ever releasing its -source code to the public. - - The GNU Affero General Public License is designed specifically to -ensure that, in such cases, the modified source code becomes available -to the community. It requires the operator of a network server to -provide the source code of the modified version running there to the -users of that server. Therefore, public use of a modified version, on -a publicly accessible server, gives the public access to the source -code of the modified version. - - An older license, called the Affero General Public License and -published by Affero, was designed to accomplish similar goals. This is -a different license, not a version of the Affero GPL, but Affero has -released a new version of the Affero GPL which permits relicensing under -this license. - - The precise terms and conditions for copying, distribution and -modification follow. - - TERMS AND CONDITIONS - - 0. Definitions. - - "This License" refers to version 3 of the GNU Affero General Public License. - - "Copyright" also means copyright-like laws that apply to other kinds of -works, such as semiconductor masks. - - "The Program" refers to any copyrightable work licensed under this -License. Each licensee is addressed as "you". "Licensees" and -"recipients" may be individuals or organizations. - - To "modify" a work means to copy from or adapt all or part of the work -in a fashion requiring copyright permission, other than the making of an -exact copy. The resulting work is called a "modified version" of the -earlier work or a work "based on" the earlier work. - - A "covered work" means either the unmodified Program or a work based -on the Program. - - To "propagate" a work means to do anything with it that, without -permission, would make you directly or secondarily liable for -infringement under applicable copyright law, except executing it on a -computer or modifying a private copy. Propagation includes copying, -distribution (with or without modification), making available to the -public, and in some countries other activities as well. - - To "convey" a work means any kind of propagation that enables other -parties to make or receive copies. Mere interaction with a user through -a computer network, with no transfer of a copy, is not conveying. - - An interactive user interface displays "Appropriate Legal Notices" -to the extent that it includes a convenient and prominently visible -feature that (1) displays an appropriate copyright notice, and (2) -tells the user that there is no warranty for the work (except to the -extent that warranties are provided), that licensees may convey the -work under this License, and how to view a copy of this License. If -the interface presents a list of user commands or options, such as a -menu, a prominent item in the list meets this criterion. - - 1. Source Code. - - The "source code" for a work means the preferred form of the work -for making modifications to it. "Object code" means any non-source -form of a work. - - A "Standard Interface" means an interface that either is an official -standard defined by a recognized standards body, or, in the case of -interfaces specified for a particular programming language, one that -is widely used among developers working in that language. - - The "System Libraries" of an executable work include anything, other -than the work as a whole, that (a) is included in the normal form of -packaging a Major Component, but which is not part of that Major -Component, and (b) serves only to enable use of the work with that -Major Component, or to implement a Standard Interface for which an -implementation is available to the public in source code form. A -"Major Component", in this context, means a major essential component -(kernel, window system, and so on) of the specific operating system -(if any) on which the executable work runs, or a compiler used to -produce the work, or an object code interpreter used to run it. - - The "Corresponding Source" for a work in object code form means all -the source code needed to generate, install, and (for an executable -work) run the object code and to modify the work, including scripts to -control those activities. However, it does not include the work's -System Libraries, or general-purpose tools or generally available free -programs which are used unmodified in performing those activities but -which are not part of the work. For example, Corresponding Source -includes interface definition files associated with source files for -the work, and the source code for shared libraries and dynamically -linked subprograms that the work is specifically designed to require, -such as by intimate data communication or control flow between those -subprograms and other parts of the work. - - The Corresponding Source need not include anything that users -can regenerate automatically from other parts of the Corresponding -Source. - - The Corresponding Source for a work in source code form is that -same work. - - 2. Basic Permissions. - - All rights granted under this License are granted for the term of -copyright on the Program, and are irrevocable provided the stated -conditions are met. This License explicitly affirms your unlimited -permission to run the unmodified Program. The output from running a -covered work is covered by this License only if the output, given its -content, constitutes a covered work. This License acknowledges your -rights of fair use or other equivalent, as provided by copyright law. - - You may make, run and propagate covered works that you do not -convey, without conditions so long as your license otherwise remains -in force. You may convey covered works to others for the sole purpose -of having them make modifications exclusively for you, or provide you -with facilities for running those works, provided that you comply with -the terms of this License in conveying all material for which you do -not control copyright. Those thus making or running the covered works -for you must do so exclusively on your behalf, under your direction -and control, on terms that prohibit them from making any copies of -your copyrighted material outside their relationship with you. - - Conveying under any other circumstances is permitted solely under -the conditions stated below. Sublicensing is not allowed; section 10 -makes it unnecessary. - - 3. Protecting Users' Legal Rights From Anti-Circumvention Law. - - No covered work shall be deemed part of an effective technological -measure under any applicable law fulfilling obligations under article -11 of the WIPO copyright treaty adopted on 20 December 1996, or -similar laws prohibiting or restricting circumvention of such -measures. - - When you convey a covered work, you waive any legal power to forbid -circumvention of technological measures to the extent such circumvention -is effected by exercising rights under this License with respect to -the covered work, and you disclaim any intention to limit operation or -modification of the work as a means of enforcing, against the work's -users, your or third parties' legal rights to forbid circumvention of -technological measures. - - 4. Conveying Verbatim Copies. - - You may convey verbatim copies of the Program's source code as you -receive it, in any medium, provided that you conspicuously and -appropriately publish on each copy an appropriate copyright notice; -keep intact all notices stating that this License and any -non-permissive terms added in accord with section 7 apply to the code; -keep intact all notices of the absence of any warranty; and give all -recipients a copy of this License along with the Program. - - You may charge any price or no price for each copy that you convey, -and you may offer support or warranty protection for a fee. - - 5. Conveying Modified Source Versions. - - You may convey a work based on the Program, or the modifications to -produce it from the Program, in the form of source code under the -terms of section 4, provided that you also meet all of these conditions: - - a) The work must carry prominent notices stating that you modified - it, and giving a relevant date. - - b) The work must carry prominent notices stating that it is - released under this License and any conditions added under section - 7. This requirement modifies the requirement in section 4 to - "keep intact all notices". - - c) You must license the entire work, as a whole, under this - License to anyone who comes into possession of a copy. This - License will therefore apply, along with any applicable section 7 - additional terms, to the whole of the work, and all its parts, - regardless of how they are packaged. This License gives no - permission to license the work in any other way, but it does not - invalidate such permission if you have separately received it. - - d) If the work has interactive user interfaces, each must display - Appropriate Legal Notices; however, if the Program has interactive - interfaces that do not display Appropriate Legal Notices, your - work need not make them do so. - - A compilation of a covered work with other separate and independent -works, which are not by their nature extensions of the covered work, -and which are not combined with it such as to form a larger program, -in or on a volume of a storage or distribution medium, is called an -"aggregate" if the compilation and its resulting copyright are not -used to limit the access or legal rights of the compilation's users -beyond what the individual works permit. Inclusion of a covered work -in an aggregate does not cause this License to apply to the other -parts of the aggregate. - - 6. Conveying Non-Source Forms. - - You may convey a covered work in object code form under the terms -of sections 4 and 5, provided that you also convey the -machine-readable Corresponding Source under the terms of this License, -in one of these ways: - - a) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by the - Corresponding Source fixed on a durable physical medium - customarily used for software interchange. - - b) Convey the object code in, or embodied in, a physical product - (including a physical distribution medium), accompanied by a - written offer, valid for at least three years and valid for as - long as you offer spare parts or customer support for that product - model, to give anyone who possesses the object code either (1) a - copy of the Corresponding Source for all the software in the - product that is covered by this License, on a durable physical - medium customarily used for software interchange, for a price no - more than your reasonable cost of physically performing this - conveying of source, or (2) access to copy the - Corresponding Source from a network server at no charge. - - c) Convey individual copies of the object code with a copy of the - written offer to provide the Corresponding Source. This - alternative is allowed only occasionally and noncommercially, and - only if you received the object code with such an offer, in accord - with subsection 6b. - - d) Convey the object code by offering access from a designated - place (gratis or for a charge), and offer equivalent access to the - Corresponding Source in the same way through the same place at no - further charge. You need not require recipients to copy the - Corresponding Source along with the object code. If the place to - copy the object code is a network server, the Corresponding Source - may be on a different server (operated by you or a third party) - that supports equivalent copying facilities, provided you maintain - clear directions next to the object code saying where to find the - Corresponding Source. Regardless of what server hosts the - Corresponding Source, you remain obligated to ensure that it is - available for as long as needed to satisfy these requirements. - - e) Convey the object code using peer-to-peer transmission, provided - you inform other peers where the object code and Corresponding - Source of the work are being offered to the general public at no - charge under subsection 6d. - - A separable portion of the object code, whose source code is excluded -from the Corresponding Source as a System Library, need not be -included in conveying the object code work. - - A "User Product" is either (1) a "consumer product", which means any -tangible personal property which is normally used for personal, family, -or household purposes, or (2) anything designed or sold for incorporation -into a dwelling. In determining whether a product is a consumer product, -doubtful cases shall be resolved in favor of coverage. For a particular -product received by a particular user, "normally used" refers to a -typical or common use of that class of product, regardless of the status -of the particular user or of the way in which the particular user -actually uses, or expects or is expected to use, the product. A product -is a consumer product regardless of whether the product has substantial -commercial, industrial or non-consumer uses, unless such uses represent -the only significant mode of use of the product. - - "Installation Information" for a User Product means any methods, -procedures, authorization keys, or other information required to install -and execute modified versions of a covered work in that User Product from -a modified version of its Corresponding Source. The information must -suffice to ensure that the continued functioning of the modified object -code is in no case prevented or interfered with solely because -modification has been made. - - If you convey an object code work under this section in, or with, or -specifically for use in, a User Product, and the conveying occurs as -part of a transaction in which the right of possession and use of the -User Product is transferred to the recipient in perpetuity or for a -fixed term (regardless of how the transaction is characterized), the -Corresponding Source conveyed under this section must be accompanied -by the Installation Information. But this requirement does not apply -if neither you nor any third party retains the ability to install -modified object code on the User Product (for example, the work has -been installed in ROM). - - The requirement to provide Installation Information does not include a -requirement to continue to provide support service, warranty, or updates -for a work that has been modified or installed by the recipient, or for -the User Product in which it has been modified or installed. Access to a -network may be denied when the modification itself materially and -adversely affects the operation of the network or violates the rules and -protocols for communication across the network. - - Corresponding Source conveyed, and Installation Information provided, -in accord with this section must be in a format that is publicly -documented (and with an implementation available to the public in -source code form), and must require no special password or key for -unpacking, reading or copying. - - 7. Additional Terms. - - "Additional permissions" are terms that supplement the terms of this -License by making exceptions from one or more of its conditions. -Additional permissions that are applicable to the entire Program shall -be treated as though they were included in this License, to the extent -that they are valid under applicable law. If additional permissions -apply only to part of the Program, that part may be used separately -under those permissions, but the entire Program remains governed by -this License without regard to the additional permissions. - - When you convey a copy of a covered work, you may at your option -remove any additional permissions from that copy, or from any part of -it. (Additional permissions may be written to require their own -removal in certain cases when you modify the work.) You may place -additional permissions on material, added by you to a covered work, -for which you have or can give appropriate copyright permission. - - Notwithstanding any other provision of this License, for material you -add to a covered work, you may (if authorized by the copyright holders of -that material) supplement the terms of this License with terms: - - a) Disclaiming warranty or limiting liability differently from the - terms of sections 15 and 16 of this License; or - - b) Requiring preservation of specified reasonable legal notices or - author attributions in that material or in the Appropriate Legal - Notices displayed by works containing it; or - - c) Prohibiting misrepresentation of the origin of that material, or - requiring that modified versions of such material be marked in - reasonable ways as different from the original version; or - - d) Limiting the use for publicity purposes of names of licensors or - authors of the material; or - - e) Declining to grant rights under trademark law for use of some - trade names, trademarks, or service marks; or - - f) Requiring indemnification of licensors and authors of that - material by anyone who conveys the material (or modified versions of - it) with contractual assumptions of liability to the recipient, for - any liability that these contractual assumptions directly impose on - those licensors and authors. - - All other non-permissive additional terms are considered "further -restrictions" within the meaning of section 10. If the Program as you -received it, or any part of it, contains a notice stating that it is -governed by this License along with a term that is a further -restriction, you may remove that term. If a license document contains -a further restriction but permits relicensing or conveying under this -License, you may add to a covered work material governed by the terms -of that license document, provided that the further restriction does -not survive such relicensing or conveying. - - If you add terms to a covered work in accord with this section, you -must place, in the relevant source files, a statement of the -additional terms that apply to those files, or a notice indicating -where to find the applicable terms. - - Additional terms, permissive or non-permissive, may be stated in the -form of a separately written license, or stated as exceptions; -the above requirements apply either way. - - 8. Termination. - - You may not propagate or modify a covered work except as expressly -provided under this License. Any attempt otherwise to propagate or -modify it is void, and will automatically terminate your rights under -this License (including any patent licenses granted under the third -paragraph of section 11). - - However, if you cease all violation of this License, then your -license from a particular copyright holder is reinstated (a) -provisionally, unless and until the copyright holder explicitly and -finally terminates your license, and (b) permanently, if the copyright -holder fails to notify you of the violation by some reasonable means -prior to 60 days after the cessation. - - Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - - Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, you do not qualify to receive new licenses for the same -material under section 10. - - 9. Acceptance Not Required for Having Copies. - - You are not required to accept this License in order to receive or -run a copy of the Program. Ancillary propagation of a covered work -occurring solely as a consequence of using peer-to-peer transmission -to receive a copy likewise does not require acceptance. However, -nothing other than this License grants you permission to propagate or -modify any covered work. These actions infringe copyright if you do -not accept this License. Therefore, by modifying or propagating a -covered work, you indicate your acceptance of this License to do so. - - 10. Automatic Licensing of Downstream Recipients. - - Each time you convey a covered work, the recipient automatically -receives a license from the original licensors, to run, modify and -propagate that work, subject to this License. You are not responsible -for enforcing compliance by third parties with this License. - - An "entity transaction" is a transaction transferring control of an -organization, or substantially all assets of one, or subdividing an -organization, or merging organizations. If propagation of a covered -work results from an entity transaction, each party to that -transaction who receives a copy of the work also receives whatever -licenses to the work the party's predecessor in interest had or could -give under the previous paragraph, plus a right to possession of the -Corresponding Source of the work from the predecessor in interest, if -the predecessor has it or can get it with reasonable efforts. - - You may not impose any further restrictions on the exercise of the -rights granted or affirmed under this License. For example, you may -not impose a license fee, royalty, or other charge for exercise of -rights granted under this License, and you may not initiate litigation -(including a cross-claim or counterclaim in a lawsuit) alleging that -any patent claim is infringed by making, using, selling, offering for -sale, or importing the Program or any portion of it. - - 11. Patents. - - A "contributor" is a copyright holder who authorizes use under this -License of the Program or a work on which the Program is based. The -work thus licensed is called the contributor's "contributor version". - - A contributor's "essential patent claims" are all patent claims -owned or controlled by the contributor, whether already acquired or -hereafter acquired, that would be infringed by some manner, permitted -by this License, of making, using, or selling its contributor version, -but do not include claims that would be infringed only as a -consequence of further modification of the contributor version. For -purposes of this definition, "control" includes the right to grant -patent sublicenses in a manner consistent with the requirements of -this License. - - Each contributor grants you a non-exclusive, worldwide, royalty-free -patent license under the contributor's essential patent claims, to -make, use, sell, offer for sale, import and otherwise run, modify and -propagate the contents of its contributor version. - - In the following three paragraphs, a "patent license" is any express -agreement or commitment, however denominated, not to enforce a patent -(such as an express permission to practice a patent or covenant not to -sue for patent infringement). To "grant" such a patent license to a -party means to make such an agreement or commitment not to enforce a -patent against the party. - - If you convey a covered work, knowingly relying on a patent license, -and the Corresponding Source of the work is not available for anyone -to copy, free of charge and under the terms of this License, through a -publicly available network server or other readily accessible means, -then you must either (1) cause the Corresponding Source to be so -available, or (2) arrange to deprive yourself of the benefit of the -patent license for this particular work, or (3) arrange, in a manner -consistent with the requirements of this License, to extend the patent -license to downstream recipients. "Knowingly relying" means you have -actual knowledge that, but for the patent license, your conveying the -covered work in a country, or your recipient's use of the covered work -in a country, would infringe one or more identifiable patents in that -country that you have reason to believe are valid. - - If, pursuant to or in connection with a single transaction or -arrangement, you convey, or propagate by procuring conveyance of, a -covered work, and grant a patent license to some of the parties -receiving the covered work authorizing them to use, propagate, modify -or convey a specific copy of the covered work, then the patent license -you grant is automatically extended to all recipients of the covered -work and works based on it. - - A patent license is "discriminatory" if it does not include within -the scope of its coverage, prohibits the exercise of, or is -conditioned on the non-exercise of one or more of the rights that are -specifically granted under this License. You may not convey a covered -work if you are a party to an arrangement with a third party that is -in the business of distributing software, under which you make payment -to the third party based on the extent of your activity of conveying -the work, and under which the third party grants, to any of the -parties who would receive the covered work from you, a discriminatory -patent license (a) in connection with copies of the covered work -conveyed by you (or copies made from those copies), or (b) primarily -for and in connection with specific products or compilations that -contain the covered work, unless you entered into that arrangement, -or that patent license was granted, prior to 28 March 2007. - - Nothing in this License shall be construed as excluding or limiting -any implied license or other defenses to infringement that may -otherwise be available to you under applicable patent law. - - 12. No Surrender of Others' Freedom. - - If conditions are imposed on you (whether by court order, agreement or -otherwise) that contradict the conditions of this License, they do not -excuse you from the conditions of this License. If you cannot convey a -covered work so as to satisfy simultaneously your obligations under this -License and any other pertinent obligations, then as a consequence you may -not convey it at all. For example, if you agree to terms that obligate you -to collect a royalty for further conveying from those to whom you convey -the Program, the only way you could satisfy both those terms and this -License would be to refrain entirely from conveying the Program. - - 13. Remote Network Interaction; Use with the GNU General Public License. - - Notwithstanding any other provision of this License, if you modify the -Program, your modified version must prominently offer all users -interacting with it remotely through a computer network (if your version -supports such interaction) an opportunity to receive the Corresponding -Source of your version by providing access to the Corresponding Source -from a network server at no charge, through some standard or customary -means of facilitating copying of software. This Corresponding Source -shall include the Corresponding Source for any work covered by version 3 -of the GNU General Public License that is incorporated pursuant to the -following paragraph. - - Notwithstanding any other provision of this License, you have -permission to link or combine any covered work with a work licensed -under version 3 of the GNU General Public License into a single -combined work, and to convey the resulting work. The terms of this -License will continue to apply to the part which is the covered work, -but the work with which it is combined will remain governed by version -3 of the GNU General Public License. - - 14. Revised Versions of this License. - - The Free Software Foundation may publish revised and/or new versions of -the GNU Affero General Public License from time to time. Such new versions -will be similar in spirit to the present version, but may differ in detail to -address new problems or concerns. - - Each version is given a distinguishing version number. If the -Program specifies that a certain numbered version of the GNU Affero General -Public License "or any later version" applies to it, you have the -option of following the terms and conditions either of that numbered -version or of any later version published by the Free Software -Foundation. If the Program does not specify a version number of the -GNU Affero General Public License, you may choose any version ever published -by the Free Software Foundation. - - If the Program specifies that a proxy can decide which future -versions of the GNU Affero General Public License can be used, that proxy's -public statement of acceptance of a version permanently authorizes you -to choose that version for the Program. - - Later license versions may give you additional or different -permissions. However, no additional obligations are imposed on any -author or copyright holder as a result of your choosing to follow a -later version. - - 15. Disclaimer of Warranty. - - THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY -APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT -HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY -OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, -THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR -PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM -IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF -ALL NECESSARY SERVICING, REPAIR OR CORRECTION. - - 16. Limitation of Liability. - - IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS -THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY -GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE -USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF -DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD -PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), -EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES. - - 17. Interpretation of Sections 15 and 16. - - If the disclaimer of warranty and limitation of liability provided -above cannot be given local legal effect according to their terms, -reviewing courts shall apply local law that most closely approximates -an absolute waiver of all civil liability in connection with the -Program, unless a warranty or assumption of liability accompanies a -copy of the Program in return for a fee. - - END OF TERMS AND CONDITIONS - - How to Apply These Terms to Your New Programs - - If you develop a new program, and you want it to be of the greatest -possible use to the public, the best way to achieve this is to make it -free software which everyone can redistribute and change under these terms. - - To do so, attach the following notices to the program. It is safest -to attach them to the start of each source file to most effectively -state the exclusion of warranty; and each file should have at least -the "copyright" line and a pointer to where the full notice is found. - - - Copyright (C) - - This program is free software: you can redistribute it and/or modify - it under the terms of the GNU Affero General Public License as published - by the Free Software Foundation, either version 3 of the License, or - (at your option) any later version. - - This program is distributed in the hope that it will be useful, - but WITHOUT ANY WARRANTY; without even the implied warranty of - MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - GNU Affero General Public License for more details. - - You should have received a copy of the GNU Affero General Public License - along with this program. If not, see . - -Also add information on how to contact you by electronic and paper mail. - - If your software can interact with users remotely through a computer -network, you should also make sure that it provides a way for users to -get its source. For example, if your program is a web application, its -interface could display a "Source" link that leads users to an archive -of the code. There are many ways you could offer source, and different -solutions will be better for different programs; see section 13 for the -specific requirements. - - You should also get your employer (if you work as a programmer) or school, -if any, to sign a "copyright disclaimer" for the program, if necessary. -For more information on this, and how to apply and follow the GNU AGPL, see -. diff --git a/packages/peer-id/LICENSE-APACHE b/packages/peer-id/LICENSE-APACHE deleted file mode 100644 index d64569567..000000000 --- a/packages/peer-id/LICENSE-APACHE +++ /dev/null @@ -1,202 +0,0 @@ - - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright [yyyy] [name of copyright owner] - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. diff --git a/packages/peer-id/README.md b/packages/peer-id/README.md deleted file mode 100644 index 30d57d55a..000000000 --- a/packages/peer-id/README.md +++ /dev/null @@ -1,38 +0,0 @@ -# bittorrent-peer-id - -In-house crate for BitTorrent `PeerId` parsing and `PeerClient` identification. - -## Origin and In-House Maintenance - -This crate was originally derived from Aquatic's `peer_id` crate: - -- https://github.com/greatest-ape/aquatic/tree/master/crates/peer_id - -This crate is extracted from previously duplicated in-house implementations in: - -- `packages/primitives/src/peer_id.rs` -- `packages/udp-protocol/src/peer_id.rs` - -It provides a shared implementation that can be consumed by both domain and protocol crates -without introducing inverted dependency directions. - -Torrust keeps this package in-house because upstream maintenance appears inactive and the tracker -still needs dependency updates, security maintenance, and ongoing evolution. - -Relevant upstream context: - -- https://github.com/greatest-ape/aquatic/issues/224 -- https://github.com/greatest-ape/aquatic/pull/235 - -## Licensing and Notices - -The original source is Apache-2.0 licensed. The in-house package keeps the required origin and -change notices in code headers, consistent with the license terms. - -An explicit copy of Apache-2.0 is included at [LICENSE-APACHE](./LICENSE-APACHE). - -## Acknowledgment - -Special thanks to [greatest-ape](https://github.com/greatest-ape) -(Joakim Frostegård) for his contributions to the BitTorrent ecosystem and the original -implementation this crate builds upon. diff --git a/packages/peer-id/src/lib.rs b/packages/peer-id/src/lib.rs deleted file mode 100644 index 779b6b6a5..000000000 --- a/packages/peer-id/src/lib.rs +++ /dev/null @@ -1,9 +0,0 @@ -//! Peer ID parsing and client identification for `BitTorrent` crates. - -#![allow(clippy::module_name_repetitions)] - -mod peer_client; -mod peer_id; - -pub use self::peer_client::PeerClient; -pub use self::peer_id::PeerId; diff --git a/packages/peer-id/src/peer_client.rs b/packages/peer-id/src/peer_client.rs deleted file mode 100644 index c0892492d..000000000 --- a/packages/peer-id/src/peer_client.rs +++ /dev/null @@ -1,244 +0,0 @@ -// Adapted from aquatic_peer_id 0.9.0 by Joakim Frostegard (greatest-ape). -// Source: https://crates.io/crates/aquatic_peer_id/0.9.0 -// Repository: https://github.com/greatest-ape/aquatic -// License: Apache License, Version 2.0 - -use std::borrow::Cow; -use std::fmt::Display; -use std::sync::OnceLock; - -use compact_str::{CompactString, format_compact}; -use regex::bytes::Regex; - -use crate::peer_id::PeerId; - -#[non_exhaustive] -#[derive(Debug, Clone, PartialEq, Eq, PartialOrd, Ord, Hash)] -pub enum PeerClient { - BitTorrent(CompactString), - Deluge(CompactString), - LibTorrentRakshasa(CompactString), - LibTorrentRasterbar(CompactString), - QBitTorrent(CompactString), - Transmission(CompactString), - UTorrent(CompactString), - UTorrentEmbedded(CompactString), - UTorrentMac(CompactString), - UTorrentWeb(CompactString), - Vuze(CompactString), - WebTorrent(CompactString), - WebTorrentDesktop(CompactString), - Mainline(CompactString), - OtherWithPrefixAndVersion { prefix: CompactString, version: CompactString }, - OtherWithPrefix(CompactString), - Other, -} - -impl PeerClient { - #[must_use] - pub fn from_prefix_and_version(prefix: &[u8], version: &[u8]) -> Self { - fn three_digits_plus_prerelease(v1: char, v2: char, v3: char, v4: char) -> CompactString { - let prerelease: Cow<'_, str> = match v4 { - 'd' | 'D' => " dev".into(), - 'a' | 'A' => " alpha".into(), - 'b' | 'B' => " beta".into(), - 'r' | 'R' => " rc".into(), - 's' | 'S' => " stable".into(), - other => format_compact!("{}", other).into(), - }; - - format_compact!("{}.{}.{}{}", v1, v2, v3, prerelease) - } - - fn webtorrent(v1: char, v2: char, v3: char, v4: char) -> CompactString { - let major = if v1 == '0' { - format_compact!("{}", v2) - } else { - format_compact!("{}{}", v1, v2) - }; - - let minor = if v3 == '0' { - format_compact!("{}", v4) - } else { - format_compact!("{}{}", v3, v4) - }; - - format_compact!("{}.{}", major, minor) - } - - if let [v1, v2, v3, v4] = version { - let (v1, v2, v3, v4) = (*v1 as char, *v2 as char, *v3 as char, *v4 as char); - - match prefix { - b"AZ" => Self::Vuze(format_compact!("{}.{}.{}.{}", v1, v2, v3, v4)), - b"BT" => Self::BitTorrent(three_digits_plus_prerelease(v1, v2, v3, v4)), - b"DE" => Self::Deluge(three_digits_plus_prerelease(v1, v2, v3, v4)), - b"lt" => Self::LibTorrentRakshasa(format_compact!("{}.{}{}.{}", v1, v2, v3, v4)), - b"LT" => Self::LibTorrentRasterbar(format_compact!("{}.{}{}.{}", v1, v2, v3, v4)), - b"qB" => Self::QBitTorrent(format_compact!("{}.{}.{}", v1, v2, v3)), - b"TR" => { - let v = match (v1, v2, v3, v4) { - ('0', '0', '0', v4) => format_compact!("0.{}", v4), - ('0', '0', v3, v4) => format_compact!("0.{}{}", v3, v4), - _ => format_compact!("{}.{}{}", v1, v2, v3), - }; - - Self::Transmission(v) - } - b"UE" => Self::UTorrentEmbedded(three_digits_plus_prerelease(v1, v2, v3, v4)), - b"UM" => Self::UTorrentMac(three_digits_plus_prerelease(v1, v2, v3, v4)), - b"UT" => Self::UTorrent(three_digits_plus_prerelease(v1, v2, v3, v4)), - b"UW" => Self::UTorrentWeb(three_digits_plus_prerelease(v1, v2, v3, v4)), - b"WD" => Self::WebTorrentDesktop(webtorrent(v1, v2, v3, v4)), - b"WW" => Self::WebTorrent(webtorrent(v1, v2, v3, v4)), - _ => Self::OtherWithPrefixAndVersion { - prefix: CompactString::from_utf8_lossy(prefix), - version: CompactString::from_utf8_lossy(version), - }, - } - } else { - match (prefix, version) { - (b"M", &[major, b'-', minor, b'-', patch, b'-']) => { - Self::Mainline(format_compact!("{}.{}.{}", major as char, minor as char, patch as char)) - } - (b"M", &[major, b'-', minor1, minor2, b'-', patch]) => Self::Mainline(format_compact!( - "{}.{}{}.{}", - major as char, - minor1 as char, - minor2 as char, - patch as char - )), - _ => Self::OtherWithPrefixAndVersion { - prefix: CompactString::from_utf8_lossy(prefix), - version: CompactString::from_utf8_lossy(version), - }, - } - } - } - - /// # Panics - /// - /// Never panics; all `expect` calls compile constant regex patterns that are always valid. - #[must_use] - pub fn from_peer_id(peer_id: &PeerId) -> Self { - static AZ_RE: OnceLock = OnceLock::new(); - static MAINLINE_RE: OnceLock = OnceLock::new(); - static PREFIX_RE: OnceLock = OnceLock::new(); - - if let Some(caps) = AZ_RE - .get_or_init(|| Regex::new(r"^\-(?P[a-zA-Z]{2})(?P[0-9]{3}[0-9a-zA-Z])").expect("compile AZ_RE regex")) - .captures(&peer_id.0) - { - return Self::from_prefix_and_version(&caps["name"], &caps["version"]); - } - - if let Some(caps) = MAINLINE_RE - .get_or_init(|| Regex::new(r"^(?P[a-zA-Z])(?P[0-9\-]{6})\-").expect("compile MAINLINE_RE regex")) - .captures(&peer_id.0) - { - return Self::from_prefix_and_version(&caps["name"], &caps["version"]); - } - - if let Some(caps) = PREFIX_RE - .get_or_init(|| Regex::new(r"^(?P[a-zA-Z0-9\-]+)\-").expect("compile PREFIX_RE regex")) - .captures(&peer_id.0) - { - return Self::OtherWithPrefix(CompactString::from_utf8_lossy(&caps["prefix"])); - } - - Self::Other - } -} - -impl Display for PeerClient { - fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { - match self { - Self::BitTorrent(v) => write!(f, "BitTorrent {}", v.as_str()), - Self::Deluge(v) => write!(f, "Deluge {}", v.as_str()), - Self::LibTorrentRakshasa(v) => write!(f, "lt (rakshasa) {}", v.as_str()), - Self::LibTorrentRasterbar(v) => write!(f, "lt (rasterbar) {}", v.as_str()), - Self::QBitTorrent(v) => write!(f, "QBitTorrent {}", v.as_str()), - Self::Transmission(v) => write!(f, "Transmission {}", v.as_str()), - Self::UTorrent(v) => write!(f, "\u{00B5}Torrent {}", v.as_str()), - Self::UTorrentEmbedded(v) => write!(f, "\u{00B5}Torrent Emb. {}", v.as_str()), - Self::UTorrentMac(v) => write!(f, "\u{00B5}Torrent Mac {}", v.as_str()), - Self::UTorrentWeb(v) => write!(f, "\u{00B5}Torrent Web {}", v.as_str()), - Self::Vuze(v) => write!(f, "Vuze {}", v.as_str()), - Self::WebTorrent(v) => write!(f, "WebTorrent {}", v.as_str()), - Self::WebTorrentDesktop(v) => write!(f, "WebTorrent Desktop {}", v.as_str()), - Self::Mainline(v) => write!(f, "Mainline {}", v.as_str()), - Self::OtherWithPrefixAndVersion { prefix, version } => { - write!(f, "Other ({}) ({})", prefix.as_str(), version.as_str()) - } - Self::OtherWithPrefix(prefix) => write!(f, "Other ({})", prefix.as_str()), - Self::Other => f.write_str("Other"), - } - } -} - -#[cfg(test)] -mod tests { - use super::*; - - fn create_peer_id(bytes: &[u8]) -> PeerId { - let mut peer_id = PeerId([0; 20]); - - let len = bytes.len(); - - peer_id.0[..len].copy_from_slice(bytes); - - peer_id - } - - #[test] - fn test_client_from_peer_id() { - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-lt1234-k/asdh3")), - PeerClient::LibTorrentRakshasa("1.23.4".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-DE123s-k/asdh3")), - PeerClient::Deluge("1.2.3 stable".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-DE123r-k/asdh3")), - PeerClient::Deluge("1.2.3 rc".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-UT123A-k/asdh3")), - PeerClient::UTorrent("1.2.3 alpha".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-TR0012-k/asdh3")), - PeerClient::Transmission("0.12".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-TR1212-k/asdh3")), - PeerClient::Transmission("1.21".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-WW0102-k/asdh3")), - PeerClient::WebTorrent("1.2".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-WW1302-k/asdh3")), - PeerClient::WebTorrent("13.2".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"-WW1324-k/asdh3")), - PeerClient::WebTorrent("13.24".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"M1-2-3--k/asdh3")), - PeerClient::Mainline("1.2.3".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"M1-23-4-k/asdh3")), - PeerClient::Mainline("1.23.4".into()) - ); - assert_eq!( - PeerClient::from_peer_id(&create_peer_id(b"S3-k/asdh3")), - PeerClient::OtherWithPrefix("S3".into()) - ); - } -} diff --git a/packages/peer-id/src/peer_id.rs b/packages/peer-id/src/peer_id.rs deleted file mode 100644 index cb28a8998..000000000 --- a/packages/peer-id/src/peer_id.rs +++ /dev/null @@ -1,53 +0,0 @@ -// Adapted from aquatic_peer_id 0.9.0 by Joakim Frostegard (greatest-ape). -// Source: https://crates.io/crates/aquatic_peer_id/0.9.0 -// Repository: https://github.com/greatest-ape/aquatic -// License: Apache License, Version 2.0 - -use compact_str::CompactString; -#[cfg(feature = "serde")] -use serde::{Deserialize, Serialize}; - -use crate::peer_client::PeerClient; - -#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] -#[cfg_attr(feature = "serde", derive(Serialize, Deserialize))] -#[cfg_attr(feature = "zerocopy", derive(zerocopy::IntoBytes, zerocopy::FromBytes, zerocopy::Immutable))] -#[repr(transparent)] -pub struct PeerId(pub [u8; 20]); - -impl PeerId { - #[must_use] - pub fn as_bytes(&self) -> &[u8; 20] { - &self.0 - } - - #[must_use] - pub fn client(&self) -> PeerClient { - PeerClient::from_peer_id(self) - } - - /// # Panics - /// - /// Never panics; the expect is unreachable because the buffer is exactly the right size. - #[must_use] - pub fn first_8_bytes_hex(&self) -> CompactString { - let mut buf = [0u8; 16]; - - hex::encode_to_slice(&self.0[..8], &mut buf).expect("PeerId.first_8_bytes_hex buffer too small"); - - CompactString::from_utf8_lossy(&buf) - } -} - -#[cfg(feature = "quickcheck")] -impl quickcheck::Arbitrary for PeerId { - fn arbitrary(g: &mut quickcheck::Gen) -> Self { - let mut bytes = [0u8; 20]; - - for byte in &mut bytes { - *byte = u8::arbitrary(g); - } - - Self(bytes) - } -} diff --git a/packages/primitives/Cargo.toml b/packages/primitives/Cargo.toml index a4a06fde3..2e97e8737 100644 --- a/packages/primitives/Cargo.toml +++ b/packages/primitives/Cargo.toml @@ -15,7 +15,7 @@ rust-version.workspace = true version.workspace = true [dependencies] -bittorrent-peer-id = { version = "3.0.0-develop", path = "../peer-id" } +torrust-peer-id = "0.1.0" binascii = "0" bittorrent-primitives = "0.2.0" derive_more = { version = "2", features = [ "constructor" ] } diff --git a/packages/primitives/src/lib.rs b/packages/primitives/src/lib.rs index fb6e5d31b..788b6dae6 100644 --- a/packages/primitives/src/lib.rs +++ b/packages/primitives/src/lib.rs @@ -9,7 +9,6 @@ pub mod mode; pub mod number_of_bytes; pub mod pagination; pub mod peer; -pub mod peer_id; pub mod policy; pub mod scrape; pub mod swarm_metadata; @@ -20,7 +19,6 @@ pub use announce::{AnnounceData, AnnounceEvent, AnnouncePolicy}; use bittorrent_primitives::info_hash::InfoHash; pub use mode::PrivateMode; pub use number_of_bytes::NumberOfBytes; -pub use peer_id::{PeerClient, PeerId}; pub use policy::TrackerPolicy; pub use scrape::ScrapeData; /// Duration since the Unix Epoch. @@ -35,6 +33,7 @@ pub use scrape::ScrapeData; this re-export will be removed in a future release (see EPIC #1669)" )] pub use torrust_clock::DurationSinceUnixEpoch; +pub use torrust_peer_id::{PeerClient, PeerId}; /// Network service binding types. /// diff --git a/packages/primitives/src/peer_id.rs b/packages/primitives/src/peer_id.rs deleted file mode 100644 index 8e8967b79..000000000 --- a/packages/primitives/src/peer_id.rs +++ /dev/null @@ -1,3 +0,0 @@ -//! Compatibility re-export for shared peer-id primitives. - -pub use bittorrent_peer_id::{PeerClient, PeerId}; diff --git a/packages/udp-protocol/Cargo.toml b/packages/udp-protocol/Cargo.toml index 53d8de3c8..f81d5b60b 100644 --- a/packages/udp-protocol/Cargo.toml +++ b/packages/udp-protocol/Cargo.toml @@ -18,7 +18,7 @@ version.workspace = true default = [ ] [dependencies] -bittorrent-peer-id = { version = "3.0.0-develop", path = "../peer-id", features = [ "zerocopy" ] } +torrust-peer-id = { version = "0.1.0", features = [ "zerocopy" ] } byteorder = "1" either = "1" zerocopy = { version = "0.8", features = [ "derive" ] } diff --git a/packages/udp-protocol/src/lib.rs b/packages/udp-protocol/src/lib.rs index b678f59c5..2d38bdee2 100644 --- a/packages/udp-protocol/src/lib.rs +++ b/packages/udp-protocol/src/lib.rs @@ -25,7 +25,7 @@ pub mod request; pub mod response; pub mod scrape; -pub use bittorrent_peer_id::{PeerClient, PeerId}; +pub use torrust_peer_id::{PeerClient, PeerId}; pub use self::announce::*; pub use self::common::*; From 091e0ba400531f296545f9704e61f282e788a38f Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Mon, 8 Jun 2026 11:49:54 +0100 Subject: [PATCH 3/7] docs: mark issue #1884 as implemented, update acceptance criteria All 13 implementation tasks are DONE. Acceptance criteria, verification scenarios, and progress log updated with completion evidence. torrust-peer-id 0.1.0 is published on crates.io under Apache-2.0. T14 (EPIC #1669 table update) remains as the final task. --- ...ittorrent-peer-id-to-torrust-bittorrent.md | 77 ++++++++++--------- 1 file changed, 40 insertions(+), 37 deletions(-) diff --git a/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md b/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md index 4ef07b5cb..d534c3174 100644 --- a/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md +++ b/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md @@ -96,20 +96,20 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`. | ID | Status | Task | Notes / Expected Output | | --- | ------ | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| T1 | TODO | Rename `name` in `packages/peer-id/Cargo.toml` to `torrust-peer-id` | `name = "torrust-peer-id"` | -| T2 | TODO | Update `repository` URL in `packages/peer-id/Cargo.toml` and crate metadata | Point to `https://github.com/torrust/torrust-bittorrent` | -| T2b | TODO | Drop AGPL-3.0 `LICENSE` from the package; inherit Apache-2.0 from the destination workspace | `LICENSE` file removed; `license.workspace = true`; `LICENSE-APACHE` attribution kept | -| T3 | TODO | Confirm destination workspace `torrust/torrust-bittorrent` migration path | Target path agreed: `packages/peer-id` | -| T4 | TODO | Move/merge crate source into destination workspace, preserving history where practical | `packages/peer-id` added to `torrust/torrust-bittorrent` | -| T5 | TODO | Set up/adjust CI in destination repository if needed | CI green after migration | -| T6 | TODO | Publish `torrust-peer-id` on crates.io from destination repository | Successful `cargo publish`; crate visible at crates.io/crates/torrust-peer-id | -| T7 | TODO | Update `packages/http-protocol/Cargo.toml`: replace path dep with published `torrust-peer-id` | `torrust-peer-id = "X.Y.Z"` (no path) | -| T8 | TODO | Update `packages/primitives/Cargo.toml`: replace path dep with published `torrust-peer-id` | `torrust-peer-id = "X.Y.Z"` (no path) | -| T9 | TODO | Update `packages/udp-protocol/Cargo.toml`: replace path dep with published `torrust-peer-id` (keep `zerocopy` feature) | `torrust-peer-id = { version = "X.Y.Z", features = ["zerocopy"] }` (no path) | -| T10 | TODO | Remove `packages/peer-id/` from tracker workspace (`members` + workspace dep in `Cargo.toml`) | `cargo build --workspace` succeeds without the local crate | -| T11 | TODO | Delete `packages/peer-id/` directory from the tracker repo | Directory gone; workspace still builds | -| T12 | TODO | Update `packages/AGENTS.md`, `AGENTS.md`, `docs/packages.md`, and any README references | No stale references to `bittorrent-peer-id` | -| T13 | TODO | Run `cargo build --workspace`, `cargo test --workspace`, `linter all` | All green | +| T1 | DONE | Rename `name` in `packages/peer-id/Cargo.toml` to `torrust-peer-id` | `name = "torrust-peer-id"` | +| T2 | DONE | Update `repository` URL in `packages/peer-id/Cargo.toml` and crate metadata | Point to `https://github.com/torrust/torrust-bittorrent` | +| T2b | DONE | Drop AGPL-3.0 `LICENSE` from the package; inherit Apache-2.0 from the destination workspace | `LICENSE` file removed; `license.workspace = true`; `LICENSE-APACHE` attribution kept | +| T3 | DONE | Confirm destination workspace `torrust/torrust-bittorrent` migration path | Target path agreed: `packages/peer-id` | +| T4 | DONE | Move/merge crate source into destination workspace, preserving history where practical | `packages/peer-id` added to `torrust/torrust-bittorrent` | +| T5 | DONE | Set up/adjust CI in destination repository if needed | CI green after migration | +| T6 | DONE | Publish `torrust-peer-id` on crates.io from destination repository | Successful `cargo publish`; crate visible at crates.io/crates/torrust-peer-id | +| T7 | DONE | Update `packages/http-protocol/Cargo.toml`: replace path dep with published `torrust-peer-id` | `torrust-peer-id = "0.1.0"` (no path) | +| T8 | DONE | Update `packages/primitives/Cargo.toml`: replace path dep with published `torrust-peer-id` | `torrust-peer-id = "0.1.0"` (no path) | +| T9 | DONE | Update `packages/udp-protocol/Cargo.toml`: replace path dep with published `torrust-peer-id` (keep `zerocopy` feature) | `torrust-peer-id = { version = "0.1.0", features = ["zerocopy"] }` (no path) | +| T10 | DONE | Remove `packages/peer-id/` from tracker workspace (`members` + workspace dep in `Cargo.toml`) | `cargo build --workspace` succeeds without the local crate | +| T11 | DONE | Delete `packages/peer-id/` directory from the tracker repo | Directory gone; workspace still builds | +| T12 | DONE | Update `packages/AGENTS.md`, `AGENTS.md`, `docs/packages.md`, and any README references | No stale references to `bittorrent-peer-id` | +| T13 | DONE | Run `cargo build --workspace`, `cargo test --workspace`, `linter all` | All green | | T14 | TODO | Update EPIC #1669 `Package Inventory` and `Desired Package State` tables | Remove `bittorrent-peer-id` from tracker table; mark as extracted in bittorrent table | ## Progress Tracking @@ -120,11 +120,11 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`. - [x] Spec reviewed and approved by user/maintainer - [x] GitHub issue created and issue number added to this spec - [x] Spec moved to `docs/issues/open/` with issue number prefix -- [ ] Implementation completed -- [ ] Automatic verification completed (`linter all`, `cargo test --workspace`) -- [ ] Manual verification scenarios executed and recorded -- [ ] Acceptance criteria reviewed after implementation and updated with evidence -- [ ] `torrust-peer-id` published from `torrust/torrust-bittorrent` +- [x] Implementation completed +- [x] Automatic verification completed (`linter all`, `cargo test --workspace`) +- [x] Manual verification scenarios executed and recorded +- [x] Acceptance criteria reviewed after implementation and updated with evidence +- [x] `torrust-peer-id` published from `torrust/torrust-bittorrent` - [ ] EPIC #1669 Active Subissues table updated to `DONE` - [ ] Issue closed and spec moved to `docs/issues/closed/` @@ -132,22 +132,25 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`. - 2026-06-05 00:00 UTC - josecelano - Spec drafted as subissue of EPIC #1669 - 2026-06-05 00:00 UTC - josecelano - GitHub issue #1884 created; spec promoted to docs/issues/open/ +- 2026-06-08 00:00 UTC - josecelano - T1-T4: Copied crate to torrust-bittorrent, renamed to torrust-peer-id, switched to Apache-2.0 +- 2026-06-08 00:00 UTC - josecelano - T6: torrust-peer-id 0.1.0 published to crates.io +- 2026-06-08 00:00 UTC - josecelano - T7-T13: Replaced path deps with crates.io dep; removed packages/peer-id/; updated AGENTS.md; all quality gates pass ## Acceptance Criteria -- [ ] `packages/peer-id/` directory no longer exists in the tracker workspace. -- [ ] Root `Cargo.toml` does not list `packages/peer-id` as a workspace member. -- [ ] No `Cargo.toml` in the tracker workspace references `bittorrent-peer-id`. -- [ ] `packages/http-protocol/Cargo.toml` depends on the published `torrust-peer-id`. -- [ ] `packages/primitives/Cargo.toml` depends on the published `torrust-peer-id`. -- [ ] `packages/udp-protocol/Cargo.toml` depends on the published `torrust-peer-id` with the `zerocopy` feature. -- [ ] `cargo build --workspace` succeeds without the local peer-id crate. -- [ ] `cargo test --workspace` passes with zero failures. -- [ ] `linter all` exits with code `0`. -- [ ] `torrust-peer-id` is published and visible on crates.io. -- [ ] `torrust-peer-id` is published under the Apache-2.0 license; no AGPL-3.0 `LICENSE` file is present in the package. -- [ ] Destination repository (`torrust/torrust-bittorrent`) has passing CI and a published release. -- [ ] `packages/AGENTS.md`, `AGENTS.md`, and `docs/packages.md` no longer list `bittorrent-peer-id`. +- [x] `packages/peer-id/` directory no longer exists in the tracker workspace. +- [x] Root `Cargo.toml` does not list `packages/peer-id` as a workspace member. +- [x] No `Cargo.toml` in the tracker workspace references `bittorrent-peer-id`. +- [x] `packages/http-protocol/Cargo.toml` depends on the published `torrust-peer-id`. +- [x] `packages/primitives/Cargo.toml` depends on the published `torrust-peer-id`. +- [x] `packages/udp-protocol/Cargo.toml` depends on the published `torrust-peer-id` with the `zerocopy` feature. +- [x] `cargo build --workspace` succeeds without the local peer-id crate. +- [x] `cargo test --workspace` passes with zero failures. +- [x] `linter all` exits with code `0`. +- [x] `torrust-peer-id` is published and visible on crates.io. +- [x] `torrust-peer-id` is published under the Apache-2.0 license; no AGPL-3.0 `LICENSE` file is present in the package. +- [x] Destination repository (`torrust/torrust-bittorrent`) has passing CI and a published release. +- [x] `packages/AGENTS.md`, `AGENTS.md`, and `docs/packages.md` no longer list `bittorrent-peer-id`. ## Verification Plan @@ -163,8 +166,8 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`. Status values: `TODO`, `IN_PROGRESS`, `DONE`, `FAILED`, `BLOCKED`. -| ID | Scenario | Command/Steps | Expected Result | Status | Evidence | -| --- | ----------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------- | ------ | -------- | -| M1 | No stale workspace reference to old crate | `grep -r "bittorrent-peer-id\|packages/peer-id" . --include="*.toml" --include="*.rs"` | Zero matches in tracker repo | TODO | | -| M2 | New crate visible on crates.io | Visit `https://crates.io/crates/torrust-peer-id` | Crate page exists, latest version shown | TODO | | -| M3 | Destination repository CI green | Check CI status on `torrust/torrust-bittorrent` default branch | All checks pass | TODO | | +| ID | Scenario | Command/Steps | Expected Result | Status | Evidence | +| --- | ----------------------------------------- | -------------------------------------------------------------------------------------- | --------------------------------------- | ------ | ---------------------------------------------------------- | +| M1 | No stale workspace reference to old crate | `grep -r "bittorrent-peer-id\|packages/peer-id" . --include="*.toml" --include="*.rs"` | Zero matches in tracker repo | DONE | Only in docs/issues/ historical specs; zero in source/toml | +| M2 | New crate visible on crates.io | Visit `https://crates.io/crates/torrust-peer-id` | Crate page exists, latest version shown | DONE | `torrust-peer-id 0.1.0` published and visible | +| M3 | Destination repository CI green | Check CI status on `torrust/torrust-bittorrent` default branch | All checks pass | DONE | Published and deployed from torrust-bittorrent | From 96f135979cd625d3f8483d1cd30a262f68c5134d Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Mon, 8 Jun 2026 11:59:40 +0100 Subject: [PATCH 4/7] docs: update EPIC #1669 tables reflecting peer-id extraction Mark SI-19 (#1884) as complete across the EPIC: - Remove bittorrent- prefix section from Package Inventory. - Update Desired Package State note [4] to 'Completed June 2026'. - Check SI-19 checkbox in Numbered Subissues. - Mark Peer-ID move row DONE in the Active Subissues table. - Mark T14 DONE and update last-updated-utc in the issue spec. --- .../open/1669-overhaul-packages/EPIC.md | 12 ++---- ...ittorrent-peer-id-to-torrust-bittorrent.md | 38 +++++++++---------- 2 files changed, 22 insertions(+), 28 deletions(-) diff --git a/docs/issues/open/1669-overhaul-packages/EPIC.md b/docs/issues/open/1669-overhaul-packages/EPIC.md index f0804a958..542f8a11d 100644 --- a/docs/issues/open/1669-overhaul-packages/EPIC.md +++ b/docs/issues/open/1669-overhaul-packages/EPIC.md @@ -94,12 +94,6 @@ The workspace currently contains **27 packages** (including the root `torrust-tr | No | `torrust-tracker-udp-tracker-protocol` | `udp-protocol` | | No | `torrust-tracker-udp-server` | `udp-server` | -### `bittorrent-` prefix - -| Published on crates.io | Crate Name | Folder | -| ---------------------- | -------------------- | --------- | -| No | `bittorrent-peer-id` | `peer-id` | - **Observation**: only 6 of 27 packages are currently published on crates.io, all of which carry the `torrust-tracker-` prefix. Every `bittorrent-` and `torrust-axum-` crate is unpublished. This confirms issue #1659's note that "many new crates have not been published @@ -233,7 +227,7 @@ Notes: 1. Will be replaced by the newer `contrib/bencode` code from tracker. 2. May be inlined into consumers rather than published independently. 3. Migrates newer tracker implementation and replaces old `packages/bencode`. -4. No workspace deps; first in the `bittorrent-*` extraction sequence. +4. **Completed June 2026**: `torrust-peer-id 0.1.0` published to crates.io from `torrust/torrust-bittorrent`. Tracker consumers migrated; `packages/peer-id` removed from tracker workspace. 5. Migrate `InfoHash` here; then archive `torrust/bittorrent-primitives`. The following crates remain in `torrust/torrust-tracker` for now: @@ -542,7 +536,7 @@ Status: TODO unless noted. - [x] [#1834](https://github.com/torrust/torrust-tracker/issues/1834) SI-13: Decouple `http-protocol` from `udp-protocol` _(Rule M; remove cross-protocol dependency edge)_ - [x] [#1835](https://github.com/torrust/torrust-tracker/issues/1835) SI-14: Decouple `http-protocol` from `torrust-tracker-primitives` _(Rule M; remove protocol -> domain coupling as step 2)_ - [ ] [#1882](https://github.com/torrust/torrust-tracker/issues/1882) SI-18: Extract `torrust-metrics` to standalone repository _(Rule E; requires completed metrics rename work)_ -- [ ] [#1884](https://github.com/torrust/torrust-tracker/issues/1884) SI-19: Move `bittorrent-peer-id` to `torrust/torrust-bittorrent` as `torrust-peer-id` _(Rule E; no workspace deps; first `bittorrent-*` extraction)_ +- [x] [#1884](https://github.com/torrust/torrust-tracker/issues/1884) SI-19: Move `bittorrent-peer-id` to `torrust/torrust-bittorrent` as `torrust-peer-id` _(Rule E; no workspace deps; first `bittorrent-*` extraction)_ - [ ] [#1885](https://github.com/torrust/torrust-tracker/issues/1885) SI-20: Extract `torrust-net-primitives` to standalone repository _(Rule E; no workspace deps; no prerequisites)_ #### 4. Other Tracked Items (Drafts and Promoted Issues) @@ -574,7 +568,7 @@ Details: | Located error rename | [#1823](https://github.com/torrust/torrust-tracker/issues/1823) — Rename `torrust-tracker-located-error` to `torrust-located-error` | [docs/issues/closed/1823-1669-10-rename-torrust-tracker-located-error-to-torrust-located-error.md](../../closed/1823-1669-10-rename-torrust-tracker-located-error-to-torrust-located-error.md) | DONE | Rule P; completed | | README refresh | #TBD — Update all package READMEs | [docs/issues/drafts/1669-update-all-package-readmes.md](../../drafts/1669-update-all-package-readmes.md) | TODO | Documentation; requires completed rename work; before extraction work | | Bencode migration | [#1881](https://github.com/torrust/torrust-tracker/issues/1881) SI-16: Migrate `contrib/bencode` to `torrust/torrust-bittorrent` as `torrust-bencode` | [docs/issues/closed/1881-1669-16-migrate-contrib-bencode-to-torrust-bittorrent/ISSUE.md](../../closed/1881-1669-16-migrate-contrib-bencode-to-torrust-bittorrent/ISSUE.md) | DONE | Rule E; torrust-bencode 3.0.0 published; contrib/bencode removed from tracker workspace | -| Peer-ID move | [#1884](https://github.com/torrust/torrust-tracker/issues/1884) — Move `bittorrent-peer-id` to `torrust/torrust-bittorrent` as `torrust-peer-id` | [docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md](../../open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md) | TODO | Rule E; no workspace deps in crate; 3 consumers to migrate; first `bittorrent-*` extraction sequence item | +| Peer-ID move | [#1884](https://github.com/torrust/torrust-tracker/issues/1884) — Move `bittorrent-peer-id` to `torrust/torrust-bittorrent` as `torrust-peer-id` | [docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md](../../open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md) | DONE | Rule E; published as torrust-peer-id 0.1.0 on crates.io; 3 tracker consumers migrated; packages/peer-id removed | | Clock extraction | [#1879](https://github.com/torrust/torrust-tracker/issues/1879) — Extract `torrust-clock` to standalone repository | [docs/issues/closed/1879-1669-17-extract-torrust-clock-to-standalone-repo.md](../../closed/1879-1669-17-extract-torrust-clock-to-standalone-repo.md) | DONE | Rule E; torrust-clock v3.0.0 published; 13 consumers migrated; packages/clock removed | | Metrics extraction | [#1882](https://github.com/torrust/torrust-tracker/issues/1882) — Extract `torrust-metrics` to standalone repository | [docs/issues/open/1882-1669-18-extract-torrust-metrics-to-standalone-repo.md](../../open/1882-1669-18-extract-torrust-metrics-to-standalone-repo.md) | TODO | Rule E; requires completed metrics rename; 7 workspace consumers to migrate | | Net-primitives extraction | [#1885](https://github.com/torrust/torrust-tracker/issues/1885) — Extract `torrust-net-primitives` to standalone repository | [docs/issues/open/1885-1669-20-extract-torrust-net-primitives-to-standalone-repo.md](../../open/1885-1669-20-extract-torrust-net-primitives-to-standalone-repo.md) | TODO | Rule E; no workspace deps; no prerequisites; 10 consumers to migrate; new repo torrust/torrust-net-primitives | diff --git a/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md b/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md index d534c3174..1f4030914 100644 --- a/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md +++ b/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md @@ -7,7 +7,7 @@ github-issue: 1884 spec-path: docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md branch: 1884-1669-move-bittorrent-peer-id-to-torrust-bittorrent related-pr: null -last-updated-utc: 2026-06-05 00:00 +last-updated-utc: 2026-06-08 00:00 semantic-links: skill-links: - create-issue @@ -94,23 +94,23 @@ This issue is a subissue of EPIC #1669 (Overhaul: Packages). Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`. -| ID | Status | Task | Notes / Expected Output | -| --- | ------ | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- | -| T1 | DONE | Rename `name` in `packages/peer-id/Cargo.toml` to `torrust-peer-id` | `name = "torrust-peer-id"` | -| T2 | DONE | Update `repository` URL in `packages/peer-id/Cargo.toml` and crate metadata | Point to `https://github.com/torrust/torrust-bittorrent` | -| T2b | DONE | Drop AGPL-3.0 `LICENSE` from the package; inherit Apache-2.0 from the destination workspace | `LICENSE` file removed; `license.workspace = true`; `LICENSE-APACHE` attribution kept | -| T3 | DONE | Confirm destination workspace `torrust/torrust-bittorrent` migration path | Target path agreed: `packages/peer-id` | -| T4 | DONE | Move/merge crate source into destination workspace, preserving history where practical | `packages/peer-id` added to `torrust/torrust-bittorrent` | -| T5 | DONE | Set up/adjust CI in destination repository if needed | CI green after migration | -| T6 | DONE | Publish `torrust-peer-id` on crates.io from destination repository | Successful `cargo publish`; crate visible at crates.io/crates/torrust-peer-id | -| T7 | DONE | Update `packages/http-protocol/Cargo.toml`: replace path dep with published `torrust-peer-id` | `torrust-peer-id = "0.1.0"` (no path) | -| T8 | DONE | Update `packages/primitives/Cargo.toml`: replace path dep with published `torrust-peer-id` | `torrust-peer-id = "0.1.0"` (no path) | -| T9 | DONE | Update `packages/udp-protocol/Cargo.toml`: replace path dep with published `torrust-peer-id` (keep `zerocopy` feature) | `torrust-peer-id = { version = "0.1.0", features = ["zerocopy"] }` (no path) | -| T10 | DONE | Remove `packages/peer-id/` from tracker workspace (`members` + workspace dep in `Cargo.toml`) | `cargo build --workspace` succeeds without the local crate | -| T11 | DONE | Delete `packages/peer-id/` directory from the tracker repo | Directory gone; workspace still builds | -| T12 | DONE | Update `packages/AGENTS.md`, `AGENTS.md`, `docs/packages.md`, and any README references | No stale references to `bittorrent-peer-id` | -| T13 | DONE | Run `cargo build --workspace`, `cargo test --workspace`, `linter all` | All green | -| T14 | TODO | Update EPIC #1669 `Package Inventory` and `Desired Package State` tables | Remove `bittorrent-peer-id` from tracker table; mark as extracted in bittorrent table | +| ID | Status | Task | Notes / Expected Output | +| --- | ------ | ---------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------- | +| T1 | DONE | Rename `name` in `packages/peer-id/Cargo.toml` to `torrust-peer-id` | `name = "torrust-peer-id"` | +| T2 | DONE | Update `repository` URL in `packages/peer-id/Cargo.toml` and crate metadata | Point to `https://github.com/torrust/torrust-bittorrent` | +| T2b | DONE | Drop AGPL-3.0 `LICENSE` from the package; inherit Apache-2.0 from the destination workspace | `LICENSE` file removed; `license.workspace = true`; `LICENSE-APACHE` attribution kept | +| T3 | DONE | Confirm destination workspace `torrust/torrust-bittorrent` migration path | Target path agreed: `packages/peer-id` | +| T4 | DONE | Move/merge crate source into destination workspace, preserving history where practical | `packages/peer-id` added to `torrust/torrust-bittorrent` | +| T5 | DONE | Set up/adjust CI in destination repository if needed | CI green after migration | +| T6 | DONE | Publish `torrust-peer-id` on crates.io from destination repository | Successful `cargo publish`; crate visible at crates.io/crates/torrust-peer-id | +| T7 | DONE | Update `packages/http-protocol/Cargo.toml`: replace path dep with published `torrust-peer-id` | `torrust-peer-id = "0.1.0"` (no path) | +| T8 | DONE | Update `packages/primitives/Cargo.toml`: replace path dep with published `torrust-peer-id` | `torrust-peer-id = "0.1.0"` (no path) | +| T9 | DONE | Update `packages/udp-protocol/Cargo.toml`: replace path dep with published `torrust-peer-id` (keep `zerocopy` feature) | `torrust-peer-id = { version = "0.1.0", features = ["zerocopy"] }` (no path) | +| T10 | DONE | Remove `packages/peer-id/` from tracker workspace (`members` + workspace dep in `Cargo.toml`) | `cargo build --workspace` succeeds without the local crate | +| T11 | DONE | Delete `packages/peer-id/` directory from the tracker repo | Directory gone; workspace still builds | +| T12 | DONE | Update `packages/AGENTS.md`, `AGENTS.md`, `docs/packages.md`, and any README references | No stale references to `bittorrent-peer-id` | +| T13 | DONE | Run `cargo build --workspace`, `cargo test --workspace`, `linter all` | All green | +| T14 | DONE | Update EPIC #1669 `Package Inventory` and `Desired Package State` tables | `bittorrent-` prefix section removed; Desired Package State table updated; Active Subissues marked DONE | ## Progress Tracking @@ -125,7 +125,7 @@ Status values: `TODO`, `IN_PROGRESS`, `BLOCKED`, `DONE`. - [x] Manual verification scenarios executed and recorded - [x] Acceptance criteria reviewed after implementation and updated with evidence - [x] `torrust-peer-id` published from `torrust/torrust-bittorrent` -- [ ] EPIC #1669 Active Subissues table updated to `DONE` +- [x] EPIC #1669 Active Subissues table updated to `DONE` - [ ] Issue closed and spec moved to `docs/issues/closed/` ### Progress Log From dac713b52d3cff3178e057f76036b82f87cd1fb7 Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Mon, 8 Jun 2026 12:44:02 +0100 Subject: [PATCH 5/7] docs: link PR #1887 in issue #1884 spec --- ...884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md b/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md index 1f4030914..c9b8ec008 100644 --- a/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md +++ b/docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md @@ -6,7 +6,7 @@ priority: p2 github-issue: 1884 spec-path: docs/issues/open/1884-1669-19-move-bittorrent-peer-id-to-torrust-bittorrent.md branch: 1884-1669-move-bittorrent-peer-id-to-torrust-bittorrent -related-pr: null +related-pr: https://github.com/torrust/torrust-tracker/pull/1887 last-updated-utc: 2026-06-08 00:00 semantic-links: skill-links: From f4cdfac367ae528cdc9ce5e1ad5e6668cec3154b Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Mon, 8 Jun 2026 13:28:13 +0100 Subject: [PATCH 6/7] refactor: restore deprecated peer_id module for backwards compatibility Address Copilot suggestion to maintain backwards compatibility when migrating to torrust-peer-id. Downstream code that imports torrust_tracker_primitives::peer_id::{PeerId, PeerClient} will continue to work with a deprecation warning, providing a smoother migration path until a planned major release removes this compatibility layer. Related-to: PR #1887 --- packages/primitives/src/lib.rs | 15 +++++++++++++++ packages/primitives/src/peer_id.rs | 13 +++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 packages/primitives/src/peer_id.rs diff --git a/packages/primitives/src/lib.rs b/packages/primitives/src/lib.rs index 788b6dae6..ae56e4477 100644 --- a/packages/primitives/src/lib.rs +++ b/packages/primitives/src/lib.rs @@ -9,6 +9,12 @@ pub mod mode; pub mod number_of_bytes; pub mod pagination; pub mod peer; +#[deprecated( + since = "3.0.0-develop", + note = "import peer ID types from `torrust_peer_id` crate instead; \ + this module will be removed in a future release (see EPIC #1669)" +)] +pub mod peer_id; pub mod policy; pub mod scrape; pub mod swarm_metadata; @@ -33,6 +39,15 @@ pub use scrape::ScrapeData; this re-export will be removed in a future release (see EPIC #1669)" )] pub use torrust_clock::DurationSinceUnixEpoch; +/// **Deprecated**: import from [`torrust_peer_id`] instead via the [`peer_id`] module. +/// This re-export is kept for backwards compatibility and will be removed in a +/// future release. Removal is tracked as a follow-up cleanup subissue of EPIC +/// [#1669](https://github.com/torrust/torrust-tracker/issues/1669). +#[deprecated( + since = "3.0.0-develop", + note = "import peer ID types from `torrust_peer_id` crate instead; \ + this re-export will be removed in a future release (see EPIC #1669)" +)] pub use torrust_peer_id::{PeerClient, PeerId}; /// Network service binding types. diff --git a/packages/primitives/src/peer_id.rs b/packages/primitives/src/peer_id.rs new file mode 100644 index 000000000..86c6d5726 --- /dev/null +++ b/packages/primitives/src/peer_id.rs @@ -0,0 +1,13 @@ +//! Peer ID types. +//! +//! **Deprecated**: import from [`torrust_peer_id`] instead. +//! This module is kept for backwards compatibility and will be removed in a +//! future release. Removal is tracked as a follow-up cleanup subissue of EPIC +//! [#1669](https://github.com/torrust/torrust-tracker/issues/1669). + +#[deprecated( + since = "3.0.0-develop", + note = "import peer ID types from `torrust_peer_id` crate instead; \ + this module will be removed in a future release (see EPIC #1669)" +)] +pub use torrust_peer_id::{PeerClient, PeerId}; From f0f651fcc654e0eb0bb26d148f3a8ae8a34540b5 Mon Sep 17 00:00:00 2001 From: Jose Celano Date: Mon, 8 Jun 2026 15:45:41 +0100 Subject: [PATCH 7/7] fix: remove peer-id references from Containerfile The packages/peer-id/ directory was deleted as part of the migration to the published torrust-peer-id crate, but the Containerfile still referenced the old path in three places: 1. COPY packages/peer-id/Cargo.toml 2. packages/peer-id/src in source copy section 3. packages/peer-id/src/lib.rs in license check Dropping these references fixes the Container (Docker) workflow failure. Related-to: PR #1887 --- Containerfile | 3 --- 1 file changed, 3 deletions(-) diff --git a/Containerfile b/Containerfile index ba4009f55..a54bf5e2d 100644 --- a/Containerfile +++ b/Containerfile @@ -78,7 +78,6 @@ COPY packages/http-tracker-core/Cargo.toml packages/http-tracker-core/ COPY packages/located-error/Cargo.toml packages/located-error/ COPY packages/metrics/Cargo.toml packages/metrics/ COPY packages/net-primitives/Cargo.toml packages/net-primitives/ -COPY packages/peer-id/Cargo.toml packages/peer-id/ COPY packages/primitives/Cargo.toml packages/primitives/ COPY packages/rest-api-client/Cargo.toml packages/rest-api-client/ COPY packages/rest-api-core/Cargo.toml packages/rest-api-core/ @@ -127,7 +126,6 @@ RUN mkdir -p \ packages/located-error/src \ packages/metrics/src \ packages/net-primitives/src \ - packages/peer-id/src \ packages/primitives/src \ packages/rest-api-client/src \ packages/rest-api-core/src \ @@ -170,7 +168,6 @@ RUN mkdir -p \ packages/located-error/src/lib.rs \ packages/metrics/src/lib.rs \ packages/net-primitives/src/lib.rs \ - packages/peer-id/src/lib.rs \ packages/primitives/src/lib.rs \ packages/rest-api-client/src/lib.rs \ packages/rest-api-core/src/lib.rs \