feat: add qr keyring package

README.md

@@ -14,6 +14,7 @@ This repository contains the following packages [^fn1]:
 
 - [`@metamask/eth-hd-keyring`](packages/keyring-eth-hd)
 - [`@metamask/eth-ledger-bridge-keyring`](packages/keyring-eth-ledger-bridge)
+- [`@metamask/eth-qr-keyring`](packages/keyring-eth-qr)
 - [`@metamask/eth-simple-keyring`](packages/keyring-eth-simple)
 - [`@metamask/eth-snap-keyring`](packages/keyring-snap-bridge)
 - [`@metamask/eth-trezor-keyring`](packages/keyring-eth-trezor)
@@ -37,6 +38,7 @@ linkStyle default opacity:0.5
   keyring_api(["@metamask/keyring-api"]);
   eth_hd_keyring(["@metamask/eth-hd-keyring"]);
   eth_ledger_bridge_keyring(["@metamask/eth-ledger-bridge-keyring"]);
+  eth_qr_keyring(["@metamask/eth-qr-keyring"]);
   eth_simple_keyring(["@metamask/eth-simple-keyring"]);
   eth_trezor_keyring(["@metamask/eth-trezor-keyring"]);
   keyring_internal_api(["@metamask/keyring-internal-api"]);
@@ -48,6 +50,7 @@ linkStyle default opacity:0.5
   keyring_api --> keyring_utils;
   eth_hd_keyring --> keyring_utils;
   eth_ledger_bridge_keyring --> keyring_utils;
+  eth_qr_keyring --> keyring_utils;
   eth_simple_keyring --> keyring_utils;
   eth_trezor_keyring --> keyring_utils;
   keyring_internal_api --> keyring_api;

packages/keyring-eth-qr/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/accounts/

packages/keyring-eth-qr/LICENSE

@@ -0,0 +1,15 @@
+ISC License
+
+Copyright (c) 2020 MetaMask
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

packages/keyring-eth-qr/README.md

@@ -0,0 +1 @@
+# QR Keyring

packages/keyring-eth-qr/jest.config.js

@@ -0,0 +1,29 @@
+/*
+ * For a detailed explanation regarding each configuration property and type check, visit:
+ * https://jestjs.io/docs/configuration
+ */
+
+const merge = require('deepmerge');
+const path = require('path');
+
+const baseConfig = require('../../jest.config.packages');
+
+const displayName = path.basename(__dirname);
+
+module.exports = merge(baseConfig, {
+  // The display name when running multiple projects
+  displayName,
+
+  // An array of regexp pattern strings used to skip coverage collection
+  coveragePathIgnorePatterns: [],
+
+  // An object that configures minimum threshold enforcement for coverage results
+  coverageThreshold: {
+    global: {
+      branches: 100,
+      functions: 100,
+      lines: 100,
+      statements: 100,
+    },
+  },
+});

packages/keyring-eth-qr/package.json

@@ -0,0 +1,96 @@
+{
+  "name": "@metamask/eth-qr-keyring",
+  "version": "0.0.0",
+  "description": "A simple standard interface for a series of Ethereum private keys.",
+  "keywords": [
+    "ethereum",
+    "keyring",
+    "qr",
+    "metamask"
+  ],
+  "homepage": "https://github.com/MetaMask/accounts/packages/keyring-eth-qr#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/accounts/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/accounts.git"
+  },
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.mts",
+        "default": "./dist/index.mjs"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "main": "./dist/index.cjs",
+  "types": "./dist/index.d.cts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build": "tsc --build tsconfig.build.json",
+    "build:clean": "rimraf dist && yarn build",
+    "build:docs": "typedoc",
+    "build:force": "tsc --build tsconfig.build.json --force",
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/eth-qr-keyring",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/eth-qr-keyring",
+    "publish:preview": "yarn npm publish --tag preview",
+    "sample": "ts-node src/sample.ts",
+    "test": "jest",
+    "test:clean": "jest --clearCache",
+    "test:verbose": "jest --verbose",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@ethereumjs/rlp": "^5.0.2",
+    "@ethereumjs/tx": "^5.4.0",
+    "@ethereumjs/util": "^9.1.0",
+    "@keystonehq/bc-ur-registry-eth": "^0.19.1",
+    "@metamask/eth-sig-util": "^8.2.0",
+    "@metamask/keyring-utils": "workspace:^",
+    "@metamask/utils": "^11.1.0",
+    "hdkey": "^2.1.0",
+    "uuid": "^9.0.1"
+  },
+  "devDependencies": {
+    "@ethereumjs/common": "^4.4.0",
+    "@keystonehq/metamask-airgapped-keyring": "^0.15.2",
+    "@lavamoat/allow-scripts": "^3.2.1",
+    "@metamask/auto-changelog": "^3.4.4",
+    "@types/hdkey": "^2.0.1",
+    "@types/jest": "^29.5.12",
+    "@types/node": "^20.12.12",
+    "deepmerge": "^4.2.2",
+    "depcheck": "^1.4.7",
+    "jest": "^29.5.0",
+    "ts-jest": "^29.0.5",
+    "ts-node": "^10.9.2",
+    "typedoc": "^0.25.13",
+    "typescript": "~5.6.3"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "lavamoat": {
+    "allowScripts": {
+      "keccak": true,
+      "secp256k1": true,
+      "@lavamoat/preinstall-always-fail": false,
+      "ethereumjs-tx>ethereumjs-util>ethereum-cryptography>keccak": false,
+      "ethereumjs-tx>ethereumjs-util>ethereum-cryptography>secp256k1": false,
+      "@keystonehq/ur-decoder>@keystonehq/bc-ur-registry-eth>ethereumjs-util>ethereum-cryptography>keccak": false,
+      "@lavamoat/allow-scripts>@lavamoat/preinstall-always-fail": false,
+      "hdkey>secp256k1": false
+    }
+  }
+}