Skip to content

Commit

Permalink
chore: update the Rust readme (#4968)
Browse files Browse the repository at this point in the history
### Description

Mostly mentions the new Rust workspace split

### Drive-by changes

None

### Related issues

None

### Backward compatibility

Yes

### Testing

None
  • Loading branch information
daniel-savu authored Dec 9, 2024
1 parent 5e9b8ba commit 08cf6ac
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 8 deletions.
23 changes: 16 additions & 7 deletions rust/README.md
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
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

0 comments on commit 08cf6ac

Please sign in to comment.