Developer Guide

Everything a developer needs to integrate with Oak Chain. Start with the Quickstart, then go deeper into consensus, the V5 settlement contract, and the content surfaces.

Start with the Quickstart. Start a three-validator local cluster, submit a signed write, and read it back. Open the Quickstart →

Foundations

The mental model. How proposals move through consensus, how identity and content paths work, and what to observe.

Consensus Model Aeron Raft mechanics: leader, followers, finality.

Write Pipeline From author signature to COMMITTED, stage by stage, with the fields to watch.

Authentication Wallet signatures and the validator token.

Content Paths Wallet-derived namespacing and shard routing.

Settlement

How writes are paid for. Flat ETH pricing, gas baseline, and Sepolia setup.

Smart Contract ValidatorPaymentV5 surface, gas baseline, and capability flags.

Testnet Sepolia setup and an end-to-end paid write.

Content and Integration

How content moves in and out: reads, events, binaries, and the AEM connector.

Reading Content Explorer, wallet and event reads, including the validator-local event stream.

Binary Storage Author-hosted and validator-hosted binaries.

AEM 6.5 LTS Integration Read-only /oak-chain mount for AEM 6.5 LTS author.

Reference

The validator HTTP surface and its live route inventory.

API Reference The validator HTTP surface for proposal submission and reads.

Going Deeper

For the architectural picture and operator-side documentation:

Architecture. System-level view across the runtime, with the system map at a glance.
Run a Validator. Starting, configuring and monitoring validators.