mcpField
S
sui-move

sui-move

github.com/mystenlabsDevelopment19377 installsUpdated today
Repository

About sui-move

A reference skill for Sui Move developers, with focused material on language fundamentals, events, and coins. It organizes guidance by task and includes resource-safety concepts, common rules, and pitfalls.

Key features

  1. 01Move types, abilities, and resource safety
  2. 02Guidance on events and coin operations
  3. 03Task-based reference routing
  4. 04Common mistakes and safety rules

Use cases

  1. 01Writing Move modules and structs
  2. 02Creating fungible tokens and handling events
  3. 03Reviewing access control and object destruction

MCP support

When available, it can query the Sui documentation MCP server to verify answers and supplement details not covered by its reference files.

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/mystenlabs/skills --skill sui-move

After installing, type/sui-movein Claude Code to confirm it loaded.

Bundled files

References and scripts installed along with SKILL.md.

events-coins.md
move.md
evals/
code-evals.json
evals.json

Details

From the project README

Sui Move

MCP tool: When available in your environment, also query the Sui documentation MCP server (https://sui.mcp.kapa.ai) for up-to-date answers. Use it for verification and for details not covered by these reference files.

Source constraint: All information in this skill is sourced exclusively from docs.sui.io and move-book.com. When extending or updating this skill, only pull from these sources. Do not use third-party blogs, tutorials, or unofficial documentation.

Move is Sui's smart contract language, designed around resource safety and an object-centric data model. This skill covers the core Move language: the type system, abilities, resource safety, events, and coins.

This skill routes to focused reference files. Load only the ones relevant to the current task.


Reference files (this skill)

move — Move Language Fundamentals

Path: move.md Load when: writing Move code, working with abilities, TxContext, time/Clock, init functions, One-Time Witness, internal::Permit<T>, type_name deprecations, packages, modules, structs, resource safety, access control patterns, admin rotation, deny lists, security review, or advanced design patterns (ability dosing, phantom events, shared-object concurrency, receiver syntax, error attributes, transfer::receive, field privacy, macros). Covers: the four abilities and common combinations, TxContext methods, Clock object, init functions, OTW pattern, internal::Permit<T> type-level authorization, type_name deprecations, packages and upgrades, modules, structs, resource safety and object destruction, a worked Greeting example, admin rotation (two-step transfer), regulated coins and deny lists, security review checklist, advanced design patterns (ability dosing, phantom-type events, event denormalization, shared-object & vs &mut, receiver-syntax ordering, #[error] constants, transfer::receive privacy, field privacy, macro gotchas).

events-coins — Events and Coins

Path: events-coins.md Load when: emitting events, subscribing to events offchain, creating fungible tokens, or working with coin operations (mint, burn, split, join). Covers: event emission, event struct requirements, coin::create_currency, TreasuryCap, CoinMetadata, standard coin operations.


Related skills (load from separate skill directories)

TopicSkillLoad when
Object model, ownership, dynamic fields, collections, Display, transfer patternsobject-model/Designing data models, choosing ownership types, using dynamic fields or collections, setting up Object Display
Programmable transaction blocks, commands, equivocationptbs/Building PTBs, composing transactions, sponsored transactions, troubleshooting transaction errors
Frontend dApp development, dApp Kit, wallet connectionfrontend-apps/Building React/Vue frontends, wallet integration, querying onchain state from the browser
Project setup, Move.toml, dependencies, publishingsui-move-project/Creating a Move project, configuring Move.toml, resolving build errors, publishing packages
Move 2024 syntax, method syntax, macrosmodern-move-syntax/Using Move 2024 edition features like method syntax, vector literals, option/loop macros
Composable function designcomposable-move-functions/Designing functions for PTB composability, parameter ordering, return patterns
Unit testing conventionsmove-unit-testing/Writing Move unit tests, test patterns, expected_failure, cleanup
Naming conventionsnaming-conventions/Naming errors, constants, capabilities, events, getters, dynamic field keys

Routing guide

TaskLoad
Writing a Move struct with abilitiesmove
Using TxContext or the Clock objectmove
Writing an init function or OTWmove
Using type_name functionsmove
Proving module authority with internal::Permit<T>move
Publishing or upgrading a packagemove
Destroying an object without dropmove
Emitting or subscribing to eventsevents-coins
Creating a fungible tokenmove + events-coins
Designing an object data modelobject-model/ skill
Choosing shared vs owned objectsobject-model/ skill
Using dynamic fields or collectionsobject-model/ skill
Setting up Object Displayobject-model/ skill
Building a PTBptbs/ skill
Implementing sponsored transactionsptbs/ skill
Building a frontendfrontend-apps/ skill
Setting up Move.tomlsui-move-project/ skill
Writing a complete smart contractmove + events-coins + object-model/ + naming-conventions/ + modern-move-syntax/
Code reviewmove + events-coins + composable-move-functions/ + naming-conventions/ + modern-move-syntax/
Security review / access control auditmove + object-model/ (patterns) + events-coins
Advanced design patterns / performance tuningmove

Rules

  • Always use object::new(ctx) to create UIDs. There is no other way.
  • Use public_transfer (not transfer) when the object has store and the call originates outside the defining module.
  • Event structs must have copy and drop abilities.
  • No as casts on numeric types. Use from/into or try_from/try_into.
  • To destroy an object without drop, unpack the struct and call object::delete(id) on the UID.

Common mistakes

  • Confusing transfer with public_transfer. The non-public variant only works within the defining module. Calling it from another module is a compile error.
  • Forgetting to delete the UID. When destroying an object, you must call object::delete(id) on the UID field.
  • Assuming ctx.epoch_timestamp_ms() is precise. It returns the epoch start time. Use the Clock object (0x6) for real-time timestamps.

Comments

Markdown supported