Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: hilo #108

Merged
merged 2 commits into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/no_std.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ jobs:
timeout-minutes: 30
strategy:
matrix:
package: ["super-registry"]
package: ["hilo-registry"]
name: check no_std ${{ matrix.features }} ${{ matrix.package }}
steps:
- uses: actions/checkout@v4
Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before working with this repository locally, you'll need to install the followin

## Pull Request Process

1. Before anything, [create an issue](https://github.com/anton-rs/superchain/issues/new) to discuss the change you're
1. Before anything, [create an issue](https://github.com/anton-rs/hilo/issues/new) to discuss the change you're
wanting to make, if it is significant or changes functionality. Feel free to skip this step for trivial changes.
1. Once your change is implemented, ensure that all checks are passing before creating a PR. The full CI pipeline can
be run locally via the `justfile`s in the repository.
Expand Down
160 changes: 80 additions & 80 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

15 changes: 7 additions & 8 deletions Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@ edition = "2021"
license = "MIT"
rust-version = "1.81"
authors = ["clabby", "refcell"]
homepage = "https://github.com/anton-rs/superchain"
repository = "https://github.com/anton-rs/superchain"
homepage = "https://github.com/anton-rs/hilo"
repository = "https://github.com/anton-rs/hilo"
keywords = ["ethereum", "optimism", "crypto"]
categories = ["cryptography", "cryptography::cryptocurrencies"]
exclude = ["benches/", "tests/"]
Expand Down Expand Up @@ -38,12 +38,11 @@ rustdoc-args = ["--cfg", "docsrs"]

[workspace.dependencies]
# Workspace
super = { version = "0.11.0", path = "crates/super", default-features = false }
super-net = { version = "0.11.0", path = "crates/net", default-features = false }
super-driver = { version = "0.11.0", path = "crates/driver", default-features = false }
super-derive = { version = "0.11.0", path = "crates/derive", default-features = false }
superchain = { version = "0.11.0", path = "crates/superchain", default-features = false }
super-registry = { version = "0.11.0", path = "crates/registry", default-features = false }
hilo = { version = "0.11.0", path = "crates/hilo", default-features = false }
hilo-net = { version = "0.11.0", path = "crates/net", default-features = false }
hilo-driver = { version = "0.11.0", path = "crates/driver", default-features = false }
hilo-derive = { version = "0.11.0", path = "crates/derive", default-features = false }
hilo-registry = { version = "0.11.0", path = "crates/registry", default-features = false }

# Kona
kona-derive = { version = "0.0.6", default-features = false }
Expand Down
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<h1 align="center">
<img src="./crates/registry/assets/banner.png" alt="superchain" width="100%" align="center">
<img src="./crates/registry/assets/banner.png" alt="hilo" width="100%" align="center">
</h1>

<h4 align="center">
A suite of `std` components for the superchain.
</h4>

<p align="center">
<a href="https://github.com/anton-rs/super/actions/workflows/rust_ci.yaml"><img src="https://github.com/anton-rs/super/actions/workflows/rust_ci.yaml/badge.svg?label=ci" alt="CI"></a>
<a href="https://github.com/anton-rs/super/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
<a href="https://anton-rs.github.io/super"><img src="https://img.shields.io/badge/Contributor%20Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
<a href="https://img.shields.io/codecov/c/github/anton-rs/super"><img src="https://img.shields.io/codecov/c/github/anton-rs/super" alt="Codecov"></a>
<a href="https://github.com/anton-rs/hilo/actions/workflows/rust_ci.yaml"><img src="https://github.com/anton-rs/hilo/actions/workflows/rust_ci.yaml/badge.svg?label=ci" alt="CI"></a>
<a href="https://github.com/anton-rs/hilo/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
<a href="https://anton-rs.github.io/hilo"><img src="https://img.shields.io/badge/Contributor%20Book-854a15?logo=mdBook&labelColor=2a2f35" alt="Book"></a>
<a href="https://img.shields.io/codecov/c/github/anton-rs/hilo"><img src="https://img.shields.io/codecov/c/github/anton-rs/hilo" alt="Codecov"></a>
</p>

<p align="center">
Expand All @@ -23,14 +23,14 @@

## Overview

`super` is a suite of portable, modular `std` OP Stack components.
`hilo` is a suite of portable, modular `std` OP Stack components.

[bin/](./bin/) provides a host of binary applications that compose [crates](./crates/).


## Development Status

`super` is currently in active development, and is not yet ready for use in production.
`hilo` is currently in active development, and is not yet ready for use in production.


## Security
Expand Down
4 changes: 2 additions & 2 deletions bin/hera/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,8 @@ rust-version.workspace = true

[dependencies]
# Local
super-net.workspace = true
superchain = { workspace = true, features = ["registry"] }
hilo-net.workspace = true
hilo = { workspace = true, features = ["registry"] }

# Workspace
eyre.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion bin/hera/src/disc.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
use crate::globals::GlobalArgs;
use clap::Args;
use eyre::Result;
use hilo_net::discovery::builder::DiscoveryBuilder;
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use super_net::discovery::builder::DiscoveryBuilder;

/// The Hera discovery subcommand.
#[derive(Debug, Clone, Args)]
Expand Down
4 changes: 2 additions & 2 deletions bin/hera/src/gossip.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,9 @@
use crate::globals::GlobalArgs;
use clap::Args;
use eyre::Result;
use hilo::registry::ROLLUP_CONFIGS;
use hilo_net::driver::NetworkDriver;
use std::net::{IpAddr, Ipv4Addr, SocketAddr};
use super_net::driver::NetworkDriver;
use superchain::registry::ROLLUP_CONFIGS;

/// The Hera gossip subcommand.
#[derive(Debug, Clone, Args)]
Expand Down
2 changes: 1 addition & 1 deletion bin/hera/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#![doc = include_str!("../README.md")]
#![doc(issue_tracker_base_url = "https://github.com/anton-rs/super/issues/")]
#![doc(issue_tracker_base_url = "https://github.com/anton-rs/hilo/issues/")]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]

Expand Down
4 changes: 2 additions & 2 deletions cliff.toml
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
# https://tera.netlify.app/docs/#introduction
body = """
{% if version %}\
## [{{ version | trim_start_matches(pat="v") }}](https://github.com/anton-rs/superchain
## [{{ version | trim_start_matches(pat="v") }}](https://github.com/anton-rs/hilo
/releases/tag/v{{ version | trim_start_matches(pat="v") }}) - {{ timestamp | date(format="%Y-%m-%d") }}
{% endif %}\
{% for group, commits in commits | group_by(attribute="group") %}
Expand All @@ -30,7 +30,7 @@ footer = "<!-- generated by git-cliff -->"
conventional_commits = true
filter_unconventional = false
commit_preprocessors = [
{ pattern = '#(\d+)', replace = "[#$1](https://github.com/anton-rs/superchain/issues/$1)" },
{ pattern = '#(\d+)', replace = "[#$1](https://github.com/anton-rs/hilo/issues/$1)" },
]
commit_parsers = [
{ message = "^[Ff]eat", group = "Features" },
Expand Down
2 changes: 1 addition & 1 deletion crates/derive/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "super-derive"
name = "hilo-derive"
description = "An alloy-backed derivation pipeline for the OP Stack, built on `kona-derive`"

version.workspace = true
Expand Down
10 changes: 5 additions & 5 deletions crates/derive/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
## `super-derive`

<a href="https://github.com/anton-rs/super/actions/workflows/rust_ci.yaml"><img src="https://github.com/anton-rs/super/actions/workflows/rust_ci.yaml/badge.svg?label=ci" alt="CI"></a>
<a href="https://crates.io/crates/super-derive"><img src="https://img.shields.io/crates/v/super-derive.svg?label=super-derive&labelColor=2a2f35" alt="Kona Derive Alloy"></a>
<a href="https://github.com/anton-rs/super/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
<a href="https://img.shields.io/codecov/c/github/anton-rs/super"><img src="https://img.shields.io/codecov/c/github/anton-rs/super" alt="Codecov"></a>
<a href="https://github.com/anton-rs/hilo/actions/workflows/rust_ci.yaml"><img src="https://github.com/anton-rs/hilo/actions/workflows/rust_ci.yaml/badge.svg?label=ci" alt="CI"></a>
<a href="https://crates.io/crates/hilo-derive"><img src="https://img.shields.io/crates/v/hilo-derive.svg?label=hilo-derive&labelColor=2a2f35" alt="Kona Derive Alloy"></a>
<a href="https://github.com/anton-rs/hilo/blob/main/LICENSE.md"><img src="https://img.shields.io/badge/License-MIT-d1d1f6.svg?label=license&labelColor=2a2f35" alt="License"></a>
<a href="https://img.shields.io/codecov/c/github/anton-rs/hilo"><img src="https://img.shields.io/codecov/c/github/anton-rs/hilo" alt="Codecov"></a>

_Notice: Requires an `std` environment._

Expand All @@ -16,7 +16,7 @@ backed by [alloy][a] providers is to use the exported `new_online_pipeline` meth

```rust
use std::sync::Arc;
use super_derive::prelude::*;
use hilo_derive::prelude::*;
use op_alloy_protocol::BlockInfo;
use op_alloy_genesis::RollupConfig;

Expand Down
4 changes: 2 additions & 2 deletions crates/derive/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#![doc = include_str!("../README.md")]
#![doc(
html_logo_url = "https://raw.githubusercontent.com/anton-rs/superchain/main/assets/square.png",
html_favicon_url = "https://raw.githubusercontent.com/anton-rs/superchain/main/assets/favicon.ico"
html_logo_url = "https://raw.githubusercontent.com/anton-rs/hilo/main/assets/square.png",
html_favicon_url = "https://raw.githubusercontent.com/anton-rs/hilo/main/assets/favicon.ico"
)]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]
Expand Down
2 changes: 1 addition & 1 deletion crates/driver/Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[package]
name = "super-driver"
name = "hilo-driver"
description = "Derivation driver for the OP Stack"

version.workspace = true
Expand Down
2 changes: 1 addition & 1 deletion crates/driver/README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# `super-driver`
# `hilo-driver`

A driver implementation for Kona's derivation pipeline that extends `kona-driver`.
2 changes: 1 addition & 1 deletion crates/driver/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
#![doc = include_str!("../README.md")]
#![doc(issue_tracker_base_url = "https://github.com/anton-rs/super/issues/")]
#![doc(issue_tracker_base_url = "https://github.com/anton-rs/hilo/issues/")]
#![cfg_attr(docsrs, feature(doc_cfg, doc_auto_cfg))]
#![cfg_attr(not(test), warn(unused_crate_dependencies))]

Expand Down
Loading