Repository navigation
Conversation
This branch was successfully deployed
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.
Note
Low Risk
Documentation-only; no runtime or API behavior changes in this PR.
Overview
Adds
docs/vendor-flow-architecture.md, a target design for generalizing@metamask/kyc-controlleracross Iron, MoonPay, and Kalshi without expanding a sharedKycPhaseenum for every vendor step.The spec replaces a linear cursor with a requirement DAG plus a recompute-on-every-trigger engine: nodes classify as retired / excluded / waiting / satisfied / unsatisfiable / blocker; durable outcomes (
createKycSession,ready,rejected) retire upstream work; consumers should gate on derivedready, notfinalStatus: approved(Iron account activation). It also covers vendor definitions, nested sub-flows (MoonPay iframes), resume/reinstall authority from kyc-api, persistence rules, package component mapping, and open questions vs today’s behavior.ARCHITECTURE.mdnow points readers at this doc for the intended model while keeping the existing doc focused on the as-shipped MoonPay/Iron linear machine.Reviewed by Cursor Bugbot for commit 51a4e7e. Bugbot is set up for automated code reviews on this repo. Configure here.