README.md

Sway

Sway is a language developed for the Fuel blockchain. It is heavily inspired by Rust and aims to bring modern language development and performance to the blockchain ecosystem.

Documentation

For user documentation, see the Sway Book: https://fuellabs.github.io/sway/latest/.

Building from Source

Dependencies

Sway is built in Rust. To begin, install the Rust toolchain following instructions at https://www.rust-lang.org/tools/install. Then configure your Rust toolchain to use Rust stable:

rustup default stable

If not already done, add the Cargo bin directory to your PATH by adding the following line to ~/.profile and restarting the shell session.

export PATH="${HOME}/.cargo/bin:${PATH}"

To ensure access to all dependent repositories, create and add SSH keys to your GitHub account.

Building Sway

Clone the repository and build the Sway toolchain:

git clone [email protected]:FuelLabs/sway.git
cd sway
cargo build

Confirm the Sway toolchain built successfully:

cargo run --bin forc -- --help
# or
./target/debug/forc --help

To run forc from any directory, install forc to your local Cargo bin directory:

cargo install --locked --path forc
# Also install sway-server if using the IDE plugin
cargo install --locked --path sway-server