| title |
|---|
Learn About Sui |
Sui: pronounced "sweet" without the "T" - with Transactions (loads of them), things are SWEET indeed. :-)
Welcome to the documentation for the Sui platform. Sui is built on the core Move programming language. This documentation assumes that you have a basic working knowledge of Move. To learn more about the differences between core Move and Sui Move, see How Sui Move differs from core Move.
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
mainbranch. Use thedevnetversion for app development on top of Sui. Use the Latest buildmainbranch for contributing to the Sui blockchain itself. Always check and submit fixes to themainbranch.
Check for the latest release of Sui on the Releases page.
We made the following updates to Sui documentation:
- Bullshark replaced Tusk as the default consensus component of the Narwhal-based Sui consensus engine for reduced latency and support for fairness with slower validators. Note, Tusk may still be used.
- You must now specify the key scheme type as an argument (
ed25519orsecp256k1) when running either thesui keytool generateorsui client new-addresscommands, as shown in adding accounts to the client. - Follow the Cryptography (math) example for a simple contract that hashes a piece of data using keccak256, recovers a Secp256k1 signature to its public key, and verifies a Secp256k1 signature, producing an event with the results.
- Sui now supports shared objects that anyone can read or write to. For an example of creating and accessing a shared object, see Shared Object on https://examples.sui.io/.
- Interact with the Sui network using our new Rust SDK, a collection of Rust language JSON-RPC wrapper and crypto utilities.
- Sui now supports development using Microsoft Windows 11, macOS, and Linux. See install Sui for the prerequisites of each operating system.
See the Sui doc/src history for a complete changelog of updates to this site.
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
The links in the section point to information to help you start working with Sui.
Go to the Move Quick Start for information about installation, defining custom objects, object operations (create/destroy/update/transfer/freeze), publishing, and invoking your published code.
See the Sui CLI client Quick Start for information about installation, querying the chain, client setup, sending transfer transactions, and viewing the effects.
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.
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 and search this site however you see fit. If you're new to Sui, we recommend that you review the following content in this order:
Learn - includes information to help you learn:
Build - includes information about how to:
- Install Sui
- Create smart contracts with Move
- Set up and configure a local Sui network
- Start a local JSON-RPC Gateway server
Explore - includes more in-depth information about:
Contribute - includes the following:
- Frequently Asked Questions
- Logging, Tracing, Metrics, and Observability
- Research Papers
- Sui Code of Conduct
Additional resources - lets you:
- Employ the Sui API Reference files for the Sui JSON-RPC API.
- View the Mysten Labs YouTube channel for introductory videos on technology and partners.