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

Docs: update benchmark command and update crate links #796

Merged
merged 2 commits into from
Jan 15, 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
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ You can run `arbiter init <simulation_name> --no-git` to remove the `.git` direc


### Bindings
You can load or write your own smart contracts in the templates `contracts/` directory and begin writing your own simulations.

You can load or write your own smart contracts in the `arbiter-bindings/contracts/` directory and begin writing your own simulations.
Arbiter treats Rust smart-contract bindings as first-class citizens. The contract bindings are generated via Foundry's `forge` command.
`arbiter bind` wraps `forge` with some convenience features that will generate all your bindings to src/bindings as a rust module.
[Foundry](https://github.com/foundry-rs/foundry) power-users are welcome to use `forge` directly.
Expand Down Expand Up @@ -124,9 +125,10 @@ You can run `arbiter init <simulation_name> --no-git` to remove the `.git` direc
## Documentation

To see the documentation for the Arbiter crates, please visit the following:
- [`arbiter`](https://docs.rs/crate/arbiter/0.3.2/)
- [`arbiter-core`](https://docs.rs/arbiter-core/0.5.1/arbiter_core/)
- [`arbiter-derive`](https://docs.rs/arbiter-derive/0.1.0/arbiter_derive/)
- [`arbiter`](https://docs.rs/crate/arbiter/)
- [`arbiter-bindings`](https://docs.rs/crate/arbiter-bindings/)
- [`arbiter-core`](https://docs.rs/arbiter-core/)
- [`arbiter-derive`](https://docs.rs/arbiter-derive/)

You will also find each of these on crates.io.

Expand All @@ -139,7 +141,7 @@ Preliminary benchmarks of the `RevmMiddleware` interface over `revm` against Anv

to run the benchmarking code yourself, you can run:
```bash
cargo bench --package arbiter-core -F contracts
cargo bench --package arbiter-core
```

bench from 10/24/23 arbiter-core v0.6.3
Expand Down
66 changes: 0 additions & 66 deletions arbiter-bindings/README.md

This file was deleted.

Loading