Skip to main content

Octant v2 Smart Contracts

This section is the contract-reference layer of the docs, aligned with octant-v2-core 1.2.0-develop.15 at commit 36ed6ad6665661a18f83394d561fa75c68ccf4ac. Use it when you need exact method names, events, inheritance, roles, or edge-case behavior. If you are still deciding which component to use or in what order to read the docs, start with Developer Orientation or Common Developer Workflows first.

Start here if you need a quick route​

I need to...Open these pages
write or inspect a custom strategyBaseStrategy, TokenizedStrategy, BaseHealthCheck
inspect a Yield Donating StrategyYieldDonatingTokenizedStrategy, ERC4626Strategy, AaveV3Strategy, YearnV3Strategy
inspect a Yield Skimming StrategyBaseYieldSkimmingStrategy, YieldSkimmingTokenizedStrategy, IYieldSkimmingStrategy, BaseYieldSkimmingHealthCheck
forward or swap donated yieldYieldForwarder, SwappingYieldForwarder, ISwapper
inspect multi-strategy vault behaviorMultistrategyVault, MultistrategyLockedVault, DebtManagementLib
deploy prebuilt strategies or factoriesBaseStrategyFactory, BaseERC4626StrategyFactory, YieldForwarderFactory
inspect allocation mechanismsBaseAllocationMechanism, TokenizedAllocationMechanism, OctantQFMechanism, QuadraticVotingMechanism
inspect staking and reward flowsRegenStaker, RegenStakerBase, RegenEarningPowerCalculator
inspect payout helpersPaymentSplitter, PaymentSplitterFactory

Core Strategy Primitives​

Concrete Strategies​

Forwarders And Swappers​

Vaults​

Factories​

Package compatibility shims​

1.2.0-develop.15 retains a few deprecated interfaces only to preserve published package import-path compatibility:

  • src/interfaces/IDragon.sol - legacy Dragon facade interface.
  • src/interfaces/IFactory.sol - legacy factory fee-configuration interface.
  • src/interfaces/IMorphoCompounderStrategyFactoryV1.sol - V1 Morpho factory interface for the mainnet factory at 0x052d20B0e0b141988bD32772C735085e45F357c1, whose createStrategy(...) signature has no _symbol parameter.

Use those only when interacting with the older deployed contracts or legacy package imports. New strategy code should prefer the current factory interfaces and the deployed-address guidance for V1/V2 factory selection.

Allocation Mechanisms​

Regen, Helpers, And Guards​

Out of scope for this reference​

The pinned [email protected] also ships the src/zodiac-core/ contracts (LinearAllowanceExecutor and LinearAllowanceSingletonForGnosisSafe). These are not covered by this reference section. Consult the source in the pinned core repo if your integration needs them.

How to use this section without getting lost​

  1. Start with the guide for your task, not with the longest contract page.
  2. Use Reading the Smart-Contract Reference to jump from a task to the right reference page.
  3. Keep the matching guide open while reading the contract page.
  4. Return to Common Developer Workflows if you lose the bigger picture.