4626 Documentation
Welcome to the CreatorVault protocol documentation.
Quick start
| Goal | Documentation |
|---|---|
| Understand the protocol | Introduction |
| Deploy a vault | Pre-launch checklist |
| Integrate with 4626 | Contract overview |
| Use governance | ve(3,3) system |
Documentation sections
| Section | Description |
|---|---|
| Overview | Architecture, strategies, and core concepts |
| Contracts | Smart contract documentation |
| Operations | Deployment and automation |
| Governance | ve(3,3) voting and bribes |
| Integrations | Cross-chain and external systems |
| Guides | Tutorials and troubleshooting |
| API Reference | Auto-generated contract and frontend docs |
Key concepts
Token notation
| Symbol | Description | Contract |
|---|---|---|
| TOKEN | Creator coin | Zora Creator Coin |
| ▢TOKEN | Vault shares | CreatorOVault |
| ■TOKEN | Wrapped shares (OFT) | CreatorShareOFT |
Architecture
Creator Coin (TOKEN)
|
v
+-------------------+
| CreatorOVault |
+-------------------+
|
+--> Issues ▢TOKEN (vault shares)
| |
| v
| +------------------+
| | Wrap via Wrapper |
| +------------------+
| |
| v
| ■TOKEN (OFT) -----> Cross-chain transfers
| |
| v
| CCA Strategy -----> Auctions ■TOKEN for ETH
|
+--> Yield Strategies -> Deploy TOKEN for yield
|
+---> Charm (V3 LP)
+---> Ajna (Lending)
Contributing
Edit files in 4626/docs/, not apps/docs-site/docs/.
The docs site syncs from source documentation and auto-generates API references from:
- Contract NatSpec comments (
forge doc) - Frontend TypeScript types (
typedoc)