Skip to content

Latest commit

 

History

History
100 lines (68 loc) · 3.83 KB

README.md

File metadata and controls

100 lines (68 loc) · 3.83 KB

eigen-rs

Rust <> EigenLayer developer tools

eigen-rs

Overview

List of crates in the repository :-

Examples

You can run any example using the command cargo run --example

Example :

cargo run --example get_quorum_count

Contributor Guidelines

We are actively looking for contributors. Thank you for your interest. We have strict ci checks in place. In case of any questions and support , feel free to raise an issue.

PR

To test locally and raise a PR :-

You need foundry , docker and make and nightly rust to successfully run it. Also, the docker engine has to be running for all the tests to execute correctly.

make pr

At least 1 approving review is required to merge the PR.

To run fireblocks tests

Add the following variables to your env

  • FIREBLOCKS_API_KEY
  • FIREBLOCKS_PRIVATE_KEY_PATH
  • FIREBLOCKS_API_URL

and then run the following command

make fireblocks-tests

Note: The tests were written using sandbox environment , you would need to modify the testing parameters according to your own asset id's , tx-id etc.

Test Coverage

Test coverage should aim to be around 80%.

Here's how to generate test coverage reports:

Install llvm tools:

rustup component add llvm-tools-preview

Run the tests with coverage instrumentations:

cargo clean && mkdir -p coverage/ && rm -r coverage/*
CARGO_INCREMENTAL=0 RUSTFLAGS='-Cinstrument-coverage' LLVM_PROFILE_FILE='coverage/cargo-test-%p-%m.profraw' cargo test --no-fail-fast

Install coverage report tool and run it:

cargo install grcov
grcov . --binary-path ./target/debug/deps/ -s . -t html --branch --ignore-not-existing --ignore '../*' --ignore "/*" -o target/coverage/

Supported Rust Version

Rolling MSRV policy of 6 months. The current MSRV is 1.79

Disclaimer

This software is unaudited.This is experimental software and is provided on an "as is" and "as available" basis and may not work at all. It should not be used in production.

Credits

Security Bugs

Please report security vulnerabilities to [email protected]. Do NOT report security bugs via Github Issues.

Contact

Telegram - supernovahs444