Yellow endpoints

The current private-channel API surface, with clear labels for what is implemented and what is still placeholder behavior

Yellow use case

Read the user-facing story first.

Protocol flow

Understand the full payment flow.

Hosted app

Open the live page.

These endpoints are real, but parts of the funding and closing behavior are still integration scaffolding rather than final on-chain settlement automation.

Endpoints

• POST /api/v1/yellow/channel/create
• POST /api/v1/yellow/channel/discover
• POST /api/v1/yellow/channel/fund
• POST /api/v1/yellow/channel/close
• GET /api/v1/yellow/channel/:id/status
• POST /api/v1/yellow/transfer
• GET /api/v1/yellow/config

What each route is for

Route	Current role
channel/create	Create a stealth destination, bind a channel_id, and publish the discovery object.
channel/discover	Scan announcements and return channel-linked discoveries.
channel/fund	Test the funding API surface.
channel/close	Test the close API surface; current response includes placeholder semantics.
channel/:id/status	Inspect current backend status for a channel id.
transfer	Simulate off-chain transfer state progression.
config	Read the active Yellow websocket and contract config.

Example calls

Create

curl -s -X POST https://backend.specterpq.com/api/v1/yellow/channel/create \
  -H "Content-Type: application/json" \
  -d '{
    "recipient":"bob.eth",
    "token":"USDC",
    "amount":"1000"
  }' | jq .

Discover

curl -s -X POST https://backend.specterpq.com/api/v1/yellow/channel/discover \
  -H "Content-Type: application/json" \
  -d '{
    "viewing_sk":"<HEX_VIEWING_SK>",
    "spending_pk":"<HEX_SPENDING_PK>",
    "spending_sk":"<HEX_SPENDING_SK>"
  }' | jq .

Config

curl -s https://backend.specterpq.com/api/v1/yellow/config | jq .

Current implementation caveats

Close does not submit the final L1 settlement from this backend

The close path is documented in the handler comments as not performing backend L1 submission.

Some transaction-like fields are placeholders

Parts of the current fund and close output are synthetic or placeholder-style values for integration continuity.

Discovery is the strongest part of the integration

The most concrete value here is the link between stealth discovery and channel discovery through channel_id announcements.

Source-backed references

• Route wiring: specter/specter-api/src/routes.rs
• Yellow handlers: specter/specter-api/src/handlers.rs
• Yellow config defaults: specter/specter-api/src/state.rs
• Yellow crate: specter/specter-yellow/src/