Quick Start¶

Get Tesseract running in under 5 minutes.

Prerequisites¶

Before you begin, ensure you have:

Python 3.11+ - Download Python
Poetry - Install Poetry
Git - Install Git

Step 1: Clone and Install¶

# Clone the repository
git clone https://github.com/your-org/tesseract.git
cd tesseract

# Install dependencies
poetry install

# Activate virtual environment
poetry shell

Step 2: Verify Installation¶

Test that the contract compiles successfully:

poetry run python scripts/test_compilation.py

Expected output:

Compiling TesseractSimple.vy...
Compilation successful!
Bytecode length: 7,276 bytes
ABI contains 18 items
All tests passed!

Step 3: Run Tests¶

Execute the test suite:

# Run all tests
poetry run pytest tests/

# Run with verbose output
poetry run pytest tests/ -v

Step 4: Deploy Locally¶

Deploy to a local blockchain (requires a running node):

poetry run python scripts/deploy_simple.py

Local Development

For local testing, you can use Anvil or Ganache 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¶

Poetry not found

Install Poetry using the official installer:

curl -sSL https://install.python-poetry.org | python3 -

Python version mismatch

Tesseract requires Python 3.11+. Check your version:

python --version

Vyper compilation errors

Ensure Vyper 0.3.10 is installed:

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

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