https://fuellabs.github.io/sway/

🌴 Empowering everyone to build reliable and efficient smart contracts.
https://fuellabs.github.io/sway/

compiler fuel language sway

Last synced: 3 months ago
JSON representation

🌴 Empowering everyone to build reliable and efficient smart contracts.

• Host: GitHub
• URL: https://fuellabs.github.io/sway/
• Owner: FuelLabs
• License: apache-2.0
• Created: 2021-01-19T20:54:33.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T17:47:38.000Z (6 months ago)
• Last Synced: 2024-05-22T18:08:53.389Z (6 months ago)
• Topics: compiler, fuel, language, sway
• Language: Rust
• Homepage: https://fuellabs.github.io/sway
• Size: 71 MB
• Stars: 63,035
• Watchers: 316
• Forks: 5,249
• Open Issues: 731
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# Sway

[![build](https://github.com/FuelLabs/sway/actions/workflows/ci.yml/badge.svg)](https://github.com/FuelLabs/sway/actions/workflows/ci.yml)

[![crates.io](https://img.shields.io/crates/v/forc?label=latest)](https://crates.io/crates/forc)

[![docs](https://docs.rs/forc/badge.svg)](https://docs.rs/forc/)

[![discord](https://img.shields.io/badge/chat%20on-discord-orange?&logo=discord&logoColor=ffffff&color=7389D8&labelColor=6A7EC2)](https://discord.gg/xfpK4Pe)

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, including installing release builds, see the Sway Book: .

For Sway Standard library documentation, see: 

Also view the technical reference for the Sway programming language: 

## Building from Source

This section is for developing the Sway compiler and toolchain. For developing contracts and using Sway, see the above documentation section.

### Dependencies

Sway is built in Rust. To begin, install the Rust toolchain following instructions at . Then configure your Rust toolchain to use Rust `stable`:

```sh

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.

```sh

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

```

### Building Forc

Clone the repository and build the Sway toolchain:

```sh

git clone [email protected]:FuelLabs/sway.git

cd sway

cargo build

```

Confirm the Sway toolchain built successfully:

```sh

cargo run --bin forc -- --help

```

## Contributing to Sway

We welcome contributions to Sway!

Please see the [Contributing To Sway](https://fuellabs.github.io/sway/master/book/reference/contributing_to_sway.html) section of the Sway book for guidelines and instructions to help you get started.