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.

Sign up for GitHub

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: update the Rust readme #4968

Merged
merged 2 commits into from
Dec 9, 2024
Merged

chore: update the Rust readme #4968

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
dd90922
chore: update the Rust readme
daniel-savu Dec 9, 2024
5e07a4e
fix: codespell
daniel-savu Dec 9, 2024
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
23 changes: 16 additions & 7 deletions rust/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ info: This is the version for the rustup toolchain manager, not the rustc compil
info: The currently active `rustc` version is `rustc 1.72.1 (d5c2e9c34 2023-09-13)`
```

### Overview of Rust Workspaces

There are two Rust workspaces in this directory:

- [main](https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/main/rust/main): The offchain agents workspace, most notably comprised of the relayer, validator, scraper and the Rust end-to-end tests (in `utils/run-locally`)
- [sealevel](https://github.com/hyperlane-xyz/hyperlane-monorepo/tree/main/rust/sealevel): Hyperlane smart contracts and tooling for the SVM, implemented in native Rust.

You can only run `cargo build` after `cd`-ing into one of these workspaces.

#### Apple Silicon

If your device has an Apple Silicon processor, you may need to install Rosetta 2:
Expand All @@ -23,7 +32,9 @@ If your device has an Apple Silicon processor, you may need to install Rosetta 2
softwareupdate --install-rosetta --agree-to-license
```

### Running Locally
### Running Agents Locally

Make sure you're in the `main` workspace.

To run the validator, run:

Expand Down Expand Up @@ -174,7 +185,7 @@ For Ethereum and Celo connections we use
We use the tokio async runtime environment. Please see the docs
[here](https://docs.rs/tokio/1.1.0/tokio/).

### Repo layout
### `main` workspace layout

- `hyperlane-base`
- lowest dependency hyperlane utilities
Expand All @@ -190,11 +201,9 @@ We use the tokio async runtime environment. Please see the docs
- traits (interfaces) for the on-chain contracts
- model implementations of the contracts in rust
- merkle tree implementations (for provers)
- `chains/hyperlane-ethereum`
- `chains/hyperlane-*`
- VM-specific integration of the agents
- depends on hyperlane-core (and transitively hyperlane-base)
- interfaces to the ethereum contracts
- `chains/hyperlane-fuel`
- depends on hyperlane-core
- interfaces to the fuel contracts
- interfaces with the contracts of that VM (e.g `ethereum`, `sealevel`, `cosmos`, `fuel`, etc)
- `agents`
- each of the off-chain agents implemented thus far
2 changes: 1 addition & 1 deletion typescript/sdk/CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
- 24784af95: Introduce GcpValidator for retrieving announcements, checkpoints and metadata for a Validator posting to a GCP bucket. Uses GcpStorageWrapper for bucket operations.
- 3e8dd70ac: Update validators for boba, duckchain, unichain, vana, bsquared, superseed. Update oort's own validator. Update blockpi's viction validator. Adad luganodes/dsrv to flame validator set.
- aa1ea9a48: updates the warp deployment config schema to be closer to the ica routing schema
- f0b98fdef: Updated the derivation logic to enable ICA ISM metdata building from on chain data to enable self relaying of ICA messages
- f0b98fdef: Updated the derivation logic to enable ICA ISM metadata building from on chain data to enable self relaying of ICA messages
- ff9e8a72b: Added a getter to derive ATA payer accounts on Sealevel warp routes
- 97c1f80b7: Implement Sealevel IGP quoting
- 323f0f158: Add ICAs management in core apply command
Expand Down
Loading