Skip to main content

Developer documentation

Guides, references and SDKs for Sui, Walrus, Seal, the Move language, and the products built on them. Set up an agent, pick a product, or go straight to a section.

For agents and LLMs

Open these docs in an agent, primed with the index and the markdown convention.

ClaudeChatGPTGemini

Or set it up yourself

Point an agent at the docs

An index of every page, built for language models.

curl https://docs.sui.io/llms.txt

Read any page as markdown

Append .md to any docs.sui.io URL and skip the HTML.

curl https://docs.sui.io/develop.md

Install the Sui agent skills

Sui-specific context for a coding agent.

npx skills add mystenlabs/skills --all

Connect over MCP

Streamable HTTP endpoint. Works in any MCP client.

https://sui.mcp.kapa.ai

llms-full.txtBrowse the skillsMCP setup guideSearch across sites

Products and solutions

Getting started

  • Example AppsSource repositories for end-to-end Sui example applications, covering Move patterns, dApp Kit frontends…
  • Hello, World!An overview of the Sui onboarding steps, from installing Sui and configuring a client to creating an…

Build on Sui

  • Accessing DataLearn how to choose the right data access method in Sui, GraphQL RPC, gRPC, custom indexers, or the…
  • CryptographyExplore Sui's cryptographic capabilities including signing, hashing, Groth16 zero-knowledge proof…
  • Managing PackagesOrient yourself to Sui package management: resolving dependencies, managing package addresses across…
  • ObjectsLearn about the Sui object model, how to use objects, and different object ownership methods.
  • PackagesA Move package on Sui includes one or more modules that define the package's interaction with onchain…
  • Paying for TransactionsUnderstand how Sui transactions pay for gas, how coinWithBalance selects funds automatically, when…
  • Sui ArchitectureAn introduction to Sui's architecture, covering the object model, transaction processing, consensus…
  • Testing and DebuggingTools and techniques for testing and debugging Move smart contracts and applications on the Sui network.
  • TransactionsEvery update on Sui, whether to the network itself or to objects on the network, happens through a…
  • Writing Move PackagesOverview of resources for writing Move smart contract packages on Sui.

Onchain finance

  • AllowancesAllowances let an address authorize another address to spend from its address balance within limits it…
  • Asset CustodyExplore tools and patterns for managing custody of digital assets on Sui, including fungible tokens…
  • Closed-Loop TokenClosed-Loop tokens can only be used for a specific service or by authorized users.
  • DeepBookDeepBook is Sui's native liquidity layer, providing a central limit order book for spot trading, margin…
  • Example Asset PatternsReference these examples to learn common asset patterns on Sui, including loyalty tokens, regulated…
  • Fungible TokensChoose between Sui's Coin Standard and Currency Standard for creating fungible tokens.
  • KioskLearn how to use Kiosk, Sui's decentralized system for commerce applications, and how to extend its…
  • NFTsLearn how to design, build, and extend NFTs on Sui, including soulbound tokens, rental mechanics, and…
  • Oracles for DeFi on SuiIntegrate price oracles into DeFi apps on Sui: pull versus push feeds, the shared-object model for price…
  • Permissioned Asset StandardLearn how the Permissioned Asset Standard (PAS) enforces restricted asset movement on Sui through…

Sui Stack

  • HashiHashi is the Sui native Bitcoin orchestrator that enables depositing and withdrawing BTC for use as a…
  • Messaging SDKBuild end-to-end encrypted group messaging on Sui using Seal threshold encryption, a Walrus-backed…
  • NautilusRun secure, offchain logic in trusted execution environments (TEEs), and verify it onchain to trigger…
  • Onchain primitivesSui provides native primitives for time and randomness that are accessible directly in Move contracts…
  • SuiNSReplace raw wallet addresses with human-readable .sui names using Sui Name Service (SuiNS), with onchain…
  • SuiPlay0X1 Development Guide for Game DevelopersLearn how to build games for the SuiPlay0X1 handheld gaming device.
  • WalrusStore and retrieve large binary files on Walrus, a decentralized storage and data availability protocol…
  • What is Seal?Seal is a decentralized secrets management service that uses access control policies on Sui to secure…
  • zkLoginzkLogin is a Sui primitive that lets users send transactions from a Sui address using an OAuth…

