Skip to main content

Set Up Development Environment

For developing on Fluence we recommend using Fluence CLI

The best way to make sure everything works for you is to ensure all the versions of Fluence Protocol parts match each other. Most importantly the version of Fluence CLI that you currently use must be compatible with the version of Nox that you trying to connect to

Keeping Fluence CLI Up-To-Date​

This is the first and the most important step that can help you ensure version compatibility. Use fluence update command to update Fluence CLI. Allowed arguments for this command are:

  • dar - version compatible with current dar environment
  • kras - version compatible with current kras environment
  • stage - version compatible with current stage environment
  • main - latest build from main branch

So if you want to work with dar environment please run fluence update dar first. You will also have to select environment by using --env flag or by running fluence default env dar inside your Fluence Project to set environment that will be used by default for your Fluence Project

Fluence CLI contains hardcoded versions of all the parts of Fluence Protocol that were tested to work together correctly. This means that if you work with local Fluence Network — generally speaking everything should just be working for you. The only thing to worry about is that you might have some dependency versions specified in fluence.yaml config of your Fluence Project that don't match with your current CLI version. To reset the versions of these dependencies to default, run:

sh
fluence dep r
sh
fluence dep r

It's not required, but you might want to run this command each time you update CLI to a different version, to ensure compatibility

For advanced users: you can also run fluence dep v to check out all these versions for yourself

Fluence CLI dependencies​

Aqua​

To install you project aqua dependencies, run:

sh
fluence dep i
sh
fluence dep i

You can install specific aqua dependencies like this:

sh
fluence dep i @fluencelabs/aqua-lib@0.9.1
sh
fluence dep i @fluencelabs/aqua-lib@0.9.1

To uninstall specific aqua dependencies run this:

sh
fluence dep un @fluencelabs/aqua-lib
sh
fluence dep un @fluencelabs/aqua-lib

You can also edit fluence.yaml directly and run fluence dep i after that

For advanced users: The Aqua compiler currently relies on npm to serve as its package manager. If you encounter any issues or problems, please refer to npm documentation. Keep in mind that you don't need to install npm as Fluence CLI installs and manages its own version.

Rust​

Fluence CLI will attempt to install Rust for you on Linux and macOS. If you are on Windows or the Fluence CLI is unable to install Rust, please refer to the official Rust documentation for installation instructions

Fluence CLI will also install the required Rust toolchain and add the wasm32-wasi target.

In case of any problems related to Rust, here's a quick troubleshoot list:

  • Check you don't have 2 Rust installations (ie via rustup and brew on macOS)
  • Install wasm32-wasi manually: rustup target add wasm32-wasi & rustup target add wasm32-wasi --toolchain nightly
  • rustup update
  • Just reinstall Rust

Marine and Mrepl​

In order to create and compile your Rust code to wasi and test the resulting Wasm modules, you need the Marine CLI and Marine REPL. Both components are wrapped by Fluence CLI and by default downloaded from the respective GitHub releases lazily. Instead of the default lazy install, you can force the download by running

sh
fluence dep i
sh
fluence dep i

For advanced users: you can override marine and mrepl version in your project using marineVersion and mreplVersion properties in fluence.yaml. If for some reason download fails — Fluence CLI will attempt to build marine and mrepl from source using cargo

Docker​

You need Docker if you want to work with a local Fluence Network, which comes in rather handy when testing your code before deploying it to the remote dar or kras environments. We recommend to install Docker Desktop for your OS using official Docker documentation. Don't forget to run docker after installation, before you attempt to set up local Fluence Network using fluence local up