diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..f11c2f5b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,41 @@ +# Contributing to signet-sdk + +:balloon: Thanks for your help improving the project! We are so happy to have +you! + +## Conduct + +This repo adheres to the [Rust Code of Conduct][coc]. This describes +the _minimum_ behavior expected from all contributors. Failure to maintain civil +behavior will result in a ban. + +[coc]: https://www.rust-lang.org/policies/code-of-conduct + +## Pull Requests + +Before making a large change, it is usually a good idea to first open an issue +describing the change to solicit feedback and guidance. This will increase the +likelihood of the PR getting merged. + +When opening a PR **please select the "Allow Edits From Maintainers" option**. +We maintain code quality and style standards, and require commit signing. This +option allows us to make small changes to your PR to bring it in line with +these standards. It helps us get your PR in faster, and with less work from you. + +## Development Basics + +Before submitting a PR we recommend you run the following commands to ensure +your code is properly formatted and passes all tests: + +```sh +cargo +nightly fmt --all +cargo clippy --all-features +cargo test --all-features +cargo test --no-default-features +``` + +### Spelling, grammar, and other trivial changes + +At this time, we will not be accepting contributions that only fix spelling or +grammatical errors in documentation, code or +elsewhere. diff --git a/Cargo.toml b/Cargo.toml index b866bc22..478d26ec 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -53,22 +53,22 @@ alloy = { version = "=0.11.1", features = ["full", "rpc-types-mev", "genesis", " alloy-contract = { version = "=0.11.1", features = ["pubsub"] } # Reth -reth = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-chainspec = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-db = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-db-common = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-eth-wire-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-evm-ethereum = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-exex = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-exex-test-utils = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-network-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-network-peers = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-node-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-node-ethereum = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-prune-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-rpc-eth-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-transaction-pool = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } -reth-trie-db = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.0" } +reth = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-chainspec = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-db = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-db-common = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-eth-wire-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-evm-ethereum = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-exex = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-exex-test-utils = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-network-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-network-peers = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-node-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-node-ethereum = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-prune-types = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-rpc-eth-api = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-transaction-pool = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } +reth-trie-db = { git = "https://github.com/paradigmxyz/reth", tag = "v1.2.2" } # Foundry periphery foundry-blob-explorers = "0.10" @@ -104,10 +104,9 @@ hex = { package = "const-hex", version = "1.10", default-features = false, featu ] } # pinned for compatibility with reth -enr = { version = "=0.12.1", default-features = false, features = [ - "k256", - "rust-secp256k1", -] } +# TODO: +# https://linear.app/initiates/issue/ENG-947/remove-hickory-resolver-dep-spec +hickory-resolver = "=0.25.0-alpha.4" # Test Utils alloy-rlp = "0.3.11" diff --git a/LICENSE-APACHE b/LICENSE-APACHE new file mode 100644 index 00000000..1b5ec8b7 --- /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-MIT b/LICENSE-MIT new file mode 100644 index 00000000..31aa7938 --- /dev/null +++ b/LICENSE-MIT @@ -0,0 +1,23 @@ +Permission is hereby granted, free of charge, to any +person obtaining a copy of this software and associated +documentation files (the "Software"), to deal in the +Software without restriction, including without +limitation the rights to use, copy, modify, merge, +publish, distribute, sublicense, and/or sell copies of +the Software, and to permit persons to whom the Software +is furnished to do so, subject to the following +conditions: + +The above copyright notice and this permission notice +shall be included in all copies or substantial portions +of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF +ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED +TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A +PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT +SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY +CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION +OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR +IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. diff --git a/README.md b/README.md index 4fdbc23d..3ad2a018 100644 --- a/README.md +++ b/README.md @@ -3,19 +3,62 @@ A collection of libraries and tools implementing core logic for [Signet]. -Signet is a pragmatic Ethereum rollup. See the [Signet docs] for more info. +### What's new in Signet? -## Libraries +Signet is a pragmatic Ethereum rollup that offers a new set of ideas and aims +to radically modernize rollup technology. -- signet-zenith - Zenith contract bindings and related types. -- signet-types - Common types and utilities for Signet. -- signet-extract - Extracts Signet blocks from an Ethereum block. -- signet-evm - A wrapper around [trevm] that implements a Signet-specific order - detector and block-execution logic. -- signet-bundle - Flashbots-like bundle types and bundle simulation logic. -- signet-rpc - An Ethereum JSON-RPC Server for Signet nodes. Makes heavy use of - reth internals. +- No proving systems or state roots, drastically reducing computational + overhead. +- Market-based cross-chain transfers for instant asset movement. +- A controlled block inclusion mechanism to combat block construction + centralization. +- Conditional transactions for secure, atomic cross-chain operations. + +Signet extends the EVM, and is compatible with all existing Ethereum tooling. +Using Signet does not require smart contract modifications, or Signet-specific +knowledge. Signet does not have a native token. + +Signet is just a rollup. + +See the [Signet docs] for more info. + +### What's in the SDK? + +- **signet-zenith** - [Zenith] contract bindings and related types. +- **signet-types** - Common types and utilities for Signet. +- **signet-extract** - Extracts Signet blocks from an Ethereum block. Also + includes test utilities for specifying host and rollup blocks. +- **signet-evm** - A wrapper around [trevm] that implements a Signet-specific + revm inspector for detecting orders, and Signet's block-execution logic. +- **signet-bundle** - Types and utilities for simulating bundles of Signet + transactions, and determining what fills would be required to include them. +- **signet-rpc** - An Ethereum JSON-RPC Server for Signet nodes. Makes heavy + use of reth internals. + +### Contributing to the SDK + +Please see [CONTRIBUTING.md](CONTRIBUTING.md). + +### Note on Stability + +For most users, we recommend depending on `main` for the most up-to-date +version of the SDK. You can do this by adding lines like the following to your +`Cargo.toml`: + +```toml +signet-types = { git = "https://github.com/init4tech/signet-sdk/" branch = "main"} +``` + +We intend to publish these crates, however, due to dependencies on unpublished +reth crates, we are currently unable to do so. We will be tagging release +versions and adhering to semver as well as possible. However, our dependence on +unstable reth APIs may result in regular breaking changes that do not adhere to +semver. We will do our best to minimize these changes. Reth also suffers +semi-frequent dependency rot, and as a result we cannot guarantee that +any given tagged versions of this crate will build without modification. [Signet]: https://signet.sh [trevm]: https://docs.rs/trevm/latest/trevm/ [Signet docs]: https://docs.signet.sh +[Zenith]: https://github.com/init4tech/zenith diff --git a/crates/evm/Cargo.toml b/crates/evm/Cargo.toml index 3a912474..2c3bb930 100644 --- a/crates/evm/Cargo.toml +++ b/crates/evm/Cargo.toml @@ -18,6 +18,11 @@ signet-zenith.workspace = true alloy.workspace = true reth.workspace = true +# pinned for reth-compat +# TODO: +# https://linear.app/initiates/issue/ENG-947/remove-hickory-resolver-dep-spec +hickory-resolver.workspace = true + thiserror.workspace = true tracing.workspace = true diff --git a/crates/evm/src/lib.rs b/crates/evm/src/lib.rs index 61469141..174f93ad 100644 --- a/crates/evm/src/lib.rs +++ b/crates/evm/src/lib.rs @@ -88,3 +88,6 @@ pub mod test_utils { trevm } } + +// TODO: https://linear.app/initiates/issue/ENG-947/remove-hickory-resolver-dep-spec +use hickory_resolver as _;