Cryptoart Monorepo

A monorepo containing all projects related to the Cryptoart channel on farcaster.

Open Source: This repository is open source. See SECURITY.md for security policy and OPEN_SOURCE_GUIDE.md for deployment instructions.

Overview

This monorepo contains several projects that work together:

1. MVP App - Main marketplace app with auctions, curation, and social features
2. Creator Core Contracts - ERC721/ERC1155 NFT framework with extensions
3. Auctionhouse Contracts - Solidity smart contracts for the auction house
4. Auctionhouse Subgraph - The Graph subgraph for indexing marketplace events

Related Projects

LSSVM Development Suite (such-lssvm)

The LSSVM Development Suite is a separate Turborepo monorepo that provides:

• LSSVM Protocol Contracts - Solidity contracts for NFT liquidity pools (sudoswap v2)
• LSSVM Miniapp - Farcaster miniapp for interacting with pools
• LSSVM Subgraph - Graph Protocol subgraph for indexing pool events
• LSSVM ABIs Package - Shared ABIs and types (@lssvm/abis)

Integration:

• The cryptoart-monorepo uses @lssvm/abis as a git dependency for LSSVM contract interactions
• LSSVM pools and Auctionhouse listings are queried directly via their respective subgraphs
• See LSSVM_INTEGRATION.md for detailed integration guide

Why Separate?

• Different scope: LSSVM is a protocol suite, cryptoart-monorepo is channel-specific apps
• Different deployment cycles and maintenance needs
• LSSVM has its own documentation site and can be used independently
• Cross-repo integration via git dependencies and unified indexer works well

Repository: github.com/mxjxn/such-lssvm

Project Structure

cryptoart-monorepo/
├── apps/
│   ├── mvp/                   # Main marketplace app with curation features
│   ├── docs/                  # Documentation site
│   └── archive/               # Archived projects (studio-app)
├── packages/
│   ├── creator-core-contracts/ # ERC721/ERC1155 NFT framework
│   ├── auctionhouse-contracts/ # Solidity auction house contracts
│   ├── auctionhouse-subgraph/  # The Graph subgraph for auctionhouse events
│   ├── creator-core-indexer/   # Background indexer for Creator Core contracts
│   ├── db/                     # Database layer with Drizzle ORM
│   ├── eslint-config/          # Shared ESLint configuration
│   ├── typescript-config/      # Shared TypeScript configuration
│   └── ui/                     # Shared UI component library
├── docs/                       # Documentation
├── README.md                   # This file
├── turbo.json                  # Turborepo configuration
└── package.json                # Root workspace configuration

Quick Start

Prerequisites

• Node.js >= 18.0.0
• pnpm >= 9.1.4 (package manager)
• Foundry (for contract development)
• PostgreSQL database (for apps and indexers)
• Redis (optional, for caching)

Installation

# Install dependencies for all projects
pnpm install

# Build all projects
pnpm run build

# Run development mode for all projects
pnpm run dev

Deployment

For complete deployment instructions for all projects, see DEPLOYMENT.md.

Quick Overview:

1. Set up shared PostgreSQL database
2. Deploy contracts (Creator Core, Auctionhouse)
3. Deploy indexers (Creator Core Indexer)
4. Deploy subgraphs (Auctionhouse Subgraph)
5. Deploy apps (MVP)

Projects

Apps

MVP App (apps/mvp/)

Main marketplace application with auctions, curation, social features, and admin tools.

Tech Stack:

• Next.js 16
• TypeScript
• React 19
• Tailwind CSS
• Wagmi + Viem
• Farcaster Mini App SDK
• PostgreSQL + Drizzle ORM

Features:

• NFT auction creation and bidding
• Curated galleries
• User profiles and social features
• Featured listings and sections
• Admin tools for moderation
• Real-time notifications

Getting Started:

cd apps/mvp
pnpm run dev

Documentation: See apps/mvp/README.md

Note: This app will be renamed to cryptoart in a future update.

Packages

Creator Core Contracts (packages/creator-core-contracts/)

Extensible NFT framework based on Manifold Creator Core contracts. Supports ERC721 and ERC1155 tokens with extension system, royalties, and upgradeable implementations.

Features:

• ERC721/ERC1155 implementations
• Extension system for adding functionality
• Multiple royalty standards support
• Upgradeable proxy pattern support

