docs(mpc): document that reducedEncryptedPrv contains private key material#8405
Draft
docs(mpc): document that reducedEncryptedPrv contains private key material#8405
Conversation
…erial Add JSDoc/inline comments to ReducedKeyShareType, getReducedKeyShare(), reducedEncryptedPrv field, and the encryption block in ecdsaMPCv2.ts clarifying that prv is the party's private scalar s_i and that the resulting reducedEncryptedPrv on the key card QR code is a second copy of private key material. Ticket: WAL-439
Contributor
Author
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.
Document clearly that
reducedEncryptedPrvandReducedKeyShare.prvcontain private key material (s_i).Changes
modules/sdk-lib-mpc/src/tss/ecdsa-dkls/types.ts— Added JSDoc onReducedKeyShareTypedocumenting each field, specifically thatprvis the party's private scalar s_i and is sensitive private key material.modules/sdk-lib-mpc/src/tss/ecdsa-dkls/dkg.ts— Added JSDoc ongetReducedKeyShare()documenting that the returned buffer contains private key material (s_i) and is stored asreducedEncryptedPrvon the key card QR code.modules/sdk-core/src/bitgo/keychain/iKeychains.ts— Expanded comment onreducedEncryptedPrvto state it contains the party's private scalar (s_i).modules/sdk-core/src/bitgo/utils/tss/ecdsa/ecdsaMPCv2.ts— Added comment above thereducedEncryptedPrvencryption block noting it produces an encrypted copy of private key material stored on the key card QR code.Comments only — no logic changes. Both modules lint cleanly.
Ticket: WAL-439