docs: add developer reference for Web3AuthMPCCoreKit API, including constructor, methods, and status details - #228
Draft
ieow wants to merge 1 commit into
Draft
docs: add developer reference for Web3AuthMPCCoreKit API, including constructor, methods, and status details#228ieow wants to merge 1 commit into
ieow wants to merge 1 commit into
Conversation
…onstructor, methods, and status details
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.
Motivation and Context
Jira Link:
Description
How has this been tested?
Screenshots (if appropriate):
Types of changes
Checklist:
Note
Low Risk
Documentation-only change; no runtime or security behavior is modified.
Overview
Adds
docs/developer.md, a new developer reference for the publicWeb3AuthMPCCoreKitAPI (types insrc/interfaces.ts).The doc covers constructor options (storage, session, OAuth, TSS/DKG, hashed factors),
COREKIT_STATUS, and method-by-method guidance for init/rehydration, JWT and OAuth login, factor/MFA flows (inputFactorKey,enableMFA,createFactor/deleteFactor,manualSync), signing (includingmakeEthereumSigner), session/account helpers,_UNSAFE_*export APIs, and helpers such asTssSecurityQuestion—with parameter tables and TypeScript examples throughout.Reviewed by Cursor Bugbot for commit a3b4210. Bugbot is set up for automated code reviews on this repo. Configure here.