Documentation: See packages/creator-core-contracts/README.md

Key Files:

• DEPLOYMENT_GUIDE.md - Webapp deployment guide
• INTEGRATION_GUIDE.md - Integration guide
• GETTING_STARTED.md - Getting started guide

Auctionhouse Contracts (packages/auctionhouse-contracts/)

Solidity smart contracts for the auction house, forked from Manifold Gallery with modifications for the Cryptoart channel.

Features:

• Listing creation with events
• Seller registry linked to hypersub membership
• Multiple auction types

Documentation: See packages/auctionhouse-contracts/README.md

Development:

cd packages/auctionhouse-contracts
forge build
forge test

Auctionhouse Subgraph (packages/auctionhouse-subgraph/)

The Graph subgraph for indexing Auctionhouse marketplace events on Base Mainnet. Indexes marketplace listings, purchases, bids, offers, and related data.

Features:

• Marketplace event indexing (listings, purchases, bids, offers)
• Library event support (MarketplaceLib, SettlementLib)
• Real-time event linking and entity relationships

Documentation: See packages/auctionhouse-subgraph/README.md

Creator Core Indexer (packages/creator-core-indexer/)

Background service for indexing Creator Core contract deployments and NFT transfers. Monitors the blockchain for new contracts and indexes their events.

Features:

• Automatic contract detection
• Transfer event indexing
• Metadata fetching and caching
• Extension registration tracking

Documentation: See packages/creator-core-indexer/README.md

Additional Packages

The monorepo also includes several shared packages:

• packages/db/ - Database layer with Drizzle ORM
• packages/eslint-config/ - Shared ESLint configuration
• packages/typescript-config/ - Shared TypeScript configuration
• packages/ui/ - Shared UI component library

For detailed information about these packages, see PACKAGES.md.

Development Workflow

Using Turborepo

This monorepo uses Turborepo for managing builds and tasks across projects.

Common Commands:

# Build all projects
pnpm run build

# Run development mode for all apps
pnpm run dev

# Run tests for all projects
pnpm run test

# Lint all projects
pnpm run lint

# Clean all build artifacts
pnpm run clean

Working on a Single Project

You can work on individual projects directly:

# MVP app development
cd apps/mvp
pnpm run dev

# Documentation site
cd apps/docs
pnpm run dev

# Contract development
cd packages/auctionhouse-contracts
forge build
forge test

Documentation

For Humans

• README.md (this file) - High-level overview and getting started
• DEPLOYMENT.md - Complete deployment guide for all projects
• PACKAGES.md - Documentation for additional shared packages
• Project-specific READMEs - See each project's directory for detailed documentation

For LLMs/AI

• llms-full.md - Complete technical documentation consolidated from all projects
  • Includes architecture, deployment guides, quick references, and technical notes
  • Use this for comprehensive understanding of the codebase

Contract Addresses

For a complete list of all contract addresses across all networks, see CONTRACT_ADDRESSES.md.

This includes:

• Auctionhouse contracts
• LSSVM contracts (Router, Factory, Bonding Curves)
• Creator Core contract deployments
• Manifold extension contracts

Security

This repository is open source. All sensitive configuration is managed through environment variables:

• Admin Configuration: Set via ADMIN_WALLET_ADDRESS, ADMIN_FARCASTER_USERNAME, and ADMIN_FID
• Database Credentials: Never committed, use environment variables
• API Keys: All keys stored in environment variables

Important:

• Never commit .env* files or secrets to Git
• See SECURITY.md for security policy
• See OPEN_SOURCE_GUIDE.md for deployment instructions
• See docs/ENV_VARS_MANAGEMENT.md for environment variable documentation

Contributing

1. Create a feature branch from main
2. Make your changes
3. Ensure all tests pass (pnpm run test)
4. Ensure linting passes (pnpm run lint)
5. Submit a pull request

License

See individual project directories for license information.

Related Links

External Documentation

• Manifold Creator Core Documentation
• Farcaster Mini Apps Documentation
• Foundry Documentation
• Turborepo Documentation

Related Repositories

• LSSVM Development Suite - Protocol contracts, miniapp, and subgraph for NFT liquidity pools
  • Documentation: mxjxn.github.io/such-lssvm
  • Integration Guide: LSSVM_INTEGRATION.md