12 | );
13 | }
14 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/constants.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | module book::constants;
5 |
6 | const MAX: u64 = 100;
7 |
8 | // however you can pass constant outside using a function
9 | public fun max(): u64 {
10 | MAX
11 | }
12 |
13 | // or using
14 | public fun is_max(num: u64): bool {
15 | num == MAX
16 | }
17 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/function_use.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_variable, unused_function)]
5 | // ANCHOR: use_math
6 | module book::use_math;
7 |
8 | use book::math;
9 |
10 | fun call_add() {
11 | // function is called via the path
12 | let sum = math::add(1, 2);
13 | }
14 | // ANCHOR_END: use_math
15 |
--------------------------------------------------------------------------------
/book/before-we-begin/move-2024.md:
--------------------------------------------------------------------------------
1 | # Move 2024
2 |
3 | Move 2024 is the current edition of the Move language maintained by Mysten Labs. All of the examples
4 | in this book are written in Move 2024. If you're used to the pre-2024 version of Move, refer
5 | to the [Move 2024 Migration Guide](./../guides/2024-migration-guide.md) to learn about the changes
6 | and improvements in the new edition.
7 |
8 |
9 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/importing-modules-external.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_use)]
5 | // ANCHOR: external
6 | module book::imports;
7 |
8 | use std::string; // std = 0x1, string is a module in the standard library
9 | use sui::coin; // sui = 0x2, coin is a module in the Sui Framework
10 | // ANCHOR_END: external
11 |
--------------------------------------------------------------------------------
/reference/TODO:
--------------------------------------------------------------------------------
1 | # TODO
2 |
3 | ## Long term
4 |
5 | - Grammar examples aren't readable
6 | - We don't describe the associativity of conditionals or other control flow constructions and {}
7 | - We don't describe identifier rules in a single place
8 | - We don't describe rules for namespaces and uses
9 | - attributes/annotations in general
10 | - describe paths/places more like the compiler thinks about them in 2024
11 |
--------------------------------------------------------------------------------
/book/appendix/acknowledgements.md:
--------------------------------------------------------------------------------
1 | # Appendix F: Acknowledgements
2 |
3 | [The Rust Book](https://doc.rust-lang.org/book) has been a great inspiration for this book. I am
4 | personally grateful to the authors of the book, Steve Klabnik and Carol Nichols, for their work, as
5 | I have learned a lot from it. This book is a small tribute to their work and an attempt to bring a
6 | similar learning experience to the Move community.
7 |
--------------------------------------------------------------------------------
/book/before-we-begin/index.md:
--------------------------------------------------------------------------------
1 | # Before We Begin
2 |
3 | Move requires an environment to run and develop applications, and in this small chapter we will
4 | cover the prerequisites for the Move language: how to set up your IDE, how to install the compiler
5 | and what is Move 2024. If you are already familiar with these topics or have a CLI installed, you
6 | can skip this chapter and proceed to [the next one](../your-first-move/hello-world.md).
7 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/transaction-context.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_variable)]
5 | module book::transaction_context;
6 |
7 | // ANCHOR: reading
8 | public fun some_action(ctx: &TxContext) {
9 | let me = ctx.sender();
10 | let epoch = ctx.epoch();
11 | let digest = ctx.digest();
12 | // ...
13 | }
14 | // ANCHOR_END: reading
15 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/importing-modules.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_use)]
5 | // ANCHOR: module_one
6 | module book::module_one;
7 |
8 | /// Struct defined in the same module.
9 | public struct Character has drop {}
10 |
11 | /// Simple function that creates a new `Character` instance.
12 | public fun new(): Character { Character {} }
13 | // ANCHOR_END: module_one
14 |
--------------------------------------------------------------------------------
/site/src/theme/CodeInline/index.tsx:
--------------------------------------------------------------------------------
1 | import React, { type ReactNode } from 'react';
2 | import type { Props } from '@theme/CodeInline';
3 |
4 | // Simple component used to render inline code blocks
5 | // its purpose is to be swizzled and customized
6 | // MDX 1 used to have a inlineCode comp, see https://mdxjs.com/migrating/v2/
7 | export default function CodeInline(props: Props): ReactNode {
8 | return ;
9 | }
10 |
--------------------------------------------------------------------------------
/book/concepts/index.md:
--------------------------------------------------------------------------------
1 | # Concepts
2 |
3 | In this chapter you will learn about the basic concepts of Sui and Move. You will learn what is a
4 | package, how to interact with it, what is an account and a transaction, and how data is stored on
5 | Sui. While this chapter is not a complete reference, and you should refer to the
6 | [Sui Documentation](https://docs.sui.io) for that, it will give you a good understanding of the
7 | basic concepts required to write Move programs on Sui.
8 |
--------------------------------------------------------------------------------
/packages/hello_world/sources/hello_world.move:
--------------------------------------------------------------------------------
1 | // ANCHOR: source
2 | /// The module `hello_world` under named address `hello_world`.
3 | /// The named address is set in the `Move.toml`.
4 | module hello_world::hello_world;
5 |
6 | // Imports the `String` type from the Standard Library
7 | use std::string::String;
8 |
9 | /// Returns the "Hello World!" as a `String`.
10 | public fun hello_world(): String {
11 | b"Hello, World!".to_string()
12 | }
13 | // ANCHOR_END: source
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/importing-modules-two.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_use)]
5 | // ANCHOR: module_two
6 | module book::module_two;
7 |
8 | use book::module_one; // importing module_one from the same package
9 |
10 | /// Calls the `new` function from the `module_one` module.
11 | public fun create_and_ignore() {
12 | let _ = module_one::new();
13 | }
14 | // ANCHOR_END: module_two
15 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/module-initializer-2.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | // ANCHOR: other
5 | // In the same package as the `shop` module
6 | module book::bank;
7 |
8 | public struct Bank has key {
9 | id: UID,
10 | /* ... */
11 | }
12 |
13 | fun init(ctx: &mut TxContext) {
14 | transfer::share_object(Bank {
15 | id: object::new(ctx)
16 | });
17 | }
18 | // ANCHOR_END: other
19 |
--------------------------------------------------------------------------------
/packages/samples/sources/your-first-move/hello_world.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | module book::hello_world;
5 |
6 | use std::string::String;
7 |
8 | public fun hello_world(): String {
9 | b"Hello, World!".to_string()
10 | }
11 |
12 | #[test_only]
13 | use std::unit_test::assert_eq;
14 |
15 | #[test]
16 | fun test_is_hello_world() {
17 | let expected = b"Hello, World!".to_string();
18 | assert_eq!(hello_world(), expected);
19 | }
20 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/importing-modules-self.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_use)]
5 | // ANCHOR: self
6 | module book::self_imports;
7 |
8 | // imports the `Character` struct, and the `module_one` module
9 | use book::module_one::{Self, Character};
10 |
11 | /// Calls the `new` function from the `module_one` module.
12 | public fun create_character(): Character {
13 | module_one::new()
14 | }
15 | // ANCHOR_END: self
16 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/comments-line.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_function, unused_variable)]
5 | // ANCHOR: main
6 | module book::comments_line;
7 |
8 | // let's add a note to everything!
9 | fun some_function_with_numbers() {
10 | let a = 10;
11 | // let b = 10 this line is commented and won't be executed
12 | let b = 5; // here comment is placed after code
13 | a + b; // result is 15, not 10!
14 | }
15 | // ANCHOR_END: main
16 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/importing-modules-conflict-resolution.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_use)]
5 | // ANCHOR: conflict
6 | module book::conflict_resolution;
7 |
8 | // `as` can be placed after any import, including group imports
9 | use book::module_one::{Self as mod, Character as Char};
10 |
11 | /// Calls the `new` function from the `module_one` module.
12 | public fun create(): Char {
13 | mod::new()
14 | }
15 | // ANCHOR_END: conflict
16 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/importing-modules-grouped.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_use)]
5 | // ANCHOR: grouped
6 | module book::grouped_imports;
7 |
8 | // imports the `new` function and the `Character` struct from
9 | // the `module_one` module
10 | use book::module_one::{new, Character};
11 |
12 | /// Calls the `new` function from the `module_one` module.
13 | public fun create_character(): Character {
14 | new()
15 | }
16 | // ANCHOR_END: grouped
17 |
--------------------------------------------------------------------------------
/book/appendix/publications.md:
--------------------------------------------------------------------------------
1 | # Appendix D: Publications
2 |
3 | This section lists publications related to Move and Sui.
4 |
5 | - [The Move Borrow Checker](https://arxiv.org/abs/2205.05181) by Sam Blackshear, John Mitchell, Todd
6 | Nowacki, Shaz Qadeer.
7 | - [Resources: A Safe Language Abstraction for Money](https://arxiv.org/abs/2004.05106) by Sam
8 | Blackshear, David L. Dill, Shaz Qadeer, Clark W. Barrett, John C. Mitchell, Oded Padon, Yoni
9 | Zohar.
10 | - [Robust Safety for Move](https://arxiv.org/abs/2110.05043) by Marco Patrignani, Sam Blackshear
11 |
--------------------------------------------------------------------------------
/book/storage/index.md:
--------------------------------------------------------------------------------
1 | # Using Objects
2 |
3 | In the [Object Model][object-model] chapter, we introduced the shift in the Move language from an
4 | account-based model to an object-based one. This chapter takes a closer look at that model. You’ll
5 | learn how objects work and how to put them to use in your Sui applications.
6 |
7 | If you haven’t read the [Object Model][object-model] chapter yet, we recommend starting there before
8 | continuing.
9 |
10 | [object-model]: ./../object
11 |
12 |
13 |
--------------------------------------------------------------------------------
/book/programmability/index.md:
--------------------------------------------------------------------------------
1 | # Advanced Programmability
2 |
3 | In previous chapters we've covered [the basics of Move](./../move-basics) and
4 | [Sui Storage Model](./../storage). Now it's time to dive deeper into the advanced topics of Sui
5 | programmability.
6 |
7 | This chapter introduces more complex concepts, practices and features of Move and Sui that are
8 | essential for building more sophisticated applications. It is intended for developers who are
9 | already familiar with the basics of Move and Sui, and are looking to expand their knowledge and
10 | skills.
11 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/comments-block.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_function)]
5 | // ANCHOR: main
6 | module book::comments_block;
7 |
8 | fun /* you can comment everywhere */ go_wild() {
9 | /* here
10 | there
11 | everywhere */ let a = 10;
12 | let b = /* even here */ 10; /* and again */
13 | a + b;
14 | }
15 | /* you can use it to remove certain expressions or definitions
16 | fun empty_commented_out() {
17 |
18 | }
19 | */
20 | // ANCHOR_END: main
21 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/constants-config.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | // ANCHOR: config
5 | module book::config;
6 |
7 | const ITEM_PRICE: u64 = 100;
8 | const TAX_RATE: u64 = 10;
9 | const SHIPPING_COST: u64 = 5;
10 |
11 | /// Returns the price of an item.
12 | public fun item_price(): u64 { ITEM_PRICE }
13 | /// Returns the tax rate.
14 | public fun tax_rate(): u64 { TAX_RATE }
15 | /// Returns the shipping cost.
16 | public fun shipping_cost(): u64 { SHIPPING_COST }
17 | // ANCHOR_END: config
18 |
--------------------------------------------------------------------------------
/book/move-basics/index.md:
--------------------------------------------------------------------------------
1 | # Move Basics
2 |
3 | This chapter is all about the basic syntax of the Move language. It covers the basics of the
4 | language, such as types, modules, functions, and control flow. It focuses on the language without a
5 | storage model or a blockchain, and explains the essential concepts of the language. To learn
6 | features specific to Sui, such as storage functions and abilities, refer to the
7 | [Using Objects](./../storage/) chapter, however, it is recommended to start with this chapter first.
8 |
9 |
10 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/module-members.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_function, unused_const, unused_use)]
5 | // ANCHOR: members
6 | module book::my_module_with_members;
7 |
8 | // import
9 | use book::my_module;
10 |
11 | // a constant
12 | const CONST: u8 = 0;
13 |
14 | // a struct
15 | public struct Struct {}
16 |
17 | // method alias
18 | public use fun function as Struct.struct_fun;
19 |
20 | // function
21 | fun function(_: &Struct) { /* function body */ }
22 | // ANCHOR_END: members
23 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/collections.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_variable, unused_field)]
5 | // ANCHOR: vector
6 | module book::collections_vector;
7 |
8 | use std::string::String;
9 |
10 | /// The Book that can be sold by a `BookStore`
11 | public struct Book has key, store {
12 | id: UID,
13 | name: String
14 | }
15 |
16 | /// The BookStore that sells `Book`s
17 | public struct BookStore has key, store {
18 | id: UID,
19 | books: vector
20 | }
21 | // ANCHOR_END: vector
22 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/importing-modules-members.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_use)]
5 | // ANCHOR: members
6 | module book::more_imports;
7 |
8 | use book::module_one::new; // imports the `new` function from the `module_one` module
9 | use book::module_one::Character; // importing the `Character` struct from the `module_one` module
10 |
11 | /// Calls the `new` function from the `module_one` module.
12 | public fun create_character(): Character {
13 | new()
14 | }
15 | // ANCHOR_END: members
16 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/capability-4.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | module book::cap_vs_addr;
5 |
6 | public struct User has key, store { id: UID }
7 |
8 | // ANCHOR: with_capability
9 | /// Grants the owner the right to create new users in the system.
10 | public struct AdminCap {}
11 |
12 | /// Creates a new user in the system. Requires the `AdminCap` capability to be
13 | /// passed as the first argument.
14 | public fun new(_: &AdminCap, ctx: &mut TxContext): User {
15 | User { id: object::new(ctx) }
16 | }
17 | // ANCHOR_END: with_capability
18 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/comments-doc.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_function, unused_const, unused_variable, unused_field)]
5 | // ANCHOR: main
6 | /// Module has documentation!
7 | module book::comments_doc;
8 |
9 | /// This is a 0x0 address constant!
10 | const AN_ADDRESS: address = @0x0;
11 |
12 | /// This is a struct!
13 | public struct AStruct {
14 | /// This is a field of a struct!
15 | a_field: u8,
16 | }
17 |
18 | /// This function does something!
19 | /// And it's documented!
20 | fun do_something() {}
21 | // ANCHOR_END: main
22 |
--------------------------------------------------------------------------------
/packages/samples/sources/your-first-move/hello_world_debug.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | module book::hello_world_debug;
5 |
6 | use std::string::String;
7 | use std::debug;
8 |
9 | public fun hello_world(): String {
10 | let result = b"Hello, World!".to_string();
11 | debug::print(&result);
12 | result
13 | }
14 |
15 | #[test_only]
16 | use std::unit_test::assert_eq;
17 |
18 | #[test]
19 | fun test_is_hello_world() {
20 | let expected = b"Hello, World!".to_string();
21 | let actual = hello_world();
22 |
23 | assert_eq!(actual, expected);
24 | }
25 |
--------------------------------------------------------------------------------
/book/index.md:
--------------------------------------------------------------------------------
1 | # The Move Book
2 |
3 |
4 |
5 | This is The Move Book - a comprehensive guide to the Move programming language and the Sui
6 | blockchain. The book is intended for developers who are interested in learning about Move and
7 | building on Sui.
8 |
9 |
10 |
11 | The book is in active development and a work in progress. If you have any feedback or suggestions,
12 | feel free to open an issue or a pull request on the
13 | [GitHub repository](https://github.com/MystenLabs/move-book).
14 |
15 |
16 |
17 | > If you're looking for The Move Reference, you can find it [here](/reference).
18 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/capability-2.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | // ANCHOR: admin_cap
5 | module book::admin_cap;
6 |
7 | /// The capability granting the admin privileges in the system.
8 | /// Created only once in the `init` function.
9 | public struct AdminCap has key { id: UID }
10 |
11 | /// Create the AdminCap object on package publish and transfer it to the
12 | /// package owner.
13 | fun init(ctx: &mut TxContext) {
14 | transfer::transfer(
15 | AdminCap { id: object::new(ctx) },
16 | ctx.sender()
17 | )
18 | }
19 | // ANCHOR_END: admin_cap
20 |
--------------------------------------------------------------------------------
/book/404.md:
--------------------------------------------------------------------------------
1 | # Page not Found
2 |
3 | You're looking for a page that doesn't exist, or has been moved. Please check the URL and try again.
4 |
5 | > Here are the links you may be looking for:
6 | >
7 | > - [The Move Book](/) - the main page of the book
8 | > - [The Move Reference](/reference) - the Move Language Reference
9 |
10 | Recently we updated the structure of the book and some pages have been moved or renamed. If you're
11 | looking for the old version of the book, please, see the
12 | ["archive" branch in the repository](https://github.com/MystenLabs/move-book/tree/archive). Though
13 | we highly recommend using [the latest version of the book](/).
14 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/collections-4.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_use, lint(collection_equality))]
5 | module book::collections_compare_vec_set;
6 |
7 | use sui::vec_set;
8 |
9 | #[test_only]
10 | use std::unit_test::assert_eq;
11 |
12 | #[test, expected_failure]
13 | fun test_compare() {
14 | // ANCHOR: vec_set_comparison
15 | let mut set1 = vec_set::empty();
16 | set1.insert(1);
17 | set1.insert(2);
18 |
19 | let mut set2 = vec_set::empty();
20 | set2.insert(2);
21 | set2.insert(1);
22 |
23 | assert_eq!(set1, set2); // aborts!
24 | // ANCHOR_END: vec_set_comparison
25 | }
26 |
--------------------------------------------------------------------------------
/site/src/theme/Icon/Image/index.tsx:
--------------------------------------------------------------------------------
1 | import React, { type ReactNode } from 'react';
2 | import type { Props } from '@theme/Icon/Copy';
3 |
4 | /**
5 | * Replace default icon with FontAwesome icon.
6 | */
7 | export default function IconImage(props: Props): ReactNode {
8 | return (
9 |
10 |
11 |
12 | //
18 | );
19 | }
20 |
--------------------------------------------------------------------------------
/reference/primitive-types.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: 'Primitive Types | Reference'
3 | description: ''
4 | ---
5 |
6 | # Primitive Types
7 |
8 | The primitive types are the basic building blocks of the language.
9 |
10 | These primitive types can be used on their own or can be used to build more complex,
11 | user-defined types, e.g. in a [`struct`](./structs).
12 |
13 | - [Integers](./primitive-types/integers)
14 | - [Bool](./primitive-types/bool)
15 | - [Address](./primitive-types/address)
16 | - [Vector](./primitive-types/vector)
17 |
18 | These primitive types are used in conjunction with other types
19 |
20 | - [References](./primitive-types/references)
21 | - [Tuples and Unit](./primitive-types/tuples)
22 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/capability-3.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | module book::addr_vs_cap;
5 |
6 | public struct User has key, store { id: UID }
7 |
8 | // ANCHOR: with_address
9 | /// Error code for unauthorized access.
10 | const ENotAuthorized: u64 = 0;
11 |
12 | /// The application admin address.
13 | const APPLICATION_ADMIN: address = @0xa11ce;
14 |
15 | /// Creates a new user in the system. Requires the sender to be the application
16 | /// admin.
17 | public fun new(ctx: &mut TxContext): User {
18 | assert!(ctx.sender() == APPLICATION_ADMIN, ENotAuthorized);
19 | User { id: object::new(ctx) }
20 | }
21 | // ANCHOR_END: with_address
22 |
23 |
--------------------------------------------------------------------------------
/book/object/index.md:
--------------------------------------------------------------------------------
1 | # Object Model
2 |
3 | This chapter describes the Object Model of Sui. It focuses on the theory and concepts behind the
4 | Object Model, preparing you for a practical dive into Sui Storage operations and resource ownership.
5 | For convenience and easier lookup, we split the chapter into several sections, each covering a
6 | specific aspect of the Object Model.
7 |
8 |
9 |
10 | In no way should this chapter be considered a comprehensive guide to the Object Model. It is only a
11 | high-level overview of the concepts and principles behind the Object Model.
12 |
13 | For a more detailed description, refer to the
14 | [Sui Documentation](https://docs.sui.io/concepts/object-model).
15 |
16 |
17 |
--------------------------------------------------------------------------------
/packages/samples/sources/your-first-move/hello_world_docs.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | /// This module contains a function that returns a string "Hello, World!".
5 | module book::hello_world_docs;
6 |
7 | use std::string::String;
8 |
9 | /// As the name says: returns a string "Hello, World!".
10 | public fun hello_world(): String {
11 | b"Hello, World!".to_string()
12 | }
13 |
14 | #[test_only]
15 | use std::unit_test::assert_eq;
16 |
17 | #[test]
18 | /// This is a test for the `hello_world` function.
19 | fun test_is_hello_world() {
20 | let expected = b"Hello, World!".to_string();
21 | let actual = hello_world();
22 |
23 | assert_eq!(actual, expected);
24 | }
25 |
--------------------------------------------------------------------------------
/book/appendix/reserved-addresses.md:
--------------------------------------------------------------------------------
1 | # Appendix B: Reserved Addresses
2 |
3 | Reserved addresses are special addresses that have a specific purpose on Sui. They stay the same
4 | between environments and are used for specific native operations.
5 |
6 | - `0x1` - address of the [Standard Library](./../move-basics/standard-library.md) (alias `std`)
7 | - `0x2` - address of the [Sui Framework](./../programmability/sui-framework.md) (alias `sui`)
8 | - `0x5` - address of the `SuiSystem` object
9 | - `0x6` - address of the system [`Clock` object](./../programmability/epoch-and-time.md)
10 | - `0x8` - address of the system `Random` object
11 | - `0xc` - address of the system `CoinRegistry` object
12 | - `0x403` - address of the `DenyList` system object
13 |
--------------------------------------------------------------------------------
/reference/control-flow.md:
--------------------------------------------------------------------------------
1 | ---
2 | title: 'Control Flow | Reference'
3 | description: ''
4 | ---
5 |
6 | # Control Flow
7 |
8 | Move offers multiple constructs for control flow based on
9 | [boolean expressions](./primitive-types/bool), including common programming constructs such as `if`
10 | expressions and `while` and `for` loops, along with advanced control flow structures including
11 | labels for loops and escapable named blocks. It also supports more complex constructs based on
12 | structural pattern matching.
13 |
14 | - [Conditional Expressions](./control-flow/conditionals)
15 | - [Pattern Matching](./control-flow/pattern-matching)
16 | - [Loops](./control-flow/loops)
17 | - [Labeled Control FLow](./control-flow/labeled-control-flow)
18 |
--------------------------------------------------------------------------------
/packages/reference/sources/abilities.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_field)]
5 | module ref::abilities {
6 |
7 | // ANCHOR: annotating_datatypes
8 | public struct Ignorable has drop { f: u64 }
9 | public struct Pair has copy, drop, store { x: u64, y: u64 }
10 | public struct MyVec(vector) has copy, drop, store;
11 |
12 | public enum IgnorableEnum has drop { Variant }
13 | public enum PairEnum has copy, drop, store { Variant }
14 | public enum MyVecEnum { Variant } has copy, drop, store;
15 | // ANCHOR_END: annotating_datatypes
16 |
17 | // ANCHOR: conditional_abilities
18 | // public struct Cup has copy, drop, store, key { item: T }
19 | // ANCHOR_END: conditional_abilities
20 |
21 | }
22 |
--------------------------------------------------------------------------------
/reference/index.md:
--------------------------------------------------------------------------------
1 | # The Move Reference
2 |
3 | Welcome to Move, a next generation language for secure asset programming. Its primary use case is in
4 | blockchain environments, where Move programs are used to construct state changes. Move allows
5 | developers to write programs that flexibly manage and transfer assets, while providing the security
6 | and protections against attacks on those assets. However, Move has been developed with use cases in
7 | mind outside a blockchain context as well.
8 |
9 | Move takes its cue from [Rust](https://www.rust-lang.org/) by using resource types with move (hence
10 | the name) semantics as an explicit representation of digital assets, such as currency.
11 |
12 |
13 |
--------------------------------------------------------------------------------
/site/src/theme/ColorModeToggle/styles.module.css:
--------------------------------------------------------------------------------
1 | .toggle {
2 | width: 2rem;
3 | height: 2rem;
4 | }
5 |
6 | .toggleButton {
7 | -webkit-tap-highlight-color: transparent;
8 | align-items: center;
9 | display: flex;
10 | justify-content: center;
11 | width: 100%;
12 | height: 100%;
13 | border-radius: 50%;
14 | transition: background var(--ifm-transition-fast);
15 | }
16 |
17 | .toggleButton:hover {
18 | background: var(--ifm-color-emphasis-200);
19 | }
20 |
21 | .toggleIcon {
22 | display: none;
23 | }
24 |
25 | [data-theme-choice='system'] .systemToggleIcon,
26 | [data-theme-choice='light'] .lightToggleIcon,
27 | [data-theme-choice='dark'] .darkToggleIcon {
28 | display: initial;
29 | }
30 |
31 | .toggleButtonDisabled {
32 | cursor: not-allowed;
33 | }
34 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/drop-ability.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | // ANCHOR: main
5 | module book::drop_ability;
6 |
7 | /// This struct has the `drop` ability.
8 | public struct IgnoreMe has drop {
9 | a: u8,
10 | b: u8,
11 | }
12 |
13 | /// This struct does not have the `drop` ability.
14 | public struct NoDrop {}
15 |
16 | #[test]
17 | // Create an instance of the `IgnoreMe` struct and ignore it.
18 | // Even though we constructed the instance, we don't need to unpack it.
19 | fun test_ignore() {
20 | let no_drop = NoDrop {};
21 | let _ = IgnoreMe { a: 1, b: 2 }; // no need to unpack
22 |
23 | // The value must be unpacked for the code to compile.
24 | let NoDrop {} = no_drop; // OK
25 | }
26 | // ANCHOR_END: main
27 |
--------------------------------------------------------------------------------
/.github/actions/diffs/action.yml:
--------------------------------------------------------------------------------
1 | name: Detect Changes
2 | description: Defines variables indicating the parts of the code that changed
3 | outputs:
4 | isDoc:
5 | description: True when changes happened to some documentation
6 | value: "${{ steps.diff.outputs.isDoc }}"
7 | isMove:
8 | description: True when changes happened to the Move code
9 | value: "${{ steps.diff.outputs.isMove }}"
10 |
11 | runs:
12 | using: composite
13 | steps:
14 | - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # Pin v4.1.1
15 | - name: Detect Changes
16 | uses: dorny/paths-filter@v2.10.2
17 | id: diff
18 | with:
19 | filters: |
20 | isDoc:
21 | - 'src/'
22 | - '.github/workflows/docs.yml'
23 | isMove:
24 | - 'samples/'
25 | - 'postcard/'
26 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/constants-shop-price.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | // ANCHOR: shop_price
5 | module book::shop_price;
6 |
7 | use sui::{coin::Coin, sui::SUI};
8 |
9 | /// Trying to purchase an item at an incorrect price.
10 | const EWrongPrice: u64 = 0;
11 |
12 | /// The price of an item in the shop.
13 | const ITEM_PRICE: u64 = 100;
14 | /// The owner of the shop, an address.
15 | const SHOP_OWNER: address = @0xa11ce;
16 |
17 | /// An item sold in the shop.
18 | public struct Item {}
19 |
20 | /// Purchase an item from the shop.
21 | public fun purchase(coin: Coin): Item {
22 | assert!(coin.value() == ITEM_PRICE, EWrongPrice);
23 |
24 | transfer::public_transfer(coin, SHOP_OWNER);
25 |
26 | Item {}
27 | }
28 | // ANCHOR_END: shop_price
29 |
--------------------------------------------------------------------------------
/site/src/theme/CodeBlock/Buttons/styles.module.css:
--------------------------------------------------------------------------------
1 | .buttonGroup {
2 | display: flex;
3 | column-gap: 0.2rem;
4 | position: absolute;
5 | /* rtl:ignore */
6 | right: calc(var(--ifm-pre-padding) / 2);
7 | top: calc(var(--ifm-pre-padding) / 2);
8 | }
9 |
10 | .buttonGroup button {
11 | display: flex;
12 | align-items: center;
13 | background: var(--prism-background-color);
14 | color: var(--prism-color);
15 | border: 1px solid var(--ifm-color-emphasis-300);
16 | border-radius: var(--ifm-global-radius);
17 | padding: 0.4rem;
18 | line-height: 0;
19 | transition: opacity var(--ifm-transition-fast) ease-in-out;
20 | opacity: 0;
21 | }
22 |
23 | .buttonGroup button:focus-visible,
24 | .buttonGroup button:hover {
25 | opacity: 1 !important;
26 | }
27 |
28 | :global(.theme-code-block:hover) .buttonGroup button {
29 | opacity: 0.4;
30 | }
31 |
--------------------------------------------------------------------------------
/packages/reference/Move.lock:
--------------------------------------------------------------------------------
1 | # @generated by Move, please check-in and do not edit manually.
2 |
3 | [move]
4 | version = 2
5 | manifest_digest = "868EC315260CC0A203EABE09C39C72CFDDB66DE119BDF7E24CE5EAABE30EFCC1"
6 | deps_digest = "F8BBB0CCB2491CA29A3DF03D6F92277A4F3574266507ACD77214D37ECA3F3082"
7 | dependencies = [
8 | { name = "Sui" },
9 | ]
10 |
11 | [[move.package]]
12 | name = "MoveStdlib"
13 | source = { git = "https://github.com/MystenLabs/sui.git", rev = "main", subdir = "crates/sui-framework/packages/move-stdlib" }
14 |
15 | [[move.package]]
16 | name = "Sui"
17 | source = { git = "https://github.com/MystenLabs/sui.git", rev = "main", subdir = "crates/sui-framework/packages/sui-framework" }
18 |
19 | dependencies = [
20 | { name = "MoveStdlib" },
21 | ]
22 |
23 | [move.toolchain-version]
24 | compiler-version = "1.27.0"
25 | edition = "2024.alpha"
26 | flavor = "sui"
27 |
--------------------------------------------------------------------------------
/packages/hello_world/Move.lock:
--------------------------------------------------------------------------------
1 | # @generated by Move, please check-in and do not edit manually.
2 |
3 | [move]
4 | version = 1
5 | manifest_digest = "60F2000F4D6DAD240EF371DB3BC521F7BD4C8B814BC59CA473B852B77FDBE53C"
6 | deps_digest = "F8BBB0CCB2491CA29A3DF03D6F92277A4F3574266507ACD77214D37ECA3F3082"
7 | dependencies = [
8 | { name = "Sui" },
9 | ]
10 |
11 | [[move.package]]
12 | name = "MoveStdlib"
13 | source = { git = "https://github.com/MystenLabs/sui.git", rev = "framework/testnet", subdir = "crates/sui-framework/packages/move-stdlib" }
14 |
15 | [[move.package]]
16 | name = "Sui"
17 | source = { git = "https://github.com/MystenLabs/sui.git", rev = "framework/testnet", subdir = "crates/sui-framework/packages/sui-framework" }
18 |
19 | dependencies = [
20 | { name = "MoveStdlib" },
21 | ]
22 |
23 | [move.toolchain-version]
24 | compiler-version = "1.23.0"
25 | edition = "legacy"
26 | flavor = "sui"
27 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/collections-3.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_field, unused_variable, unused_use)]
5 | // ANCHOR: vec_map
6 | module book::collections_vec_map;
7 |
8 | use std::string::String;
9 | use sui::vec_map::{Self, VecMap};
10 |
11 | public struct Metadata has drop {
12 | name: String,
13 | /// `VecMap` used in the struct definition
14 | attributes: VecMap
15 | }
16 |
17 | #[test]
18 | fun vec_map_playground() {
19 | let mut map = vec_map::empty(); // create an empty map
20 |
21 | map.insert(2, b"two".to_string()); // add a key-value pair to the map
22 | map.insert(3, b"three".to_string());
23 |
24 | assert!(map.contains(&2)); // check if a key is in the map
25 |
26 | map.remove(&2); // remove a key-value pair from the map
27 | }
28 | // ANCHOR_END: vec_map
29 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/one-time-witness.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_variable, unused_mut_parameter)]
5 | // ANCHOR: definition
6 | module book::one_time;
7 |
8 | /// The OTW for the `book::one_time` module.
9 | /// Only `drop`, no fields, no generics, all uppercase.
10 | public struct ONE_TIME has drop {}
11 |
12 | /// Receive the instance of `ONE_TIME` as the first argument.
13 | fun init(otw: ONE_TIME, ctx: &mut TxContext) {
14 | // do something with the OTW
15 | }
16 | // ANCHOR_END: definition
17 |
18 | // ANCHOR: usage
19 | use sui::types;
20 |
21 | const ENotOneTimeWitness: u64 = 1;
22 |
23 | /// Takes an OTW as an argument, aborts if the type is not OTW.
24 | public fun takes_witness(otw: T) {
25 | assert!(types::is_one_time_witness(&otw), ENotOneTimeWitness);
26 | }
27 | // ANCHOR_END: usage
28 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/copy-ability.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | #[allow(unused_variable)]
5 | module book::copy_ability;
6 |
7 | // ANCHOR: copyable
8 | public struct Copyable has copy {}
9 | // ANCHOR_END: copyable
10 |
11 | #[test] fun test_copy() {
12 |
13 | // ANCHOR: copyable_test
14 | let a = Copyable {}; // allowed because the Copyable struct has the `copy` ability
15 | let b = a; // `a` is copied to `b`
16 | let c = *&b; // explicit copy via dereference operator
17 |
18 | // Copyable doesn't have the `drop` ability, so every instance (a, b, and c) must
19 | // be used or explicitly destructured. The `drop` ability is explained below.
20 | let Copyable {} = a;
21 | let Copyable {} = b;
22 | let Copyable {} = c;
23 | // ANCHOR_END: copyable_test
24 | }
25 |
26 | // ANCHOR: copy_drop
27 | public struct Value has copy, drop {}
28 | // ANCHOR_END: copy_drop
29 |
--------------------------------------------------------------------------------
/site/src/theme/CodeBlock/Buttons/CopyButton/styles.module.css:
--------------------------------------------------------------------------------
1 | :global(.theme-code-block:hover) .copyButtonCopied {
2 | opacity: 1 !important;
3 | }
4 |
5 | .copyButtonIcons {
6 | position: relative;
7 | width: 1.125rem;
8 | height: 1.125rem;
9 | }
10 |
11 | .copyButtonIcon,
12 | .copyButtonSuccessIcon {
13 | position: absolute;
14 | top: 0;
15 | left: 0;
16 | fill: currentColor;
17 | opacity: inherit;
18 | width: inherit;
19 | height: inherit;
20 | transition: all var(--ifm-transition-fast) ease;
21 | }
22 |
23 | .copyButtonSuccessIcon {
24 | top: 50%;
25 | left: 50%;
26 | transform: translate(-50%, -50%) scale(0.33);
27 | opacity: 0;
28 | color: #00d600;
29 | }
30 |
31 | .copyButtonCopied .copyButtonIcon {
32 | transform: scale(0.33);
33 | opacity: 0;
34 | }
35 |
36 | .copyButtonCopied .copyButtonSuccessIcon {
37 | transform: translate(-50%, -50%) scale(1);
38 | opacity: 1;
39 | transition-delay: 0.075s;
40 | }
41 |
--------------------------------------------------------------------------------
/packages/samples/sources/programmability/module-initializer.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | // ANCHOR: main
5 | module book::shop;
6 |
7 | /// The Capability which grants the Shop owner the right to manage
8 | /// the shop.
9 | public struct ShopOwnerCap has key, store { id: UID }
10 |
11 | /// The singular Shop itself, created in the `init` function.
12 | public struct Shop has key {
13 | id: UID,
14 | /* ... */
15 | }
16 |
17 | // Called only once, upon module publication. It must be
18 | // private to prevent external invocation.
19 | fun init(ctx: &mut TxContext) {
20 | // Transfers the ShopOwnerCap to the sender (publisher).
21 | transfer::transfer(ShopOwnerCap {
22 | id: object::new(ctx)
23 | }, ctx.sender());
24 |
25 | // Shares the Shop object.
26 | transfer::share_object(Shop {
27 | id: object::new(ctx)
28 | });
29 | }
30 | // ANCHOR_END: main
31 |
--------------------------------------------------------------------------------
/site/src/theme/CodeBlock/Buttons/RenderButton/styles.module.css:
--------------------------------------------------------------------------------
1 | :global(.theme-code-block:hover) .copyButtonCopied {
2 | opacity: 1 !important;
3 | }
4 |
5 | .copyButtonIcons {
6 | position: relative;
7 | width: 1.125rem;
8 | height: 1.125rem;
9 | }
10 |
11 | .copyButtonIcon,
12 | .copyButtonSuccessIcon {
13 | position: absolute;
14 | top: 0;
15 | left: 0;
16 | fill: currentColor;
17 | opacity: inherit;
18 | width: inherit;
19 | height: inherit;
20 | transition: all var(--ifm-transition-fast) ease;
21 | }
22 |
23 | .copyButtonSuccessIcon {
24 | top: 50%;
25 | left: 50%;
26 | transform: translate(-50%, -50%) scale(0.33);
27 | opacity: 0;
28 | color: #00d600;
29 | }
30 |
31 | .copyButtonCopied .copyButtonIcon {
32 | transform: scale(0.33);
33 | opacity: 0;
34 | }
35 |
36 | .copyButtonCopied .copyButtonSuccessIcon {
37 | transform: translate(-50%, -50%) scale(1);
38 | opacity: 1;
39 | transition-delay: 0.075s;
40 | }
41 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/struct-methods-3.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | // ANCHOR: hero_to_bytes
5 | // TODO: better example (external module...)
6 | module book::hero_to_bytes;
7 |
8 | // Alias for the `bcs::to_bytes` method. Imported aliases should be defined
9 | // in the top of the module.
10 | // public use fun bcs::to_bytes as Hero.to_bytes;
11 |
12 | /// A struct representing a hero.
13 | public struct Hero has drop {
14 | health: u8,
15 | mana: u8,
16 | }
17 |
18 | /// Create a new Hero.
19 | public fun new(): Hero { Hero { health: 100, mana: 100 } }
20 |
21 | // #[test_only]
22 | // use std::unit_test::assert_eq;
23 |
24 | #[test]
25 | // Test the methods of the `Hero` struct.
26 | fun test_hero_serialize() {
27 | // let mut hero = new();
28 | // let serialized = hero.to_bytes();
29 | // assert_eq!(serialized.length(), 3);
30 | }
31 | // ANCHOR_END: hero_to_bytes
32 |
--------------------------------------------------------------------------------
/site/README.md:
--------------------------------------------------------------------------------
1 | # Website
2 |
3 | This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
4 |
5 | ## Installation
6 |
7 | ```bash
8 | yarn
9 | ```
10 |
11 | ## Local Development
12 |
13 | ```bash
14 | yarn start
15 | ```
16 |
17 | This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
18 |
19 | ## Build
20 |
21 | ```bash
22 | yarn build
23 | ```
24 |
25 | This command generates static content into the `build` directory and can be served using any static contents hosting service.
26 |
27 | ## Deployment
28 |
29 | Using SSH:
30 |
31 | ```bash
32 | USE_SSH=true yarn deploy
33 | ```
34 |
35 | Not using SSH:
36 |
37 | ```bash
38 | GIT_USER= yarn deploy
39 | ```
40 |
41 | If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
42 |
--------------------------------------------------------------------------------
/packages/samples/sources/move-basics/module.move:
--------------------------------------------------------------------------------
1 | // Copyright (c) Mysten Labs, Inc.
2 | // SPDX-License-Identifier: Apache-2.0
3 |
4 | // ANCHOR: address_literal
5 | module 0x0::address_literal { /* ... */ }
6 | module book::named_address { /* ... */ }
7 | // ANCHOR_END: address_literal
8 |
9 | #[allow(unused_function, unused_const, unused_use)]
10 | // ANCHOR: members
11 | module book::my_block_module_with_members {
12 | // import
13 | use book::my_module;
14 |
15 | // a constant
16 | const CONST: u8 = 0;
17 |
18 | // a struct
19 | public struct Struct {}
20 |
21 | // method alias
22 | public use fun function as Struct.struct_fun;
23 |
24 | // function
25 | fun function(_: &Struct) { /* function body */ }
26 | }
27 |
28 | // module block allows multiple module definitions in the
29 | // same file but this is not a recommended practice
30 | module book::another_module_in_the_file {
31 | // ...
32 | }
33 | // ANCHOR_END: members
34 |
--------------------------------------------------------------------------------
/.github/workflows/test.yml:
--------------------------------------------------------------------------------
1 | name: Run tests for Move packages
2 | permissions:
3 | contents: read
4 |
5 | # Set the VERSION variable to use when downloading the binary
6 | # Currently, requires explicit setup, ideally it should be fetched
7 | # automatically
8 | # env:
9 | # VERSION: 'v1.24.1'
10 |
11 | on:
12 | pull_request:
13 |
14 | jobs:
15 | download-binary:
16 | runs-on: ubuntu-latest
17 | steps:
18 | - uses: actions/checkout@v2
19 | - name: Download Sui
20 | uses: jaxxstorm/action-install-gh-release@v1.12.0
21 | with:
22 | repo: MystenLabs/sui
23 | platform: ubuntu
24 | version: main
25 | cache: enable
26 |
27 | # Run the tests in every directory using the latest mainnet binary
28 | - run: sui move test --path packages/samples
29 | - run: sui move test --path packages/reference
30 | - run: sui move test --path packages/todo_list
31 | - run: sui move test --path packages/hello_world
32 |
--------------------------------------------------------------------------------
/packages/samples/sources/README.md:
--------------------------------------------------------------------------------
1 | # Managing Samples
2 |
3 | For every page in the book (under the `src/` directory), there is a `samples/` directory which contains the code samples for that page. The `samples/` directory is organized in the same way as the `src/` directory, with the same directory structure and file names.
4 |
5 | ## Rules
6 |
7 | 1. There's one Move file per page in the book.
8 | 2. The file name is the same as the page name (or similar for keywords).
9 | 3. The file can hold multiple modules.
10 | 4. The modules are named after the sub-sections of the page.
11 | 5. Anchors should be used to point to the specific code snippets in the Move file.
12 |
13 | ## Example
14 |
15 | For example, the `src/basic-syntax/address.md` page has a corresponding `samples/guides/address.move` file. The file contains the code samples for the page, organized in modules named after the sub-sections of the page.
16 |
17 | ```bash
18 | samples/
19 | basic-syntax/
20 | address.move
21 | ```
22 |
--------------------------------------------------------------------------------
/site/src/theme/CodeBlock/Buttons/index.tsx:
--------------------------------------------------------------------------------
1 | import React, { type ReactNode } from 'react';
2 | import clsx from 'clsx';
3 | import BrowserOnly from '@docusaurus/BrowserOnly';
4 |
5 | import CopyButton from './CopyButton';
6 | import WordWrapButton from './WordWrapButton';
7 | import RenderButton from './RenderButton';
8 | import type { Props } from '@theme/CodeBlock/Buttons';
9 |
10 | import styles from './styles.module.css';
11 |
12 | // Code block buttons are not server-rendered on purpose
13 | // Adding them to the initial HTML is useless and expensive (due to JSX SVG)
14 | // They are hidden by default and require React to become interactive
15 | export default function CodeBlockButtons({ className }: Props): ReactNode {
16 | return (
17 |
18 | {() => (
19 |