diff --git a/Cargo.toml b/Cargo.toml index d13295e..33a345f 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -2,7 +2,7 @@ name = "electrum-client" version = "0.24.1" authors = ["Alekos Filini "] -license = "MIT" +license = "MIT OR Apache-2.0" homepage = "https://github.com/bitcoindevkit/rust-electrum-client" repository = "https://github.com/bitcoindevkit/rust-electrum-client" documentation = "https://docs.rs/electrum-client/" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 0000000..d9a10c0 --- /dev/null +++ b/LICENSE-APACHE @@ -0,0 +1,176 @@ + 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 diff --git a/LICENSE b/LICENSE-MIT similarity index 100% rename from LICENSE rename to LICENSE-MIT diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..93f3495 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,14 @@ +This software is licensed under [Apache 2.0](LICENSE-APACHE) or +[MIT](LICENSE-MIT), at your option. + +Some files retain their own copyright notice, however, for full authorship +information, see version control history. + +Except as otherwise noted in individual files, all files in this repository are +licensed under the Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or +) or the MIT license ([LICENSE-MIT](LICENSE-MIT) or +), at your option. + +You may not use, copy, modify, merge, publish, distribute, sublicense, and/or +sell copies of this software or any files in this repository except in +accordance with one or both of these licenses. diff --git a/README.md b/README.md index af483b9..6580838 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,31 @@ -# rust-electrum-client -[![Build Status]][GitHub Workflow] [![Latest Version]][crates.io] [![MSRV Badge]][Rust Blog] +# rust-electrum-client -[Build Status]: https://github.com/bitcoindevkit/rust-electrum-client/actions/workflows/cont_integration.yml/badge.svg -[GitHub Workflow]: https://github.com/bitcoindevkit/rust-electrum-client/actions?query=workflow%3ACI -[Latest Version]: https://img.shields.io/crates/v/electrum-client.svg -[crates.io]: https://crates.io/crates/electrum-client -[MSRV Badge]: https://img.shields.io/badge/rustc-1.75.0%2B-lightgrey.svg -[Rust Blog]: https://blog.rust-lang.org/2023/12/28/Rust-1.75.0.html +

+ + + + + +

Bitcoin Electrum client library. Supports plaintext, TLS and Onion servers. ## Minimum Supported Rust Version (MSRV) This library should compile with any combination of features with Rust 1.75.0. + +## License + +Licensed under either of + +* Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or ) +* MIT license ([LICENSE-MIT](LICENSE-MIT) or ) + +at your option. + +### Contribution + +Unless you explicitly state otherwise, any contribution intentionally +submitted for inclusion in the work by you, as defined in the Apache-2.0 +license, shall be dual licensed as above, without any additional terms or +conditions. diff --git a/examples/jwt_auth.rs b/examples/jwt_auth.rs index 9045fd8..1e928e0 100644 --- a/examples/jwt_auth.rs +++ b/examples/jwt_auth.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! # JWT Static Authentication with Electrum Client //! //! This example demonstrates how to use a static JWT_TOKEN authentication with the diff --git a/examples/jwt_dynamic_auth.rs b/examples/jwt_dynamic_auth.rs index 1fed314..ccbde63 100644 --- a/examples/jwt_dynamic_auth.rs +++ b/examples/jwt_dynamic_auth.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! # JWT Dynamic Authentication //! //! ## Advanced: Token Refresh with Keycloak diff --git a/examples/plaintext.rs b/examples/plaintext.rs index 68543e1..967fe8e 100644 --- a/examples/plaintext.rs +++ b/examples/plaintext.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + extern crate electrum_client; use electrum_client::{Client, ElectrumApi}; diff --git a/examples/ssl.rs b/examples/ssl.rs index 2c6d727..d63bde1 100644 --- a/examples/ssl.rs +++ b/examples/ssl.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + extern crate electrum_client; use electrum_client::{Client, ElectrumApi}; diff --git a/examples/tor.rs b/examples/tor.rs index b7bc1e8..43bd5c7 100644 --- a/examples/tor.rs +++ b/examples/tor.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + extern crate electrum_client; use electrum_client::{Client, ConfigBuilder, ElectrumApi, Socks5Config}; diff --git a/src/api.rs b/src/api.rs index 824e478..aa26da1 100644 --- a/src/api.rs +++ b/src/api.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! Electrum APIs use std::borrow::Borrow; diff --git a/src/batch.rs b/src/batch.rs index 83a67cd..b56129e 100644 --- a/src/batch.rs +++ b/src/batch.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! Batch utilities //! //! This module contains definitions and helper functions used when making batch calls. diff --git a/src/client.rs b/src/client.rs index 4f9e457..1f39417 100644 --- a/src/client.rs +++ b/src/client.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! Electrum Client use std::{borrow::Borrow, sync::RwLock}; diff --git a/src/config.rs b/src/config.rs index b3e6d7a..226ae22 100644 --- a/src/config.rs +++ b/src/config.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + use std::sync::Arc; use std::time::Duration; diff --git a/src/lib.rs b/src/lib.rs index 94ff0aa..bd65d39 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + #![warn(missing_docs)] //! This library provides an extendable Bitcoin-Electrum client that supports batch calls, diff --git a/src/raw_client.rs b/src/raw_client.rs index daa9fe6..0a7a3ff 100644 --- a/src/raw_client.rs +++ b/src/raw_client.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! Raw client //! //! This module contains the definition of the raw client that wraps the transport method diff --git a/src/socks/mod.rs b/src/socks/mod.rs index 2767b9d..6257986 100644 --- a/src/socks/mod.rs +++ b/src/socks/mod.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! SOCKS proxy clients use std::io; diff --git a/src/socks/v4.rs b/src/socks/v4.rs index b4e999d..00fbbeb 100644 --- a/src/socks/v4.rs +++ b/src/socks/v4.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt}; use std::io::{self, Read, Write}; use std::net::{Ipv4Addr, SocketAddr, SocketAddrV4, SocketAddrV6, TcpStream, ToSocketAddrs}; diff --git a/src/socks/v5.rs b/src/socks/v5.rs index 6b06e8f..c28eda9 100644 --- a/src/socks/v5.rs +++ b/src/socks/v5.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt}; use std::cmp; use std::io::{self, Read, Write}; diff --git a/src/socks/writev.rs b/src/socks/writev.rs index 67c64f8..34324e6 100644 --- a/src/socks/writev.rs +++ b/src/socks/writev.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + use std::io; use std::net::UdpSocket; diff --git a/src/stream.rs b/src/stream.rs index 1ee29ff..46310c6 100644 --- a/src/stream.rs +++ b/src/stream.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + use log::error; use std::io::{self, Read, Write}; use std::sync::{Arc, Mutex}; diff --git a/src/types.rs b/src/types.rs index d8352be..68e3d36 100644 --- a/src/types.rs +++ b/src/types.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! Return types //! //! This module contains definitions of all the complex data structures that are returned by calls diff --git a/src/utils.rs b/src/utils.rs index bcc3450..bacf9cc 100644 --- a/src/utils.rs +++ b/src/utils.rs @@ -1,3 +1,5 @@ +// SPDX-License-Identifier: MIT OR Apache-2.0 + //! Utilities helping to handle Electrum-related data. use crate::types::GetMerkleRes;