Node operation

  • Data Indexing and ArchivesOverview of data indexing, archival storage, and remote store configuration for Sui network nodes, with…
  • Full NodesGuides for setting up and operating Sui full nodes.
  • Sui ValidatorsGuides for validator nodes on the Sui network.

References

  • Sui CLISui provides command line tools to interact with the network, its features, and the Move programming…
  • Sui FrameworkThe Sui framework documentation is generated from source code comments using the Rust `cargo doc`…
  • Sui IDE SupportIDE tools and extensions for developing Move smart contracts on Sui, including language server support…
  • Sui RPCSuiJSON is a JSON-based format with restrictions that enable Sui to align JSON inputs more closely with…

Data storage with Walrus

  • Getting Started with WalrusComplete getting started guide for Walrus including installation, configuration, storing and retrieving…
  • Release NotesRelease notes for Walrus, Walrus Memory, and Walrus Sites.
  • Service ProvidersComprehensive guide for operating Walrus network services including storage nodes, aggregators, and…
  • System OverviewOverview of Walrus system concepts, including storage costs, tokenomics, and how the protocol works.
  • TroubleshootingTroubleshooting guide for common Walrus issues including configuration, binary compatibility, and…
  • Walrus ClientUse the Walrus client through the command line to store and retrieve blobs.
  • Walrus ExamplesExample applications that demonstrate different workflows and use cases on Walrus.
  • Walrus SitesDeploy decentralized websites on Walrus.

SDKs

  • BCS - Binary Canonical SerializationEncode and decode Sui Move types with Binary Canonical Serialization.
  • Kiosk SDKTypeScript SDK for interacting with Sui Kiosk onchain commerce
  • Payment KitAccept payments in any coin type on the Sui blockchain with built-in duplicate prevention.
  • Seal SDKDecentralized secrets management with threshold encryption on Sui.
  • Slush Wallet IntegrationIntegrate Slush Wallet into your Sui application for mobile and web wallet support.
  • SponsorBuild gas sponsorship services with pluggable transaction validation
  • Sui dApp KitBuild Sui apps with framework-agnostic core and React bindings.
  • Sui TypeScript CodegenGenerate type-safe TypeScript bindings from onchain Sui Move packages.
  • Sui TypeScript SDKTypeScript SDK for building on the Sui blockchain
  • Walrus SDKStore and retrieve blobs on Walrus decentralized storage using the TypeScript SDK.
  • zkSend SDKSend Sui assets through shareable claim links using the zkSend SDK.

The Move language

  • Advanced Move UsageAdvanced Move language features: modes, extended build configurations, and advanced programming…
  • Advanced ProgrammabilityAdvanced Sui programmability: patterns, events, dynamic fields, capabilities, BCS serialization, and…
  • Before We BeginSet up your Move development environment: install Sui, configure your IDE, and learn about the Move 2024…
  • ConceptsCore Sui and Move concepts: packages, accounts, transactions, addresses, and how data is stored on the…
  • GuidesPractical guides for Sui Move development: migration, upgradeability, error handling, code quality, and…
  • Move BasicsLearn Move language fundamentals: types, modules, functions, structs, abilities, generics, and control…
  • Object ModelThe Sui Object Model explained: theory and concepts behind digital asset representation, ownership, and…
  • Testing Move ProgramsTesting Move smart contracts on Sui: unit tests, test scenarios, linting, coverage reports, gas…
  • Using ObjectsLearn how to use Sui objects in Move: storage abilities, transfer functions, ownership rules, and object…