repository·main·Indexed 25 days ago
https://github.com/sui-foundation/sui-move-intro-courseAn introductory educational course maintained by the Sui Foundation for the Move programming language tailored for the Sui blockchain. The curriculum covers environment setup, Sui objects, fungible tokens, marketplace contracts, Sui Kiosk, Programmable Transaction Blocks, and advanced topics such as BCS encoding.
Bag type when you need a map-like collection that holds objects of different types, or when the types are not known at compile time. Unlike Vector or Table, which are homogeneous, a Bag allows for heterogeneous key-value pairs. The Bag struct acts as a handle to the Sui object system, where keys and values are stored as objects rather than within the Bag value itself.TokenPolicy objects. These policies control how tokens are transferred, spent, minted, and other lifecycle actions, providing more granular control than the standard Coin type.Sui Kiosk is a decentralized system for onchain commerce on Sui. It is composed of two primary shared object components that manage asset storage and trade conditions:
Kiosk + KioskOwnerCap: The Kiosk acts as a shared safe that stores assets and displays them for sale. The person holding the KioskOwnerCap is the Kiosk Owner, maintaining logical ownership of the assets even when they are physically stored within the kiosk.TransferPolicy + TransferPolicyCap: The TransferPolicy is a shared object that defines the rules and conditions for trading assets. Rules (such as royalty fee requirements) can be enabled or disabled by the holder of the TransferOwnerCap.sui::url). Developers building custom fungible tokens on Sui will heavily leverage libraries within this framework.Sui Kiosk operations are categorized into three user roles:
KioskOwnerCap. They can place assets in the kiosk, withdraw non-locked assets, list assets for sale, withdraw sales profits, and borrow/mutate owned assets.TransferPolicy.TransferPolicy for a specific type (e.g., a specific NFT collection). Creators can set rules, manage multiple rule tracks, enable/disable trades via policy, and enforce royalties globally.A Programmable Transaction Block (PTB) is a native feature of the Sui Network and Sui VM that allows developers to batch multiple individual commands into a single atomic transaction. This enables high composability and scalability by allowing the output of one command to be used as the input for a subsequent command within the same block.
Key Features:
MoveCall) executed in order.drop value, that value must be consumed by a subsequent command within the same PTB, or the transaction will fail.Sui Move provides two ways to attach heterogeneous fields to an object at runtime:
Dynamic Fields (sui::dynamic_field):
store ability.key ability.Dynamic Object Fields (sui::dynamic_object_field):
key and store abilities, and id: UID as the first field).You can create a new Kiosk using two different methods. A Kiosk is a shared object, and the owner receives a KioskOwnerCap to manage it.
Deploy a contract that calls kiosk::new(ctx), shares the Kiosk object via transfer::public_share_object, and transfers the KioskOwnerCap to the sender via transfer::public_transfer.
kiosk::default()Use the entry kiosk::default() function to automatically handle the creation, sharing of the Kiosk, and transfer of the KioskOwnerCap in one step.
To interact via the CLI, use:
sui client call --package $KIOSK_PACKAGE_ID --module kiosk --function new_kioskAfter creation, export the resulting object IDs for subsequent operations:
export KIOSK=<Object id of newly created Kiosk>
export KIOSK_OWNER_CAP=<Object id of newly created KioskOwnerCap>To improve the development experience in VS Code, install the Move Analyzer plugin from the VS Marketplace. To ensure compatibility with Sui-style wallet addresses, you must also install the analyzer with the address20 feature enabled via Cargo.
cargo install --git https://github.com/move-language/move move-analyzer --features "address20"Custom events allow indexers to track specific on-chain actions. When defining custom events, follow these conventions:
TranscriptRequested) because they describe actions that have already occurred.copy and drop abilities. They are not assets; they are used solely for data logging.sui::event::emit method to trigger the event.Example of defining and emitting a custom event:
// 1. Define the event struct with copy and drop abilities
public struct TranscriptRequested has copy, drop {
wrapper_id: ID,
requester: address,
intended_address: address,
}
// 2. Emit the event within a function
public fun request_transcript(
transcript: WrappableTranscript,
intended_address: address,
ctx: &mut TxContext,
) {
let folder_object = Folder {
id: object::new(ctx),
transcript,
intended_address,
};
event::emit(TranscriptRequested {
wrapper_id: object::id(&folder_object),
requester: ctx.sender(),
intended_address,
});
transfer::transfer(folder_object, intended_address);
}public struct TranscriptRequested has copy, drop {
wrapper_id: ID,
requester: address,
intended_address: address,
}
public fun request_transcript(
transcript: WrappableTranscript,
intended_address: address,
ctx: &mut TxContext,
) {
let folder_object = Folder {
id: object::new(ctx),
transcript,
intended_address,
};
event::emit(TranscriptRequested {
wrapper_id: object::id(&folder_object),
requester: ctx.sender(),
intended_address,
});
transfer::transfer(folder_object, intended_address);
}