Document SDK 0.5.7 quote auth#108
Draft
richardliang wants to merge 1 commit into
Draft
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Updates the developer docs for the
@zkp2p/sdk@0.5.7npm release.The Slack release note confirmed that npm
latestnow points to0.5.7, that the SDK depends on@zkp2p/zkp2p-attestation@1.6.3, and that authenticated quote paths now forward the configured SDKapiKeyasx-api-keyforgetQuote()andgetQuotesBestByPlatform().Issue
The docs still described
@zkp2p/sdk@0.5.2as the current release and did not explain the0.5.7authenticated quote behavior. Integrators using authenticated curator quote flows, such as private orderbook lookups or internal quote preferences, would not know that they need0.5.7+for theapiKeyheader 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
@zkp2p/sdk@0.5.7as the current npm release.@zkp2p/zkp2p-attestation@1.6.3.getQuote()andgetQuotesBestByPlatform()forwardapiKeyasx-api-keystarting in0.5.7.0.5.7+guidance to onramp docs and the LLM helper file for authenticated quote/private orderbook flows.Validation
npm view @zkp2p/sdk@0.5.7andnpm view @zkp2p/sdk dist-tagsusing a writable cache.@zkp2p/sdk@0.5.7package declarations and runtime bundle to confirmincludePrivateOrderbooksandx-api-keyforwarding.git diff --check.yarn build.yarn buildpassed. Docusaurus emitted its standard update-check warning because/home/ubuntu/.configis not writable in this environment, but static generation completed successfully.