Skip to main content

Introduction

The Cowboy documentation is comprehensive and covers many topics. This guide helps you find the most relevant content based on your role, experience level, and goals.
Not sure where to start? Follow the path that best matches your situation below.

By Role

Application Developer

Goal: Build actors (smart contracts) on Cowboy You should focus on:
  1. High-level concepts
  2. SDK usage
  3. Actor patterns
  4. Deployment
Recommended Path:
1

Quick Overview

2

Hands-On Start

3

SDK Mastery

Repository LayoutUnderstand the documentation structure
4

Best Practices

Style Guide (15 min)Glossary (15 min)Security, gas optimization, patterns
5

Advanced Topics

Actor VM Overview (20 min)Fee Model (20 min)Understand the platform
Skip (for now):
  • Core protocol implementation details
  • Consensus mechanisms
  • Validator operations

Protocol Developer

Goal: Contribute to Cowboy core or build infrastructure You should focus on:
  1. Architecture deep dives
  2. Protocol specifications (CIPs)
  3. Implementation details
  4. Consensus and networking
Recommended Path:
1

Foundation

2

Deep Dive: Actor VM

3

Deep Dive: Fee System

4

Deep Dive: Scheduler

5

Deep Dive: Off-Chain Compute

6

Codebase

Key Documents:

AI/ML Engineer

Goal: Build autonomous AI agents on Cowboy You should focus on:
  1. Off-chain compute capabilities
  2. Python actor development
  3. Model inference patterns
  4. Data handling
Recommended Path:
1

Overview

What is Cowboy? (5 min)Key Innovations (10 min)Focus on “Verifiable Off-Chain Compute” section
2

Quick Start

3

Off-Chain Deep Dive

Off-Chain Compute Overview (30 min)Task Lifecycle (40 min)This is your key feature!
4

SDK for AI

Repository LayoutFocus on off-chain task submission APIs (see CIP-2)
5

Runner Economics

Understand Runner Economics (see Off-Chain Overview)Learn how pricing works for compute tasks
Key Features for You:
  • ✅ Off-chain computation via runners (CIP-2)
  • ✅ Verifiable result submission (per framework rules)
  • ✅ Deterministic on-chain callbacks via deferred transactions (CIP-2)

DeFi Developer

Goal: Build DeFi protocols (DEX, lending, derivatives) You should focus on:
  1. Actor patterns
  2. Gas optimization
  3. Security (reentrancy, etc.)
  4. Transaction atomicity
Recommended Path:
1

Basics

2

SDK & Patterns

3

Security (Critical!)

Review scheduling and congestion handling (CIP-1), determinism constraints, and best practices.
4

Gas Optimization

Fee Model Overview (20 min)Worked Example (30 min)Understand dual-gas system
5

Advanced Patterns

  • Flash loans (via atomic transactions)
  • Oracle integration (via off-chain compute)
  • Governance (via timers for delayed execution)
DeFi-Specific Considerations:
  • ✅ Native timers for scheduled execution (CIP-1)
  • ✅ Dual-metered pricing for compute vs data (CIP-3)

Security Researcher

Goal: Audit actors or find protocol vulnerabilities You should focus on:
  1. Security model
  2. Attack vectors
  3. Gas economics
  4. Consensus safety
Recommended Path:
2

Attack Vectors

Study vulnerable patterns and congestion handling in the context of CIP-1 and CIP-3.
3

Resource Limits

Review determinism, metering, and limits (see CIP-3 and Actor VM sections).
4

Gas Economics

5

Consensus Security

Review consensus mechanism and Byzantine fault tolerance assumptions.
6

Off-Chain Security

Off-Chain OverviewConsider runner selection and collusion risks (see CIP-2).
Key Security Documents:

Researcher / Academic

Goal: Understand novel mechanisms and write papers You should focus on:
  1. Novel contributions
  2. Formal specifications
  3. Economic models
  4. Performance analysis
Recommended Path:
2

Novel Mechanism 1: Dual-Metered Gas

Fee Model OverviewDual EIP-1559Research angle: Independent resource markets
3

Novel Mechanism 2: Autonomous Scheduling

Scheduler OverviewResearch angle: Gas bidding for timers
4

Novel Mechanism 3: Verifiable Off-Chain

Off-Chain OverviewResearch angle: VRF-based task assignment
6

Governance

Parameters (15 min)Compatibility (15 min)
Core Specifications:
  • Whitepaper and CIPs (see documentation)
Potential Research Topics:
  • Dual-resource EIP-1559 dynamics
  • VRF-based task assignment fairness
  • Gas bidding agent strategies
  • Off-chain compute verification trade-offs

By Experience Level

Blockchain Beginner

You’re new to blockchain entirely Start here:
  1. What is Cowboy?
  2. Key Innovations
  3. Quickstart Guide
  4. FAQ
Then:
  • SDK docs and examples (as available)
Skip (for now):
  • Deep architecture docs
  • Protocol specifications
  • Consensus mechanisms

Python Developer (No Blockchain)

You know Python but not blockchain Your Advantages:
  • ✅ Python syntax familiarity
  • ✅ Testing frameworks familiarity
New Concepts to Learn:
  1. Blockchain basics: Blocks, transactions, consensus
  2. Determinism: Whitelisted modules, no JIT, strict UTF-8
  3. Fees: Dual-metered Cycles (compute) and Cells (data)
  4. Immutability: Code can’t be changed after deploy
Recommended Path:
  1. What is Cowboy?
  2. Quickstart
  3. Determinism & Sandboxing
  4. Fee Model
Key Insight: Think of actors as Python classes that:
  • Persist state via provided storage APIs
  • Do not access filesystem/network directly
  • Consume metered resources (Cycles/Cells)
  • Are immutable after deployment

Advanced / Protocol Level

You want to understand everything deeply Comprehensive Path:
4

Scheduler

5

Off-Chain

6

Transactions

  • Idempotency
  • Reentrancy
7

Development

  • SDK (as available)
  • Best Practices

By Goal

”I want to build a DApp quickly”

Fast Track:
  1. Quickstart
  2. SDK docs (as available)
  3. Examples (as available)

“I want to build production-grade contracts”

Quality Track:
  1. Quickstart
  2. Best Practices
  3. Security
  4. Fee Model
  5. Testing

”I want to run infrastructure (validator/runner)”

Infrastructure Track:
  1. Architecture Overview
  2. Repository Layout
  3. Validator guide (as available)
  4. Runner guide (as available)
  5. Off-Chain Overview

”I want to contribute to Cowboy”

Contributor Track:
  1. Repository Layout
  2. Contributing Guide
  3. Writing rules and style guides
  4. Pick an area (core/SDK/docs)
  5. Start contributing

Need Help Choosing?

Still not sure where to start? Refer to the Overview section or CIPs for authoritative guidance.