Skip to main content

What to expect: Install the State Space CLI
Upload your first smart contract
Validate your project appears in the State Space Workbench UI
1

Setup

Create an account.

Install the State Space CLI:

Optional: Use an example ERC20 from our examples Github repo

As an example, we’ll use an unmodified ERC20 project from OpenZeppelin.Clone the repo based on your framework preference.
If you are using your own project, make sure your code successfully compiles.

2

Configure and Deploy

Initialize project

Run the init command from the main folder of your Foundry or Hardhat project to create the state-space.toml config file.
It should look like this:
state-space.toml

Configure settings

Update the following settings in state-space.toml with your project details:
See the CLI settings guide for more details.

Deploy to State Space

Deploy your project to state space by running the push command:
Make sure your code successfully compiles before running the push command.
You will be provided a link to login using the same credentials you created in Step 1.After you authenticate, the CLI will compile and deploy your code to State Space. Depending on the size of your codebase, they may take a few minutes.Please contact us if you experience any issues.
3

Workbench

Login to State Space Workbench and open your newly created Workbench project from the Home dashboard.Expand the folder tree, and begin designing a test scenario by dragging a deployment to the canvas, and a sequence of transactions (function calls) to the canvas.For a more in-depth walkthrough, try one of our tutorials: