Prerequisites

Before you begin working with the Artinals modules, ensure you have the necessary tools and environment properly set up. This section covers the prerequisites, how to clone the repository, and how to build and test the modules locally.

1. Sui Toolchain: Artinals is designed to run on the Sui blockchain. You’ll need to have the Sui command-line interface (CLI) and related tools installed. Follow the official Sui documentation for instructions: Sui Documentation

   In general, you will:

   • Install Rust and its toolchain (if not already installed).

   • Install sui CLI binaries.

   • Set up a Sui network (local or testnet) as required.

2. Move Compiler: The Artinals modules are written in Move, a safe, smart contract language originally developed for the Diem (formerly Libra) project and adopted by various blockchains including Sui. You’ll need a Move compiler to build the modules:

   • The Move compiler is typically bundled with the Sui toolchain.

   • Ensure that running sui move build or sui move test commands works without errors before proceeding.

3. Familiarity with Move and Sui: While not strictly required, understanding the basics of Move and Sui concepts (objects, capabilities, modules, entry functions) will help you follow and modify the code more easily.

4. Version Control with Git: To clone and manage updates to the repository, ensure you have git installed:

   git --version

   This should return your installed Git version if it’s set up correctly.