Skip to content

Repository files navigation

Seismic Alloy Core

This repository contains Seismic's fork of alloy-core

The upstream repository lives here. This fork is up-to-date with it through commit c268e8d. You can see this by viewing the main branch on this repository

You can view all of our changes vs. upstream on this pull request. The sole purpose of this PR is display our diff; it will never be merged in to the main branch of this repo

Main Changes

The repository was forked to support Seismic's modifications to Solidity. Seismic introduces new types that represent shielded state in smart contracts.

New Shielded Types

These shielded types include:

  • saddress
  • suint and the suint{n} family
  • sint and the sint{n} family
  • sbool

Each of these types behaves similarly to its unshielded counterpart, with one key exception: the values are hidden from the state tree.

Structure

Seismic's forks of the reth stack all have the same branch structure:

  • main or master: this branch only consists of commits from the upstream repository. However it will rarely be up-to-date with upstream. The latest commit from this branch reflects how recently Seismic has merged in upstream commits to the seismic branch
  • seismic: the default and production branch for these repositories. This includes all Seismic-specific code essential to make our network run

Overview

This repository contains the following crates:

Supported Rust Versions (MSRV)

The current MSRV (minimum supported rust version) is 1.85.

Alloy will keep a rolling MSRV policy of at least two versions behind the latest stable release (so if the latest stable release is 1.58, we would support 1.56).

Note that the MSRV is not increased automatically, and only as part of a patch (pre-1.0) or minor (post-1.0) release.

Contributing

Thanks for your help improving the project! We are so happy to have you! We have a contributing guide to help you get involved in the Alloy project.

Pull requests will not be merged unless CI passes, so please ensure that your contribution follows the linting rules and passes clippy.

WASM support

We provide full support for all the wasm*-* targets. If a crate does not build on a WASM target, please open an issue.

When building for the wasm32-unknown-unknown target and the "getrandom" feature is enabled, compilation for the getrandom crate will fail. This is expected: see their documentation for more details.

To fix this, either disable the "getrandom" feature on alloy-core or add getrandom to your dependencies with the "wasm_js" feature enabled:

getrandom = { version = "0.3", features = ["wasm_js"] }

There is currently no plan to provide an official JS/TS-accessible library interface, as we believe viem or ethers.js serve that need very well.

Note on no_std

All crates in this workspace should support no_std environments, with the alloc crate. If you find a crate that does not support no_std, please open an issue.

Credits

None of these crates would have been possible without the great work done in:

License

Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in these crates by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

About

Seismic's fork of alloy-rs/core: High-performance, well-tested & documented core libraries for Ethereum, in Rust

Resources

Contributing

Security policy

Stars

1 star

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages