diff --git a/AGENTS.md b/AGENTS.md index e82f61c2..2d92ba75 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -2,7 +2,7 @@ ## Scope -This document applies to work in `charon-rs/` (the Rust workspace, aka Pluto). +This document applies to work in `pluto/` (the Rust workspace, aka Pluto). The Go codebase is used only as a behavioral reference. ## Project Structure @@ -10,7 +10,7 @@ The Go codebase is used only as a behavioral reference. Workspace layout (high level): ```text -charon-rs/ +pluto/ Cargo.toml # Workspace members, shared deps, lints crates/ # Workspace crates (Rust source lives here) app/ # Application crate @@ -178,10 +178,10 @@ mod tests { Environment: -- Recommended dev setup: `nix develop` (see `charon-rs/CONTRIBUTING.md`). -- Rust toolchain is pinned in `charon-rs/rust-toolchain.toml`. +- Recommended dev setup: `nix develop` (see `pluto/CONTRIBUTING.md`). +- Rust toolchain is pinned in `pluto/rust-toolchain.toml`. -Commands (run from `charon-rs/`): +Commands (run from `pluto/`): ```bash cargo fmt --all --check @@ -219,7 +219,7 @@ Findings format (use `path:line` references, 1-based): ```text - [Severity] Title Impact: ... - Evidence: charon-rs/crates/foo/src/lib.rs:123 + Evidence: pluto/crates/foo/src/lib.rs:123 Go reference: charon/cmd/foo.go:456 Recommendation: ... ``` diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2b0c957c..a397544d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,8 +19,8 @@ If you prefer not to use Nix, install the following manually: * [Rust](https://www.rust-lang.org/tools/install) * [Protobuf](https://protobuf.dev/installation/) * [Docker](https://www.docker.com/) -* [cargo-deny](https://github.com/EmbarkStudios/cargo-deny) - `cargo install --locked cargo-deny` -* [oas3-gen](https://github.com/eklipse2k8/oas3-gen) - `cargo install oas3-gen` +* [cargo-deny](https://github.com/EmbarkStudios/cargo-deny) - `cargo install cargo-deny@0.19.0` +* [oas3-gen](https://github.com/eklipse2k8/oas3-gen) - `cargo install oas3-gen@0.24.0` Then install the pre-push git hook: diff --git a/Cargo.toml b/Cargo.toml index 34b514cc..2a6eee3d 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -22,7 +22,7 @@ resolver = "3" [workspace.package] version = "1.7.1" edition = "2024" -repository = "https://github.com/NethermindEth/charon-rs" +repository = "https://github.com/NethermindEth/pluto" license = "Apache-2.0" publish = false @@ -74,7 +74,7 @@ k256 = { version = "0.13.4", features = ["ecdsa", "sha256"] } tracing = "0.1.32" tracing-subscriber = { version = "0.3.9", features = ["env-filter"] } tracing-loki = "0.2.6" -# todo: remove this once vise is published https://github.com/NethermindEth/charon-rs/issues/126 +# todo: remove this once vise is published https://github.com/NethermindEth/pluto/issues/126 vise = { git = "https://github.com/matter-labs/vise", rev = "73c654303d8190023cf30034d627b74cf3101b23" } vise-exporter = { git = "https://github.com/matter-labs/vise", rev = "73c654303d8190023cf30034d627b74cf3101b23" } criterion = "0.8.0" diff --git a/README.md b/README.md index f19e0252..255a0590 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,9 @@ # Pluto -[![Docs](https://github.com/NethermindEth/charon-rs/actions/workflows/docs.yml/badge.svg)](https://github.com/NethermindEth/charon-rs/actions/workflows/docs.yml) -[![Lint](https://github.com/NethermindEth/charon-rs/actions/workflows/linter.yml/badge.svg)](https://github.com/NethermindEth/charon-rs/actions/workflows/linter.yml) -[![Build](https://github.com/NethermindEth/charon-rs/actions/workflows/test.yml/badge.svg)](https://github.com/NethermindEth/charon-rs/actions/workflows/test.yml) -[![Dependencies](https://github.com/NethermindEth/charon-rs/actions/workflows/dependency-audit.yml/badge.svg)](https://github.com/NethermindEth/charon-rs/actions/workflows/dependency-audit.yml) -![Coverage](https://github.com/NethermindEth/charon-rs/wiki/coverage.svg) +[![Docs](https://github.com/NethermindEth/pluto/actions/workflows/docs.yml/badge.svg)](https://github.com/NethermindEth/pluto/actions/workflows/docs.yml) +[![Lint](https://github.com/NethermindEth/pluto/actions/workflows/linter.yml/badge.svg)](https://github.com/NethermindEth/pluto/actions/workflows/linter.yml) +[![Build](https://github.com/NethermindEth/pluto/actions/workflows/test.yml/badge.svg)](https://github.com/NethermindEth/pluto/actions/workflows/test.yml) +[![Dependencies](https://github.com/NethermindEth/pluto/actions/workflows/dependency-audit.yml/badge.svg)](https://github.com/NethermindEth/pluto/actions/workflows/dependency-audit.yml) +![Coverage](https://github.com/NethermindEth/pluto/wiki/coverage.svg) ![Rust](https://img.shields.io/badge/rust-1.89-orange.svg) [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) @@ -37,9 +37,11 @@ The `charon dkg` subcommand **is more restrictive** than this general compatibil Examples are located in crate-specific example folders: -- [P2P](crates/charon-p2p/examples/metrics.rs) -- [Peerinfo](crates/peerinfo/examples/peerinfo.rs) - [Relay Server](crates/relay-server/examples/relay_server.rs) +- [Peerinfo](crates/peerinfo/examples/peerinfo.rs) +- [P2P](crates/p2p/examples/p2p.rs) +- [Quic Upgrade](crates/p2p/examples/quic_upgrade.rs) +- [Metrics](crates/p2p/examples/metrics.rs) - [Tracing](crates/tracing/examples/basic.rs) ## License diff --git a/SECURITY.md b/SECURITY.md index 36153ad0..8b4a2dc9 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -7,7 +7,7 @@ We ask you to please not publicly disclose any details of the vulnerability unti **Please do not report security vulnerabilities through public GitHub issues.** -Instead, please use GitHub's [report vulnerability](https://github.com/NethermindEth/charon-rs/security/advisories/new) tool to create a draft advisory. +Instead, please use GitHub's [report vulnerability](https://github.com/NethermindEth/pluto/security/advisories/new) tool to create a draft advisory. Please include as much information as you can provide (listed below) to help us better understand the nature and scope of the possible issue: * Type of issue. @@ -25,4 +25,4 @@ But if you have not received an answer after a couple of days, please follow up ## Fixes We will release fixes for verified security vulnerabilities. -We expect to publish vulnerabilities using GitHub [security advisories](https://github.com/NethermindEth/charon-rs/security/advisories). +We expect to publish vulnerabilities using GitHub [security advisories](https://github.com/NethermindEth/pluto/security/advisories).