Artinals Protocol
  • Introduction
    • What is Artinals?
    • Overview of the Modules
    • Key Concepts and Terminology
  • Getting Started
    • Prerequisites
    • Cloning the Repository
    • Building and Testing the Modules
  • ART20
    • Overview and Capabilities
    • Data Structures
      • NFT
      • CollectionCap
      • UserBalance
      • TokenIdCounter
      • Dual IDs
    • Events
      • NFTMintedEvent
      • CollectionCreatedEvent
      • MetadataUpdateEvent
      • BurnEvent
      • TransferEvent
      • Additional Events
    • Functions and Entry Points
      • Initializing the Module
      • Creating Collections
      • Minting ART20 NFTs
      • Updating Metadata
      • Transfer and Burn Operations
      • Batch Operations
      • Deny List Mechanics and Authority
      • Custom Transfers
    • Value Sources (API, Oracle)
    • Best Practices & Examples
  • SALE Module
    • Purpose and Functionality
    • Interdependence
    • Price Index Module
    • Liquidity Module
    • Data Structures
      • NFTSale
      • NFTListing
  • Events
    • SaleCreated
    • NFTPurchased
    • PriceUpdateEvent
    • CurrencyWithdrawn
    • DenyList & Related Events
    • PoolCreatedEvent
    • OrderCanceled
    • OrderExecuted
  • Functions and Entry Points
    • Creating a Sale
    • Adding NFTs to a Sale
    • Purchasing NFTs from a Sale
    • Withdrawing Proceeds
    • Managing Sale State
    • Core Trading Functionality
  • Integrating with ART20
  • Examples & Best Practices
  • MARKET Module
    • Introduction
    • Testnet (Beta)
    • Smart Contract Overview
    • Data Structures
      • Trade Ledger (TradeLedger)
      • Trade Offer (TradeOffer)
      • Buy Offer (BuyOffer)
      • Ledger Registry (LedgerRegistry)
    • Event Structures
      • Offer Created (OfferCreated)
      • Offer Accepted (OfferAccepted)
      • Buy Offer Created (BuyOfferCreated)
      • Buy Offer Accepted (BuyOfferAccepted)
      • Batch Transactions
    • Event Emissions
    • Functions and Entry Points
      • Trade Ledger Management
      • Register Ledger
      • Get Trade Ledger
      • Create Sell Offer
      • Accept Sell Offer
      • Cancel Sell Offer
      • Create Buy Offer
      • Accept Buy Offer
      • Cancel Buy Offer
      • Batch Accept Sell Offers
      • Batch Accept Buy Offers
  • Security Mechanisms
  • TRADE Module
    • Introduction
    • Purpose and Ecosystem Role
    • Data Structures
      • TradingPool
      • LiquidityPosition
      • PriceOracle
      • CollectionPool
    • Events
      • PoolCreated
      • LiquidityAdded
      • LiquidityRemoved
      • TradeExecuted
      • PoolStatusChanged
      • PoolFeesUpdated
    • Functions and Entry Points
      • Creating and Managing Liquidity Pools
      • Adding/Removing Liquidity
      • Swapping NFTs and Tokens
      • Fee Mechanics and Distribution
      • Emergency Operations and Recovery
  • Working with Price Oracles
  • Metrics and Statistics (24h Volumes, TWAP, Price Impact)
  • Integration with SALE and ART20
  • Integration and Workflows
    • Typical User Journeys
      • Creating a Collection and Minting Tokens (ART20)
      • Listing and Selling NFTs (SALE)
      • Providing Liquidity and Trading NFTs (TRADE)
    • Example Scripts and Transactions
    • Interactions Between Modules
  • Security, Permissions, and Deny Lists
    • Introduction
    • Role of Deny List in ART20
    • Creator vs. Owner Permissions
    • Fee Distribution and Authority
    • Best Practices for Secure Deployment
  • Testing and Troubleshooting
    • Running Unit Tests
    • Common Issues and Solutions
    • Debugging and Emitting Debug Events
  • Advanced Topics
    • Value Sources (API Endpoints and Oracle Addresses)
    • Batch Update Operations
    • Customizing Parameters (Fees, Supply, Price Ranges)
    • Extensibility and Future Integrations
  • Appendices
    • Move Language and Sui Concepts
    • Glossary of Terms
    • Code Style and Conventions
  • Building on Top of the Artinals Contract
    • Overview
    • Package ID
    • Import Modules
    • Commom Integration Patterns
    • Best Practices
    • Common Errors and Solutions
Powered by GitBook
On this page
  • Introduction to Artinals
  • What is Artinals?
  • Why Build with Artinals?
  • Key Features

Introduction

Introduction to Artinals

Artinals is a comprehensive NFT framework built on the Sui blockchain that revolutionizes how creators, collectors, and developers interact with digital art and collectibles. By combining advanced NFT functionality with innovative trading mechanisms and liquidity pools, Artinals provides a complete ecosystem for building next-generation NFT applications.

What is Artinals?

Artinals is a smart contract system composed of three core modules:

  • ART20: The foundation module that handles NFT creation, management, and metadata. It introduces advanced features like deny lists, mutable collections, and batch operations.

  • SALE: A sophisticated marketplace module that enables direct sales, auctions, and flexible pricing mechanisms for NFTs.

  • TRADE: An innovative trading module that implements automated market making for NFTs through liquidity pools, enabling instant trades and price discovery.

Why Build with Artinals?

For Developers

  • Comprehensive Framework: Get access to a complete suite of NFT functionalities without building from scratch

  • Flexibility: Modular design allows you to use only the components you need

  • Gas Efficiency: Optimized operations and batch processing capabilities

  • Security: Battle-tested smart contracts with robust access controls and safety checks

For Projects

  • Quick Launch: Rapidly deploy NFT collections with advanced features

  • Market Liquidity: Built-in trading pools ensure constant liquidity for your NFTs

  • Scalability: Handle large collections and high-volume trading efficiently

  • Customization: Extensive parameters and controls to suit your project's needs

For the Ecosystem

  • Standardization: Promotes consistent NFT implementation across the Sui ecosystem

  • Interoperability: Common interface enables seamless integration between different projects

  • Innovation: Advanced features push the boundaries of what's possible with NFTs

  • Accessibility: Lower barriers to entry for new projects entering the NFT space

Key Features

  • 🎨 Advanced NFT Management

    • Batch minting and transfers

    • Metadata mutability controls

    • Access control mechanisms

    • Deny list functionality

  • 💰 Flexible Trading Options

    • Direct sales

    • Automated market making

    • Price discovery mechanisms

    • Efficient order matching

  • 💧 Liquidity Solutions

    • Automated liquidity pools

    • Price stability mechanisms

    • Fee distribution systems

    • LP token rewards

This documentation will guide you through integrating Artinals into your project, whether you're building a simple NFT collection or a complex trading platform. Let's explore how you can leverage the power of Artinals to create incredible NFT experiences on Sui.


Ready to start building? Jump to the Integration Guide to begin implementing Artinals in your project.

NextWhat is Artinals?

Last updated 5 months ago

Page cover image