Skip to main content

Prerequisites

This chapter will show you how to install the software required for developing a ROFL app using the Oasis SDK. After successfully completing all the described steps you will be able to start building your first ROFL app!

If you already have everything set up, feel free to skip to the next chapter.

Environment Setup​

The following is a list of prerequisites required to start developing using the Oasis SDK:

Rust​

We follow Rust upstream's recommendation on using rustup to install and manage Rust versions.

info

rustup cannot be installed alongside a distribution packaged Rust version. You will need to remove it (if it's present) before you can start using rustup.

Install it by running:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
info

If you want to avoid directly executing a shell script fetched the internet, you can also download rustup-init executable for your platform and run it manually.

This will run rustup-init which will download and install the latest stable version of Rust on your system.

Rust Toolchain Version​

The version of the Rust toolchain we use in the Oasis SDK is specified in the rust-toolchain.toml file.

The rustup-installed versions of cargo, rustc and other tools will automatically detect this file and use the appropriate version of the Rust toolchain. When you are building applications that use the SDK, it is recommended that you copy the same rust-toolchain.toml file to your project's top-level directory as well.

To install the appropriate version of the Rust toolchain, make sure you are in the project directory and run:

rustup show

This will automatically install the appropriate Rust toolchain (if not present) and output something similar to:

...

active toolchain
----------------

nightly-2022-08-22-x86_64-unknown-linux-gnu (overridden by '/code/rust-toolchain')
rustc 1.65.0-nightly (c0941dfb5 2022-08-21)

For testing ROFL binaries on Sapphire Localnet, the binaries should be compiled for MUSL C standard library. You will need to add the following target to your rust environment:

rustup target add x86_64-unknown-linux-musl

Additionally, you will need the MUSL wrapper for gcc, the multilib package and clang for compiling the mbedtls-sys-auto dependency. On Ubuntu/Debian systems, you can install those by running:

sudo apt install musl-tools gcc-multilib clang

SGXS Utilities​

In order to generate binaries suitable for use with Intel SGX, you also need to install the relevant utilities. You can do so as follows:

cargo install fortanix-sgx-tools
cargo install sgxs-tools

Oasis CLI Installation​

The rest of the guide uses the Oasis CLI as an easy way to interact with the ParaTimes. You can use one of the binary releases or compile it yourself.

TEE-enabled Hardware for Deployment​

While ROFL app development and testing can be performed on any machine that has the appropriate tools, for actually running the apps, at least one machine with appropriate TEE-enabled hardware is required.

Please look at the Set up Trusted Execution Environment (TEE) chapter for instructions. The deployment part of the guide assumes you have an appropriate machine ready to use.