Jump to an example

​
General Settings

​
project
string
required

Sets the name of the project. The project is auto-created if it does not already exist using the folder name.

​
team
string

Enter the team slug (found in your account settings) you wish to deploy and upload your project. If left blank, it will default to your personal workspace.

​
framework
string

Specifies your project environment. Options are: "hardhat" or "foundry".

​
artifacts
string[]

Specify paths to solc json output files. Not required if specifying a framework (e.g. hardhat or foundry )

​
workbench.new
string

Auto-creates a new Workbench and sets its name.

​
Deployment Settings (optional)

Deployments are a set of concrete transactions and accounts. They are used as initial states when exploring your state space. Deployments are recorded by running a script against a local EVM. Deployments are currently only supported when using a framework.

​
[deployment.Main]

Defines a deployment structure.

​
name
string

Name of your custom deployment.

​
script
string

Foundry deployments only. When using Foundry scripts, the scripts property may be used as a shorthand alternative to the command property. The RPC url does not need to be specified when using this form.

script="./script/DEPLOY.s.sol"
​
modules
string[]

When using Hardhat’s Ignition, the modules property may be used as a shorthand alternative to the command property. The RPC url does not need to be specified when using this form.

modules = [
   "path to Ignition module", 
]
​
command
string[]

For both Foundry and Hardhat deployments. Command is a list of strings representing the command to run when recording this deployment. Ensure that your RPC endpoint points to localhost:8545.

## example usage
command=["npx", "deploy.ts", "node", "--localhost", ...]

Prefer to use the Hardhat config? Try the Hardhat plugin.

​
accounts
uint

Specify the number of externally owned accounts (wallets) to use in this deployment (up to max 20 accounts).

accounts = 3%

​
Example

state-space.toml
# Sets the name of the project. 
#
# The project is created if it does not already exist.
project = "Project MyToken"

# If using State Space in a team, specify the team identifier.
# By default, your personal account will be used.
team = "my-team"

# Sets the primary framework to use.
# 
# When setting a framework, contract sources and solc settings are 
# automatically used when pushing code to State Space.
# 
# Optional. Supports "foundry" or "hardhat".
framework = "hardhat"


# Creates a new Workbench project
workbench.new = "MyToken"

# Specify paths to solc json output files.
# If using a framework, this usually isn't necessary.
# artifacts = []

# Defines a deployment
# 
# Deployments are a set of concrete transactions and accounts. 
# They are used as initial states when exploring your state space.
# 
# Deployments are recorded by running a script against a local EVM.
# Deployments are currently only supported when using a framework.
# [deployment.Main]

# Command is a list of strings representing the command to run when 
# recording this deployment. Ensure that your RPC endpoint points to
# localhost:8545.
# command = ["forge", "script", ...]

# When using Foundry scripts, the scripts property may be used as a 
# shorthand alternative to the command property.
# The RPC url does not need to be specified when using this form.
# scripts = [
#    "name of or path to Foundry script", 
# ]

# When using Hardhat's Ignition, the modules property may be used as a 
# shorthand alternative to the command property.
# The RPC url does not need to be specified when using this form.
# modules = [
#    "path to Ignition module", 
# ]

# Specify the number of externally owned accounts (wallets) to use
# in this deployment
# accounts = 3%