Developer Docs Hub

A practical guide to Yokefellow’s integration surface for internal teams, approved partners, and future approved builders.

Overview

This hub is the technical front door for building against Yokefellow. It is where builders can find the SDK, the direct API surface, product-integration guidance, and one concrete reference implementation path for working with buckets, offerings, rights-related outputs, queue state, and lifecycle-driven flows.

Use this hub when your goal is to get from setup to a real working integration without piecing the builder surface together from the broader launch set.

The current builder surface is not only conceptual. It already includes a packaged SDK client, a versioned direct API family, lifecycle helpers for funding flows, offering participation flows, queue and request surfaces, market and activity reads, and a live reference app path that shows those rails working together.

Access posture

Yokefellow is building toward a broader builder ecosystem, but builder access starts controlled. The integration surface is real now. Wider builder participation expands later through the governance and platform-control layers rather than opening all at once.

This hub is therefore written for the people building against that surface today, while also serving as the technical front door for future approved builders and technical evaluators.

One practical boundary is worth keeping clear from the start: public route reachability, authenticated integration recognition, wallet context, and wallet signing are related, but they are not the same proof. The deeper docs in this hub keep those layers separate on purpose.

Choose your path

Quickstart

Start here if your goal is first successful integration with the fewest moving parts. This is the fastest route from setup to a real read and one controlled write or transaction flow, followed by state confirmation.

SDK Guide

Use this if you want the packaged developer surface. This covers install and setup, auth and signing posture, transaction lifecycle, read and write groupings, and the main Yokefellow primitives builders work with in code.

API Reference

Use this if you need the direct programmatic surface in lookup form. This covers the versioned route family, auth model, read APIs, write APIs, object groupings, request and response patterns, lifecycle handling, and errors.

Integration Playbook

Use this if you are wiring Yokefellow into a real app or partner flow. This covers how to structure the product around the right primitive, how bucket, offering, output, funding, and lifecycle surfaces fit together, and how to keep pending, reviewable, queued, and resolved state legible in production.

Example App Spec

Use this if you want to see one full reference integration end to end. The current reference path is Snake Test, a bucket-linked app surface that proves direct buys, random outputs, request flows, earned-event flows, craft paths, funding flows, queue handling, wallet state, and lifecycle confirmation on Yokefellow’s real rails.

Docs map

This hub is organized into five working documents:

Quickstart — the smallest path to first successful integration.

SDK Guide — install, setup, auth posture, signing assumptions, transaction lifecycle, and common builder flows.

API Reference — the direct /api/sdk/v1 surface, including read families, write families, object groupings, lifecycle handling, and errors.

Integration Playbook — how buckets, offerings, outputs, funding flows, queue state, and lifecycle handling fit into real product integrations.

Example App Spec — a reference implementation path showing the engine in use through the current Snake Test surface.

What this surface currently includes

At a practical level, the current builder surface includes:

bucket-centered reads and funding reads

wallet-linked entitlement and NFT reads

offering request, buy, craft, and earned-event flows

request and mint queue surfaces

market and activity reads

class, collection, and mint lookups

capability and permission-adjacent routes

tracked funding lifecycle flows for deposit, withdraw, transfer-between-buckets, status, and finalization

That breadth matters because Yokefellow is not only exposing one narrow buy path. It is exposing a broader programmable participation surface.