Skip to content

Getting Started

Welcome to Iyup Protocol! This guide will help you get started with the platform for tokenizing Real World Assets (RWA) with privacy-preserving document management.

Overview

Iyup enables you to:

  • Tokenize assets: Create NFT-like tokens representing real-world assets
  • Store documents securely: Upload encrypted documents to decentralized storage (Walrus)
  • Trade tokens: Buy and sell RWA tokens on the marketplace with automatic document access transfer
  • Verify authenticity: Use zero-knowledge proofs or hash verification to verify documents

Quick Start

Prerequisites

  • Wallet: A Sui wallet (e.g., Sui Wallet extension)
  • SUI Tokens: Some SUI tokens for gas fees (testnet SUI available from faucet)
  • Web Browser: Modern browser with Web Crypto API support

Step 1: Connect Your Wallet

  1. Visit the Iyup frontend application
  2. Click "Connect Wallet" in the top navigation
  3. Select your Sui wallet (Sui Wallet, Ethos, etc.)
  4. Approve the connection request

Step 2: Mint an RWA Token

RWA tokens represent your real-world assets. To mint one:

  1. Navigate to the admin section (if you have minting permissions)
  2. Provide token details:
    • Name: Human-readable name (e.g., "Property #123")
    • Symbol: Short symbol (e.g., "PROP")
    • URI: Metadata URI pointing to public information
  3. Mint the token to your address

Step 3: Register a Document

After minting your token, register associated documents:

  1. Go to Upload page
  2. Select your RWA token address
  3. Choose your document file
  4. Select encryption mode:
    • Regular Mode: Document hash stored on-chain (public verification)
    • ZK Mode: Zero-knowledge commitment stored on-chain (privacy-preserving)
  5. Optionally enable threshold encryption (Mysten Seal)
  6. Upload and register

The document will be:

  • Encrypted client-side
  • Uploaded to Walrus decentralized storage
  • Hash/commitment registered on Sui blockchain
  • Access key secured in smart contract

Step 4: List on Marketplace

To sell your RWA token:

  1. Navigate to Marketplace
  2. Find your token or go to "My Listings"
  3. Click "List for Sale"
  4. Set your price in SUI
  5. Confirm the transaction

Your token will be moved to escrow and listed for sale.

Step 5: Purchase a Token

To buy an RWA token:

  1. Browse active listings on Marketplace
  2. Click on a listing to view details
  3. Click "Buy" and approve the transaction
  4. The token will be transferred to you
  5. Document access key will be automatically available

User Flows

Complete Workflow

1. Mint RWA Token
   ↓
2. Register Document (with encryption)
   ↓
3. List Token on Marketplace
   ↓
4. Buyer Purchases Token
   ↓
5. New Owner Accesses Documents
   ↓
6. Verify Document Authenticity

Document Verification Flow

1. Retrieve Access Key (requires token ownership)
   ↓
2. Download Document from Walrus
   ↓
3. Decrypt Using Access Key
   ↓
4. Verify Hash/Commitment Matches On-Chain Record
   ↓
5. View or Download Verified Document

Key Concepts

RWA Tokens

  • Non-Fungible: Each token represents a unique real-world asset
  • Transferable: Tokens can be traded on the marketplace
  • Document-Backed: Linked to encrypted documents stored on Walrus
  • Ownership-Based Access: Only token owners can access associated documents

Document Storage

  • Encryption: Documents encrypted client-side before upload
  • Decentralized Storage: Stored on Walrus network (1000+ nodes with erasure coding)
  • On-Chain Verification: Hash or ZK commitment stored on Sui for integrity checks
  • Version History: Immutable version tracking for audit trails

Zero-Knowledge Mode

  • Privacy: Document hash never stored on-chain
  • Verification: Prove authenticity without revealing content
  • Groth16 Proofs: Uses Sui's native Groth16 verifier
  • Commitments: Cryptographic commitments stored instead of hashes

Marketplace

  • Escrow Protection: Tokens locked in marketplace during listing
  • Automatic Transfer: Access keys automatically available to new owners
  • Fee System: Configurable marketplace fees (default 0.5%)
  • Atomic Swaps: SUI for token transfers happen atomically

Next Steps

Support

For questions or issues:

  • Check the documentation sections
  • Review smart contract READMEs in the codebase
  • Open an issue on GitHub (if applicable)

Ready to tokenize your first asset? Use the frontend application to upload and register your first document!