Installation

Setting up your local machine to develop with Seismic

sforge, sanvil, and ssolc

We currently support devices with x84_64/arm64 architectures running MacOS, Ubuntu or Windows.

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

1. Install [rust / cargo / brew / jq] on your machine if you don't already have them. Default installations for all work well.

# install rust and cargo
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. Remove old build artifacts in existing projects.

sforge clean  # run in your project's contract directory

VSCode extension

We also recommend adding syntax highlighting via the seismic extension from the VSCode marketplace. If you have the solidity extension, you'll have to disable it while writing Seismic code.