docs: align stealth scheme + examples to canonical EIP-5564 (SDK 0.10.0) - #112
Merged
Conversation
@sip-protocol/sdk@0.10.0 flipped the stealth scheme to canonical EIP-5564 (ECDH shared secret on the viewing key; one-time address on the spending key; view-only scanning with viewing-private + spending-public). Align the docs with the published SDK: - Revert the stealth-scheme descriptions that PR #109 had flipped to the old swapped scheme (security/crypto-assumptions, security/audit-checklist) back to canonical, fix the muddled security/security-properties proof sketch, and the concepts/stealth-address + guides/cross-chain-stealth pseudocode. #109's unrelated fixes (Pedersen H try-and-increment, ACIR opcode counts, UltraHonk) are kept intact. - Fix the specs/eip-5564 cryptographic math to canonical. - Migrate check*StealthAddress code examples to the view-only 0.10.0 signature (addr, viewingPrivateKey, spendingPublicKey) across glossary, specs/eip-5564, guides/ethereum-privacy, and cookbook/05-stealth-scanning — and rework the cookbook scanner so it never holds the spending private key. derive* examples are unchanged (their signature did not change). Relates to sip-protocol/sip-protocol#1099, #1100.
|
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
1 participant
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.
Aligns the docs with the now-live
@sip-protocol/sdk@0.10.0, which flipped the stealth scheme to canonical EIP-5564 (ECDH on the viewing key, one-time address on the spending key, view-only scanning).Changes
check*StealthAddressexamples to the view-only 0.10.0 signature(addr, viewingPrivateKey, spendingPublicKey)across glossary, specs/eip-5564, guides/ethereum-privacy, cookbook/05-stealth-scanning; reworks the cookbook scanner so it never holds the spending private key.derive*examples unchanged.Verification
check*signatures remain (outside auto-generatedreference/).npm run buildsucceeds (1277 pages).Completes Plan 3 of the sip-protocol/sip-protocol#1099 rollout (SDK fix: sip-protocol/sip-protocol#1100).