Skip to content

Latest commit

 

History

History
136 lines (100 loc) · 4.08 KB

README.md

File metadata and controls

136 lines (100 loc) · 4.08 KB

Music/Media Royalty Tokenization Platform

A Solana-based platform for tokenizing music and media royalty revenue streams. Artists can tokenize their future royalty revenue, allowing fans and investors to buy tokens and receive proportional distributions from streaming income.

🎯 Features

  • ✅ Royalty Token Issuance: Artists create tokenized royalty projects
  • ✅ Token Purchase: Fans/investors buy royalty tokens with SOL
  • ✅ Automatic Distribution: Streaming income automatically distributed to token holders
  • ✅ Oracle Integration: Spotify API integration for automated royalty tracking (nice to have)
  • ✅ Claim System: Token holders can claim their proportional share of royalties

👋 Contact Here

Telegram: https://t.me/vvizardev

  • Smart Contract: Anchor framework on Solana (programs/royalty-tokenization/)
  • Backend: Node.js Express server with Solana integration (backend/)
  • Frontend: React + Vite with wallet connection (frontend/)

📁 Project Structure

.
├── smart-contract/              # Anchor smart contract
│   └── royalty-tokenization/
│       └── src/lib.rs     # Main program logic
├── backend/               # Express API server
│   ├── src/
│   │   ├── index.js       # Main server
│   │   ├── routes/        # API routes
│   │   └── services/       # Oracle service
│   └── package.json
├── frontend/              # React + Vite app
│   ├── src/
│   │   ├── App.jsx        # Main component
│   │   └── main.jsx       # Entry point
│   └── package.json
├── Anchor.toml            # Anchor configuration
└── README.md

🚀 Quick Start

See SETUP.md for detailed setup instructions.

Prerequisites

  • Rust (latest stable)
  • Anchor framework
  • Node.js 18+
  • Solana CLI

Quick Setup

# 1. Build the Anchor program
anchor build

# 2. Start local validator (in separate terminal)
solana-test-validator

# 3. Deploy the program
anchor deploy

# 4. Setup and start backend
cd backend
npm install
npm run dev

# 5. Setup and start frontend (in new terminal)
cd frontend
npm install
npm run dev

📚 Documentation

🔧 Smart Contract Functions

initialize_project

Creates a new royalty token project with configurable royalty percentage.

buy_tokens

Allows users to purchase royalty tokens. SOL is transferred to treasury, tokens are minted.

distribute_royalties

Distributes streaming income to the treasury. Can be called by artist or authorized oracle.

claim_royalties

Token holders claim their proportional share based on their token holdings.

🌐 API Endpoints

  • GET /health - Health check
  • GET /api/projects - List all projects
  • GET /api/projects/:address - Get project details
  • GET /api/royalties/:projectAddress - Get distribution history
  • GET /api/royalties/claimable/:wallet/:project - Get claimable amount
  • POST /api/oracle/distribute - Trigger royalty distribution
  • POST /api/oracle/spotify/fetch - Fetch Spotify streaming data

🔐 Security

  • PDA-based treasury for secure fund management
  • Oracle authorization for automated distributions
  • Checked arithmetic to prevent overflow
  • Input validation on all functions

🎨 Frontend Features

  • Wallet connection (Phantom, Solflare)
  • Project browsing and selection
  • Token purchase interface
  • Royalty claiming interface
  • Modern, responsive UI

🔮 Oracle Integration

The platform includes an Oracle service that can:

  • Fetch streaming data from Spotify API
  • Calculate royalty distributions
  • Automatically trigger distributions via cron jobs
  • Support multiple royalty sources (extensible)

📝 License

MIT

🤝 Contributing

Contributions welcome! Please open an issue or submit a pull request.