Skip to main content

Common Developer Workflows

Purpose: Map common Octant v2 engineering tasks to the smallest useful reading path. Audience: Developers who know the job they need to do and want the fastest route through the docs. Level: Beginner Source of truth: [email protected] for contract behavior, the linked implementation pages for exact setup details. Use this page when: you want a task-based reading order instead of navigating section by section. Do not use this page for: exact deployment parameters, initializer arguments, or contract-level edge cases without checking the linked reference pages.

Source-of-truth rule

This page is a routing layer. It helps you choose a reading order, but it does not override the underlying implementation docs or the pinned core source.

If a workflow summary and a contract page appear to disagree, prefer:

  1. the pinned [email protected] source,
  2. the specific implementation or reference page linked from that workflow,
  3. this page for reading order only.

Use this page when you know the job you need to do, but you do not want to reconstruct the reading order from scratch.

The following diagram shows how the different doc sections relate and build on each other:

How to use this page

Treat each workflow as a practical reading path, not just a topic list. If your job involves deployment or live operations, do not stop at the conceptual guides, continue into the contract-reference pages and the relevant setup steps.

One recurring pattern across Octant v2

Many integrations have two layers:

  1. your contract or instance, such as a strategy, vault, or allocation mechanism,
  2. shared Octant infrastructure, such as implementation contracts, factories, role managers, or downstream routing.

If you are moving beyond pure code reading, make sure your path includes deployment details, roles, and post-deploy operations.

1. Build your first Yield Donating Strategy​

Goal: wrap an external yield source and route realized yield to a donation address.

Recommended order

  1. Developer Orientation
  2. Local Development Quickstart
  3. Hello World Strategy
  4. Introduction to YDS
  5. Architecture — YDS
  6. Writing a YDS Strategy
  7. Deployed Addresses
  8. Reference pages: BaseStrategy, YieldDonatingTokenizedStrategy, BaseHealthCheck

Use this path when you need a concrete, fork-tested starting point, then want the full lifecycle and reference detail before deploying against the shared Octant implementation.

2. Build a Yield Skimming Strategy​

Goal: hold a yield-bearing asset and route exchange-rate appreciation to a donation address.

Recommended order

  1. Developer Orientation
  2. Local Development Quickstart
  3. Introduction to YSS
  4. Architecture — YSS
  5. Writing a YSS Strategy
  6. Deployed Addresses
  7. Reference pages: BaseYieldSkimmingHealthCheck, YieldSkimmingTokenizedStrategy, TokenizedStrategy

Use this path when your strategy holds a value-accruing asset rather than periodically harvesting reward tokens.

3. Deploy a standalone strategy against shared Octant infrastructure​

Goal: take a strategy you already understand and deploy it correctly against the shared Octant implementation layer.

Recommended order

  1. Local Development Quickstart
  2. Reading the Smart-Contract Reference
  3. Deployed Addresses
  4. Your strategy-specific build guide, for example Hello World Strategy, Writing a YDS Strategy, or Writing a YSS Strategy
  5. Strategy reference pages for the exact inheritance tree you are using

Use this path when your code is already written and you now need the correct implementation address, constructor arguments, operational roles, and deployment-time checks.

4. Deploy and operate a multi-strategy vault​

Goal: allocate one underlying asset across several ERC-4626-compatible strategies and run the vault safely after deployment.

Recommended order

  1. Multi-Strategy Vaults
  2. Reading the Smart-Contract Reference
  3. Deployed Addresses
  4. Reference pages: MultistrategyVault, MultistrategyLockedVault, DebtManagementLib
  5. Payment Splitter Patterns, if the vault's donated yield must be routed to several fixed recipients

Use this path when you already understand the underlying strategies and now need queue policy, role assignment, report processing, debt limits, rebalancing, and shutdown behavior.

5. Deploy or operate Regen Staker​

Goal: create a token staking flow with rewards, optional compounding, and contributions into approved allocation mechanisms.

Recommended order

  1. Regen Staker
  2. Reading the Smart-Contract Reference
  3. Deployed Addresses
  4. Reference pages: RegenStaker, RegenStakerBase, RegenEarningPowerCalculator

Use this path when community staking and downstream funding are part of the same deployment.

6. Route one yield stream to several fixed recipients​

Goal: put a simple routing layer between a strategy or vault and several downstream recipients.

Recommended order

  1. Core Concepts
  2. Payment Splitter Patterns
  3. Reading the Smart-Contract Reference
  4. Reference page: PaymentSplitter

Use this path when one donated yield stream should be split across a fixed set of recipients such as a TAM, RegenStaker, and an OpEx address.

7. Build a Tokenized Allocation Mechanism​

Goal: author a new on-chain funding mechanism with Octant's shared lifecycle and accounting.

Recommended order

  1. Tokenized Allocation Mechanisms
  2. Introduction to TAM
  3. TAM: Architecture
  4. TAM: Mental Model & Lifecycle
  5. TAM: Writing a New Funding Mechanism
  6. Reading the Smart-Contract Reference
  7. Deployed Addresses
  8. Reference pages: BaseAllocationMechanism, TokenizedAllocationMechanism, AllocationMechanismFactory

Use this path when you are extending allocation logic rather than yield generation.

8. Find the right page quickly​

I need to...Best starting page
build a first strategy fastHello World Strategy
understand the overall systemDeveloper Orientation
deploy a strategy against shared Octant infrastructureDeployed Addresses
connect a strategy to a vaultMulti-Strategy Vaults
operate a vault after deploymentMulti-Strategy Vaults
understand contract pages without getting lostReading the Smart-Contract Reference
work with staking and rewardsRegen Staker
split one yield stream across fixed recipientsPayment Splitter Patterns
work on allocation logicTokenized Allocation Mechanisms