Skip to main content

Reading order

Suggested paths through the documentation based on your goals.

New to 4626​

Start here to understand what the protocol does and why.

  1. Introduction — What is 4626?
  2. Token Model — The three-token system
  3. Vault Concept — ERC-4626 basics
  4. Fee Flow — Where fees go

Time: 15–20 minutes

Integrators​

Building on top of 4626? Focus on interfaces and integration points.

  1. Architecture — System overview
  2. CreatorOVault — Vault interface
  3. CreatorShareOFT — OFT mechanics
  4. OFT Integration — Cross-chain setup
  5. API Reference — Generated interface docs

Time: 30–45 minutes

Auditors​

Reviewing security? Focus on invariants and failure modes.

  1. Architecture — Contract relationships
  2. Token Model — Asset vs accounting tokens
  3. CreatorOVault — Core vault invariants
  4. CreatorGaugeController — Fee distribution
  5. BaseCreatorStrategy — Strategy pattern
  6. CCA Launch Strategy — Auction mechanics
  7. Diagram Style Guide — Asset flow rules

Time: 1–2 hours

Operators​

Deploying or maintaining infrastructure? Focus on procedures.

  1. Deploy Vault Guide — End-to-end deployment
  2. Pre-launch Checklist — Before going live
  3. CCA Verification — Auction setup
  4. Automation — Keeper configuration
  5. Troubleshooting — Common issues

Time: 45–60 minutes

Governance participants​

Participating in ve(3,3) voting? Understand the incentive system.

  1. Governance Overview — ve(3,3) mechanics
  2. ve4626 — Lock mechanics
  3. VaultGaugeVoting — Voting system
  4. VoterRewardsDistributor — Claiming rewards
  5. Lottery — Probability direction

Time: 30 minutes

Quick reference​

TopicPage
Contract addressesAddresses
TerminologyGlossary
Token notationDiagram Style Guide
ERC-4337 issuesDebugging