Skip to content

Repository files navigation

Forc plugins

This repository contains independently released plugins for the Fuel Orchestrator (forc). It does not contain the Sway compiler or the core forc executable; those remain in FuelLabs/sway.

Repository split

Package Installed commands Purpose
forc-client forc call, forc deploy, forc run, forc submit Build and submit transactions to a Fuel node
forc-node forc node Start and manage a local Fuel Core node
forc-crypto forc crypto Cryptographic operations and conversions
forc-wallet forc wallet Generate, import, and manage local wallets
forc-tracing internal library Shared tracing support for Forc plugins

Compiler-facing commands such as forc build, forc check, forc test, forc fmt, forc doc, forc lsp, and forc migrate are maintained and released from the Sway repository.

Choose a compatible toolchain

These packages have independent release numbers. A plugin version should not be selected by making it numerically match the installed Sway, Forc, Fuel Core, or SDK version.

For applications targeting a public Fuel network:

  1. Install the named mainnet or testnet toolchain with fuelup.
  2. Inspect the selected components with fuelup show and forc plugins.
  3. Keep the project's fuel-toolchain.toml, Forc.lock, SDK lockfile, ABI, bytecode, and target chain ID together.
  4. Verify command flags with forc <command> --help from the selected toolchain.

For a custom or source-built toolchain, use releases.toml to see which Sway, Fuel Core, and fuels-rs versions a published plugin release was built against. The file is generated as part of the release process and only records releases cut since that automation was introduced, so not every published release has an entry; for a release without one, use the Cargo.lock and changelog at that release's tag as the compatibility evidence. An entry is compatibility evidence for that release; it is not a promise that every other component combination is supported.

Development

The current workspace dependency set is declared in Cargo.toml. Run the workspace checks before proposing a change:

cargo fmt --all --check
cargo clippy --workspace --all-targets
cargo test --workspace

Release and installation documentation should always name both the plugin release and the compiler/node versions it was tested with. Avoid the ambiguous term “latest” unless it is qualified as an upstream release or a specific Fuelup network channel.

About

A variety of tools for developers working with the Fuel ecosystem.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Used by

Contributors

Languages