A Forc Project

To initialize a new project with Forc, use forc new:

forc new my-fuel-project

Here is the project that Forc has initialized:

$ cd my-fuel-project
$ tree .
├── Forc.toml
└── src
    └── main.sw

Forc.toml is the manifest file (similar to Cargo.toml for Cargo or package.json for Node), and defines project metadata such as the project name and dependencies.

For additional information on dependency management, see: here.

authors = ["User"]
entry = "main.sw"
license = "Apache-2.0"
name = "my-fuel-project"


Here are the contents of the only Sway file in the project, and the main entry point, src/main.sw:


abi MyContract {
    fn test_function() -> bool;

impl MyContract for Contract {
    fn test_function() -> bool {

The project is a contract, one of four different project types. For additional information on different project types, see here.

We now compile our project with forc build, passing the flag --finalized-asm to view the generated assembly:

$ forc build --finalized-asm
ji   i4
lw   $ds $is 1
add  $$ds $$ds $is
lw   $r0 $fp i73              ; load input function selector
lw   $r1 data_0               ; load fn selector for comparison
eq   $r2 $r0 $r1              ; function selector comparison
jnzi $r2 i12                  ; jump to selected function
movi $$tmp i123               ; special code for mismatched selector
rvrt $$tmp                    ; revert if no selectors matched
ret  $one
data_0 .word 559005003

  Compiled contract "my-fuel-project".
  Bytecode size is 60 bytes.