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
First, build the test projects using forc:
forc build --path packages/fuelsThen you can run the SDK tests with:
cargo testYou 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-outputYou need to have wasm32 as a target, if you don't already:
rustup target add wasm32-unknown-unknownYou also need wasm-pack, if you don't already:
cargo install wasm-packNavigate to packages/wasm-tests and run wasm-pack test.
Before doing anything else, try all these commands:
cargo clean
rm Cargo.lock
forc build --path packages/fuels
cargo testIn 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.
Install mdbook by running:
cargo install mdbookNext, 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 --openYou can build the book by running:
mdbook build