Skip to content

Document SDK 0.5.7 quote auth#108

Draft
richardliang wants to merge 1 commit into
mainfrom
codex/sdk-0-5-7-docs
Draft

Document SDK 0.5.7 quote auth#108
richardliang wants to merge 1 commit into
mainfrom
codex/sdk-0-5-7-docs

Conversation

@richardliang

Copy link
Copy Markdown
Contributor

Summary

Updates the developer docs for the @zkp2p/sdk@0.5.7 npm release.

The Slack release note confirmed that npm latest now points to 0.5.7, that the SDK depends on @zkp2p/zkp2p-attestation@1.6.3, and that authenticated quote paths now forward the configured SDK apiKey as x-api-key for getQuote() and getQuotesBestByPlatform().

Issue

The docs still described @zkp2p/sdk@0.5.2 as the current release and did not explain the 0.5.7 authenticated quote behavior. Integrators using authenticated curator quote flows, such as private orderbook lookups or internal quote preferences, would not know that they need 0.5.7+ for the apiKey header forwarding fix.

Cause And User Impact

The SDK release moved ahead of the docs. That left public SDK installation guidance stale and made the quote API reference incomplete for authenticated quote callers. Public quote users are unaffected, but backend and payment integrations that use authenticated quote options could keep chasing quote/payment creation failures if they stayed on older SDK versions.

Fix

  • Updates the SDK overview to list @zkp2p/sdk@0.5.7 as the current npm release.
  • Updates the client reference runtime note to document @zkp2p/zkp2p-attestation@1.6.3.
  • Documents that getQuote() and getQuotesBestByPlatform() forward apiKey as x-api-key starting in 0.5.7.
  • Adds 0.5.7+ guidance to onramp docs and the LLM helper file for authenticated quote/private orderbook flows.

Validation

  • Verified npm metadata with npm view @zkp2p/sdk@0.5.7 and npm view @zkp2p/sdk dist-tags using a writable cache.
  • Inspected the published @zkp2p/sdk@0.5.7 package declarations and runtime bundle to confirm includePrivateOrderbooks and x-api-key forwarding.
  • Ran git diff --check.
  • Ran yarn build.

yarn build passed. Docusaurus emitted its standard update-check warning because /home/ubuntu/.config is not writable in this environment, but static generation completed successfully.

@vercel

vercel Bot commented Jun 24, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment Jun 24, 2026 7:22pm

Request Review

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.

1 participant