Skip to content

feat: kyc controller scaffolding - #9781

Open
Akaryatrh wants to merge 6 commits into
mainfrom
feat/scaffold-kyc-controller
Open

feat: kyc controller scaffolding#9781
Akaryatrh wants to merge 6 commits into
mainfrom
feat/scaffold-kyc-controller

Conversation

@Akaryatrh

@Akaryatrh Akaryatrh commented Aug 4, 2026

Copy link
Copy Markdown
Contributor

Explanation

This PR adds the @metamask/kyc-controller package scaffold and registration:

  • New packages/kyc-controller workspace (package.json, tsconfig*.json, jest.config.js, typedoc.json, LICENSE, README.md, CHANGELOG.md) with a placeholder export
  • Monorepo registration: .github/CODEOWNERS, teams.json, codeowners.ts, root tsconfig.json / tsconfig.build.json references, and the root README.md package list
  • yarn.lock entry for the new workspace (dev dependencies only)

The KYC / identity verification controller itself — its state, messenger, actions/events, and verification logic — is added in a follow-up PR built on top of this one.

References

  • Follow-up PR will add the @metamask/kyc-controller features (controller implementation, messenger, actions/events, and tests)

Checklist

  • I've updated the test suite for new or updated code as appropriate
  • I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate
  • I've communicated my changes to consumers by updating changelogs for packages I've changed
  • I've introduced breaking changes in this PR and have prepared draft pull requests for clients and consumer packages to resolve them

Note

Low Risk
Scaffolding and ownership/metadata only; no runtime KYC logic or client integration in this change.

Overview
Introduces @metamask/kyc-controller as a new workspace under packages/kyc-controller, with the usual package layout (build/tsconfig, Jest, Typedoc, licenses, README, changelog) and a placeholder default export only—the real KYC controller, messenger, and verification behavior are deferred to a follow-up PR.

Wires the package into the monorepo: codeowners.ts / generated CODEOWNERS (Universal KYC team → @MetaMask/universal-kyc), teams.json, root README package list and dependency graph node, root tsconfig.json / tsconfig.build.json project references, and yarn.lock.

Reviewed by Cursor Bugbot for commit fa9f5c2. Bugbot is set up for automated code reviews on this repo. Configure here.

Signed-off-by: Sébastien Van Eyck <sebastien.vaneyck@consensys.net>
@Akaryatrh
Akaryatrh requested a review from a team as a code owner August 4, 2026 16:06

@cursor cursor Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cursor Bugbot has reviewed your changes and found 1 potential issue.

Fix All in Cursor

❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.

Reviewed by Cursor Bugbot for commit c60a07b. Configure here.

Comment thread packages/kyc-controller/CHANGELOG.md Outdated
Signed-off-by: Sébastien Van Eyck <sebastien.vaneyck@consensys.net>
@mcmire

mcmire commented Aug 4, 2026

Copy link
Copy Markdown
Collaborator

@Akaryatrh It looks like you're missing some lint scripts from the package. I added some new ones recently and forgot to add them to the create-package script. But you should be able to add them automatically by running yarn constraints --fix.

Signed-off-by: Sébastien Van Eyck <sebastien.vaneyck@consensys.net>
Signed-off-by: Sébastien Van Eyck <sebastien.vaneyck@consensys.net>
@Akaryatrh

Copy link
Copy Markdown
Contributor Author

@Akaryatrh It looks like you're missing some lint scripts from the package. I added some new ones recently and forgot to add them to the create-package script. But you should be able to add them automatically by running yarn constraints --fix.

Hey @mcmire, thanks for feedback, all green now! 🙂

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