Skip to content

Commit

Permalink
chore: Improve CI tests, README documentation, and update feature gua…
Browse files Browse the repository at this point in the history
…rd in error.rs

This commit includes updates to the README.md to show the updated uniswap-sdk-core version and additional notes on the `no_std` feature. It also introduces improvements in the CI tests by adding a step to run tests with all features. Furthermore, the condition for running tests in error.rs is updated.
  • Loading branch information
shuhuiluo committed Jul 18, 2024
1 parent c3537fc commit 417428a
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 6 deletions.
3 changes: 3 additions & 0 deletions .github/workflows/rust.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,7 @@ jobs:
run: cargo build

- name: Run tests
run: cargo test

- name: Run tests with all features
run: cargo test --all-features
15 changes: 10 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Add this to your Cargo.toml

```
[dependencies]
uniswap-sdk-core = "0.23.0";
uniswap-sdk-core = "1.0.0-rc";
```

And this to your code:
Expand Down Expand Up @@ -80,15 +80,20 @@ assuming the addresses are correctly set up for this comparison.
Remember to replace "0x6B175474E89094C44Da98b954EedeAC495271d0F" with the actual address of the DAI token you're working
with, and adjust the CHAIN_ID if you're working on a different network (e.g., a testnet).

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Contribution

Contributions are welcome! If you find a bug or have suggestions for improvements, feel free to open an issue or submit
a pull request on the [GitHub repository](https://github.com/malik672/uniswap-sdk-core-rust).

## Note on `no_std`

By default, this library does not depend on the standard library (`std`). However, the `std` feature can be enabled to
use `thiserror` for error handling.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

The Uniswap SDK Core in Rust is inspired by the original [Uniswap SDK](https://github.com/Uniswap/sdk-core) and aims to
Expand Down
2 changes: 1 addition & 1 deletion src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ pub enum Error {
Incorrect(),
}

#[cfg(any(feature = "std", test))]
#[cfg(all(feature = "std", test))]
mod tests {
use super::*;

Expand Down

0 comments on commit 417428a

Please sign in to comment.