Skip to content

docs: add run-a-job and payment-provider walkthroughs#27

Draft
rickstaa wants to merge 1 commit into
mainfrom
docs/payment-provider-walkthroughs
Draft

docs: add run-a-job and payment-provider walkthroughs#27
rickstaa wants to merge 1 commit into
mainfrom
docs/payment-provider-walkthroughs

Conversation

@rickstaa

@rickstaa rickstaa commented Jun 17, 2026

Copy link
Copy Markdown
Member

Draft docs for the clearinghouse, for review @ John. Two pages:

docs/run-a-job.md — Tier 1, the consume path

The developer flow: find an app → call it through the SDK → pay via a signer.

  • Frames apps as containers orchestrators host, with passthrough over HTTP / SSE / WebSocket / trickle; runtime in beta (contact the team to onboard your own app).
  • Discovery via the dashboard or the discovery endpoint, routed by app id.
  • One worked example per transport, grounded in the real livepeer-python-gateway SDK and the example apps: hello-world (HTTP), vllm (SSE), echo (trickle), streaming-asr (WebSocket).
  • Payment via a hosted signer (PymtHouse) with a pointer into the Payment Provider doc.

docs/payment-provider.md — Tier 2, the operator role

  • Payments on Livepeer — PM tickets settle in ETH; a signer mints them so your app pays with just a URL + key.
  • Three paths: use a hosted signer (fiat billing, no crypto), run a remote signer (next to your SDK on a private network, no accounts), run the clearinghouse suite (auth/metering/billing via OpenMeter, OAuth, Stripe — ports & adapters).
  • Reference: signer flags, endpoints/status codes, auth-webhook contract, create_signed_ticket event.

Open questions for John

  • Does the framing of the lean clearinghouse core + suite match your build plan?
  • *(In build)* markers flag what's still scaffolded in livepeer/clearinghouse — correct as listed?
  • Is https://pymthouse.com / https://api.pymthouse.com the right hosted endpoint to point developers at?

Status: draft. Code samples are illustrative of the target DX; SDK method/param names may still change.

🤖 Generated with Claude Code

Refs #16

Draft developer/operator docs for the clearinghouse:

- run-a-job.md (Tier 1, consume path): find an app, call it through
  the SDK across HTTP/SSE/trickle/WebSocket transports, and pay via a
  signer. Grounded in the livepeer-python-gateway SDK and example apps.
- payment-provider.md (Tier 2, operator role): payments on Livepeer,
  then three paths — use a hosted signer, run your own remote signer,
  or run the clearinghouse suite (auth/metering/billing via OpenMeter,
  OAuth, Stripe).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@linear-code

linear-code Bot commented Jun 23, 2026

Copy link
Copy Markdown

ENG-142

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants