13 releases (breaking)
|0.48.0||Sep 11, 2023|
|0.46.0||Aug 15, 2023|
|0.44.0||Jul 17, 2023|
|0.0.0||Mar 22, 2023|
#227 in Cryptography
4,022 downloads per month
Used in 8 crates (4 directly)
Rust SDK for Fuel. It can be used for a variety of things, including but not limited to:
- Compiling, deploying, and testing Sway contracts;
- Launching a local Fuel network;
- Crafting and signing transactions with hand-crafted scripts or contract calls;
- Generating type-safe Rust bindings of contract methods;
- And more,
fuels-rsis still in active development.
- Launch Fuel nodes
- Deploy contracts
- Interact with deployed contracts
- Type-safe Sway contracts bindings code generation
- Run Sway scripts
- CLI for common operations
- Local test wallets
- Wallet integration
- Events querying/monitoring
What dependencies do I need?
How can I run the SDK tests?
First, build the test projects using
forc build --path packages/fuels
Then you can run the SDK tests with:
You can also run specific tests. The following example will run all integration tests in
types.rs whose names contain
in_vector and show their outputs:
cargo test --test types in_vector -- --show-output
How to run WASM tests?
You need to have wasm32 as a target, if you don't already:
rustup target add wasm32-unknown-unknown
You also need
wasm-pack, if you don't already:
cargo install wasm-pack
packages/wasm-tests and run
What to do if my tests are failing on
Before doing anything else, try all these commands:
cargo clean rm Cargo.lock forc build --path packages/fuels cargo test
Why is the prefix
fuels and not
In order to make the SDK for Fuel feel familiar with those coming from the ethers.js ecosystem, this project opted for an
s at the end. The
fuels-* family of SDKs is inspired by The Ethers Project.
How can I run the docs locally?
mdbook by running:
cargo install mdbook
Next, navigate to the
docs folder and run the command below to start a local server and open a new tab in you browser.
mdbook serve --open
You can build the book by running: