Crates.io | uniswap-v3-sdk |
lib.rs | uniswap-v3-sdk |
version | 2.7.0 |
source | src |
created_at | 2024-01-05 06:16:41.324726 |
updated_at | 2024-11-25 05:19:24.415316 |
description | Uniswap V3 SDK for Rust |
homepage | |
repository | https://github.com/shuhuiluo/uniswap-v3-sdk-rs |
max_upload_size | |
id | 1089318 |
size | 570,819 |
A Rust SDK for building applications on top of Uniswap V3. Migration from the TypeScript Uniswap/v3-sdk.
It is feature-complete with unit tests matching the TypeScript SDK.
Opinionated Rust implementation of the Uniswap V3 SDK with a focus on readability and performance
Usage of alloy-rs types
Reimplementation of the math libraries in Uniswap V3 Math In Rust based on optimizations presented in Uni V3 Lib
Extensive unit tests and benchmarks
An extensions
feature for additional functionalities related to Uniswap V3, including:
pool
module for creating a Pool
struct from a pool key and fetching the
liquidity map within a tick range for the specified pool, using RPC clientposition
module for creating a Position
struct from a token id and fetching
the state and pool for all positions of the specified owner, using RPC client, etcprice_tick_conversions
module for converting between prices and
ticksephemeral_tick_data_provider
module for fetching ticks using
an ephemeral contract
in a single eth_call
ephemeral_tick_map_data_provider
fetches ticks in a
single eth_call
and creates a TickMap
tick_map
provides a way to access tick data directly from a hashmap, supposedly
more efficient than TickList
Function | Time | Reference |
---|---|---|
get_sqrt_ratio_at_tick | 4.0437 µs | 8.8094 µs |
get_tick_at_sqrt_ratio | 21.232 µs | 31.547 µs |
get_amount_0_delta | 3.6099 µs | 4.4475 µs |
get_amount_1_delta | 2.5942 µs | 3.5725 µs |
Add the following to your Cargo.toml
file:
uniswap-v3-sdk = { version = "2.7.0", features = ["extensions", "std"] }
The package structure follows that of the TypeScript SDK, but with snake_case
instead of camelCase
.
For easy import, use the prelude:
use uniswap_v3_sdk::prelude::*;
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.
Contributions are welcome. Please open an issue if you have any questions or suggestions.
Tests are run with
cargo test
for the core library. To run the tests for the extensions, use
cargo test --all-features --lib extensions -- --test-threads=1
To test a specific module, use cargo test --test <module_name>
.
Linting is done with clippy
and rustfmt
. To run the linter, use:
cargo clippy --all-targets --all-features -- -D warnings
cargo fmt --all -- --check
Benchmarking is done with criterion
. To run the benchmarks, use cargo bench
.
This project is licensed under the MIT License.
This project is inspired by and adapted from the following projects: