Purpose: Route experienced builders to the right Octant v2 docs path quickly. Audience: Developers new to Octant, choosing where to start. Level: Beginner Source of truth: [email protected] Use this page when: you need the fastest path to the right tutorial, concept page, or reference page. Do not use this page for: exact function signatures, deployment scripts, or a full production runbook.

Developer Orientation

Before you read this page

• Helpful: Introduction and DeFi Concepts Primer (for Octant vocabulary and DeFi foundations)

Octant v2 is infrastructure for sustainable on-chain funding. It connects DeFi yield generation with configurable allocation mechanisms, enabling communities and organizations to route yield to causes they support, permissionlessly and transparently.

This page is the routing layer for the developer docs. Read it to decide where to start. Then switch to the tutorial or reference page that matches your actual task.

New to Octant v2?

Start by setting up your local environment: Local Development Quickstart. If you are completely new, begin with Track A: build a Yield Donating Strategy through the Hello World tutorial. It is the most supported first path.

This orientation page is aligned with [email protected]. If you are working with a newer core revision, re-check constructor signatures, hook surfaces, deployment flows, and factory expectations before following code examples. When several docs pages, starter repos, or ABI bundles appear to disagree, prefer: (1) the pinned [email protected] source for contract architecture and behavior, (2) the specific starter repository you are actively using for its local scaffolding, (3) this page for routing and terminology only.

Scope of the onboarding docs

The first pages in this section do not all describe the same kind of workflow.

• Local Development Quickstart is a repo and toolchain bootstrap guide. It helps you clone repos, install dependencies, and run builds and tests.
• Hello World Strategy is a fork-based tutorial. It assumes a mainnet RPC and an already deployed YieldDonatingTokenizedStrategy implementation address.
• The current docs do not yet include a single end-to-end recipe for deploying a complete Octant stack entirely from local contracts.

Use the tracks below to choose the closest starting point for your goal.

How to use this page

1. Identify the concrete thing you want to build or operate.
2. Use the routing table below to choose the first page.
3. Move to the contract reference only when you need exact signatures, roles, factories, or events.
4. Return here if you lose the thread between concept docs, tutorials, and autogenerated reference pages.

What do I actually deploy?

This is the most important architecture distinction to keep in mind.

Goal	Deploy this	Why
One asset, one strategy, direct deposits	a strategy vault	The strategy itself is the ERC-4626 deposit surface
One asset, several strategies, operator-managed allocation	MultistrategyVault or MultistrategyLockedVault	The vault sits above several strategies and manages debt, queue policy, and rebalancing
One donated yield stream, several fixed downstream recipients	PaymentSplitter behind the donation address	Routing is a downstream concern, not a vault concern

In these docs, funding vault is only an umbrella term for the broader product pattern. It is not the concrete contract name you should reach for first when building.

Before you choose a path

Doc type	What it is good for	What it does not do
Orientation and concept pages	Understanding Octant's architecture, vocabulary, and component boundaries	Walking you through deployment or testing step by step
Tutorial pages	Getting a specific path working quickly, usually with a worked example	Replacing the autogenerated contract reference or defining a production runbook
Autogenerated contract reference	Looking up exact methods, inheritance, modifiers, events, and storage	Teaching first principles or giving a beginner-friendly reading order

Choose your path

I want to...	Start here	Then read...
build my first Yield Donating Strategy vault	Hello World Strategy	Yield Donating Strategy, Common Developer Workflows
build a Yield Skimming Strategy vault	Yield Skimming Strategy	Common Developer Workflows, Reading the Smart-Contract Reference
build an allocation mechanism	Tokenized Allocation Mechanisms	Common Developer Workflows
operate a vault across several strategies	Multi-Strategy Vaults	Reading the Smart-Contract Reference, Common Developer Workflows
deploy or operate community staking	Regen Staker	Reading the Smart-Contract Reference
route one yield stream to several fixed recipients	Payment Splitter Patterns	Reading the Smart-Contract Reference, Common Developer Workflows
understand the contract docs before coding	Reading the Smart-Contract Reference	Common Developer Workflows

1. Yield Donating Strategies

Integrate an external yield source so that generated profit is donated to a configured on-chain address.

Build here if you want to connect protocols like Aave, Compound, Spark, or other yield sources that fit the Yield Donating Strategy model.

Dive in: Yield Donating Strategy

2. Yield Skimming Strategies

Hold a yield-bearing token and capture its exchange-rate appreciation, routing that value to a configured beneficiary address.

Build here if you want to use yield-bearing tokens such as wstETH, rETH, or Lido-derived assets with Octant v2.

Dive in: Yield Skimming Strategy

3. Tokenized Allocation Mechanisms

Build systems for communities to decide how funds are distributed, such as voting rounds, quadratic funding, or custom governance mechanisms.

