feat: migrate snap-simple-keyring

.prettierignore

@@ -0,0 +1,3 @@
+# Snap packages use older tooling (Prettier v2, different configs).
+# Formatting will be aligned in a follow-up.
+packages/snaps/

README.md

@@ -34,6 +34,8 @@ This repository contains the following packages [^fn1]:
 - [`@metamask/keyring-snap-client`](packages/keyring-snap-client)
 - [`@metamask/keyring-snap-sdk`](packages/keyring-snap-sdk)
 - [`@metamask/keyring-utils`](packages/keyring-utils)
+- [`@metamask/snap-simple-keyring-site`](packages/snaps/simple-keyring/packages/site)
+- [`@metamask/snap-simple-keyring-snap`](packages/snaps/simple-keyring/packages/snap)
 
 <!-- end package list -->
 
@@ -61,6 +63,8 @@ linkStyle default opacity:0.5
   keyring_snap_client(["@metamask/keyring-snap-client"]);
   keyring_snap_sdk(["@metamask/keyring-snap-sdk"]);
   keyring_utils(["@metamask/keyring-utils"]);
+  snap_simple_keyring_site(["@metamask/snap-simple-keyring-site"]);
+  snap_simple_keyring_snap(["@metamask/snap-simple-keyring-snap"]);
   account_api --> keyring_api;
   account_api --> keyring_utils;
   keyring_api --> keyring_utils;
@@ -107,6 +111,10 @@ linkStyle default opacity:0.5
   keyring_snap_client --> keyring_utils;
   keyring_snap_sdk --> keyring_utils;
   keyring_snap_sdk --> keyring_api;
