Skip to main content

RGB Guides Overview

This section provides practical, hands-on guides for building applications with RGB v0.12. Whether you're creating fungible tokens, NFTs, complex smart contracts, or integrating RGB into existing applications, these guides will help you get started.

Quick Navigation​

Token Development​

  • RGB20 Tokens - Fungible token standard
    • Creating tokens
    • Transferring assets
    • Secondary issuance
    • Supply management

NFT Development​

  • RGB21 NFTs - Non-fungible token standard
    • Creating NFTs
    • Metadata and attachments
    • Transferring NFTs
    • Royalties and rights

Smart Contracts​

  • Contract Development - Building custom contracts
    • Schema design
    • Contractum language
    • Genesis creation
    • State transitions
    • Validation logic

Lightning Network​

  • Lightning Integration - RGB on Lightning
    • Asset channels
    • Routing RGB payments
    • Channel management
    • Liquidity

Development​

  • Development Guides - Building applications
    • Rust SDK
    • RGB.js
    • Wallet integration
    • Testing strategies

Getting Started​

Prerequisites​

To be expanded: What you need to know

Before starting with RGB development:

  • Bitcoin basics: UTXOs, transactions, scripts
  • Programming: Rust or TypeScript/JavaScript
  • Cryptography: Hashes, signatures, commitments
  • Development tools: Git, package managers

Choosing Your Path​

To be expanded: Guide selection

For fungible assets → Start with RGB20 guide

For unique assets/NFTs → Start with RGB21 guide

For custom logic → Start with Contracts guide

For Lightning → Start with Lightning guide

For integration → Start with Development guide

Development Environment​

Tools and SDKs​

To be expanded: Development tools

Available tooling:

  • rgb-sdk: Rust library for RGB operations
  • rgbjs: JavaScript/TypeScript implementation
  • rgb-cli: Command-line interface
  • rgb-wallet: Reference wallet implementation

Networks​

To be expanded: Testing networks

Development networks:

  • Regtest: Local testing
  • Signet: Public test network
  • Testnet: Bitcoin testnet
  • Mainnet: Production network

Common Patterns​

Asset Creation​

To be expanded: Creating assets

Typical workflow:

  1. Design schema (or use standard)
  2. Create genesis transaction
  3. Issue initial supply
  4. Distribute to holders

Asset Transfers​

To be expanded: Transfer patterns

Transfer process:

  1. Validate current state
  2. Create state transition
  3. Commit to Bitcoin
  4. Generate consignment
  5. Send to recipient

Multi-Asset Operations​

To be expanded: Handling multiple assets

Coordinating operations:

  • Batched transfers
  • Atomic swaps
  • Multi-protocol transactions

Best Practices​

Security​

To be expanded: Security guidelines

  • Always validate full history
  • Verify Bitcoin commitments
  • Secure private keys
  • Test thoroughly
  • Audit contracts

Privacy​

To be expanded: Privacy best practices

  • Use Tapret commitments
  • Avoid address reuse
  • Consider CoinJoin
  • Minimize data disclosure

Efficiency​

To be expanded: Optimization tips

  • Batch operations
  • Prune history when possible
  • Optimize state size
  • Cache validation results

Example Projects​

Simple Token​

To be expanded: Basic token example

Complete example: Simple RGB20 Token

NFT Collection​

To be expanded: NFT project example

Complete example: RGB21 NFT Collection

DAO​

To be expanded: DAO example

Complete example: DAO Contract

Lightning Asset Wallet​

To be expanded: Lightning example

Complete example: Lightning Asset Wallet

Troubleshooting​

Common issues and solutions in Troubleshooting Guide

Community Resources​

  • Discord: RGB developer community
  • GitHub: RGB repositories and issues
  • Documentation: Technical reference
  • Examples: Sample projects

Next Steps​

Choose a guide based on your needs:

Status: Overview complete - Individual guides provide detailed implementations.