sway README

The project's README from github.com/FuelLabs/sway. As one markdown file: README.md.

Sway

build crates.io docs twitter discord

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 latest released Sway Book: https://fuellabs.github.io/sway/latest/.

The documentation URLs describe different source versions:

These labels are Sway documentation versions. They are not Fuelup channel names and do not identify the toolchain activated on a Fuel network. Check the compiler you are running with forc --version and consult the Fuelup channel documentation when selecting network-compatible tooling.

For Sway standard library documentation from the default branch, see https://fuellabs.github.io/sway/master/std/.

Also view the default-branch technical reference for the Sway programming language at https://fuellabs.github.io/sway/master/reference/.

The Stable Sway and Forc pages on docs.fuel.network are published by FuelLabs/docs-hub from an explicitly selected Sway release. That selection can differ from both the newest upstream release and the compiler in a named Fuelup network channel.

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 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}"

Building Forc

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

All other scripts/commands

For all other scripts and commands use https://github.com/casey/just:

> just --list
Available recipes:
    [automation]
    update-contract-ids
    update-fuel-dependencies

    [benchmark]
    benchmark
    benchmark-tests
    collect-gas-usage

    [build]
    build-highlightjs
    build-prism
    generate-sway-lib-std

    [ci]
    ci-check
    install-ci-check

    [test]
    test-forc-fmt-check-panic

Contributing to Sway

We welcome contributions to Sway!

Please see the Contributing To Sway section of the Sway book for guidelines and instructions to help you get started.

sway (FuelLabs/sway)

Searching Database…

61.4K ·GitHub
这是什么东西?Sway 是为 Fuel 区块链开发的编程语言。它深受 Rust 启发,目标是把现代化的语言开发体验和高性能带给智能合约。
这个仓库是语言本身,还是编译它的工具?它是 Sway 编译器和工具链:你用 Sway 语言编写合约,而负责编译合约的工具(Forc)就是由这套 Rust 代码库构建出来的。
我该怎么开始用它写合约?按照 Sway Book 安装一个发布版本即可;从源码构建只适合想参与开发编译器和工具链本身的人。
我该看哪个版本文档?这些是文档版本,不是 Fuelup 的频道名称:latest 跟踪最新发布的版本,master 可能描述尚未发布的行为。可以用 forc --version 确认你实际的编译器版本。
Forc 是什么?Forc 是构建本仓库后得到的 Sway 工具链。构建完成后,运行 forc --version 就能确认工具链是否正常。
What are similar projects?solidity, rust, foundry, Singeli, go, fuel-core, fuels-ts, SolcQueue
Creator
FuelLabs
Size
117.1 MB
Stars
61.4K
Age
5y
Commits · 90 Days