+  snap_simple_keyring_site --> keyring_api;
+  snap_simple_keyring_site --> keyring_snap_client;
+  snap_simple_keyring_snap --> keyring_api;
+  snap_simple_keyring_snap --> keyring_snap_sdk;
 ```
 
 <!-- end dependency graph -->

eslint.config.mjs

@@ -16,6 +16,9 @@ const config = createConfig([
       '**/dist/**',
       '**/docs/**',
       '**/coverage/**',
+      // Snap packages use older tooling (ESLint v8, different configs).
+      // Linting will be aligned in a follow-up.
+      'packages/snaps/**',
     ],
   },
 

package.json

@@ -8,12 +8,16 @@
     "url": "https://github.com/MetaMask/accounts.git"
   },
   "workspaces": [
+    "packages/snaps/*/packages/*",
+    "packages/snaps/*",
     "packages/*"
   ],
   "files": [],
   "scripts": {
     "build": "ts-bridge --project tsconfig.build.json",
     "build:clean": "yarn build --clean",
+    "build:snaps": "yarn build:snaps:deps && yarn workspaces foreach --all --include '@metamask/snap-simple-keyring' --parallel --verbose run build",
+    "build:snaps:deps": "yarn workspaces foreach --all --include '@metamask/keyring-utils' --include '@metamask/keyring-api' --include '@metamask/keyring-snap-sdk' --include '@metamask/keyring-snap-client' --topological --verbose run build",
     "build:docs": "yarn foreach build:docs",
     "build:only-clean": "rimraf -g 'packages/*/dist'",
     "build:types": "tsc --build tsconfig.build.json --verbose",
@@ -24,7 +28,7 @@
     "lint:dependencies:fix": "yarn foreach depcheck && yarn dedupe",
     "lint:eslint": "yarn build:only-clean && yarn eslint",
     "lint:fix": "yarn lint:eslint --fix --prune-suppressions && yarn lint:misc --write && yarn constraints --fix && yarn lint:dependencies:fix",
-    "lint:misc": "oxfmt --ignore-path .gitignore",
+    "lint:misc": "oxfmt --ignore-path .gitignore --ignore-path .prettierignore",
     "lint:misc:check": "yarn lint:misc --check",
     "lint:readme": "yarn readme:update",
     "prepare:preview": "ts-node --project tsconfig.scripts.json scripts/prepare-preview-builds.ts",

packages/snaps/simple-keyring/.depcheckrc.json

@@ -0,0 +1,3 @@
+{
+  "ignore-patterns": [".yarn/"]
+}

packages/snaps/simple-keyring/.eslintrc.js

@@ -0,0 +1,44 @@
+module.exports = {
+  root: true,
+
+  extends: ['@metamask/eslint-config'],
+
+  overrides: [
+    {
+      files: ['*.ts', '*.tsx'],
+      extends: ['@metamask/eslint-config-typescript'],
+      rules: {
+        // This prevents using Node.js and/or browser specific globals. We
+        // currently use both in our codebase, so this rule is disabled.
+        'no-restricted-globals': 'off',
+        'spaced-comment': ['error', 'always', { markers: ['/'] }],
+      },
+    },
+
+    {
+      files: ['*.js', '*.jsx', '*.cjs'],
+      extends: ['@metamask/eslint-config-nodejs'],
+    },
+
+    {
+      files: ['*.test.ts', '*.test.js'],
+      extends: [
+        '@metamask/eslint-config-jest',
+        '@metamask/eslint-config-nodejs',
+      ],
+    },
+  ],
+
+  rules: {
+    // This is necessary to run eslint on Windows and not get a thousand CRLF errors
+    'prettier/prettier': ['error', { endOfLine: 'auto' }],
+  },
+
+  ignorePatterns: [
+    '!.eslintrc.js',
+    '!.prettierrc.js',
+    'dist/',
+    'docs/',
+    '.yarn/',
+  ],
+};

packages/snaps/simple-keyring/.gitignore

@@ -0,0 +1,86 @@
+.DS_Store
+dist/
+build/
+coverage/
+
+# We have to ignore files in the root .gitignore file because it's also used by
+# prettier, which doesn't support nested .gitignore files.
+/packages/site/.cache/
+/packages/site/public/
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v3 (w/o zero-install)
+# See: https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# IntelliJ
+.idea/

packages/snaps/simple-keyring/.prettierrc.js

@@ -0,0 +1,9 @@
+// All of these are defaults except singleQuote, but we specify them
+// for explicitness
+module.exports = {
+  endOfLine: 'auto',
+  quoteProps: 'as-needed',
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'all',
+};

packages/snaps/simple-keyring/.yarn/patches/@noble-hashes-npm-1.7.1-4106ab26c5.patch

@@ -0,0 +1,27 @@
+diff --git a/esm/cryptoNode.js b/esm/cryptoNode.js
+index 4f77e8f46c5e242e1e3cb92712dc65e95a8b8eb0..acd05d884061e18adf27d33ba4a1c55e9cc85e7f 100644
+--- a/esm/cryptoNode.js
++++ b/esm/cryptoNode.js
+@@ -7,9 +7,19 @@
+  */
+ // @ts-ignore
+ import * as nc from 'node:crypto';
+-export const crypto = nc && typeof nc === 'object' && 'webcrypto' in nc
+-    ? nc.webcrypto
+-    : nc && typeof nc === 'object' && 'randomBytes' in nc
++// It seems `webpack` is not able to resolve `nc.webcrypto` at build time. Probably because
++// we use `crypto-browserify` under the hood, and this package does not expose `webcrypto`.
++// While this work when using `require` imports, it seems to fail with ESM exports (at least
++// in this case).
++// export const crypto = nc && typeof nc === 'object' && 'webcrypto' in nc
++//     ? nc.webcrypto
++//     : nc && typeof nc === 'object' && 'randomBytes' in nc
++//         ? nc
++//         : undefined;
++
++// We just fallback to the "normal crypto" object to workaround this.
++export const crypto =
++    nc && typeof nc === 'object' && 'randomBytes' in nc
+         ? nc
+         : undefined;
+ //# sourceMappingURL=cryptoNode.js.map