Skip to main content

4626 Documentation

Welcome to the CreatorVault protocol documentation.


Quick start

GoalDocumentation
Understand the protocolIntroduction
Deploy a vaultPre-launch checklist
Integrate with 4626Contract overview
Use governanceve(3,3) system

Documentation sections

SectionDescription
OverviewArchitecture, strategies, and core concepts
ContractsSmart contract documentation
OperationsDeployment and automation
Governanceve(3,3) voting and bribes
IntegrationsCross-chain and external systems
GuidesTutorials and troubleshooting
API ReferenceAuto-generated contract and frontend docs

Key concepts

Token notation

SymbolDescriptionContract
TOKENCreator coinZora Creator Coin
▢TOKENVault sharesCreatorOVault
■TOKENWrapped 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)