Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: link to docs hub fuel installation guide #5144

Merged
merged 6 commits into from
Oct 12, 2023
Merged

docs: link to docs hub fuel installation guide #5144

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
7aa8758
docs: link to docs hub fuel installation guide
cold-briu Sep 25, 2023
2a7e6ac
docs: Link developer quickstart to docs-hub
cold-briu Oct 7, 2023
5813723
docs: fix lint err
cold-briu Oct 7, 2023
d33654b
docs: book - merge installation and quickstart
cold-briu Oct 9, 2023
8417f03
docs: book fix typo
cold-briu Oct 9, 2023
6eeaeb8
Merge branch 'master' into docs/fuelup-install-guide
cold-briu Oct 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
169 changes: 2 additions & 167 deletions docs/book/src/introduction/installation.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,170 +1,5 @@
# Installation

The _Sway toolchain_ is sufficient to compile Sway smart contracts. Otherwise, note that if you want to run Sway smart contracts (e.g. for testing), a Fuel Core full node is required, which is packaged together with the _Sway toolchain_ together as the _Fuel toolchain_.
## The `Fuel` toolchain

## Install via Pre-compiled Binaries (Recommended)

Installing via pre-compiled release binaries is the recommended way to get up and running with the Sway toolchain. Pre-compiled binaries for Linux and macOS are available. Native Windows is currently unsupported ([tracking issue for Windows support](https://github.com/FuelLabs/sway/issues/1526)). Windows Subsystem for Linux should work but is not officially supported.

### Dependencies

A prerequisite for installing and using Sway is the Rust toolchain. Platform-specific instructions for installing `rustup` can be found [here](https://www.rust-lang.org/tools/install). Then, install the Rust toolchain with:

```sh
# Install the latest stable Rust toolchain.
rustup install stable
```

The Sway toolchain is built and tested against the `stable` Rust toolchain version (<https://github.com/rust-lang/rust/releases/latest>). There is no guarantee it will work with the `nightly` Rust toolchain, or with earlier `stable` versions, so ensure you are using `stable` with:

```sh
# Update installed Rust toolchain; can be used independently.
rustup update
# Set the stable Rust toolchain as default; can be used independently.
rustup default stable
```

Now you're ready to install [`fuelup`](https://github.com/FuelLabs/fuelup), the equivalent of Rust's `rustup` for the Fuel toolchain. It enables easily downloading binary releases of the Fuel toolchain.

1. Start by installing `fuelup` with the following command:

```sh
curl --proto '=https' --tlsv1.2 -sSf \
https://install.fuel.network/fuelup-init.sh | sh
```

This downloads the `fuelup-init` script to a temp directory on your machine, which installs `fuelup`. `fuelup-init` will ask for permission to add `~/.fuelup/bin` to your PATH. Otherwise, you can also pass `--no-modify-path` so that `fuelup-init` does not modify your PATH:

```sh
curl --proto '=https' --tlsv1.2 -sSf \
https://install.fuel.network/fuelup-init.sh | sh -s -- --no-modify-path
```

2. Once fuelup is installed, fuelup-init automatically runs `fuelup toolchain install latest` to install the latest toolchain

You can run `fuelup update` at anytime to get the most up-to-date toolchain.

3. (Optional) You can optionally install distributed toolchains optimized for different networks.

To configure the optimal toolchain for beta-3, run the following commands:

```sh
$ fuelup self update
Fetching binary from https://github.com/FuelLabs/fuelup/releases/download/v0.18.0/fuelup-0.18.0-aarch64-apple-darwin.tar.gz
Downloading component fuelup without verifying checksum
Unpacking and moving fuelup to /var/folders/tp/0l8zdx9j4s9_n609ykwxl0qw0000gn/T/.tmpP3HfvR
Moving /var/folders/tp/0l8zdx9j4s9_n609ykwxl0qw0000gn/T/.tmpP3HfvR/fuelup to /Users/user/.fuelup/bin/fuelup


$ fuelup toolchain install beta-3
Downloading: forc forc-explore forc-wallet fuel-core fuel-indexer

Adding component forc v0.35.0 to 'beta-3-aarch64-apple-darwin'
Fetching binary from https://github.com/FuelLabs/sway/releases/download/v0.35.0/forc-binaries-darwin_arm64.tar.gz
npacking and moving forc-doc to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Unpacking and moving forc to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Unpacking and moving forc-deploy to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Unpacking and moving forc-run to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Unpacking and moving forc-lsp to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Unpacking and moving forc-fmt to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Fetching core forc dependencies
Installed forc v0.35.0 for toolchain 'beta-3-aarch64-apple-darwin'

Adding component forc-explore v0.28.1 to 'beta-3-aarch64-apple-darwin'
Fetching binary from https://github.com/FuelLabs/forc-explorer/releases/download/v0.28.1/forc-explore-0.28.1-aarch64-apple-darwin.tar.gz
Unpacking and moving forc-explore to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Installed forc-explore v0.28.1 for toolchain 'beta-3-aarch64-apple-darwin'

Adding component forc-wallet v0.1.3 to 'beta-3-aarch64-apple-darwin'
Fetching binary from https://github.com/FuelLabs/forc-wallet/releases/download/v0.1.3/forc-wallet-0.1.3-aarch64-apple-darwin.tar.gz
Unpacking and moving forc-wallet to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Installed forc-wallet v0.1.3 for toolchain 'beta-3-aarch64-apple-darwin'

Adding component fuel-core v0.17.1 to 'beta-3-aarch64-apple-darwin'
Fetching binary from https://github.com/FuelLabs/fuel-core/releases/download/v0.17.1/fuel-core-0.17.1-aarch64-apple-darwin.tar.gz
Unpacking and moving fuel-core to /Users/user/.fuelup/toolchains/ beta-3-aarch64-apple-darwin/bin
Installed fuel-core v0.17.1 for toolchain 'beta-3-aarch64-apple-darwin'

Adding component fuel-indexer v0.2.3 to 'beta-3-aarch64-apple-darwin'
Fetching binary from https://github.com/FuelLabs/fuel-indexer/releases/download/v0.2.3/fuel-indexer-0.2.3-aarch64-apple-darwin.tar.gz
Unpacking and moving fuel-indexer to /Users/user/.fuelup/toolchains/beta-3-aarch64-apple-darwin/bin
Installed fuel-indexer v0.2.3 for toolchain 'beta-3-aarch64-apple-darwin'

Installed:
- forc 0.35.0
- forc-explore 0.28.1
- forc-wallet 0.1.3
- fuel-core 0.17.1
- fuel-indexer 0.2.3

The Fuel toolchain is installed and up to date
```

You're all set to start building!

### Need Help?

You may refer to [The Fuelup Book](https://fuellabs.github.io/fuelup/latest/) for an in-depth look into fuelup, or check out the tooling section in the [Fuel forum](https://forum.fuel.network/) if you're running into problems through the installation process. If you don't see your question, post the issue you're running into with as many details as possible and the team will get back to you asap!

### Installing from Cargo

The Sway toolchain and Fuel Core full node can be installed from source with Cargo with:

```sh
cargo install forc fuel-core
```

#### Updating `forc` from Cargo

You can update the toolchain from source with Cargo with:

```sh
cargo update forc fuel-core
```

#### Installing `forc` Plugins from Cargo

The Fuel ecosystem has a few plugins which can be easily installed via Cargo.

> **Note**: `forc` detects anything in your `$PATH` prefixed with `forc-` as a plugin. Use `forc plugins` to see what you currently have installed.

```sh
# Sway Formatter
cargo install forc-fmt

# Block Explorer
cargo install forc-explore

# Sway Language Server
cargo install forc-lsp
```

## Installing from Source

Rather than installing from `cargo`, the Sway toolchain can be built from a local source checkout by following instructions at <https://github.com/FuelLabs/sway>. The Fuel Core full node implementation can be built from source by following instructions at <https://github.com/FuelLabs/fuel-core>.

## Enable tab completion for Bash, Fish, Zsh, or PowerShell

`forc` supports generating completion scripts for Bash, Fish, Zsh, and PowerShell. See `forc completions --help` for full details, but the gist is as simple as using one of the following:

```sh
# Bash
forc completions --shell=bash > ~/.local/share/bash-completion/completions/forc

# Bash (macOS/Homebrew)
forc completions --shell=bash > $(brew --prefix)/etc/bash_completion.d/forc.bash-completion

# Fish
mkdir -p ~/.config/fish/completions
forc completions --shell=fish > ~/.config/fish/completions/forc.fish

# Zsh
forc completions --shell=zsh > ~/.zfunc/_forc

# PowerShell v5.0+
forc completions --shell=powershell >> $PROFILE.CurrentUserCurrentHost
# or
forc completions --shell=powershell | Out-String | Invoke-Expression
```

Once the completions have been generated and properly installed, close and reopen your terminal for the new completions to take effect.
Please visit the Fuel's [installation guide](https://docs.fuel.network/guides/installation) to install The Fuel toolchain binaries and pre requisites.
cold-briu marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion docs/book/src/introduction/sway_quickstart.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Sway Quickstart

Check out the [Developer Quickstart Guide](https://fuelbook.fuel.network/master/quickstart/developer-quickstart.html) for a step-by-step guide on building a fullstack dapp on Fuel. The guide will walk you through writing a smart contract, setting up a wallet, and building a frontend to interact with your contract.
Check out the [Developer Quickstart Guide](https://docs.fuel.network/guides/quickstart/) for a step-by-step guide on building a fullstack dapp on Fuel. The guide will walk you through writing a smart contract, setting up a wallet, and building a frontend to interact with your contract.