Enhance FROST DKG and Signing Manager with comprehensive documentation - #8
Merged
Merged
Conversation
zy0n
commented
May 26, 2026
Collaborator
- Added detailed JSDoc comments throughout the TrustedDKG class to clarify the purpose and functionality of methods related to the DKG process.
- Improved type definitions in the types.ts file for better clarity and usability.
- Expanded the RFC9591Hasher class documentation to explain domain-separated hash helpers used in FROST and DKG implementations.
- Enhanced DKGManager class with method documentation to describe orchestration of trusted-dealer and coordinator-less DKG flows.
- Updated FROSTSigningManager class with comments to explain the two-round signing flow and its orchestration.
- Improved module-index.ts with type exports and added documentation for shareable key encoding and decoding functions.
- Added detailed JSDoc comments throughout the TrustedDKG class to clarify the purpose and functionality of methods related to the DKG process. - Improved type definitions in the types.ts file for better clarity and usability. - Expanded the RFC9591Hasher class documentation to explain domain-separated hash helpers used in FROST and DKG implementations. - Enhanced DKGManager class with method documentation to describe orchestration of trusted-dealer and coordinator-less DKG flows. - Updated FROSTSigningManager class with comments to explain the two-round signing flow and its orchestration. - Improved module-index.ts with type exports and added documentation for shareable key encoding and decoding functions.
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.