Install the Scrypto Toolchain

To begin working with Scrypto, you need to first prepare you system for Rust development. Then you can install the Scrypto Libraries, Radix Engine Simulator resim and command line tools from the Radixdlt-Scrypto github repository.

Install Rust compiler

• On Windows:

  • Install git by running the installer that you can find here

    • Enable git long path support:

    git config --system core.longpaths true

  • Install "Desktop development with C++" with Build Tools for Visual Studio 2019

  • Download and install rustup-init.exe

  • Install LLVM 13.0.1 (make sure you tick the option that adds LLVM to the system PATH)

• On macOS:

  • Make sure you have the xcode command line tools by running:

    xcode-select --install

  • Install cmake and LLVM

    brew install cmake llvm

    Add LLVM to the system path by adding below line to the ~/.profile

    • ~/.profile if bash is the default shell

    • ~/.zshrc if zsh is the default shell

    • respective config file in case of other shell

    PATH="/opt/homebrew/opt/llvm/bin:$PATH"

    You can check, which shell is the default one by inspecting $SHELL variable:

    echo $SHELL

  • Install Rust compiler

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

• On Linux:

  • Make sure a C++ compiler and LLVM is installed:

    sudo apt install clang build-essential llvm

  • Install Rust compiler

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

Enable cargo in the current shell

• On Windows:

  • Start a new PowerShell

• On Linux or macOS:

  source $HOME/.cargo/env

Add WebAssembly target:

rustup target add wasm32-unknown-unknown

Install Radix Engine Simulator and command-line tools:

git clone https://github.com/radixdlt/radixdlt-scrypto.git
cd radixdlt-scrypto
cargo install --path ./simulator

If you encounter problems when installing the simulator, make sure that you’re running the latest stable version of Rust before trying again!

rustup update stable

When you install the simulator crate you get two things, the scrypto CLI tool which is essentially a wrapper around the cargo CLI tool with a few adjustments and resim the Radix Engine Simulator

Troubleshooting

Have an x86 (Intel-based) MacOS? Try the following steps:

• Define rust stable:

  rustup default stable

• Install LLVM@15 using brew:

  brew install llvm@15

• Confirm the Installation Path:

  brew --prefix llvm@15

  Output: /usr/local/opt/llvm

• Add LLVM to the system path by adding below line to the ~/.zshrc

  PATH="$(brew --prefix llvm@15)/bin:$PATH"

• Reload the environment:

  source ~/.zshrc

• Check that the installation of LLVM was done correctly by checking the clang version

  clang --version

  Output:

  Homebrew clang version 15.0.7
  Target: x86_64-apple-darwin23.4.0
  Thread model: posix
  InstalledDir: /usr/local/opt/llvm@15/bin

• Install XCode from the App Store

• Reset the XCode config:

  xcodebuild -runFirstLaunch

• Proceed to Install Radix Engine Simulator and command-line tools

For more info:

• Scrypto CLI

• Radix Engine Simulator