Build here if you are designing allocation logic or governance flows on top of Octant v2.

Dive in: Tokenized Allocation Mechanisms

4. Multi-Strategy Vaults

Create vaults that allocate capital across several strategies with configurable debt limits, queue policy, reporting, and rebalancing.

Build here if you are managing diversified capital deployment across multiple yield sources.

Dive in: Multi-Strategy Vaults

5. Payment Splitters and Routing

Route one donated yield stream to several fixed downstream recipients without embedding custom allocation policy directly into a strategy or vault.

Build here if one yield stream must be split across a TAM, RegenStaker, treasury operations, or other fixed recipients.

Dive in: Payment Splitter Patterns

6. Getting Help

• Developer FAQ: FAQ
• Deployed Addresses: Deployed Addresses
• How to use the contract reference: Reading the Smart-Contract Reference
• Task-by-task reading orders: Common Developer Workflows
• Discord Support Channel: #builder-support
• Join the Octant Discord

Learning Tracks

These suggested reading paths are ordered from first principles to implementation. Pick the track that matches your goal and follow the pages in sequence.

Track A — Build a Yield Donating Strategy (YDS)

For engineers who want to connect an external yield source such as Aave, Compound, DSR, SSR, or Spark and route generated profit on-chain to a beneficiary address.

1. Local Development Quickstart — bootstrap the repos, toolchain, and test environment
2. Hello World Strategy — zero to a fork-tested sDAI strategy in one page, start here for your first strategy vault
3. Introduction to YDS — understand the model and lifecycle
4. Architecture — YDS — immutable-proxy pattern and design invariants
5. Mental Model & Lifecycle — YDS — required overrides and hook surface
6. How to Create a YieldDonating Strategy — starter-template workflow and Aave-based example
7. Writing a YDS Strategy — deeper worked examples and reference-aligned implementation patterns

Track B — Build a Yield Skimming Strategy (YSS)

For engineers who want to hold yield-bearing tokens such as wstETH or rETH and capture their exchange-rate appreciation on-chain for a beneficiary address.

1. Local Development Quickstart — bootstrap the repos, toolchain, and test environment
2. Introduction to YSS — understand the value model and lifecycle
3. Architecture — YSS — value-shares, RAY precision, and design invariants
4. Writing a YSS Strategy — worked example with tests

No starter template yet

Unlike Track A, Track B does not currently have a dedicated starter template. You will need to work directly within octant-v2-core and use the worked example in the Writing a YSS Strategy page as your starting point.

Track C — Build a Tokenized Allocation Mechanism (TAM)

For engineers designing funding rounds, quadratic funding, or other community allocation logic on top of Octant v2.

1. Local Development Quickstart — bootstrap the repos, toolchain, and test environment
2. Introduction to TAM — understand the allocation model and where TAM sits in the protocol
3. TAM: Architecture — delegatecall proxy pattern, roles, and system flow
4. TAM: Mental Model & Lifecycle — required hooks, invariants, and window semantics
5. TAM: Writing a New Funding Mechanism — worked example and the full constructor surface
6. Reading the Smart-Contract Reference — exact methods, roles, and inheritance surface
7. Deployed Addresses — look up the canonical AllocationMechanismFactory address before deploying
8. Common Developer Workflows — task-based reading order

No starter template yet

Track C does not currently have a dedicated starter template. You will need to work directly within octant-v2-core.

Track D — Operate a Multi-Strategy Vault

For engineers managing diversified capital deployment with configurable allocation across multiple strategies.

1. Local Development Quickstart — bootstrap the repos, toolchain, and test environment
2. Multi-Strategy Vaults — vault configuration, strategy queue, debt limits, and allocation management
3. Reading the Smart-Contract Reference — understand role-gated operations and reference pages
4. Deployed Addresses — use the correct shared deployment layer for your environment
5. Common Developer Workflows — follow the task-based vault operation path

Track E — Deploy or Operate Regen Staker

For engineers wiring staking, streamed rewards, and contribution flows into allocation mechanisms.

1. Local Development Quickstart — bootstrap the repos, toolchain, and test environment
2. Regen Staker — deployment and operations model
3. Reading the Smart-Contract Reference — exact methods and role-gated behavior
4. Common Developer Workflows — broader reading order around staking and downstream funding

Track F — Route One Yield Stream to Several Fixed Recipients

For engineers who want one strategy or vault to feed several downstream recipients without embedding custom allocation logic into the upstream contract.

1. Payment Splitter Patterns — routing model and decision points
2. Reading the Smart-Contract Reference — exact initializer and claim surface
3. Deployed Addresses — look up the canonical PaymentSplitterFactory address before calling create()
4. Common Developer Workflows — where this fits relative to strategies, vaults, and staking