Quick Start¶

Get Tesseract running in under 5 minutes.

Prerequisites¶

Before you begin, ensure you have:

Python 3.11+ - Download Python
uv - Install uv (Python package manager)
Git - Install Git

Optional:

Rust 1.75+ - For building the relayer
Anvil - For local testing (install via Foundry)

Step 1: Clone and Install¶

# Clone the repository
git clone https://github.com/cryptuon/tesseract.git
cd tesseract

# Install dependencies
uv sync

Step 2: Verify Installation¶

Test that all contracts compile successfully:

uv run pytest tests/test_compilation.py -v

The repository ships 7 production Vyper contracts, plus a TesseractSimple.vy reference implementation. Compilation of all contracts is covered by the test suite.

You can also confirm the Vyper compiler version directly:

uv run python -c "import vyper; print(f'Vyper: {vyper.__version__}')"

Step 3: Run Tests¶

Execute the full test suite (135 tests):

# Run all tests
uv run pytest tests/ -v

# Run a specific category
uv run pytest tests/test_compilation.py -v   # Contract compilation
uv run pytest tests/test_tokenomics.py -v    # Token, staking, governance
uv run pytest tests/test_defi_security.py -v # DeFi security features

Step 4: Deploy¶

Deploy to a public testnet:

# Set environment
export PRIVATE_KEY="0x..."
export SEPOLIA_RPC_URL="https://eth-sepolia.g.alchemy.com/v2/..."

# Deploy
uv run python scripts/deploy_simple.py sepolia

Local Development

For local testing, use Anvil as your local blockchain.

Next Steps¶

Now that you have Tesseract installed:

Installation Guide - Detailed setup instructions
Your First Transaction - Create your first cross-rollup transaction
Core Concepts - Understand how Tesseract works
Deploy to Testnet - Go live on Sepolia

Troubleshooting¶

Common Issues¶

uv not found

Install uv using the official installer:

curl -LsSf https://astral.sh/uv/install.sh | sh

Python version mismatch

Tesseract requires Python 3.11+. Check your version:

python --version

Vyper compilation errors

Ensure Vyper 0.3.10 is installed:

uv run python -c "import vyper; print(vyper.__version__)"

Need more help? Check the Troubleshooting Guide or open an issue.