Getting Started
Installation Guide
Please visit the Fuel installation guide to install the Fuel toolchain binaries and prerequisites.
forc
is Sway equivalent of Rust's cargo
. fuel-core
is a Fuel full node implementation.
There are two main ways you can use the Fuel Rust SDK:
- Creating a new Sway project with
forc
and running the tests - Creating a standalone project and importing the
fuels-rs
crate
Creating a new project with Forc
You can create a new Sway project with
forc new <Project name>
Or you can initialize a project within an existing folder with
forc init
Adding a Rust integration test to the Sway project
Now that we have a new project, we can add a Rust integration test using a cargo generate
template.
If cargo generate
is not already installed, you can install it with:
cargo install cargo-generate
Note You can learn more about cargo generate by visiting its repository.
Let's generate the default test harness with the following command:
cargo generate --init fuellabs/sway templates/sway-test-rs --name <Project name> --force
--force
forces your --name
input to retain your desired casing for the {{project-name}}
placeholder in the template. Otherwise, cargo-generate
automatically converts it to kebab-case. With --force
, this means that both my_fuel_project
and my-fuel-project
are valid project names, depending on your needs.
Before running test, we need to build the Sway project with:
forc build
Afterwards, we can run the test with:
cargo test
Note If you need to capture output from the tests, use one of the following commands:
cargo test -- --nocapture
Importing the Fuel Rust SDK
Add these dependencies on your Cargo.toml
:
fuels = "{{versions.fuels}}"
Note We're using version
{{versions.fuels}}
of the SDK, which is the latest version at the time of this writing.
And then, in your Rust file that's going to make use of the SDK:
use fuels::prelude::*;
The Fuel Rust SDK source code
Another way to experience the SDK is to look at the source code. The e2e/tests/
folder is full of integration tests that go through almost all aspects of the SDK.
Note Before running the tests, we need to build all the Sway test projects. The file
packages/fuels/Forc.toml
contains a `[workspace], which members are the paths to all integration tests. To build these tests, run the following command:
forc build --release --path packages/fuels
forc
can also be used to clean and format the test projects. Check thehelp
output for more info.
After building the projects, we can run the tests with
cargo test
If you need all targets and all features, you can run
cargo test --all-targets --all-features
Note If you need to capture output from the tests, you can run
cargo test -- --nocapture
More in-depth Fuel and Sway knowledge
Read The Sway Book for more in-depth knowledge about Sway, the official smart contract language for the Fuel Virtual Machine.