Welcome to the Sui development environment! Note, this site is built from the upstream
branch and therefore will contain updates not yet found in
devnet. The instructions here
recommend use of
devnet as the latest stable release. To contribute to Sui,
instead use the
To immediately get started using Sui:
- Meet the prerequisites.
- Install the binaries.
- Configure an Integrated Development Environment (IDE).
- Optionally, download the source code to have local access to examples and modify Sui itself.
Tip: Assuming you have Rust Cargo, the
gitcommand, and a GitHub account (see prerequisites(#prerequisites)), you can download the
sui-setup.shscript and run it to conduct all of the setup below, including removal of any existing sui assets. To use it, run these commands in a terminal:
$ curl https://raw.githubusercontent.com/MystenLabs/sui/main/doc/utils/sui-setup.sh -o sui-setup.sh chmod 755 sui-setup.sh ./sui-setup.sh
At a minimum, you should have a machine capable of installing command line tools. These prerequisites are broken down into the essential tools you need to work in Sui and the advanced items needed for Sui source code development.
Sui is written in Rust, and we are using Cargo to build and manage the dependencies. You will need Cargo to build and install Sui on your machine.
To run Sui, you will need to install:
- A command line interface, as virtually everything done here is done by CLI.
curlcommand to download other tools, which you can confirm with:
$ which curl
- The Rust and Cargo toolchain version 1.60.0 or higher; update it with:
$ rustup update stable
- The Sui binaries.
In addition, to conduct advanced work such as altering Sui itself, also obtain:
gitcommand line interface.
- The Sui source code; for simplicity, we recommend installing in
~/suior using an environment variable
To develop in Sui, you will need the Sui binaries. After installing
$ cargo install --locked --git https://github.com/MystenLabs/sui.git --branch "devnet" sui sui-json-rpc
This will put the following binaries in your
PATH (ex. under
~/.cargo/bin) that provide these command line interfaces (CLIs):
- sui - The Sui CLI tool contains subcommands for enabling
genesisof validators and accounts, starting the Sui network, and building and testing Move packages, as well as a client for interacting with the Sui network.
rpc-server- run a local Sui gateway service accessible via an RPC interface.
Confirm the installation with:
$ echo $PATH
And ensure the
.cargo/bin directory appears. Access the help for any of these binaries by passing the
--help argument to it.
Integrated Development Environment
For Move development, we recommend the Visual Studio Code (vscode) IDE with the Move Analyzer language server plugin installed:
$ cargo install --git https://github.com/move-language/move move-analyzer
Then follow the Visual Studio Marketplace instructions to install the Move Analyzer extension. (The
cargo install command for the language server is broken there; hence, we include the correct command above.)
If you need to download and understand the Sui source code, clone the Sui repository:
$ git clone https://github.com/MystenLabs/sui.git --branch devnet
You can start exploring Sui's source code by looking into the following primary directories:
- sui - the Sui CLI binary
- sui_programmability - Sui's Move language integration also including games and other Move code examples for testing and reuse
- sui_core - authority server and Sui Gateway
- sui-types - coins, gas, and other object types
- explorer - object explorer for the Sui network
- sui-network - networking interfaces
And see the Rust Crates in use at:
- https://mystenlabs.github.io/sui/ - the Sui blockchain
- https://mystenlabs.github.io/narwhal/ - the Narwhal and Tusk consensus engine
- https://mystenlabs.github.io/mysten-infra/ - Mysten Labs infrastructure
To contribute updates to Sui code, send pull requests our way.
NOTE: the above
git clonecommand syncs with the
devnetbranch, which makes sure the source code is compatible with our devnet. If you want to run network locally using the latest version and don't need to interact with our devnet, you could switch to
Continue your journey through: