m/metamask-extension
1
0
Fork 0
mirror of https://github.com/kremalicious/metamask-extension.git synced 2024-12-23 09:52:26 +01:00
Code
🦊 Minimalized version of MetaMask for my own personal use.
13,096 Commits 2 Branches 0 Tags 265 MiB
JavaScript 83.4%
TypeScript 12.8%
SCSS 3.5%
Shell 0.2%
HTML 0.1%
9d70c60c22
Go to file
Dan J Miller 9d70c60c22
Connect Ledger via WebHID (#12411) 
* Connect ledger via webhid if that option is available

* Explicitly setting preference for webhid

* Use ledgerTransportType enum instead of booleans for ledger live and webhid preferences

* Use single setLEdgerTransport preference methods and property

* Temp

* Lint fix

* Unit test fix

* Remove async keyword from setLedgerTransportPreference function definition in preferences controller

* Fix ledgelive setting toggle logic

* Migrate useLedgerLive preference property to ledgerTransportType

* Use shared constants for ledger transport type enums

* Use constant for ledger usb vendor id

* Use correct property to check if ledgerLive preference is set when deciding whether to ask for webhid connection

* Update eth-ledger-bridge-keyring to v0.9.0

* Only show ledger live transaction helper messages if using ledger live

* Only show ledger live part of tutorial if ledger live setting is on

* Fix ledger related prop type errors

* Explicitly use u2f enum instead of empty string as a transport type; default transport type to webhid if available; use constants for u2f and webhid

* Cleanup

* Wrap ledger webhid device request in try/catch

* Clean up

* Lint fix

* Ensure user can easily connect their ledger wallet when they need to.

* Fix locales

* Fix/improve locales changes

* Remove unused isFirefox property from confirm-transaction-base.container.js

* Disable transaction and message signing confirmation if ledger webhid requires connection

* Ensure translation keys for ledger connection options in settings dropdown can be properly detected by verify-locales

* Drop .component from ledger-instruction-field file name

* Move renderLedgerLiveStep to module scope

* Remove ledgerLive from function and message names in ledger-instruction-field

* Wrap ledger connection logic in ledger-instruction-field in try catch

* Clean up signature-request.component.js

* Check whether the signing address, and not the selected address, is a ledger account in singature-request.container

* Ensure ledger instructions and webhid connection button are shown on signature-request-original signatures

* Improve webhid selection handling in select-ledger-transport-type onChange handler

* Move metamask redux focused ledger selectors to metamask duck

* Lint fix

* Use async await in checkWebHidStatusRef.current

* Remove unnecessary use of ref in ledger-instruction-field.js

* Lint fix

* Remove unnecessary try/catch in ledger-instruction-field.js

* Check if from address, not selected address, is from a ledger account in confirm-approve

* Move findKeyringForAddress to metamask duck

* Fix typo in function name

* Ensure isEqualCaseInsensitive handles possible differences in address casing

* Fix Learn More link size in advanced settings tab

* Update app/scripts/migrations/066.js

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

* Update ui/pages/settings/advanced-tab/advanced-tab.component.test.js

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

* Add jsdoc comments for new selectors

* Use jest.spyOn for mocking navigator in ledger webhid migration tests

* Use LEDGER_TRANSPORT_TYPES values to set proptype of ledgerTransportType

* Use LEDGER_TRANSPORT_TYPES values to set proptype of ledgerTransportType

* Fix font size of link in ledger connection description in advanced settings

* Fix return type in setLedgerTransportPreference comment

* Clean up connectHardware code for webhid connection in actions.js

* Update app/scripts/migrations/066.test.js

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

* Update ui/ducks/metamask/metamask.js

Co-authored-by: Mark Stacey <markjstacey@gmail.com>

* Add migration test for when useLedgerLive is true in a browser that supports webhid

* Lint fix

* Fix inline-link size

Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-10-21 16:47:03 -02:30
.circleci use improved-yarn-audit and exclude 1002401 and 1002581 (#12310) 2021-10-08 12:18:38 -05:00
.github Update bug-report.md (#12368) 2021-10-18 10:34:04 -07:00
.storybook Add send-hex-data-row to Storybook (#12085) 2021-10-15 09:32:13 -02:30
app Connect Ledger via WebHID (#12411) 2021-10-21 16:47:03 -02:30
development Fix 12265 - Update onboarding welcome screen (#12275) 2021-10-13 09:22:51 -05:00
docs Fix URL (#11832) 2021-08-13 09:13:10 -07:00
lavamoat Migrate beta version to the main version field (#12246) 2021-10-06 15:14:48 -02:30
patches Update immer from v8 to v9 (#12303) 2021-10-08 11:50:07 -02:30
shared Connect Ledger via WebHID (#12411) 2021-10-21 16:47:03 -02:30
test Fixing address truncation papercuts (#12330) 2021-10-13 12:54:48 -05:00
ui Connect Ledger via WebHID (#12411) 2021-10-21 16:47:03 -02:30
.depcheckrc.yml use improved-yarn-audit and exclude 1002401 and 1002581 (#12310) 2021-10-08 12:18:38 -05:00
.editorconfig Clean EditorConfig file 2019-05-23 07:17:42 -02:30
.eslintrc.js Avoid storybook-build directory when linting (#12408) 2021-10-20 07:34:54 -05:00
.gitattributes Use Infura v3 API (#9368) 2020-09-10 13:46:00 -02:30
.gitignore remove the ui/app and ui/lib folders (#10911) 2021-04-28 14:53:59 -05:00
.metamaskrc.dist Fix case of password env variable (#12120) 2021-09-21 23:27:24 +05:30
.mocharc.js Normalize extension verison to SemVer (#12254) 2021-10-14 18:50:14 -02:30
.mocharc.lax.js Simplify Mocha npm scripts (#12313) 2021-10-12 10:10:33 -02:30
.nvmrc Update to Node v14 (#9514) 2021-02-03 13:45:38 +08:00
.prettierignore Add jest-coverage/ to prettierignore (#10865) 2021-04-09 11:16:19 -07:00
.prettierrc.yml @metamask/eslint config@5.0.0 (#10358) 2021-02-04 10:15:23 -08:00
.yarnrc Add .yarnrc to disable scripts (#10354) 2021-02-03 21:53:12 -03:30
babel.config.js Bump minimum Chrome version to 66 (#11995) 2021-09-01 13:19:03 -07:00
CHANGELOG.md Add missing changelog entries for v9.8.0 (#11509) 2021-10-15 12:17:28 -02:30
jest.config.js Normalize extension verison to SemVer (#12254) 2021-10-14 18:50:14 -02:30
jsconfig.json fix jsconfig woes (#11253) 2021-06-09 12:26:16 -05:00
LICENSE Add new license (#9282) 2020-08-20 16:01:22 -07:00
nyc.config.js @metamask/eslint config@5.0.0 (#10358) 2021-02-04 10:15:23 -08:00
package.json Connect Ledger via WebHID (#12411) 2021-10-21 16:47:03 -02:30
README.md Removing unneeded build sections from README.md (#12414) 2021-10-20 06:17:54 -07:00
stylelint.config.js @metamask/eslint-config*@6.0.0 (#10858) 2021-04-08 14:34:55 -07:00
yarn.lock Connect Ledger via WebHID (#12411) 2021-10-21 16:47:03 -02:30

README.md

MetaMask Browser Extension

Hey! We are hiring JavaScript Engineers! Apply here!

You can find the latest version of MetaMask on our official website. For help using MetaMask, visit our User Support Site.

For general questions, feature requests, or developer questions, visit our Community Forum.

MetaMask supports Firefox, Google Chrome, and Chromium-based browsers. We recommend using the latest available browser version.

For up to the minute news, follow our Twitter or Medium pages.

To learn how to develop MetaMask-compatible applications, visit our Developer Docs.

To learn how to contribute to the MetaMask project itself, visit our Internal Docs.

Building locally

  • Install Node.js version 14
    • If you are using nvm (recommended) running nvm use will automatically choose the right node version for you.
  • Install Yarn
  • Install dependencies: yarn setup (not the usual install command)
  • Copy the .metamaskrc.dist file to .metamaskrc
    • Replace the INFURA_PROJECT_ID value with your own personal Infura Project ID.
    • If debugging MetaMetrics, you'll need to add a value for SEGMENT_WRITE_KEY Segment write key.
  • Build the project to the ./dist/ folder with yarn dist.

Uncompressed builds can be found in /dist, compressed builds can be found in /builds once they're built.

See the build system readme for build system usage information.

Contributing

Development builds

To start a development build (e.g. with logging and file watching) run yarn start.

To start the React DevTools and Redux DevTools Extension alongside the app, use yarn start:dev.

  • React DevTools will open in a separate window; no browser extension is required
  • Redux DevTools will need to be installed as a browser extension. Open the Redux Remote Devtools to access Redux state logs. This can be done by either right clicking within the web browser to bring up the context menu, expanding the Redux DevTools panel and clicking Open Remote DevTools OR clicking the Redux DevTools extension icon and clicking Open Remote DevTools.
    • You will also need to check the "Use custom (local) server" checkbox in the Remote DevTools Settings, using the default server configuration (host localhost, port 8000, secure connection checkbox unchecked)

Test site can be used to execute different user flows.

Running Unit Tests and Linting

Run unit tests and the linter with yarn test. To run just unit tests, run yarn test:unit.

You can run the linter by itself with yarn lint, and you can automatically fix some lint problems with yarn lint:fix. You can also run these two commands just on your local changes to save time with yarn lint:changed and yarn lint:changed:fix respectively.

Running E2E Tests

Our e2e test suite can be run on either Firefox or Chrome. In either case, start by creating a test build by running yarn build:test.

Firefox e2e tests can be run with yarn test:e2e:firefox.

Chrome e2e tests can be run with yarn test:e2e:chrome, but they will only work if you have Chrome v79 installed. Update the chromedriver package to a version matching your local Chrome installation to run e2e tests on newer Chrome versions.

Changing dependencies

Whenever you change dependencies (adding, removing, or updating, either in package.json or yarn.lock), there are various files that must be kept up-to-date.

  • yarn.lock:
    • Run yarn setup again after your changes to ensure yarn.lock has been properly updated.
  • The allow-scripts configuration in package.json
    • Run yarn allow-scripts auto to update the allow-scripts configuration automatically. This config determines whether the package's install/postinstall scripts are allowed to run. Review each new package to determine whether the install script needs to run or not, testing if necessary.
    • Unfortunately, yarn allow-scripts auto will behave inconsistently on different platforms. macOS and Windows users may see extraneous changes relating to optional dependencies.
  • The LavaMoat auto-generated policy in lavamoat/node/policy.json
    • Run yarn lavamoat:auto to re-generate this policy file. Review the changes to determine whether the access granted to each package seems appropriate.
    • Unfortunately, yarn lavamoat:auto will behave inconsistently on different platforms. macOS and Windows users may see extraneous changes relating to optional dependencies.

Architecture

Architecture Diagram

Other Docs