Skip to content

docs(mpc): document that reducedEncryptedPrv contains private key material#8405

Open
aali-1 wants to merge 1 commit intomasterfrom
wal-439-document-reducedencryptedprv-private-key-material
Open

docs(mpc): document that reducedEncryptedPrv contains private key material#8405
aali-1 wants to merge 1 commit intomasterfrom
wal-439-document-reducedencryptedprv-private-key-material

Conversation

@aali-1
Copy link
Copy Markdown
Contributor

@aali-1 aali-1 commented Apr 6, 2026

Document clearly that reducedEncryptedPrv and ReducedKeyShare.prv contain private key material (s_i).

Changes

  • modules/sdk-lib-mpc/src/tss/ecdsa-dkls/types.ts — Added JSDoc on ReducedKeyShareType documenting each field, specifically that prv is 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 on getReducedKeyShare() documenting that the returned buffer contains private key material (s_i) and is stored as reducedEncryptedPrv on the key card QR code.
  • modules/sdk-core/src/bitgo/keychain/iKeychains.ts — Expanded comment on reducedEncryptedPrv to state it contains the party's private scalar (s_i).
  • modules/sdk-core/src/bitgo/utils/tss/ecdsa/ecdsaMPCv2.ts — Added comment above the reducedEncryptedPrv encryption 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

@linear
Copy link
Copy Markdown

linear bot commented Apr 6, 2026

@aali-1
Copy link
Copy Markdown
Contributor Author

aali-1 commented Apr 6, 2026

@aali-1 aali-1 force-pushed the wal-439-document-reducedencryptedprv-private-key-material branch from 7601ea8 to 8059a22 Compare April 7, 2026 17:30
contains private key material

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: WP-8474
@aali-1 aali-1 force-pushed the wal-439-document-reducedencryptedprv-private-key-material branch from 8059a22 to 3805b29 Compare April 7, 2026 17:51
@aali-1 aali-1 marked this pull request as ready for review April 7, 2026 18:22
@aali-1 aali-1 requested review from a team as code owners April 7, 2026 18:22
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