Welcome to Muddoc!

Muddoc is a documentation of mud written by mud developers and focg buidlers, especially for native solidity developers. We think that mud’s official documentation is not particularly friendly to native solidity developers, so we decided to write this documentation.

Check out the Introduction to mud framework section for an introduction and examples of mud, including how to Installation the mud.

Note

This documentation temporarily only focuses on the smart contract written part of the mud project.

Contents

Basics

• Introduction to mud framework
  • For smart contract developers
• Differences of writing smart contracts
  • Read&Write State
  • Message Call
• Examples of mud
• Installation
• Best Practices
  • Gas Efficiency
    • Choose Smaller Data Types
    • Read and write all fields of a table at once whenever possible
    • Design table structure based on field usage frequency
    • Using IWorld.call() to invoke system contracts

Descriptions

• Configuration
• Autonomous World
  • Components
  • Operation Mechanism
  • Access Control
• Tables
  • Defining a Table
    • Supported Table Field Types
      • Enums
      • User-defined Types
    • Table Definition Shorthand
  • Table Usage
    • Internal CRUD Methods
    • CRUD Methods with tableId Parameter
    • CRUD Methods with store Parameter
• Systems
  • Developing a System
    • Calling Other Systems
    • Calling External Contracts
  • System Registration
    • Registration through Configuration Files
    • Manual Registration
  • System Usage
  • Core Systems
• Modules
  • Implementation Process
  • Official Modules
  • Module Installation
    • Installation via Configuration File
    • Manual Installation
  • Writing Modules
• Namespaces
  • Creating a Namespace
    • Manual Creation
  • Creating Multiple Namespaces
  • Access Control
    • Access Management
    • Namespace Ownership Management
• hooks

Internals

• Layout of tables in storage
• Store namespace
• World namespace
• Core Systems
  • AccessManagementSystem
    • grantAccess
    • revokeAccess
    • transferOwnership
    • renounceOwnership
  • BalanceTransferSystem
    • transferBalanceToNamespace
    • transferBalanceToAddress
  • BatchCallSystem
    • batchCall
    • batchCallFrom
  • ModuleInstallationSystem
    • installModule
  • StoreRegistrationSystem
    • registerTable
    • registerStoreHook
    • unregisterStoreHook
  • WorldRegistrationSystem
    • registerNamespace
    • registerSystemHook
    • unregisterSystemHook
    • registerSystem
    • registerFunctionSelector
    • registerRootFunctionSelector
    • registerDelegation
    • unregisterDelegation
    • registerNamespaceDelegation
    • unregisterNamespaceDelegation

CLI

• tablegen
• worldgen
• test
• set-version

Appendix

• Gas Report