Installation

Setting up your local machine to develop with Seismic

System requirements

Before you begin, make sure your machine meets the following requirements:

  • x84_64 or arm64 architecture

  • MacOS, Ubuntu, or Windows

Install the local development suite

The local development suite uses sforge as the testing framework, sanvil as the local node, and ssolc as the compiler.

  1. Install rust and cargo on your machine if you don't already have them. Default installation works well.

curl https://sh.rustup.rs -sSf | sh

  1. Download and execute the sfoundryup installation script.

curl -L \
     -H "Accept: application/vnd.github.v3.raw" \
     "https://api.github.com/repos/SeismicSystems/seismic-foundry/contents/sfoundryup/install?ref=seismic" | bash
source ~/.zshenv  # or ~/.bashrc or ~/.zshrc

  1. Install sforge, sanvil, ssolc. Expect this to take between 5-20 minutes depending on your machine.

sfoundryup
source ~/.zshenv  # or ~/.bashrc or ~/.zshrc

  1. (Optional) Remove old build artifacts in existing projects. You can ignore this step if you aren't working with existing foundry projects.

sforge clean  # run in your project's contract directory

Set up the VSCode extension

We recommend adding syntax highlighting via the seismic (or seismic for Open VSX) extension from the VSCode marketplace. If you already have the solidity extension, you'll have to disable it while writing Seismic code.

PreviousWelcomeNextQuickstart

Last updated