🤹 LUKSO Playground

A comprehensive set of code examples and development playground for building on the LUKSO blockchain with the LSP standards.

This repository contains Typescript and Solidity code examples to help you get started building dApps and smart contracts with LUKSO's LSP standards.

🚀 Getting Started

Prerequisites

This repository uses bun to manage packages and run scripts. Make sure to install it first.

Installation

Clone this repository and install its dependencies:

git clone https://github.com/lukso-network/lukso-playground.git
cd lukso-playground && bun install

📁 Project Structure

🌐 DApps (/dapps)

Interactive examples and scripts demonstrating LUKSO standards integration:

• universal-profile: Universal Profile related scripts
• digital-assets: Digital assets (LSP7/8) scripts
• interface-detection: Verify EIP165 Standard Compatibility
• key-manager: Permission Management of Controller Keys
• metadata-detection: Verify ERC725Y Storage Compatibility
• transfer-lyx: Coin Transfers for Backend and Extension
• universal-factory: Universal Factory related scripts

Running DApp Examples

Run any DApp script from the root directory:

bun run dapps/universal-profile/fetch-json-data.ts

See the DApps README for detailed usage instructions.

🔨 Smart Contracts (/smart-contracts)

Hardhat-based smart contract development environment with example contracts and deployment scripts:

• Example Contracts: LSP1 Universal Receivers, LSP25 Delegated Voting, NFT collections (basic & dynamic), digital tokens (LSP7/LSP8)
• Deployment Scripts: Deploy tokens and collections as EOA or Universal Profile, attach metadata, mint tokens
• Verification Tools: Blockscout contract verification setup

Working with Smart Contracts

Navigate to the smart-contracts directory for contract development:

cd smart-contracts
# Install smart contract-specific dependencies
bun install
# Compile contracts
bun run compile
# Deploy contracts by running one of the scripts
bun hardhat --network luksoTestnet run <scripts/deployTokenAsEOA.ts>

See the Smart Contracts README for detailed development instructions.

🛠️ Key Technologies

LUKSO Libraries

• @erc725/erc725.js: Library for interacting with ERC725 contracts
• @lukso/lsp-smart-contracts: LUKSO Standard Proposals smart contract implementations

🌍 Network Configuration

LUKSO Networks

• Mainnet: https://rpc.mainnet.lukso.network
• Testnet: https://rpc.testnet.lukso.network

IPFS Gateway

For development purposes, this repository uses:

• IPFS Gateway: https://api.universalprofile.cloud/ipfs

⚠️ Production Recommendation: We highly recommend that developers use their own IPFS gateway solutions like Pinata or Infura for production applications.

📖 Documentation

• LUKSO Tech Docs
• LSP Standards
• Universal Profile
• Digital Assets

🤝 Contributing

Contributions are welcome! Please check out our Contributing Guidelines for details on how to get started.