index.md

title
Learning Sui

Sui: pronounced "sweet" without the "T" - with Transactions (loads of them), things are SWEET indeed. :-)

Welcome to the documentation for the Sui platform. Since Sui is built upon the core Move programming language, you should familiarize yourself with it and use this content to apply the differences. For a summary of these differences, see Sui compared to other blockchains.

For a deep dive into Sui technology, see the Sui Smart Contracts Platform white paper. Find answers to common questions about our roadmap and more in our FAQ.

Important: This site is available in two versions in the menu at top left: the default and stable Devnet branch and the Latest build upstream main branch. Use the devnet version for app development on top of Sui. Use the Latest build main branch for contributing to the Sui blockchain itself. Always check and submit fixes to the main branch.

built from the upstream main branch and therefore will contain updates not yet found in devnet.

See what's new

Find the latest updates to these contents in this section:

• This site is now available in two versions in the menu at top left: the default and stable Devnet branch and the Latest build upstream main branch. Use the devnet version for app development on top of Sui. Use the Latest build main branch for contributing to the Sui blockchain itself. Always check and submit fixes to the main branch.
• Sui now supports development using Microsoft Windows 11, macOS, and Linux. See install Sui for the prerequisites of each operating system.
• sui::id is now sui::object and VersionedID is now Info. Use the Object module that has replaced the former ID.move.
• Find a list of single-writer apps that would benefit from Sui's advantages in handling simple transactions.
• Sui version 0.6.1 released to DevNet. See the #sui-release-notes channel in Discord for details on this and prior releases.
• Install the Sui Wallet Browser Extension to create NFTs, transfer coins, and carry out common transactions in a Chrome tab.
• Sui Move is feature complete and ready for you to write safe and efficient smart contracts. See https://examples.sui.io/ to learn Sui Move by example.
• If your application is written in JavaScript or TypeScript, follow the TypeScript SDK documentation and reference files.

For a complete view of all changes in the Sui devnet branch, see: https://github.com/MystenLabs/sui/commits/devnet

For upstream updates in the main branch, see: https://github.com/MystenLabs/sui/commits/main

See the Sui doc/src history for a complete changelog of updates to this site.

Kickstart development

Write Smart Contracts with Move

Go to the Move Quick Start for installation, defining custom objects, object operations (create/destroy/update/transfer/freeze), publishing, and invoking your published code.

Start the Sui network with Sui CLI client

See the Sui CLI client Quick Start for installation, querying the chain, client setup, sending transfer transactions, and viewing the effects.

Take the tic-tac-toe tutorial

Proceed to the Sui Tutorial for a summary view of setting up your environment, starting a Sui network, gathering accounts and gas, and publishing and playing a game in Sui.

Program with Objects

Finish with the detailed Programming with objects tutorial series offering detailed guidance on manipulating Sui objects, from creation and storage through wrapping and using child objects.

Navigate this site

Navigate and search this site however you see fit. Here is the order we recommend if you are new to Sui:

1. Learn about Sui, how Sui Move differs from Core Move, and how Sui works starting in this very section.
2. Build smart contracts, the Sui client, a Sui fullnode, and more.
3. Explore prototypes and examples.
4. Contribute to Sui by joining the community, making enhancements, and learning about Mysten Labs.
5. Employ the Sui API Reference reference files for the Sui JSON-RPC API.
6. View the Mysten Labs YouTube channel for introductory videos on technology and partners.