2021-02-04 19:15:23 +01:00
import EventEmitter from 'events' ;
import pump from 'pump' ;
import { ObservableStore } from '@metamask/obs-store' ;
import { storeAsStream } from '@metamask/obs-store/dist/asStream' ;
import { JsonRpcEngine } from 'json-rpc-engine' ;
import { debounce } from 'lodash' ;
import createEngineStream from 'json-rpc-middleware-stream/engineStream' ;
import createFilterMiddleware from 'eth-json-rpc-filters' ;
import createSubscriptionManager from 'eth-json-rpc-filters/subscriptionManager' ;
2021-11-11 21:26:49 +01:00
import { providerAsMiddleware } from 'eth-json-rpc-middleware' ;
2021-02-04 19:15:23 +01:00
import KeyringController from 'eth-keyring-controller' ;
2022-03-10 18:55:25 +01:00
import {
errorCodes as rpcErrorCodes ,
EthereumRpcError ,
ethErrors ,
} from 'eth-rpc-errors' ;
2021-02-04 19:15:23 +01:00
import { Mutex } from 'await-semaphore' ;
2021-05-17 23:19:39 +02:00
import { stripHexPrefix } from 'ethereumjs-util' ;
2021-02-04 19:15:23 +01:00
import log from 'loglevel' ;
import TrezorKeyring from 'eth-trezor-keyring' ;
import LedgerBridgeKeyring from '@metamask/eth-ledger-bridge-keyring' ;
2021-11-08 15:48:41 +01:00
import LatticeKeyring from 'eth-lattice-keyring' ;
2021-11-23 18:28:39 +01:00
import { MetaMaskKeyring as QRHardwareKeyring } from '@keystonehq/metamask-airgapped-keyring' ;
2021-02-04 19:15:23 +01:00
import EthQuery from 'eth-query' ;
import nanoid from 'nanoid' ;
2021-11-11 04:27:04 +01:00
import { captureException } from '@sentry/browser' ;
2020-08-18 21:18:25 +02:00
import {
AddressBookController ,
2020-12-14 17:04:26 +01:00
ApprovalController ,
2021-05-20 04:57:51 +02:00
ControllerMessenger ,
2020-08-18 21:18:25 +02:00
CurrencyRateController ,
PhishingController ,
2022-04-27 10:36:32 +02:00
AnnouncementController ,
2021-07-08 22:23:00 +02:00
GasFeeController ,
2021-07-16 01:08:16 +02:00
TokenListController ,
2021-09-10 19:37:19 +02:00
TokensController ,
2021-09-15 21:02:28 +02:00
TokenRatesController ,
2021-11-19 17:16:41 +01:00
CollectiblesController ,
AssetsContractController ,
CollectibleDetectionController ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
PermissionController ,
SubjectMetadataController ,
2022-03-17 17:43:18 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
RateLimitController ,
///: END:ONLY_INCLUDE_IN
2022-03-10 00:37:40 +01:00
} from '@metamask/controllers' ;
import SmartTransactionsController from '@metamask/smart-transactions-controller' ;
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
2022-05-11 08:08:42 +02:00
import {
SnapController ,
IframeExecutionService ,
} from '@metamask/snap-controllers' ;
2022-02-15 01:02:51 +01:00
///: END:ONLY_INCLUDE_IN
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
2022-01-10 17:23:53 +01:00
import {
TRANSACTION _STATUSES ,
TRANSACTION _TYPES ,
} from '../../shared/constants/transaction' ;
2021-09-08 19:26:37 +02:00
import {
GAS _API _BASE _URL ,
GAS _DEV _API _BASE _URL ,
2021-09-29 15:11:19 +02:00
SWAPS _CLIENT _ID ,
2021-09-08 19:26:37 +02:00
} from '../../shared/constants/swaps' ;
2021-12-02 00:46:26 +01:00
import { MAINNET _CHAIN _ID } from '../../shared/constants/network' ;
2021-11-23 18:28:39 +01:00
import {
DEVICE _NAMES ,
KEYRING _TYPES ,
} from '../../shared/constants/hardware-wallets' ;
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
import {
CaveatTypes ,
RestrictedMethods ,
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
EndowmentPermissions ,
///: END:ONLY_INCLUDE_IN
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
} from '../../shared/constants/permissions' ;
2021-04-28 18:51:41 +02:00
import { UI _NOTIFICATIONS } from '../../shared/notifications' ;
2021-05-17 23:19:39 +02:00
import { toChecksumHexAddress } from '../../shared/modules/hexstring-utils' ;
2021-06-10 21:27:03 +02:00
import { MILLISECOND } from '../../shared/constants/time' ;
2021-12-09 00:37:29 +01:00
import {
2022-04-26 19:07:39 +02:00
ORIGIN _METAMASK ,
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
MESSAGE _TYPE ,
///: END:ONLY_INCLUDE_IN
2021-12-09 00:37:29 +01:00
POLLING _TOKEN _ENVIRONMENT _TYPES ,
SUBJECT _TYPES ,
} from '../../shared/constants/app' ;
2022-04-22 18:09:10 +02:00
import { EVENT } from '../../shared/constants/metametrics' ;
2021-04-28 18:51:41 +02:00
2021-07-16 01:08:16 +02:00
import { hexToDecimal } from '../../ui/helpers/utils/conversions.util' ;
2022-01-10 17:23:53 +01:00
import { getTokenValueParam } from '../../ui/helpers/utils/token-util' ;
2022-03-07 19:54:36 +01:00
import { isEqualCaseInsensitive } from '../../shared/modules/string-utils' ;
2022-03-17 19:35:40 +01:00
import { parseStandardTokenTransactionData } from '../../shared/modules/transaction.utils' ;
2022-04-27 20:14:10 +02:00
import {
onMessageReceived ,
checkForMultipleVersionsRunning ,
} from './detect-multiple-instances' ;
2021-02-04 19:15:23 +01:00
import ComposableObservableStore from './lib/ComposableObservableStore' ;
import AccountTracker from './lib/account-tracker' ;
import createLoggerMiddleware from './lib/createLoggerMiddleware' ;
2022-02-15 01:02:51 +01:00
import {
createMethodMiddleware ,
///: BEGIN:ONLY_INCLUDE_IN(flask)
createSnapMethodMiddleware ,
///: END:ONLY_INCLUDE_IN
} from './lib/rpc-method-middleware' ;
2021-02-04 19:15:23 +01:00
import createOriginMiddleware from './lib/createOriginMiddleware' ;
import createTabIdMiddleware from './lib/createTabIdMiddleware' ;
import createOnboardingMiddleware from './lib/createOnboardingMiddleware' ;
import { setupMultiplex } from './lib/stream-utils' ;
import EnsController from './controllers/ens' ;
2021-02-09 00:22:30 +01:00
import NetworkController , { NETWORK _EVENTS } from './controllers/network' ;
2021-02-04 19:15:23 +01:00
import PreferencesController from './controllers/preferences' ;
import AppStateController from './controllers/app-state' ;
import CachedBalancesController from './controllers/cached-balances' ;
import AlertController from './controllers/alert' ;
import OnboardingController from './controllers/onboarding' ;
import ThreeBoxController from './controllers/threebox' ;
import IncomingTransactionsController from './controllers/incoming-transactions' ;
2021-11-19 17:05:24 +01:00
import MessageManager , { normalizeMsgData } from './lib/message-manager' ;
2021-02-04 19:15:23 +01:00
import DecryptMessageManager from './lib/decrypt-message-manager' ;
import EncryptionPublicKeyManager from './lib/encryption-public-key-manager' ;
import PersonalMessageManager from './lib/personal-message-manager' ;
import TypedMessageManager from './lib/typed-message-manager' ;
import TransactionController from './controllers/transactions' ;
import DetectTokensController from './controllers/detect-tokens' ;
import SwapsController from './controllers/swaps' ;
import accountImporter from './account-import-strategies' ;
import seedPhraseVerifier from './lib/seed-phrase-verifier' ;
import MetaMetricsController from './controllers/metametrics' ;
2021-04-26 18:05:43 +02:00
import { segment } from './lib/segment' ;
2021-03-18 19:23:46 +01:00
import createMetaRPCHandler from './lib/createMetaRPCHandler' ;
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
import {
CaveatMutatorFactories ,
getCaveatSpecifications ,
getChangedAccounts ,
getPermissionBackgroundApiMethods ,
getPermissionSpecifications ,
getPermittedAccountsByOrigin ,
2021-12-08 11:37:35 +01:00
NOTIFICATION _NAMES ,
2022-02-15 01:02:51 +01:00
PermissionLogController ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
unrestrictedMethods ,
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
buildSnapEndowmentSpecifications ,
buildSnapRestrictedMethodSpecifications ,
///: END:ONLY_INCLUDE_IN
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
} from './controllers/permissions' ;
2022-04-04 21:26:13 +02:00
import createRPCMethodTrackingMiddleware from './lib/createRPCMethodTrackingMiddleware' ;
2016-11-22 01:46:26 +01:00
2021-02-09 00:22:30 +01:00
export const METAMASK _CONTROLLER _EVENTS = {
// Fired after state changes that impact the extension badge (unapproved msg count)
// The process of updating the badge happens in app/scripts/background.js.
UPDATE _BADGE : 'updateBadge' ,
2021-08-31 21:27:13 +02:00
// TODO: Add this and similar enums to @metamask/controllers and export them
APPROVAL _STATE _CHANGE : 'ApprovalController:stateChange' ,
2021-02-09 00:22:30 +01:00
} ;
2020-01-09 04:34:58 +01:00
export default class MetamaskController extends EventEmitter {
2018-03-15 23:27:10 +01:00
/ * *
2018-03-28 03:07:51 +02:00
* @ param { Object } opts
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
constructor ( opts ) {
2021-02-04 19:15:23 +01:00
super ( ) ;
2017-06-16 03:00:24 +02:00
2021-02-04 19:15:23 +01:00
this . defaultMaxListeners = 20 ;
2018-01-25 21:28:11 +01:00
2021-06-10 21:27:03 +02:00
this . sendUpdate = debounce (
this . privateSendUpdate . bind ( this ) ,
MILLISECOND * 200 ,
) ;
2021-02-04 19:15:23 +01:00
this . opts = opts ;
2022-03-18 20:07:05 +01:00
this . extension = opts . browser ;
2021-02-04 19:15:23 +01:00
this . platform = opts . platform ;
2022-01-05 18:09:19 +01:00
this . notificationManager = opts . notificationManager ;
2021-02-04 19:15:23 +01:00
const initState = opts . initState || { } ;
const version = this . platform . getVersion ( ) ;
this . recordFirstTimeInfo ( initState ) ;
2017-01-12 04:04:19 +01:00
2018-08-22 01:30:11 +02:00
// this keeps track of how many "controllerStream" connections are open
// the only thing that uses controller connections are open metamask UI instances
2021-02-04 19:15:23 +01:00
this . activeControllerConnections = 0 ;
2018-08-22 01:30:11 +02:00
2021-02-04 19:15:23 +01:00
this . getRequestAccountTabIds = opts . getRequestAccountTabIds ;
this . getOpenMetamaskTabsIds = opts . getOpenMetamaskTabsIds ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
2021-08-31 21:27:13 +02:00
this . controllerMessenger = new ControllerMessenger ( ) ;
2021-05-20 04:57:51 +02:00
2017-01-12 04:04:19 +01:00
// observable state store
2021-05-20 04:57:51 +02:00
this . store = new ComposableObservableStore ( {
state : initState ,
2021-08-31 21:27:13 +02:00
controllerMessenger : this . controllerMessenger ,
2021-09-06 04:33:37 +02:00
persist : true ,
2021-05-20 04:57:51 +02:00
} ) ;
2017-01-28 01:11:59 +01:00
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
// external connections by origin
// Do not modify directly. Use the associated methods.
2021-02-04 19:15:23 +01:00
this . connections = { } ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
2017-11-20 22:47:35 +01:00
// lock to ensure only one vault created at once
2021-02-04 19:15:23 +01:00
this . createVaultMutex = new Mutex ( ) ;
2017-11-20 22:47:35 +01:00
2020-10-06 20:28:38 +02:00
this . extension . runtime . onInstalled . addListener ( ( details ) => {
if ( details . reason === 'update' && version === '8.1.0' ) {
2021-02-04 19:15:23 +01:00
this . platform . openExtensionInBrowser ( ) ;
2020-10-06 20:28:38 +02:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2020-10-06 20:28:38 +02:00
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
// next, we will initialize the controllers
2020-05-27 19:57:42 +02:00
// controller initialization order matters
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
2020-12-14 17:04:26 +01:00
this . approvalController = new ApprovalController ( {
2021-08-31 21:27:13 +02:00
messenger : this . controllerMessenger . getRestricted ( {
name : 'ApprovalController' ,
} ) ,
2020-12-14 17:04:26 +01:00
showApprovalRequest : opts . showUserConfirmation ,
2021-02-04 19:15:23 +01:00
} ) ;
2020-12-14 17:04:26 +01:00
2021-02-04 19:15:23 +01:00
this . networkController = new NetworkController ( initState . NetworkController ) ;
this . networkController . setInfuraProjectId ( opts . infuraProjectId ) ;
2017-06-22 21:32:08 +02:00
2021-06-22 19:39:44 +02:00
// now we can initialize the RPC provider, which other controllers require
this . initializeProvider ( ) ;
this . provider = this . networkController . getProviderAndBlockTracker ( ) . provider ;
this . blockTracker = this . networkController . getProviderAndBlockTracker ( ) . blockTracker ;
2017-01-30 22:01:07 +01:00
this . preferencesController = new PreferencesController ( {
initState : initState . PreferencesController ,
2018-03-22 16:09:16 +01:00
initLangCode : opts . initLangCode ,
2018-09-27 20:19:09 +02:00
openPopup : opts . openPopup ,
2018-07-27 00:04:34 +02:00
network : this . networkController ,
2021-06-22 19:39:44 +02:00
provider : this . provider ,
Update address book state upon custom RPC chainId edit (#9493)
When the `chainId` for a custom RPC endpoint is edited, we now migrate
the corresponding address book entries to ensure they are not orphaned.
The address book entries are grouped by the `metamask.network` state,
which unfortunately was sometimes the `chainId`, and sometimes the
`networkId`. It was always the `networkId` for built-in Infura
networks, but for custom RPC endpoints it would be set to the user-set
`chainId` field, with a fallback to the `networkId` of the network.
A recent change will force users to enter valid `chainId`s on all
custom networks, which will be normalized to be hex-prefixed. As a
result, address book contacts will now be keyed by a different string.
The contact entries are now migrated when this edit takes place.
There are some edge cases where two separate entries share the same set
of contacts. For example, if two entries have the same `chainId`, or if
they had the same `networkId` and had no `chainId` set. When the
`chainId` is edited in such cases, the contacts are duplicated on both
networks. This is the best we can do, as we don't have any way to know
which network the contacts _should_ be on.
The `typed-message-manager` unit tests have also been updated as part
of this commit because the addition of `sinon.restore()` to the
preferences controller tests ended up clearing a test object in-between
individual tests in that file. The test object is now re-constructed
before each individual test.
2020-10-07 19:32:17 +02:00
migrateAddressBookState : this . migrateAddressBookState . bind ( this ) ,
2021-02-04 19:15:23 +01:00
} ) ;
2017-01-30 21:42:24 +01:00
2021-09-10 19:37:19 +02:00
this . tokensController = new TokensController ( {
onPreferencesStateChange : this . preferencesController . store . subscribe . bind (
this . preferencesController . store ,
) ,
onNetworkStateChange : this . networkController . store . subscribe . bind (
this . networkController . store ,
) ,
config : { provider : this . provider } ,
state : initState . TokensController ,
} ) ;
2022-04-13 18:23:41 +02:00
process . env . TOKEN _DETECTION _V2
? ( this . assetsContractController = new AssetsContractController ( {
onPreferencesStateChange : ( listener ) =>
this . preferencesController . store . subscribe ( listener ) ,
onNetworkStateChange : ( cb ) =>
this . networkController . store . subscribe ( ( networkState ) => {
const modifiedNetworkState = {
... networkState ,
provider : {
... networkState . provider ,
chainId : hexToDecimal ( networkState . provider . chainId ) ,
} ,
} ;
return cb ( modifiedNetworkState ) ;
} ) ,
config : {
provider : this . provider ,
} ,
state : initState . AssetsContractController ,
} ) )
: ( this . assetsContractController = new AssetsContractController (
{
onPreferencesStateChange : ( listener ) =>
this . preferencesController . store . subscribe ( listener ) ,
} ,
{
provider : this . provider ,
} ,
) ) ;
2021-11-19 17:16:41 +01:00
2021-12-14 00:41:10 +01:00
this . collectiblesController = new CollectiblesController (
{
onPreferencesStateChange : this . preferencesController . store . subscribe . bind (
this . preferencesController . store ,
) ,
onNetworkStateChange : this . networkController . store . subscribe . bind (
this . networkController . store ,
) ,
2022-01-19 15:38:33 +01:00
getERC721AssetName : this . assetsContractController . getERC721AssetName . bind (
2021-12-14 00:41:10 +01:00
this . assetsContractController ,
) ,
2022-01-19 15:38:33 +01:00
getERC721AssetSymbol : this . assetsContractController . getERC721AssetSymbol . bind (
2021-12-14 00:41:10 +01:00
this . assetsContractController ,
) ,
2022-01-19 15:38:33 +01:00
getERC721TokenURI : this . assetsContractController . getERC721TokenURI . bind (
2021-12-14 00:41:10 +01:00
this . assetsContractController ,
) ,
2022-01-19 15:38:33 +01:00
getERC721OwnerOf : this . assetsContractController . getERC721OwnerOf . bind (
2021-12-14 00:41:10 +01:00
this . assetsContractController ,
) ,
2022-01-19 15:38:33 +01:00
getERC1155BalanceOf : this . assetsContractController . getERC1155BalanceOf . bind (
2021-12-14 00:41:10 +01:00
this . assetsContractController ,
) ,
2022-01-19 15:38:33 +01:00
getERC1155TokenURI : this . assetsContractController . getERC1155TokenURI . bind (
2021-12-14 00:41:10 +01:00
this . assetsContractController ,
) ,
} ,
{ } ,
initState . CollectiblesController ,
) ;
2021-11-19 17:16:41 +01:00
2022-01-20 18:49:49 +01:00
this . collectiblesController . setApiKey ( process . env . OPENSEA _KEY ) ;
2021-11-19 17:16:41 +01:00
process . env . COLLECTIBLES _V1 &&
( this . collectibleDetectionController = new CollectibleDetectionController (
{
onCollectiblesStateChange : ( listener ) =>
this . collectiblesController . subscribe ( listener ) ,
onPreferencesStateChange : this . preferencesController . store . subscribe . bind (
this . preferencesController . store ,
) ,
onNetworkStateChange : this . networkController . store . subscribe . bind (
this . networkController . store ,
) ,
getOpenSeaApiKey : ( ) => this . collectiblesController . openSeaApiKey ,
getBalancesInSingleCall : this . assetsContractController . getBalancesInSingleCall . bind (
this . assetsContractController ,
) ,
addCollectible : this . collectiblesController . addCollectible . bind (
this . collectiblesController ,
) ,
getCollectiblesState : ( ) => this . collectiblesController . state ,
} ,
) ) ;
2020-12-02 22:41:30 +01:00
this . metaMetricsController = new MetaMetricsController ( {
segment ,
preferencesStore : this . preferencesController . store ,
onNetworkDidChange : this . networkController . on . bind (
this . networkController ,
2021-02-09 00:22:30 +01:00
NETWORK _EVENTS . NETWORK _DID _CHANGE ,
2020-12-02 22:41:30 +01:00
) ,
getNetworkIdentifier : this . networkController . getNetworkIdentifier . bind (
this . networkController ,
) ,
getCurrentChainId : this . networkController . getCurrentChainId . bind (
this . networkController ,
) ,
version : this . platform . getVersion ( ) ,
environment : process . env . METAMASK _ENVIRONMENT ,
initState : initState . MetaMetricsController ,
2021-11-11 04:27:04 +01:00
captureException ,
2021-02-04 19:15:23 +01:00
} ) ;
2020-10-08 18:41:23 +02:00
2022-03-28 23:56:56 +02:00
this . on ( 'update' , ( update ) => {
this . metaMetricsController . handleMetaMaskStateUpdate ( update ) ;
} ) ;
2021-08-31 21:27:13 +02:00
const gasFeeMessenger = this . controllerMessenger . getRestricted ( {
2021-07-08 22:23:00 +02:00
name : 'GasFeeController' ,
} ) ;
2021-09-08 19:26:37 +02:00
const gasApiBaseUrl = process . env . SWAPS _USE _DEV _APIS
? GAS _DEV _API _BASE _URL
: GAS _API _BASE _URL ;
2021-07-08 22:23:00 +02:00
this . gasFeeController = new GasFeeController ( {
interval : 10000 ,
messenger : gasFeeMessenger ,
2021-09-29 15:11:19 +02:00
clientId : SWAPS _CLIENT _ID ,
2021-07-08 22:23:00 +02:00
getProvider : ( ) =>
this . networkController . getProviderAndBlockTracker ( ) . provider ,
onNetworkStateChange : this . networkController . on . bind (
this . networkController ,
NETWORK _EVENTS . NETWORK _DID _CHANGE ,
) ,
getCurrentNetworkEIP1559Compatibility : this . networkController . getEIP1559Compatibility . bind (
this . networkController ,
) ,
getCurrentAccountEIP1559Compatibility : this . getCurrentAccountEIP1559Compatibility . bind (
this ,
) ,
2021-09-08 19:26:37 +02:00
legacyAPIEndpoint : ` ${ gasApiBaseUrl } /networks/<chain_id>/gasPrices ` ,
EIP1559APIEndpoint : ` ${ gasApiBaseUrl } /networks/<chain_id>/suggestedGasFees ` ,
2021-07-16 18:06:32 +02:00
getCurrentNetworkLegacyGasAPICompatibility : ( ) => {
const chainId = this . networkController . getCurrentChainId ( ) ;
return process . env . IN _TEST || chainId === MAINNET _CHAIN _ID ;
} ,
getChainId : ( ) => {
return process . env . IN _TEST
? MAINNET _CHAIN _ID
: this . networkController . getCurrentChainId ( ) ;
} ,
2021-07-08 22:23:00 +02:00
} ) ;
2021-11-23 18:28:39 +01:00
this . qrHardwareKeyring = new QRHardwareKeyring ( ) ;
2019-05-13 18:16:09 +02:00
this . appStateController = new AppStateController ( {
2020-03-23 17:25:55 +01:00
addUnlockListener : this . on . bind ( this , 'unlock' ) ,
isUnlocked : this . isUnlocked . bind ( this ) ,
2019-11-26 22:24:53 +01:00
initState : initState . AppStateController ,
2020-03-23 17:25:55 +01:00
onInactiveTimeout : ( ) => this . setLocked ( ) ,
2020-11-16 17:32:53 +01:00
showUnlockRequest : opts . showUserConfirmation ,
2020-03-23 17:25:55 +01:00
preferencesStore : this . preferencesController . store ,
2021-11-23 18:28:39 +01:00
qrHardwareStore : this . qrHardwareKeyring . getMemStore ( ) ,
2021-02-04 19:15:23 +01:00
} ) ;
2019-05-13 18:16:09 +02:00
2021-08-31 21:27:13 +02:00
const currencyRateMessenger = this . controllerMessenger . getRestricted ( {
2021-05-20 04:57:51 +02:00
name : 'CurrencyRateController' ,
} ) ;
this . currencyRateController = new CurrencyRateController ( {
2022-05-05 16:14:06 +02:00
includeUsdRate : true ,
2021-05-20 04:57:51 +02:00
messenger : currencyRateMessenger ,
2022-04-21 21:09:41 +02:00
state : {
... initState . CurrencyController ,
nativeCurrency : this . networkController . providerStore . getState ( ) . ticker ,
} ,
2021-05-20 04:57:51 +02:00
} ) ;
2017-02-03 08:32:24 +01:00
2021-08-31 21:27:13 +02:00
const tokenListMessenger = this . controllerMessenger . getRestricted ( {
2021-07-16 01:08:16 +02:00
name : 'TokenListController' ,
} ) ;
2022-04-13 18:23:41 +02:00
process . env . TOKEN _DETECTION _V2
? ( this . tokenListController = new TokenListController ( {
chainId : hexToDecimal ( this . networkController . getCurrentChainId ( ) ) ,
onNetworkStateChange : ( cb ) =>
this . networkController . store . subscribe ( ( networkState ) => {
const modifiedNetworkState = {
... networkState ,
provider : {
... networkState . provider ,
chainId : hexToDecimal ( networkState . provider . chainId ) ,
} ,
} ;
return cb ( modifiedNetworkState ) ;
} ) ,
messenger : tokenListMessenger ,
state : initState . TokenListController ,
} ) )
: ( this . tokenListController = new TokenListController ( {
chainId : hexToDecimal ( this . networkController . getCurrentChainId ( ) ) ,
useStaticTokenList : ! this . preferencesController . store . getState ( )
. useTokenDetection ,
onNetworkStateChange : ( cb ) =>
this . networkController . store . subscribe ( ( networkState ) => {
const modifiedNetworkState = {
... networkState ,
provider : {
... networkState . provider ,
chainId : hexToDecimal ( networkState . provider . chainId ) ,
} ,
} ;
return cb ( modifiedNetworkState ) ;
} ) ,
onPreferencesStateChange : ( cb ) =>
this . preferencesController . store . subscribe ( ( preferencesState ) => {
const modifiedPreferencesState = {
... preferencesState ,
useStaticTokenList : ! this . preferencesController . store . getState ( )
. useTokenDetection ,
} ;
return cb ( modifiedPreferencesState ) ;
} ) ,
messenger : tokenListMessenger ,
state : initState . TokenListController ,
} ) ) ;
2021-07-16 01:08:16 +02:00
2021-02-04 19:15:23 +01:00
this . phishingController = new PhishingController ( ) ;
2017-06-22 21:32:08 +02:00
2022-04-27 10:36:32 +02:00
this . announcementController = new AnnouncementController (
{ allAnnouncements : UI _NOTIFICATIONS } ,
initState . AnnouncementController ,
2021-04-28 18:51:41 +02:00
) ;
2021-09-15 21:02:28 +02:00
// token exchange rate tracker
2018-04-16 17:21:06 +02:00
this . tokenRatesController = new TokenRatesController ( {
2021-09-15 21:02:28 +02:00
onTokensStateChange : ( listener ) =>
this . tokensController . subscribe ( listener ) ,
onCurrencyRateStateChange : ( listener ) =>
this . controllerMessenger . subscribe (
` ${ this . currencyRateController . name } :stateChange ` ,
listener ,
) ,
onNetworkStateChange : ( cb ) =>
this . networkController . store . subscribe ( ( networkState ) => {
const modifiedNetworkState = {
... networkState ,
provider : {
... networkState . provider ,
chainId : hexToDecimal ( networkState . provider . chainId ) ,
} ,
} ;
return cb ( modifiedNetworkState ) ;
} ) ,
2021-02-04 19:15:23 +01:00
} ) ;
2018-04-16 17:21:06 +02:00
2019-11-01 18:54:00 +01:00
this . ensController = new EnsController ( {
provider : this . provider ,
2021-02-25 12:40:57 +01:00
getCurrentChainId : this . networkController . getCurrentChainId . bind (
this . networkController ,
) ,
onNetworkDidChange : this . networkController . on . bind (
this . networkController ,
NETWORK _EVENTS . NETWORK _DID _CHANGE ,
) ,
2021-02-04 19:15:23 +01:00
} ) ;
2019-11-01 18:54:00 +01:00
2019-08-16 20:54:10 +02:00
this . incomingTransactionsController = new IncomingTransactionsController ( {
blockTracker : this . blockTracker ,
2021-03-19 22:54:30 +01:00
onNetworkDidChange : this . networkController . on . bind (
this . networkController ,
NETWORK _EVENTS . NETWORK _DID _CHANGE ,
) ,
getCurrentChainId : this . networkController . getCurrentChainId . bind (
this . networkController ,
) ,
2019-08-16 20:54:10 +02:00
preferencesController : this . preferencesController ,
initState : initState . IncomingTransactionsController ,
2021-02-04 19:15:23 +01:00
} ) ;
2019-08-16 20:54:10 +02:00
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
// account tracker watches balances, nonces, and any code at their address
2017-09-22 23:16:19 +02:00
this . accountTracker = new AccountTracker ( {
2017-02-03 07:05:06 +01:00
provider : this . provider ,
2017-09-08 06:26:25 +02:00
blockTracker : this . blockTracker ,
2020-11-03 00:41:28 +01:00
getCurrentChainId : this . networkController . getCurrentChainId . bind (
this . networkController ,
) ,
2021-02-04 19:15:23 +01:00
} ) ;
2018-09-28 08:45:16 +02:00
2018-08-22 01:49:24 +02:00
// start and stop polling for balances based on activeControllerConnections
this . on ( 'controllerConnectionChanged' , ( activeControllerConnections ) => {
if ( activeControllerConnections > 0 ) {
2021-02-04 19:15:23 +01:00
this . accountTracker . start ( ) ;
this . incomingTransactionsController . start ( ) ;
2021-05-20 04:57:51 +02:00
this . currencyRateController . start ( ) ;
2021-07-16 01:08:16 +02:00
this . tokenListController . start ( ) ;
2018-08-22 01:49:24 +02:00
} else {
2021-02-04 19:15:23 +01:00
this . accountTracker . stop ( ) ;
this . incomingTransactionsController . stop ( ) ;
2021-05-20 04:57:51 +02:00
this . currencyRateController . stop ( ) ;
2021-07-16 01:08:16 +02:00
this . tokenListController . stop ( ) ;
2018-08-22 01:49:24 +02:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2018-10-26 10:26:43 +02:00
2018-11-30 23:51:24 +01:00
this . cachedBalancesController = new CachedBalancesController ( {
accountTracker : this . accountTracker ,
2021-03-02 23:53:07 +01:00
getCurrentChainId : this . networkController . getCurrentChainId . bind (
2020-11-03 00:41:28 +01:00
this . networkController ,
) ,
2018-11-30 23:51:24 +01:00
initState : initState . CachedBalancesController ,
2021-02-04 19:15:23 +01:00
} ) ;
2018-11-30 23:51:24 +01:00
2019-08-02 05:57:26 +02:00
this . onboardingController = new OnboardingController ( {
initState : initState . OnboardingController ,
2021-02-04 19:15:23 +01:00
} ) ;
2019-08-02 05:57:26 +02:00
2021-09-10 19:37:19 +02:00
this . tokensController . hub . on ( 'pendingSuggestedAsset' , async ( ) => {
await opts . openPopup ( ) ;
} ) ;
2021-11-08 15:48:41 +01:00
const additionalKeyrings = [
TrezorKeyring ,
LedgerBridgeKeyring ,
LatticeKeyring ,
2021-11-23 18:28:39 +01:00
QRHardwareKeyring ,
2021-11-08 15:48:41 +01:00
] ;
2016-10-21 04:01:04 +02:00
this . keyringController = new KeyringController ( {
2018-06-10 09:52:32 +02:00
keyringTypes : additionalKeyrings ,
2017-01-28 22:12:12 +01:00
initState : initState . KeyringController ,
2017-09-22 22:25:08 +02:00
encryptor : opts . encryptor || undefined ,
2021-02-04 19:15:23 +01:00
} ) ;
2020-12-08 20:48:47 +01:00
this . keyringController . memStore . subscribe ( ( state ) =>
this . _onKeyringControllerUpdate ( state ) ,
2021-02-04 19:15:23 +01:00
) ;
2021-10-14 19:50:07 +02:00
this . keyringController . on ( 'unlock' , ( ) => this . _onUnlock ( ) ) ;
2021-02-04 19:15:23 +01:00
this . keyringController . on ( 'lock' , ( ) => this . _onLock ( ) ) ;
2017-01-27 00:09:31 +01:00
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
const getIdentities = ( ) =>
this . preferencesController . store . getState ( ) . identities ;
this . permissionController = new PermissionController ( {
messenger : this . controllerMessenger . getRestricted ( {
name : 'PermissionController' ,
allowedActions : [
` ${ this . approvalController . name } :addRequest ` ,
` ${ this . approvalController . name } :hasRequest ` ,
` ${ this . approvalController . name } :acceptRequest ` ,
` ${ this . approvalController . name } :rejectRequest ` ,
] ,
} ) ,
state : initState . PermissionController ,
caveatSpecifications : getCaveatSpecifications ( { getIdentities } ) ,
2022-02-15 01:02:51 +01:00
permissionSpecifications : {
... getPermissionSpecifications ( {
getIdentities ,
getAllAccounts : this . keyringController . getAccounts . bind (
this . keyringController ,
) ,
captureKeyringTypesWithMissingIdentities : (
identities = { } ,
accounts = [ ] ,
) => {
const accountsMissingIdentities = accounts . filter (
( address ) => ! identities [ address ] ,
) ;
const keyringTypesWithMissingIdentities = accountsMissingIdentities . map (
( address ) =>
this . keyringController . getKeyringForAccount ( address ) ? . type ,
) ;
2022-02-07 20:00:37 +01:00
2022-02-15 01:02:51 +01:00
const identitiesCount = Object . keys ( identities || { } ) . length ;
2022-02-07 20:00:37 +01:00
2022-02-15 01:02:51 +01:00
const accountTrackerCount = Object . keys (
this . accountTracker . store . getState ( ) . accounts || { } ,
) . length ;
2022-02-07 20:00:37 +01:00
2022-02-15 01:02:51 +01:00
captureException (
new Error (
` Attempt to get permission specifications failed because their were ${ accounts . length } accounts, but ${ identitiesCount } identities, and the ${ keyringTypesWithMissingIdentities } keyrings included accounts with missing identities. Meanwhile, there are ${ accountTrackerCount } accounts in the account tracker. ` ,
) ,
) ;
} ,
} ) ,
///: BEGIN:ONLY_INCLUDE_IN(flask)
... this . getSnapPermissionSpecifications ( ) ,
///: END:ONLY_INCLUDE_IN
} ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
unrestrictedMethods ,
} ) ;
this . permissionLogController = new PermissionLogController ( {
restrictedMethods : new Set ( Object . keys ( RestrictedMethods ) ) ,
initState : initState . PermissionLogController ,
} ) ;
this . subjectMetadataController = new SubjectMetadataController ( {
messenger : this . controllerMessenger . getRestricted ( {
name : 'SubjectMetadataController' ,
allowedActions : [ ` ${ this . permissionController . name } :hasPermissions ` ] ,
} ) ,
state : initState . SubjectMetadataController ,
subjectCacheLimit : 100 ,
} ) ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
this . workerController = new IframeExecutionService ( {
iframeUrl : new URL (
2022-05-11 08:08:42 +02:00
'https://metamask.github.io/iframe-execution-environment/0.4.5' ,
2022-02-15 01:02:51 +01:00
) ,
messenger : this . controllerMessenger . getRestricted ( {
name : 'ExecutionService' ,
} ) ,
setupSnapProvider : this . setupSnapProvider . bind ( this ) ,
} ) ;
const snapControllerMessenger = this . controllerMessenger . getRestricted ( {
name : 'SnapController' ,
allowedEvents : [
'ExecutionService:unhandledError' ,
'ExecutionService:unresponsive' ,
] ,
allowedActions : [
` ${ this . permissionController . name } :getEndowments ` ,
` ${ this . permissionController . name } :getPermissions ` ,
` ${ this . permissionController . name } :hasPermission ` ,
2022-03-14 20:37:19 +01:00
` ${ this . permissionController . name } :hasPermissions ` ,
2022-02-15 01:02:51 +01:00
` ${ this . permissionController . name } :requestPermissions ` ,
` ${ this . permissionController . name } :revokeAllPermissions ` ,
2022-04-28 18:17:28 +02:00
` ${ this . permissionController . name } :revokePermissionForAllSubjects ` ,
2022-02-15 01:02:51 +01:00
] ,
} ) ;
this . snapController = new SnapController ( {
2022-05-18 13:49:26 +02:00
environmentEndowmentPermissions : Object . values ( EndowmentPermissions ) ,
2022-02-15 01:02:51 +01:00
terminateAllSnaps : this . workerController . terminateAllSnaps . bind (
this . workerController ,
) ,
terminateSnap : this . workerController . terminateSnap . bind (
this . workerController ,
) ,
executeSnap : this . workerController . executeSnap . bind (
this . workerController ,
) ,
getRpcMessageHandler : this . workerController . getRpcMessageHandler . bind (
this . workerController ,
) ,
closeAllConnections : this . removeAllConnections . bind ( this ) ,
state : initState . SnapController ,
messenger : snapControllerMessenger ,
} ) ;
2022-03-17 17:43:18 +01:00
this . rateLimitController = new RateLimitController ( {
messenger : this . controllerMessenger . getRestricted ( {
name : 'RateLimitController' ,
} ) ,
implementations : {
showNativeNotification : ( origin , message ) => {
const subjectMetadataState = this . controllerMessenger . call (
'SubjectMetadataController:getState' ,
) ;
const originMetadata = subjectMetadataState . subjectMetadata [ origin ] ;
this . platform . _showNotification (
originMetadata ? . name ? ? origin ,
message ,
) ;
return null ;
} ,
} ,
} ) ;
2022-02-15 01:02:51 +01:00
///: END:ONLY_INCLUDE_IN
2022-04-13 18:23:41 +02:00
process . env . TOKEN _DETECTION _V2
? ( this . detectTokensController = new DetectTokensController ( {
preferences : this . preferencesController ,
tokensController : this . tokensController ,
assetsContractController : this . assetsContractController ,
network : this . networkController ,
keyringMemStore : this . keyringController . memStore ,
tokenList : this . tokenListController ,
2022-05-11 22:27:58 +02:00
trackMetaMetricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
2022-04-13 18:23:41 +02:00
} ) )
: ( this . detectTokensController = new DetectTokensController ( {
preferences : this . preferencesController ,
tokensController : this . tokensController ,
network : this . networkController ,
keyringMemStore : this . keyringController . memStore ,
tokenList : this . tokenListController ,
} ) ) ;
2018-07-20 01:46:46 +02:00
2020-11-03 00:41:28 +01:00
this . addressBookController = new AddressBookController (
undefined ,
initState . AddressBookController ,
2021-02-04 19:15:23 +01:00
) ;
2017-03-10 19:34:46 +01:00
2020-05-12 15:01:52 +02:00
this . alertController = new AlertController ( {
initState : initState . AlertController ,
preferencesStore : this . preferencesController . store ,
2021-02-04 19:15:23 +01:00
} ) ;
2020-05-08 21:45:52 +02:00
2019-09-16 19:11:01 +02:00
this . threeBoxController = new ThreeBoxController ( {
preferencesController : this . preferencesController ,
addressBookController : this . addressBookController ,
keyringController : this . keyringController ,
initState : initState . ThreeBoxController ,
2020-11-03 00:41:28 +01:00
getKeyringControllerState : this . keyringController . memStore . getState . bind (
this . keyringController . memStore ,
) ,
2019-09-16 19:11:01 +02:00
version ,
2021-07-02 21:30:40 +02:00
trackMetaMetricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
2021-02-04 19:15:23 +01:00
} ) ;
2019-09-16 19:11:01 +02:00
2017-05-16 19:27:41 +02:00
this . txController = new TransactionController ( {
2020-11-03 00:41:28 +01:00
initState :
initState . TransactionController || initState . TransactionManager ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
getPermittedAccounts : this . getPermittedAccounts . bind ( this ) ,
2021-06-16 22:40:17 +02:00
getProviderConfig : this . networkController . getProviderConfig . bind (
this . networkController ,
) ,
2021-07-28 01:13:48 +02:00
getCurrentNetworkEIP1559Compatibility : this . networkController . getEIP1559Compatibility . bind (
2021-06-30 16:39:00 +02:00
this . networkController ,
) ,
2021-07-28 01:13:48 +02:00
getCurrentAccountEIP1559Compatibility : this . getCurrentAccountEIP1559Compatibility . bind (
this ,
) ,
2017-05-18 23:54:02 +02:00
networkStore : this . networkController . networkStore ,
2020-11-03 00:41:28 +01:00
getCurrentChainId : this . networkController . getCurrentChainId . bind (
this . networkController ,
) ,
2017-02-03 06:09:17 +01:00
preferencesStore : this . preferencesController . store ,
2022-02-24 17:51:33 +01:00
txHistoryLimit : 60 ,
2020-11-03 00:41:28 +01:00
signTransaction : this . keyringController . signTransaction . bind (
this . keyringController ,
) ,
2016-12-16 19:33:36 +01:00
provider : this . provider ,
2017-09-08 06:26:25 +02:00
blockTracker : this . blockTracker ,
2022-01-20 17:26:39 +01:00
createEventFragment : this . metaMetricsController . createEventFragment . bind (
this . metaMetricsController ,
) ,
updateEventFragment : this . metaMetricsController . updateEventFragment . bind (
this . metaMetricsController ,
) ,
finalizeEventFragment : this . metaMetricsController . finalizeEventFragment . bind (
this . metaMetricsController ,
) ,
getEventFragmentById : this . metaMetricsController . getEventFragmentById . bind (
this . metaMetricsController ,
) ,
2020-12-08 17:10:55 +01:00
trackMetaMetricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
2020-11-03 00:41:28 +01:00
getParticipateInMetrics : ( ) =>
2020-12-02 22:41:30 +01:00
this . metaMetricsController . state . participateInMetaMetrics ,
2021-07-31 02:45:18 +02:00
getEIP1559GasFeeEstimates : this . gasFeeController . fetchGasFeeEstimates . bind (
this . gasFeeController ,
) ,
2022-02-18 17:48:38 +01:00
getExternalPendingTransactions : this . getExternalPendingTransactions . bind (
this ,
) ,
2022-02-23 16:15:41 +01:00
getAccountType : this . getAccountType . bind ( this ) ,
getDeviceModel : this . getDeviceModel . bind ( this ) ,
2022-03-16 23:15:03 +01:00
getTokenStandardAndDetails : this . assetsContractController . getTokenStandardAndDetails . bind (
this . assetsContractController ,
) ,
2021-02-04 19:15:23 +01:00
} ) ;
this . txController . on ( 'newUnapprovedTx' , ( ) => opts . showUserConfirmation ( ) ) ;
2017-01-28 01:11:59 +01:00
2019-04-29 08:18:40 +02:00
this . txController . on ( ` tx:status-update ` , async ( txId , status ) => {
2020-11-07 08:38:12 +01:00
if (
status === TRANSACTION _STATUSES . CONFIRMED ||
status === TRANSACTION _STATUSES . FAILED
) {
2021-03-30 16:54:05 +02:00
const txMeta = this . txController . txStateManager . getTransaction ( txId ) ;
2021-03-09 22:37:19 +01:00
const frequentRpcListDetail = this . preferencesController . getFrequentRpcListDetail ( ) ;
let rpcPrefs = { } ;
if ( txMeta . chainId ) {
const rpcSettings = frequentRpcListDetail . find (
( rpc ) => txMeta . chainId === rpc . chainId ,
) ;
rpcPrefs = rpcSettings ? . rpcPrefs ? ? { } ;
}
this . platform . showTransactionNotification ( txMeta , rpcPrefs ) ;
2019-04-29 08:18:40 +02:00
2021-02-04 19:15:23 +01:00
const { txReceipt } = txMeta ;
2022-01-10 17:23:53 +01:00
// if this is a transferFrom method generated from within the app it may be a collectible transfer transaction
// in which case we will want to check and update ownership status of the transferred collectible.
if (
txMeta . type === TRANSACTION _TYPES . TOKEN _METHOD _TRANSFER _FROM &&
txMeta . txParams !== undefined
) {
const {
data ,
to : contractAddress ,
from : userAddress ,
} = txMeta . txParams ;
const { chainId } = txMeta ;
2022-03-17 19:35:40 +01:00
const transactionData = parseStandardTokenTransactionData ( data ) ;
2022-01-10 17:23:53 +01:00
const tokenAmountOrTokenId = getTokenValueParam ( transactionData ) ;
const { allCollectibles } = this . collectiblesController . state ;
// check if its a known collectible
const knownCollectible = allCollectibles ? . [ userAddress ] ? . [
chainId
] . find (
( { address , tokenId } ) =>
isEqualCaseInsensitive ( address , contractAddress ) &&
tokenId === tokenAmountOrTokenId ,
) ;
// if it is we check and update ownership status.
if ( knownCollectible ) {
this . collectiblesController . checkAndUpdateSingleCollectibleOwnershipStatus (
knownCollectible ,
false ,
2022-01-20 18:49:49 +01:00
{ userAddress , chainId } ,
2022-01-10 17:23:53 +01:00
) ;
}
}
2021-03-12 23:23:26 +01:00
const metamaskState = await this . getState ( ) ;
2020-08-07 21:28:23 +02:00
if ( txReceipt && txReceipt . status === '0x0' ) {
2021-03-12 23:23:26 +01:00
this . metaMetricsController . trackEvent (
{
2021-05-24 21:02:26 +02:00
event : 'Tx Status Update: On-Chain Failure' ,
2022-04-22 18:09:10 +02:00
category : EVENT . CATEGORIES . BACKGROUND ,
2021-03-12 23:23:26 +01:00
properties : {
action : 'Transactions' ,
errorMessage : txMeta . simulationFails ? . reason ,
numberOfTokens : metamaskState . tokens . length ,
numberOfAccounts : Object . keys ( metamaskState . accounts ) . length ,
} ,
} ,
{
matomoEvent : true ,
} ,
) ;
2019-04-29 08:18:40 +02:00
}
2018-07-20 13:20:40 +02:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2018-07-20 13:20:40 +02:00
2021-05-20 04:57:51 +02:00
this . networkController . on ( NETWORK _EVENTS . NETWORK _DID _CHANGE , async ( ) => {
const { ticker } = this . networkController . getProviderConfig ( ) ;
try {
await this . currencyRateController . setNativeCurrency ( ticker ) ;
} catch ( error ) {
// TODO: Handle failure to get conversion rate more gracefully
console . error ( error ) ;
}
2021-02-04 19:15:23 +01:00
} ) ;
2021-11-26 21:03:35 +01:00
2021-02-04 19:15:23 +01:00
this . networkController . lookupNetwork ( ) ;
2021-11-15 17:13:51 +01:00
this . messageManager = new MessageManager ( {
metricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
} ) ;
this . personalMessageManager = new PersonalMessageManager ( {
metricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
} ) ;
this . decryptMessageManager = new DecryptMessageManager ( {
metricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
} ) ;
this . encryptionPublicKeyManager = new EncryptionPublicKeyManager ( {
metricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
} ) ;
2020-10-12 21:10:19 +02:00
this . typedMessageManager = new TypedMessageManager ( {
2020-11-03 00:41:28 +01:00
getCurrentChainId : this . networkController . getCurrentChainId . bind (
this . networkController ,
) ,
2021-11-15 17:13:51 +01:00
metricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
2021-02-04 19:15:23 +01:00
} ) ;
2019-05-03 19:32:05 +02:00
2020-10-06 20:28:38 +02:00
this . swapsController = new SwapsController ( {
2020-11-03 00:41:28 +01:00
getBufferedGasLimit : this . txController . txGasUtil . getBufferedGasLimit . bind (
this . txController . txGasUtil ,
) ,
2020-10-28 19:47:32 +01:00
networkController : this . networkController ,
2020-10-06 20:28:38 +02:00
provider : this . provider ,
2020-11-03 00:41:28 +01:00
getProviderConfig : this . networkController . getProviderConfig . bind (
this . networkController ,
) ,
2021-11-22 13:04:31 +01:00
getTokenRatesState : ( ) => this . tokenRatesController . state ,
2021-03-18 11:20:06 +01:00
getCurrentChainId : this . networkController . getCurrentChainId . bind (
this . networkController ,
) ,
2021-07-30 13:35:30 +02:00
getEIP1559GasFeeEstimates : this . gasFeeController . fetchGasFeeEstimates . bind (
this . gasFeeController ,
) ,
2021-02-04 19:15:23 +01:00
} ) ;
2022-03-04 21:20:18 +01:00
this . smartTransactionsController = new SmartTransactionsController (
{
onNetworkStateChange : this . networkController . store . subscribe . bind (
this . networkController . store ,
) ,
getNetwork : this . networkController . getNetworkState . bind (
this . networkController ,
) ,
getNonceLock : this . txController . nonceTracker . getNonceLock . bind (
this . txController . nonceTracker ,
) ,
confirmExternalTransaction : this . txController . confirmExternalTransaction . bind (
this . txController ,
) ,
provider : this . provider ,
trackMetaMetricsEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
} ,
undefined ,
initState . SmartTransactionsController ,
) ;
2020-10-06 20:28:38 +02:00
2021-02-09 00:22:30 +01:00
// ensure accountTracker updates balances after network change
this . networkController . on ( NETWORK _EVENTS . NETWORK _DID _CHANGE , ( ) => {
this . accountTracker . _updateAccounts ( ) ;
} ) ;
// clear unapproved transactions and messages when the network will change
this . networkController . on ( NETWORK _EVENTS . NETWORK _WILL _CHANGE , ( ) => {
this . txController . txStateManager . clearUnapprovedTxs ( ) ;
this . encryptionPublicKeyManager . clearUnapproved ( ) ;
this . personalMessageManager . clearUnapproved ( ) ;
this . typedMessageManager . clearUnapproved ( ) ;
this . decryptMessageManager . clearUnapproved ( ) ;
this . messageManager . clearUnapproved ( ) ;
} ) ;
2020-12-08 20:48:47 +01:00
// ensure isClientOpenAndUnlocked is updated when memState updates
2021-02-04 19:15:23 +01:00
this . on ( 'update' , ( memState ) => this . _onStateUpdate ( memState ) ) ;
2020-12-08 20:48:47 +01:00
2018-04-13 05:26:50 +02:00
this . store . updateStructure ( {
2019-05-13 18:16:09 +02:00
AppStateController : this . appStateController . store ,
2018-04-13 05:26:50 +02:00
TransactionController : this . txController . store ,
KeyringController : this . keyringController . store ,
PreferencesController : this . preferencesController . store ,
2020-12-02 22:41:30 +01:00
MetaMetricsController : this . metaMetricsController . store ,
2019-03-12 05:40:41 +01:00
AddressBookController : this . addressBookController ,
2019-06-01 00:14:22 +02:00
CurrencyController : this . currencyRateController ,
2018-04-13 05:26:50 +02:00
NetworkController : this . networkController . store ,
2018-11-30 23:51:24 +01:00
CachedBalancesController : this . cachedBalancesController . store ,
2020-05-08 21:45:52 +02:00
AlertController : this . alertController . store ,
2019-08-02 05:57:26 +02:00
OnboardingController : this . onboardingController . store ,
2019-08-16 20:54:10 +02:00
IncomingTransactionsController : this . incomingTransactionsController . store ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
PermissionController : this . permissionController ,
PermissionLogController : this . permissionLogController . store ,
SubjectMetadataController : this . subjectMetadataController ,
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
ThreeBoxController : this . threeBoxController . store ,
2022-04-27 10:36:32 +02:00
AnnouncementController : this . announcementController ,
2021-07-08 22:23:00 +02:00
GasFeeController : this . gasFeeController ,
2021-07-16 01:08:16 +02:00
TokenListController : this . tokenListController ,
2021-09-10 19:37:19 +02:00
TokensController : this . tokensController ,
2022-02-18 17:48:38 +01:00
SmartTransactionsController : this . smartTransactionsController ,
2021-11-19 17:16:41 +01:00
CollectiblesController : this . collectiblesController ,
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
SnapController : this . snapController ,
///: END:ONLY_INCLUDE_IN
2021-02-04 19:15:23 +01:00
} ) ;
2018-01-31 19:49:58 +01:00
2021-05-20 04:57:51 +02:00
this . memStore = new ComposableObservableStore ( {
config : {
AppStateController : this . appStateController . store ,
NetworkController : this . networkController . store ,
AccountTracker : this . accountTracker . store ,
TxController : this . txController . memStore ,
CachedBalancesController : this . cachedBalancesController . store ,
2021-09-15 21:02:28 +02:00
TokenRatesController : this . tokenRatesController ,
2021-05-20 04:57:51 +02:00
MessageManager : this . messageManager . memStore ,
PersonalMessageManager : this . personalMessageManager . memStore ,
DecryptMessageManager : this . decryptMessageManager . memStore ,
EncryptionPublicKeyManager : this . encryptionPublicKeyManager . memStore ,
TypesMessageManager : this . typedMessageManager . memStore ,
KeyringController : this . keyringController . memStore ,
PreferencesController : this . preferencesController . store ,
MetaMetricsController : this . metaMetricsController . store ,
AddressBookController : this . addressBookController ,
CurrencyController : this . currencyRateController ,
AlertController : this . alertController . store ,
OnboardingController : this . onboardingController . store ,
IncomingTransactionsController : this . incomingTransactionsController
. store ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
PermissionController : this . permissionController ,
PermissionLogController : this . permissionLogController . store ,
SubjectMetadataController : this . subjectMetadataController ,
2021-05-20 04:57:51 +02:00
ThreeBoxController : this . threeBoxController . store ,
SwapsController : this . swapsController . store ,
EnsController : this . ensController . store ,
ApprovalController : this . approvalController ,
2022-04-27 10:36:32 +02:00
AnnouncementController : this . announcementController ,
2021-07-08 22:23:00 +02:00
GasFeeController : this . gasFeeController ,
2021-07-16 01:08:16 +02:00
TokenListController : this . tokenListController ,
2021-09-10 19:37:19 +02:00
TokensController : this . tokensController ,
2022-02-18 17:48:38 +01:00
SmartTransactionsController : this . smartTransactionsController ,
2021-11-19 17:16:41 +01:00
CollectiblesController : this . collectiblesController ,
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
SnapController : this . snapController ,
///: END:ONLY_INCLUDE_IN
2021-05-20 04:57:51 +02:00
} ,
2021-08-31 21:27:13 +02:00
controllerMessenger : this . controllerMessenger ,
2021-02-04 19:15:23 +01:00
} ) ;
this . memStore . subscribe ( this . sendUpdate . bind ( this ) ) ;
2020-05-15 21:40:06 +02:00
2021-09-21 19:57:24 +02:00
const password = process . env . CONF ? . PASSWORD ;
2020-05-15 21:40:06 +02:00
if (
2020-11-03 00:41:28 +01:00
password &&
! this . isUnlocked ( ) &&
2021-10-15 20:52:52 +02:00
this . onboardingController . store . getState ( ) . completedOnboarding
2020-05-15 21:40:06 +02:00
) {
2021-02-04 19:15:23 +01:00
this . submitPassword ( password ) ;
2020-05-15 21:40:06 +02:00
}
2021-01-13 02:43:45 +01:00
2021-04-30 17:28:07 +02:00
// Lazily update the store with the current extension environment
2022-03-18 20:07:05 +01:00
this . extension . runtime . getPlatformInfo ( ) . then ( ( { os } ) => {
2021-04-30 17:28:07 +02:00
this . appStateController . setBrowserEnvironment (
os ,
// This method is presently only supported by Firefox
this . extension . runtime . getBrowserInfo === undefined
? 'chrome'
: 'firefox' ,
) ;
} ) ;
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
this . setupControllerEventSubscriptions ( ) ;
2021-01-13 02:43:45 +01:00
// TODO:LegacyProvider: Delete
2021-02-04 19:15:23 +01:00
this . publicConfigStore = this . createPublicConfigStore ( ) ;
2022-04-27 20:14:10 +02:00
// Multiple MetaMask instances launched warning
this . extension . runtime . onMessageExternal . addListener ( onMessageReceived ) ;
// Fire a ping message to check if other extensions are running
checkForMultipleVersionsRunning ( ) ;
2016-06-24 22:05:21 +02:00
}
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
/ * *
* Constructor helper for getting Snap permission specifications .
* /
getSnapPermissionSpecifications ( ) {
return {
... buildSnapEndowmentSpecifications ( ) ,
... buildSnapRestrictedMethodSpecifications ( {
addSnap : this . controllerMessenger . call . bind (
this . controllerMessenger ,
'SnapController:add' ,
) ,
2022-04-28 18:17:28 +02:00
clearSnapState : this . controllerMessenger . call . bind (
this . controllerMessenger ,
'SnapController:clearSnapState' ,
) ,
2022-02-15 01:02:51 +01:00
getMnemonic : this . getPrimaryKeyringMnemonic . bind ( this ) ,
2022-04-28 18:17:28 +02:00
getUnlockPromise : this . appStateController . getUnlockPromise . bind (
this . appStateController ,
) ,
2022-02-15 01:02:51 +01:00
getSnap : this . controllerMessenger . call . bind (
this . controllerMessenger ,
'SnapController:get' ,
) ,
getSnapRpcHandler : this . controllerMessenger . call . bind (
this . controllerMessenger ,
'SnapController:getRpcMessageHandler' ,
) ,
2022-04-04 16:32:49 +02:00
getSnapState : this . controllerMessenger . call . bind (
this . controllerMessenger ,
'SnapController:getSnapState' ,
) ,
2022-02-15 01:02:51 +01:00
showConfirmation : ( origin , confirmationData ) =>
this . approvalController . addAndShowApprovalRequest ( {
origin ,
type : MESSAGE _TYPE . SNAP _CONFIRM ,
requestData : confirmationData ,
} ) ,
2022-03-17 17:43:18 +01:00
showNotification : ( origin , args ) =>
this . controllerMessenger . call (
'RateLimitController:call' ,
origin ,
'showNativeNotification' ,
origin ,
args . message ,
) ,
2022-02-15 01:02:51 +01:00
updateSnapState : this . controllerMessenger . call . bind (
this . controllerMessenger ,
'SnapController:updateSnapState' ,
) ,
} ) ,
} ;
}
///: END:ONLY_INCLUDE_IN
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
/ * *
* Sets up BaseController V2 event subscriptions . Currently , this includes
* the subscriptions necessary to notify permission subjects of account
* changes .
*
* Some of the subscriptions in this method are ControllerMessenger selector
* event subscriptions . See the relevant @ metamask / controllers documentation
* for more information .
*
* Note that account - related notifications emitted when the extension
* becomes unlocked are handled in MetaMaskController . _onUnlock .
* /
setupControllerEventSubscriptions ( ) {
const handleAccountsChange = async ( origin , newAccounts ) => {
if ( this . isUnlocked ( ) ) {
this . notifyConnections ( origin , {
method : NOTIFICATION _NAMES . accountsChanged ,
// This should be the same as the return value of `eth_accounts`,
// namely an array of the current / most recently selected Ethereum
// account.
params :
newAccounts . length < 2
? // If the length is 1 or 0, the accounts are sorted by definition.
newAccounts
: // If the length is 2 or greater, we have to execute
// `eth_accounts` vi this method.
await this . getPermittedAccounts ( origin ) ,
} ) ;
}
this . permissionLogController . updateAccountsHistory ( origin , newAccounts ) ;
} ;
// This handles account changes whenever the selected address changes.
let lastSelectedAddress ;
this . preferencesController . store . subscribe ( async ( { selectedAddress } ) => {
if ( selectedAddress && selectedAddress !== lastSelectedAddress ) {
lastSelectedAddress = selectedAddress ;
const permittedAccountsMap = getPermittedAccountsByOrigin (
this . permissionController . state ,
) ;
for ( const [ origin , accounts ] of permittedAccountsMap . entries ( ) ) {
if ( accounts . includes ( selectedAddress ) ) {
handleAccountsChange ( origin , accounts ) ;
}
}
}
} ) ;
// This handles account changes every time relevant permission state
// changes, for any reason.
this . controllerMessenger . subscribe (
` ${ this . permissionController . name } :stateChange ` ,
async ( currentValue , previousValue ) => {
const changedAccounts = getChangedAccounts ( currentValue , previousValue ) ;
for ( const [ origin , accounts ] of changedAccounts . entries ( ) ) {
handleAccountsChange ( origin , accounts ) ;
}
} ,
getPermittedAccountsByOrigin ,
) ;
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
// Record Snap metadata whenever a Snap is added to state.
this . controllerMessenger . subscribe (
` ${ this . snapController . name } :snapAdded ` ,
( snapId , snap , svgIcon = null ) => {
const {
manifest : { proposedName } ,
version ,
} = snap ;
this . subjectMetadataController . addSubjectMetadata ( {
subjectType : SUBJECT _TYPES . SNAP ,
name : proposedName ,
origin : snapId ,
version ,
svgIcon ,
} ) ;
} ,
) ;
this . controllerMessenger . subscribe (
` ${ this . snapController . name } :snapInstalled ` ,
( snapId ) => {
this . metaMetricsController . trackEvent ( {
event : 'Snap Installed' ,
2022-04-22 18:09:10 +02:00
category : EVENT . CATEGORIES . SNAPS ,
2022-02-15 01:02:51 +01:00
properties : {
snap _id : snapId ,
} ,
} ) ;
} ,
) ;
2022-05-11 16:15:26 +02:00
this . controllerMessenger . subscribe (
` ${ this . snapController . name } :snapTerminated ` ,
( snapId ) => {
const approvals = Object . values (
this . approvalController . state . pendingApprovals ,
) . filter (
( approval ) =>
approval . origin === snapId &&
approval . type === MESSAGE _TYPE . SNAP _CONFIRM ,
) ;
for ( const approval of approvals ) {
this . approvalController . reject (
approval . id ,
new Error ( 'Snap was terminated.' ) ,
) ;
}
} ,
) ;
2022-02-15 01:02:51 +01:00
///: END:ONLY_INCLUDE_IN
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
}
2018-03-15 23:27:10 +01:00
/ * *
* Constructor helper : initialize a provider .
* /
2020-11-03 00:41:28 +01:00
initializeProvider ( ) {
2021-02-04 19:15:23 +01:00
const version = this . platform . getVersion ( ) ;
2017-10-19 00:09:32 +02:00
const providerOpts = {
static : {
eth _syncing : false ,
web3 _clientVersion : ` MetaMask/v ${ version } ` ,
} ,
2018-09-25 21:14:37 +02:00
version ,
2017-10-19 00:09:32 +02:00
// account mgmt
2022-04-29 15:05:14 +02:00
getAccounts : async (
{ origin } ,
{ suppressUnauthorizedError = true } = { } ,
) => {
2022-04-26 19:07:39 +02:00
if ( origin === ORIGIN _METAMASK ) {
2021-02-04 19:15:23 +01:00
const selectedAddress = this . preferencesController . getSelectedAddress ( ) ;
return selectedAddress ? [ selectedAddress ] : [ ] ;
2020-03-23 17:25:55 +01:00
} else if ( this . isUnlocked ( ) ) {
2022-04-29 15:05:14 +02:00
return await this . getPermittedAccounts ( origin , {
suppressUnauthorizedError ,
} ) ;
2017-10-19 00:09:32 +02:00
}
2021-02-04 19:15:23 +01:00
return [ ] ; // changing this is a breaking change
2017-10-19 00:09:32 +02:00
} ,
// tx signing
2018-08-17 18:56:07 +02:00
processTransaction : this . newUnapprovedTransaction . bind ( this ) ,
// msg signing
processEthSignMessage : this . newUnsignedMessage . bind ( this ) ,
2018-10-25 05:03:55 +02:00
processTypedMessage : this . newUnsignedTypedMessage . bind ( this ) ,
processTypedMessageV3 : this . newUnsignedTypedMessage . bind ( this ) ,
2019-08-20 21:52:59 +02:00
processTypedMessageV4 : this . newUnsignedTypedMessage . bind ( this ) ,
2017-10-19 00:09:32 +02:00
processPersonalMessage : this . newUnsignedPersonalMessage . bind ( this ) ,
2020-02-19 19:24:16 +01:00
processDecryptMessage : this . newRequestDecryptMessage . bind ( this ) ,
processEncryptionPublicKey : this . newRequestEncryptionPublicKey . bind ( this ) ,
2018-09-21 19:34:21 +02:00
getPendingNonce : this . getPendingNonce . bind ( this ) ,
2020-11-03 00:41:28 +01:00
getPendingTransactionByHash : ( hash ) =>
2021-03-30 16:54:05 +02:00
this . txController . getTransactions ( {
searchCriteria : {
hash ,
status : TRANSACTION _STATUSES . SUBMITTED ,
} ,
2020-11-07 08:38:12 +01:00
} ) [ 0 ] ,
2021-02-04 19:15:23 +01:00
} ;
2020-11-03 00:41:28 +01:00
const providerProxy = this . networkController . initializeProvider (
providerOpts ,
2021-02-04 19:15:23 +01:00
) ;
return providerProxy ;
2017-10-19 00:09:32 +02:00
}
2021-01-13 02:43:45 +01:00
/ * *
* TODO : LegacyProvider : Delete
* Constructor helper : initialize a public config store .
* This store is used to make some config info available to Dapps synchronously .
* /
createPublicConfigStore ( ) {
// subset of state for metamask inpage provider
2021-02-04 19:15:23 +01:00
const publicConfigStore = new ObservableStore ( ) ;
const { networkController } = this ;
2021-01-13 02:43:45 +01:00
// setup memStore subscription hooks
2021-02-04 19:15:23 +01:00
this . on ( 'update' , updatePublicConfigStore ) ;
updatePublicConfigStore ( this . getState ( ) ) ;
2021-01-13 02:43:45 +01:00
function updatePublicConfigStore ( memState ) {
2021-02-04 19:15:23 +01:00
const chainId = networkController . getCurrentChainId ( ) ;
2021-01-13 02:43:45 +01:00
if ( memState . network !== 'loading' ) {
2021-02-04 19:15:23 +01:00
publicConfigStore . putState ( selectPublicState ( chainId , memState ) ) ;
2021-01-13 02:43:45 +01:00
}
}
function selectPublicState ( chainId , { isUnlocked , network } ) {
return {
isUnlocked ,
chainId ,
networkVersion : network ,
2021-02-04 19:15:23 +01:00
} ;
2021-01-13 02:43:45 +01:00
}
2021-02-04 19:15:23 +01:00
return publicConfigStore ;
2021-01-13 02:43:45 +01:00
}
2018-03-15 23:27:10 +01:00
/ * *
2020-12-08 20:48:47 +01:00
* Gets relevant state for the provider of an external origin .
*
* @ param { string } origin - The origin to get the provider state for .
* @ returns { Promise < {
* isUnlocked : boolean ,
* networkVersion : string ,
* chainId : string ,
* accounts : string [ ] ,
* } > } An object with relevant state properties .
2018-03-15 23:27:10 +01:00
* /
2020-12-08 20:48:47 +01:00
async getProviderState ( origin ) {
return {
isUnlocked : this . isUnlocked ( ) ,
... this . getProviderNetworkState ( ) ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
accounts : await this . getPermittedAccounts ( origin ) ,
2021-02-04 19:15:23 +01:00
} ;
2020-12-08 20:48:47 +01:00
}
2017-05-05 02:50:59 +02:00
2020-12-08 20:48:47 +01:00
/ * *
* Gets network state relevant for external providers .
*
* @ param { Object } [ memState ] - The MetaMask memState . If not provided ,
* this function will retrieve the most recent state .
* @ returns { Object } An object with relevant network state properties .
* /
getProviderNetworkState ( memState ) {
2021-02-04 19:15:23 +01:00
const { network } = memState || this . getState ( ) ;
2020-12-08 20:48:47 +01:00
return {
chainId : this . networkController . getCurrentChainId ( ) ,
networkVersion : network ,
2021-02-04 19:15:23 +01:00
} ;
2017-01-27 06:19:09 +01:00
}
2019-07-31 22:17:11 +02:00
//=============================================================================
// EXPOSED TO THE UI SUBSYSTEM
//=============================================================================
2017-01-27 06:19:09 +01:00
2018-03-15 23:27:10 +01:00
/ * *
2018-03-16 01:29:53 +01:00
* The metamask - state of the various controllers , made available to the UI
2018-03-28 03:07:51 +02:00
*
2020-11-10 18:30:41 +01:00
* @ returns { Object } status
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
getState ( ) {
2021-02-04 19:15:23 +01:00
const { vault } = this . keyringController . store . getState ( ) ;
const isInitialized = Boolean ( vault ) ;
2017-09-13 23:20:19 +02:00
2018-04-13 05:26:50 +02:00
return {
2021-03-12 23:23:26 +01:00
isInitialized ,
2018-04-13 05:26:50 +02:00
... this . memStore . getFlatState ( ) ,
2021-02-04 19:15:23 +01:00
} ;
2016-06-24 22:05:21 +02:00
}
2018-03-15 23:27:10 +01:00
/ * *
2018-04-20 18:26:24 +02:00
* Returns an Object containing API Callback Functions .
* These functions are the interface for the UI .
2021-03-18 19:23:46 +01:00
* The API object can be transmitted over a stream via JSON - RPC .
2018-03-28 03:07:51 +02:00
*
2020-11-10 18:30:41 +01:00
* @ returns { Object } Object containing API functions .
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
getApi ( ) {
2020-08-18 22:06:58 +02:00
const {
2021-12-08 22:36:53 +01:00
addressBookController ,
2020-12-11 00:40:29 +01:00
alertController ,
2021-02-12 16:25:58 +01:00
approvalController ,
2021-12-08 22:36:53 +01:00
appStateController ,
collectiblesController ,
collectibleDetectionController ,
currencyRateController ,
detectTokensController ,
ensController ,
gasFeeController ,
2020-08-18 22:06:58 +02:00
keyringController ,
2020-12-11 00:40:29 +01:00
metaMetricsController ,
2020-08-18 22:06:58 +02:00
networkController ,
2022-04-27 10:36:32 +02:00
announcementController ,
2020-08-18 22:06:58 +02:00
onboardingController ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
permissionController ,
2020-08-18 22:06:58 +02:00
preferencesController ,
2021-12-08 22:36:53 +01:00
qrHardwareKeyring ,
2020-12-11 00:40:29 +01:00
swapsController ,
2020-08-18 22:06:58 +02:00
threeBoxController ,
2021-09-10 19:37:19 +02:00
tokensController ,
2022-02-18 17:48:38 +01:00
smartTransactionsController ,
2021-12-08 22:36:53 +01:00
txController ,
2022-04-13 18:23:41 +02:00
assetsContractController ,
2021-02-04 19:15:23 +01:00
} = this ;
2016-06-24 22:05:21 +02:00
return {
2017-01-27 07:30:12 +01:00
// etc
2021-12-08 22:36:53 +01:00
getState : this . getState . bind ( this ) ,
setCurrentCurrency : currencyRateController . setCurrentCurrency . bind (
currencyRateController ,
) ,
setUseBlockie : preferencesController . setUseBlockie . bind (
preferencesController ,
) ,
setUseNonceField : preferencesController . setUseNonceField . bind (
preferencesController ,
) ,
setUsePhishDetect : preferencesController . setUsePhishDetect . bind (
preferencesController ,
) ,
setUseTokenDetection : preferencesController . setUseTokenDetection . bind (
preferencesController ,
) ,
setUseCollectibleDetection : preferencesController . setUseCollectibleDetection . bind (
preferencesController ,
2021-05-20 04:57:51 +02:00
) ,
2021-12-08 22:36:53 +01:00
setOpenSeaEnabled : preferencesController . setOpenSeaEnabled . bind (
preferencesController ,
) ,
setIpfsGateway : preferencesController . setIpfsGateway . bind (
preferencesController ,
2021-11-26 19:54:57 +01:00
) ,
2021-12-08 22:36:53 +01:00
setParticipateInMetaMetrics : metaMetricsController . setParticipateInMetaMetrics . bind (
metaMetricsController ,
2021-07-16 01:08:16 +02:00
) ,
2021-12-08 22:36:53 +01:00
setCurrentLocale : preferencesController . setCurrentLocale . bind (
preferencesController ,
2021-12-01 05:12:27 +01:00
) ,
2018-02-08 01:38:55 +01:00
markPasswordForgotten : this . markPasswordForgotten . bind ( this ) ,
unMarkPasswordForgotten : this . unMarkPasswordForgotten . bind ( this ) ,
2020-06-08 20:06:37 +02:00
safelistPhishingDomain : this . safelistPhishingDomain . bind ( this ) ,
2021-12-08 22:36:53 +01:00
getRequestAccountTabIds : this . getRequestAccountTabIds ,
getOpenMetamaskTabsIds : this . getOpenMetamaskTabsIds ,
2022-01-05 18:09:19 +01:00
markNotificationPopupAsAutomaticallyClosed : ( ) =>
this . notificationManager . markAsAutomaticallyClosed ( ) ,
2017-01-28 01:11:59 +01:00
2017-01-27 07:30:12 +01:00
// primary HD keyring management
2021-12-08 22:36:53 +01:00
addNewAccount : this . addNewAccount . bind ( this ) ,
verifySeedPhrase : this . verifySeedPhrase . bind ( this ) ,
resetAccount : this . resetAccount . bind ( this ) ,
removeAccount : this . removeAccount . bind ( this ) ,
importAccountWithStrategy : this . importAccountWithStrategy . bind ( this ) ,
2017-01-27 07:30:12 +01:00
2018-07-12 03:21:36 +02:00
// hardware wallets
2021-12-08 22:36:53 +01:00
connectHardware : this . connectHardware . bind ( this ) ,
forgetDevice : this . forgetDevice . bind ( this ) ,
checkHardwareStatus : this . checkHardwareStatus . bind ( this ) ,
unlockHardwareWalletAccount : this . unlockHardwareWalletAccount . bind ( this ) ,
setLedgerTransportPreference : this . setLedgerTransportPreference . bind (
2021-10-21 21:17:03 +02:00
this ,
) ,
2021-12-08 22:36:53 +01:00
attemptLedgerTransportCreation : this . attemptLedgerTransportCreation . bind (
2021-11-04 19:19:53 +01:00
this ,
) ,
2021-12-08 22:36:53 +01:00
establishLedgerTransportPreference : this . establishLedgerTransportPreference . bind (
2021-11-05 17:13:29 +01:00
this ,
) ,
2018-06-10 09:52:32 +02:00
2021-11-23 18:28:39 +01:00
// qr hardware devices
2021-12-08 22:36:53 +01:00
submitQRHardwareCryptoHDKey : qrHardwareKeyring . submitCryptoHDKey . bind (
qrHardwareKeyring ,
2021-11-23 18:28:39 +01:00
) ,
2021-12-08 22:36:53 +01:00
submitQRHardwareCryptoAccount : qrHardwareKeyring . submitCryptoAccount . bind (
qrHardwareKeyring ,
2021-11-23 18:28:39 +01:00
) ,
2021-12-08 22:36:53 +01:00
cancelSyncQRHardware : qrHardwareKeyring . cancelSync . bind (
qrHardwareKeyring ,
2021-11-23 18:28:39 +01:00
) ,
2021-12-08 22:36:53 +01:00
submitQRHardwareSignature : qrHardwareKeyring . submitSignature . bind (
qrHardwareKeyring ,
2021-11-23 18:28:39 +01:00
) ,
2021-12-08 22:36:53 +01:00
cancelQRHardwareSignRequest : qrHardwareKeyring . cancelSignRequest . bind (
qrHardwareKeyring ,
2021-11-23 18:28:39 +01:00
) ,
2019-02-25 20:10:13 +01:00
// mobile
2021-12-08 22:36:53 +01:00
fetchInfoToSync : this . fetchInfoToSync . bind ( this ) ,
2019-02-25 20:10:13 +01:00
2017-01-27 07:30:12 +01:00
// vault management
2021-12-08 22:36:53 +01:00
submitPassword : this . submitPassword . bind ( this ) ,
verifyPassword : this . verifyPassword . bind ( this ) ,
2017-01-27 07:30:12 +01:00
2017-09-30 01:09:38 +02:00
// network management
2021-12-08 22:36:53 +01:00
setProviderType : networkController . setProviderType . bind (
2020-11-03 00:41:28 +01:00
networkController ,
) ,
2021-12-08 22:36:53 +01:00
rollbackToPreviousProvider : networkController . rollbackToPreviousProvider . bind (
2021-01-07 00:31:11 +01:00
networkController ,
) ,
2021-12-08 22:36:53 +01:00
setCustomRpc : this . setCustomRpc . bind ( this ) ,
updateAndSetCustomRpc : this . updateAndSetCustomRpc . bind ( this ) ,
delCustomRpc : this . delCustomRpc . bind ( this ) ,
2017-09-30 01:09:38 +02:00
2017-01-30 22:01:07 +01:00
// PreferencesController
2021-12-08 22:36:53 +01:00
setSelectedAddress : preferencesController . setSelectedAddress . bind (
2020-11-03 00:41:28 +01:00
preferencesController ,
) ,
2021-12-08 22:36:53 +01:00
addToken : tokensController . addToken . bind ( tokensController ) ,
rejectWatchAsset : tokensController . rejectWatchAsset . bind (
2021-09-10 19:37:19 +02:00
tokensController ,
) ,
2021-12-08 22:36:53 +01:00
acceptWatchAsset : tokensController . acceptWatchAsset . bind (
2021-09-10 19:37:19 +02:00
tokensController ,
) ,
2021-12-08 22:36:53 +01:00
updateTokenType : tokensController . updateTokenType . bind ( tokensController ) ,
removeToken : tokensController . removeAndIgnoreToken . bind ( tokensController ) ,
setAccountLabel : preferencesController . setAccountLabel . bind (
2020-11-03 00:41:28 +01:00
preferencesController ,
) ,
2021-12-08 22:36:53 +01:00
setFeatureFlag : preferencesController . setFeatureFlag . bind (
2020-11-03 00:41:28 +01:00
preferencesController ,
) ,
2021-12-08 22:36:53 +01:00
setPreference : preferencesController . setPreference . bind (
2020-11-03 00:41:28 +01:00
preferencesController ,
) ,
2021-10-15 20:52:52 +02:00
2021-12-08 22:36:53 +01:00
addKnownMethodData : preferencesController . addKnownMethodData . bind (
2020-11-03 00:41:28 +01:00
preferencesController ,
) ,
2021-12-08 22:36:53 +01:00
setDismissSeedBackUpReminder : preferencesController . setDismissSeedBackUpReminder . bind (
preferencesController ,
2021-05-05 15:58:29 +02:00
) ,
2021-12-08 22:36:53 +01:00
setAdvancedGasFee : preferencesController . setAdvancedGasFee . bind (
2021-11-11 20:18:50 +01:00
preferencesController ,
) ,
2022-01-11 20:17:56 +01:00
setEIP1559V2Enabled : preferencesController . setEIP1559V2Enabled . bind (
preferencesController ,
) ,
2022-03-07 19:53:19 +01:00
setTheme : preferencesController . setTheme . bind ( preferencesController ) ,
2017-01-30 22:01:07 +01:00
2022-01-19 15:38:33 +01:00
// AssetsContractController
2022-03-09 15:38:12 +01:00
getTokenStandardAndDetails : this . getTokenStandardAndDetails . bind ( this ) ,
2022-01-19 15:38:33 +01:00
2021-11-19 17:16:41 +01:00
// CollectiblesController
2021-12-08 22:36:53 +01:00
addCollectible : collectiblesController . addCollectible . bind (
2021-11-19 17:16:41 +01:00
collectiblesController ,
) ,
2021-12-08 22:36:53 +01:00
addCollectibleVerifyOwnership : collectiblesController . addCollectibleVerifyOwnership . bind (
2021-11-26 21:03:35 +01:00
collectiblesController ,
) ,
2021-12-08 22:36:53 +01:00
removeAndIgnoreCollectible : collectiblesController . removeAndIgnoreCollectible . bind (
2021-11-19 17:16:41 +01:00
collectiblesController ,
) ,
2021-12-08 22:36:53 +01:00
removeCollectible : collectiblesController . removeCollectible . bind (
2021-11-19 17:16:41 +01:00
collectiblesController ,
) ,
2022-01-10 17:23:53 +01:00
checkAndUpdateAllCollectiblesOwnershipStatus : collectiblesController . checkAndUpdateAllCollectiblesOwnershipStatus . bind (
collectiblesController ,
) ,
checkAndUpdateSingleCollectibleOwnershipStatus : collectiblesController . checkAndUpdateSingleCollectibleOwnershipStatus . bind (
collectiblesController ,
) ,
isCollectibleOwner : collectiblesController . isCollectibleOwner . bind (
2022-01-03 21:39:41 +01:00
collectiblesController ,
) ,
2017-03-10 00:10:27 +01:00
// AddressController
2021-12-08 22:36:53 +01:00
setAddressBook : addressBookController . set . bind ( addressBookController ) ,
removeFromAddressBook : addressBookController . delete . bind (
addressBookController ,
2020-11-03 00:41:28 +01:00
) ,
2017-03-10 00:10:27 +01:00
2019-05-13 18:16:09 +02:00
// AppStateController
2021-12-08 22:36:53 +01:00
setLastActiveTime : appStateController . setLastActiveTime . bind (
appStateController ,
2020-11-03 00:41:28 +01:00
) ,
2021-12-08 22:36:53 +01:00
setDefaultHomeActiveTabName : appStateController . setDefaultHomeActiveTabName . bind (
appStateController ,
2020-11-03 00:41:28 +01:00
) ,
2021-12-08 22:36:53 +01:00
setConnectedStatusPopoverHasBeenShown : appStateController . setConnectedStatusPopoverHasBeenShown . bind (
appStateController ,
2020-11-03 00:41:28 +01:00
) ,
2021-12-08 22:36:53 +01:00
setRecoveryPhraseReminderHasBeenShown : appStateController . setRecoveryPhraseReminderHasBeenShown . bind (
appStateController ,
2021-06-05 08:33:58 +02:00
) ,
2021-12-08 22:36:53 +01:00
setRecoveryPhraseReminderLastShown : appStateController . setRecoveryPhraseReminderLastShown . bind (
appStateController ,
2021-06-05 08:33:58 +02:00
) ,
2021-12-08 22:36:53 +01:00
setShowTestnetMessageInDropdown : appStateController . setShowTestnetMessageInDropdown . bind (
appStateController ,
2021-11-16 23:22:01 +01:00
) ,
2021-12-14 00:41:10 +01:00
setCollectiblesDetectionNoticeDismissed : appStateController . setCollectiblesDetectionNoticeDismissed . bind (
appStateController ,
) ,
2022-01-11 20:17:56 +01:00
setEnableEIP1559V2NoticeDismissed : appStateController . setEnableEIP1559V2NoticeDismissed . bind (
appStateController ,
) ,
2022-01-27 18:26:33 +01:00
updateCollectibleDropDownState : appStateController . updateCollectibleDropDownState . bind (
appStateController ,
) ,
2019-11-01 18:54:00 +01:00
// EnsController
2021-12-08 22:36:53 +01:00
tryReverseResolveAddress : ensController . reverseResolveAddress . bind (
ensController ,
2020-11-03 00:41:28 +01:00
) ,
2019-11-01 18:54:00 +01:00
2017-01-27 07:30:12 +01:00
// KeyringController
2021-12-08 22:36:53 +01:00
setLocked : this . setLocked . bind ( this ) ,
createNewVaultAndKeychain : this . createNewVaultAndKeychain . bind ( this ) ,
createNewVaultAndRestore : this . createNewVaultAndRestore . bind ( this ) ,
exportAccount : keyringController . exportAccount . bind ( keyringController ) ,
2017-01-27 07:30:12 +01:00
2017-05-16 19:27:41 +02:00
// txController
2021-12-08 22:36:53 +01:00
cancelTransaction : txController . cancelTransaction . bind ( txController ) ,
updateTransaction : txController . updateTransaction . bind ( txController ) ,
updateAndApproveTransaction : txController . updateAndApproveTransaction . bind (
2020-11-03 00:41:28 +01:00
txController ,
) ,
2022-02-18 17:48:38 +01:00
approveTransactionsWithSameNonce : txController . approveTransactionsWithSameNonce . bind (
txController ,
) ,
2021-12-08 22:36:53 +01:00
createCancelTransaction : this . createCancelTransaction . bind ( this ) ,
createSpeedUpTransaction : this . createSpeedUpTransaction . bind ( this ) ,
estimateGas : this . estimateGas . bind ( this ) ,
getNextNonce : this . getNextNonce . bind ( this ) ,
addUnapprovedTransaction : txController . addUnapprovedTransaction . bind (
2020-11-03 00:41:28 +01:00
txController ,
) ,
2022-01-20 17:26:39 +01:00
createTransactionEventFragment : txController . createTransactionEventFragment . bind (
txController ,
) ,
2022-02-14 19:29:24 +01:00
getTransactions : txController . getTransactions . bind ( txController ) ,
2017-02-03 05:20:13 +01:00
2022-03-07 20:14:48 +01:00
updateEditableParams : txController . updateEditableParams . bind (
txController ,
) ,
updateTransactionGasFees : txController . updateTransactionGasFees . bind (
txController ,
) ,
2022-05-04 18:54:46 +02:00
updateTransactionSendFlowHistory : txController . updateTransactionSendFlowHistory . bind (
txController ,
) ,
2022-03-10 03:31:04 +01:00
updateSwapApprovalTransaction : txController . updateSwapApprovalTransaction . bind (
txController ,
) ,
updateSwapTransaction : txController . updateSwapTransaction . bind (
txController ,
) ,
2022-03-25 18:11:04 +01:00
updatePreviousGasParams : txController . updatePreviousGasParams . bind (
txController ,
) ,
2017-02-03 05:20:13 +01:00
// messageManager
2021-12-08 22:36:53 +01:00
signMessage : this . signMessage . bind ( this ) ,
2017-04-27 06:05:45 +02:00
cancelMessage : this . cancelMessage . bind ( this ) ,
2017-01-27 07:30:12 +01:00
2017-02-23 01:23:13 +01:00
// personalMessageManager
2021-12-08 22:36:53 +01:00
signPersonalMessage : this . signPersonalMessage . bind ( this ) ,
2017-04-27 06:05:45 +02:00
cancelPersonalMessage : this . cancelPersonalMessage . bind ( this ) ,
2017-01-27 07:30:12 +01:00
2020-03-16 23:06:22 +01:00
// typedMessageManager
2021-12-08 22:36:53 +01:00
signTypedMessage : this . signTypedMessage . bind ( this ) ,
2017-09-29 18:24:08 +02:00
cancelTypedMessage : this . cancelTypedMessage . bind ( this ) ,
2020-02-19 19:24:16 +01:00
// decryptMessageManager
2021-12-08 22:36:53 +01:00
decryptMessage : this . decryptMessage . bind ( this ) ,
decryptMessageInline : this . decryptMessageInline . bind ( this ) ,
2020-02-19 19:24:16 +01:00
cancelDecryptMessage : this . cancelDecryptMessage . bind ( this ) ,
// EncryptionPublicKeyManager
2021-12-08 22:36:53 +01:00
encryptionPublicKey : this . encryptionPublicKey . bind ( this ) ,
2020-02-19 19:24:16 +01:00
cancelEncryptionPublicKey : this . cancelEncryptionPublicKey . bind ( this ) ,
2019-08-02 05:57:26 +02:00
// onboarding controller
2021-12-08 22:36:53 +01:00
setSeedPhraseBackedUp : onboardingController . setSeedPhraseBackedUp . bind (
2020-11-03 00:41:28 +01:00
onboardingController ,
) ,
2021-12-08 22:36:53 +01:00
completeOnboarding : onboardingController . completeOnboarding . bind (
2021-10-15 20:52:52 +02:00
onboardingController ,
) ,
2021-12-08 22:36:53 +01:00
setFirstTimeFlowType : onboardingController . setFirstTimeFlowType . bind (
2021-10-15 20:52:52 +02:00
onboardingController ,
) ,
2019-09-16 19:11:01 +02:00
2020-05-08 21:45:52 +02:00
// alert controller
2021-12-08 22:36:53 +01:00
setAlertEnabledness : alertController . setAlertEnabledness . bind (
2020-11-03 00:41:28 +01:00
alertController ,
) ,
2021-12-08 22:36:53 +01:00
setUnconnectedAccountAlertShown : alertController . setUnconnectedAccountAlertShown . bind (
2020-12-11 00:40:29 +01:00
alertController ,
) ,
2021-12-08 22:36:53 +01:00
setWeb3ShimUsageAlertDismissed : alertController . setWeb3ShimUsageAlertDismissed . bind (
2020-12-11 00:40:29 +01:00
alertController ,
2020-11-03 00:41:28 +01:00
) ,
2020-05-08 21:45:52 +02:00
2019-09-16 19:11:01 +02:00
// 3Box
2021-12-08 22:36:53 +01:00
setThreeBoxSyncingPermission : threeBoxController . setThreeBoxSyncingPermission . bind (
2020-11-03 00:41:28 +01:00
threeBoxController ,
) ,
2021-12-08 22:36:53 +01:00
restoreFromThreeBox : threeBoxController . restoreFromThreeBox . bind (
2020-11-03 00:41:28 +01:00
threeBoxController ,
) ,
2021-12-08 22:36:53 +01:00
setShowRestorePromptToFalse : threeBoxController . setShowRestorePromptToFalse . bind (
2020-11-03 00:41:28 +01:00
threeBoxController ,
) ,
2021-12-08 22:36:53 +01:00
getThreeBoxLastUpdated : threeBoxController . getLastUpdated . bind (
2020-11-03 00:41:28 +01:00
threeBoxController ,
) ,
2021-12-08 22:36:53 +01:00
turnThreeBoxSyncingOn : threeBoxController . turnThreeBoxSyncingOn . bind (
2020-11-03 00:41:28 +01:00
threeBoxController ,
) ,
2021-12-08 22:36:53 +01:00
initializeThreeBox : this . initializeThreeBox . bind ( this ) ,
2019-09-24 23:08:38 +02:00
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
// permissions
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
removePermissionsFor : permissionController . revokePermissions . bind (
permissionController ,
) ,
2021-12-08 22:36:53 +01:00
approvePermissionsRequest : permissionController . acceptPermissionsRequest . bind (
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
permissionController ,
2020-11-03 00:41:28 +01:00
) ,
2021-12-08 22:36:53 +01:00
rejectPermissionsRequest : permissionController . rejectPermissionsRequest . bind (
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
permissionController ,
2020-11-03 00:41:28 +01:00
) ,
2021-12-08 22:36:53 +01:00
... getPermissionBackgroundApiMethods ( permissionController ) ,
2020-10-06 20:28:38 +02:00
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
// snaps
removeSnapError : this . snapController . removeSnapError . bind (
this . snapController ,
) ,
disableSnap : this . snapController . disableSnap . bind ( this . snapController ) ,
enableSnap : this . snapController . enableSnap . bind ( this . snapController ) ,
2022-05-09 18:19:34 +02:00
removeSnap : this . snapController . removeSnap . bind ( this . snapController ) ,
2022-02-15 01:02:51 +01:00
///: END:ONLY_INCLUDE_IN
2020-10-06 20:28:38 +02:00
// swaps
2021-12-08 22:36:53 +01:00
fetchAndSetQuotes : swapsController . fetchAndSetQuotes . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setSelectedQuoteAggId : swapsController . setSelectedQuoteAggId . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
resetSwapsState : swapsController . resetSwapsState . bind ( swapsController ) ,
setSwapsTokens : swapsController . setSwapsTokens . bind ( swapsController ) ,
clearSwapsQuotes : swapsController . clearSwapsQuotes . bind ( swapsController ) ,
setApproveTxId : swapsController . setApproveTxId . bind ( swapsController ) ,
setTradeTxId : swapsController . setTradeTxId . bind ( swapsController ) ,
setSwapsTxGasPrice : swapsController . setSwapsTxGasPrice . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setSwapsTxGasLimit : swapsController . setSwapsTxGasLimit . bind (
2021-09-15 15:13:18 +02:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setSwapsTxMaxFeePerGas : swapsController . setSwapsTxMaxFeePerGas . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setSwapsTxMaxFeePriorityPerGas : swapsController . setSwapsTxMaxFeePriorityPerGas . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
safeRefetchQuotes : swapsController . safeRefetchQuotes . bind (
2021-07-30 13:35:30 +02:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
stopPollingForQuotes : swapsController . stopPollingForQuotes . bind (
2021-07-30 13:35:30 +02:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setBackgroundSwapRouteState : swapsController . setBackgroundSwapRouteState . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
resetPostFetchState : swapsController . resetPostFetchState . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setSwapsErrorKey : swapsController . setSwapsErrorKey . bind ( swapsController ) ,
setInitialGasEstimate : swapsController . setInitialGasEstimate . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setCustomApproveTxData : swapsController . setCustomApproveTxData . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setSwapsLiveness : swapsController . setSwapsLiveness . bind ( swapsController ) ,
2022-02-18 17:48:38 +01:00
setSwapsFeatureFlags : swapsController . setSwapsFeatureFlags . bind (
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setSwapsUserFeeLevel : swapsController . setSwapsUserFeeLevel . bind (
2020-11-03 00:41:28 +01:00
swapsController ,
) ,
2021-12-08 22:36:53 +01:00
setSwapsQuotesPollingLimitEnabled : swapsController . setSwapsQuotesPollingLimitEnabled . bind (
2021-09-15 15:13:18 +02:00
swapsController ,
2021-08-06 21:31:30 +02:00
) ,
2020-12-02 22:41:30 +01:00
2022-02-18 17:48:38 +01:00
// Smart Transactions
setSmartTransactionsOptInStatus : smartTransactionsController . setOptInState . bind (
smartTransactionsController ,
) ,
fetchSmartTransactionFees : smartTransactionsController . getFees . bind (
smartTransactionsController ,
) ,
estimateSmartTransactionsGas : smartTransactionsController . estimateGas . bind (
smartTransactionsController ,
) ,
submitSignedTransactions : smartTransactionsController . submitSignedTransactions . bind (
smartTransactionsController ,
) ,
cancelSmartTransaction : smartTransactionsController . cancelSmartTransaction . bind (
smartTransactionsController ,
) ,
fetchSmartTransactionsLiveness : smartTransactionsController . fetchLiveness . bind (
smartTransactionsController ,
) ,
updateSmartTransaction : smartTransactionsController . updateSmartTransaction . bind (
smartTransactionsController ,
) ,
setStatusRefreshInterval : smartTransactionsController . setStatusRefreshInterval . bind (
smartTransactionsController ,
) ,
2020-12-02 22:41:30 +01:00
// MetaMetrics
2021-12-08 22:36:53 +01:00
trackMetaMetricsEvent : metaMetricsController . trackEvent . bind (
2020-12-02 22:41:30 +01:00
metaMetricsController ,
) ,
2021-12-08 22:36:53 +01:00
trackMetaMetricsPage : metaMetricsController . trackPage . bind (
2020-12-02 22:41:30 +01:00
metaMetricsController ,
) ,
2022-01-12 20:31:54 +01:00
createEventFragment : metaMetricsController . createEventFragment . bind (
metaMetricsController ,
) ,
updateEventFragment : metaMetricsController . updateEventFragment . bind (
metaMetricsController ,
) ,
finalizeEventFragment : metaMetricsController . finalizeEventFragment . bind (
metaMetricsController ,
) ,
2021-02-12 16:25:58 +01:00
// approval controller
2021-12-08 22:36:53 +01:00
resolvePendingApproval : approvalController . accept . bind (
2021-02-12 16:25:58 +01:00
approvalController ,
) ,
2022-03-10 18:55:25 +01:00
rejectPendingApproval : async ( id , error ) => {
approvalController . reject (
id ,
new EthereumRpcError ( error . code , error . message , error . data ) ,
) ;
} ,
2021-04-28 18:51:41 +02:00
// Notifications
2022-04-27 10:36:32 +02:00
updateViewedNotifications : announcementController . updateViewed . bind (
announcementController ,
2021-07-08 22:23:00 +02:00
) ,
// GasFeeController
2021-12-08 22:36:53 +01:00
getGasFeeEstimatesAndStartPolling : gasFeeController . getGasFeeEstimatesAndStartPolling . bind (
gasFeeController ,
2021-07-08 22:23:00 +02:00
) ,
2021-12-08 22:36:53 +01:00
disconnectGasFeeEstimatePoller : gasFeeController . disconnectPoller . bind (
gasFeeController ,
2021-07-30 15:00:02 +02:00
) ,
2021-12-08 22:36:53 +01:00
getGasFeeTimeEstimate : gasFeeController . getTimeEstimate . bind (
gasFeeController ,
2021-04-28 18:51:41 +02:00
) ,
2021-08-04 23:53:13 +02:00
2021-12-08 22:36:53 +01:00
addPollingTokenToAppState : appStateController . addPollingToken . bind (
appStateController ,
2021-08-04 23:53:13 +02:00
) ,
2021-12-08 22:36:53 +01:00
removePollingTokenFromAppState : appStateController . removePollingToken . bind (
appStateController ,
2021-08-04 23:53:13 +02:00
) ,
2021-09-10 20:03:42 +02:00
// DetectTokenController
2021-12-08 22:36:53 +01:00
detectNewTokens : detectTokensController . detectNewTokens . bind (
detectTokensController ,
2021-09-10 20:03:42 +02:00
) ,
2021-11-19 17:16:41 +01:00
// DetectCollectibleController
detectCollectibles : process . env . COLLECTIBLES _V1
2021-12-08 22:36:53 +01:00
? collectibleDetectionController . detectCollectibles . bind (
collectibleDetectionController ,
2021-11-19 17:16:41 +01:00
)
: null ,
2022-04-13 18:23:41 +02:00
/** Token Detection V2 */
addDetectedTokens : process . env . TOKEN _DETECTION _V2
? tokensController . addDetectedTokens . bind ( tokensController )
: null ,
importTokens : process . env . TOKEN _DETECTION _V2
? tokensController . importTokens . bind ( tokensController )
: null ,
ignoreTokens : process . env . TOKEN _DETECTION _V2
? tokensController . ignoreTokens . bind ( tokensController )
: null ,
getBalancesInSingleCall : process . env . TOKEN _DETECTION _V2
? assetsContractController . getBalancesInSingleCall . bind (
assetsContractController ,
)
: null ,
2021-02-04 19:15:23 +01:00
} ;
2016-06-24 22:05:21 +02:00
}
2022-03-09 15:38:12 +01:00
async getTokenStandardAndDetails ( address , userAddress , tokenId ) {
const details = await this . assetsContractController . getTokenStandardAndDetails (
address ,
userAddress ,
tokenId ,
) ;
return {
... details ,
decimals : details ? . decimals ? . toString ( 10 ) ,
balance : details ? . balance ? . toString ( 10 ) ,
} ;
}
2019-07-31 22:17:11 +02:00
//=============================================================================
// VAULT / KEYRING RELATED METHODS
//=============================================================================
2017-01-27 07:30:12 +01:00
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 02:54:50 +02:00
* Creates a new Vault and create a new keychain .
2018-03-28 03:07:51 +02:00
*
2018-04-19 02:54:50 +02:00
* A vault , or KeyringController , is a controller that contains
* many different account strategies , currently called Keyrings .
* Creating it new means wiping all previous keyrings .
2018-03-28 03:07:51 +02:00
*
2018-04-19 02:54:50 +02:00
* A keychain , or keyring , controls many accounts with a single backup and signing strategy .
* For example , a mnemonic phrase can generate many accounts , and is a keyring .
2018-03-28 03:07:51 +02:00
*
2020-11-10 18:30:41 +01:00
* @ param { string } password
* @ returns { Object } vault
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
async createNewVaultAndKeychain ( password ) {
2021-02-04 19:15:23 +01:00
const releaseLock = await this . createVaultMutex . acquire ( ) ;
2017-11-20 22:47:35 +01:00
try {
2021-02-04 19:15:23 +01:00
let vault ;
const accounts = await this . keyringController . getAccounts ( ) ;
2017-11-20 22:47:35 +01:00
if ( accounts . length > 0 ) {
2021-02-04 19:15:23 +01:00
vault = await this . keyringController . fullUpdate ( ) ;
2017-11-20 22:47:35 +01:00
} else {
2021-02-04 19:15:23 +01:00
vault = await this . keyringController . createNewVaultAndKeychain (
password ,
) ;
const addresses = await this . keyringController . getAccounts ( ) ;
this . preferencesController . setAddresses ( addresses ) ;
this . selectFirstIdentity ( ) ;
2017-11-20 22:47:35 +01:00
}
2021-11-05 17:13:29 +01:00
2021-02-04 19:15:23 +01:00
return vault ;
2020-03-23 17:25:55 +01:00
} finally {
2021-02-04 19:15:23 +01:00
releaseLock ( ) ;
2017-11-20 22:27:29 +01:00
}
}
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 02:54:50 +02:00
* Create a new Vault and restore an existent keyring .
2022-01-07 16:57:33 +01:00
*
2020-11-10 18:30:41 +01:00
* @ param { string } password
2021-07-30 23:37:40 +02:00
* @ param { number [ ] } encodedSeedPhrase - The seed phrase , encoded as an array
* of UTF - 8 bytes .
2018-03-15 23:27:10 +01:00
* /
2021-07-30 23:37:40 +02:00
async createNewVaultAndRestore ( password , encodedSeedPhrase ) {
2021-02-04 19:15:23 +01:00
const releaseLock = await this . createVaultMutex . acquire ( ) ;
2018-01-04 01:06:46 +01:00
try {
2021-02-04 19:15:23 +01:00
let accounts , lastBalance ;
2018-07-27 05:40:11 +02:00
2021-07-30 23:37:40 +02:00
const seedPhraseAsBuffer = Buffer . from ( encodedSeedPhrase ) ;
2021-02-04 19:15:23 +01:00
const { keyringController } = this ;
2018-07-27 05:40:11 +02:00
2018-06-03 21:02:35 +02:00
// clear known identities
2021-02-04 19:15:23 +01:00
this . preferencesController . setAddresses ( [ ] ) ;
2020-06-14 03:42:39 +02:00
// clear permissions
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
this . permissionController . clearState ( ) ;
2020-06-14 03:42:39 +02:00
2020-07-17 04:09:38 +02:00
// clear accounts in accountTracker
2021-02-04 19:15:23 +01:00
this . accountTracker . clearAccounts ( ) ;
2020-07-17 04:09:38 +02:00
// clear cachedBalances
2021-02-04 19:15:23 +01:00
this . cachedBalancesController . clearCachedBalances ( ) ;
2020-07-17 04:09:38 +02:00
2020-07-17 03:37:56 +02:00
// clear unapproved transactions
2021-02-04 19:15:23 +01:00
this . txController . txStateManager . clearUnapprovedTxs ( ) ;
2020-07-17 03:37:56 +02:00
2018-06-03 21:02:35 +02:00
// create new vault
2020-11-03 00:41:28 +01:00
const vault = await keyringController . createNewVaultAndRestore (
password ,
2021-07-30 23:37:40 +02:00
seedPhraseAsBuffer ,
2021-02-04 19:15:23 +01:00
) ;
2018-07-27 05:40:11 +02:00
2021-02-04 19:15:23 +01:00
const ethQuery = new EthQuery ( this . provider ) ;
accounts = await keyringController . getAccounts ( ) ;
2020-11-03 00:41:28 +01:00
lastBalance = await this . getBalance (
accounts [ accounts . length - 1 ] ,
ethQuery ,
2021-02-04 19:15:23 +01:00
) ;
2018-07-27 05:40:11 +02:00
2020-11-03 00:41:28 +01:00
const primaryKeyring = keyringController . getKeyringsByType (
'HD Key Tree' ,
2021-02-04 19:15:23 +01:00
) [ 0 ] ;
2018-07-27 05:40:11 +02:00
if ( ! primaryKeyring ) {
2021-02-04 19:15:23 +01:00
throw new Error ( 'MetamaskController - No HD Key Tree found' ) ;
2018-07-27 05:40:11 +02:00
}
// seek out the first zero balance
while ( lastBalance !== '0x0' ) {
2021-02-04 19:15:23 +01:00
await keyringController . addNewAccount ( primaryKeyring ) ;
accounts = await keyringController . getAccounts ( ) ;
2020-11-03 00:41:28 +01:00
lastBalance = await this . getBalance (
accounts [ accounts . length - 1 ] ,
ethQuery ,
2021-02-04 19:15:23 +01:00
) ;
2018-07-27 05:40:11 +02:00
}
2021-09-16 23:20:57 +02:00
// remove extra zero balance account potentially created from seeking ahead
if ( accounts . length > 1 && lastBalance === '0x0' ) {
await this . removeAccount ( accounts [ accounts . length - 1 ] ) ;
accounts = await keyringController . getAccounts ( ) ;
}
2021-11-03 17:23:13 +01:00
// This must be set as soon as possible to communicate to the
// keyring's iframe and have the setting initialized properly
// Optimistically called to not block Metamask login due to
// Ledger Keyring GitHub downtime
const transportPreference = this . preferencesController . getLedgerTransportPreference ( ) ;
this . setLedgerTransportPreference ( transportPreference ) ;
2018-06-03 21:02:35 +02:00
// set new identities
2021-02-04 19:15:23 +01:00
this . preferencesController . setAddresses ( accounts ) ;
this . selectFirstIdentity ( ) ;
return vault ;
2020-03-23 17:25:55 +01:00
} finally {
2021-02-04 19:15:23 +01:00
releaseLock ( ) ;
2018-01-04 01:06:46 +01:00
}
2017-10-17 22:19:57 +02:00
}
2018-07-27 05:40:11 +02:00
/ * *
* Get an account balance from the AccountTracker or request it directly from the network .
2022-01-07 16:57:33 +01:00
*
2018-07-27 05:40:11 +02:00
* @ param { string } address - The account address
* @ param { EthQuery } ethQuery - The EthQuery instance to use when asking the network
* /
2020-11-03 00:41:28 +01:00
getBalance ( address , ethQuery ) {
2018-07-27 05:40:11 +02:00
return new Promise ( ( resolve , reject ) => {
2021-02-04 19:15:23 +01:00
const cached = this . accountTracker . store . getState ( ) . accounts [ address ] ;
2018-07-27 05:40:11 +02:00
if ( cached && cached . balance ) {
2021-02-04 19:15:23 +01:00
resolve ( cached . balance ) ;
2018-07-27 05:40:11 +02:00
} else {
ethQuery . getBalance ( address , ( error , balance ) => {
if ( error ) {
2021-02-04 19:15:23 +01:00
reject ( error ) ;
log . error ( error ) ;
2018-07-27 05:40:11 +02:00
} else {
2021-02-04 19:15:23 +01:00
resolve ( balance || '0x0' ) ;
2018-07-27 05:40:11 +02:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2018-07-27 05:40:11 +02:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2018-07-27 05:40:11 +02:00
}
2019-02-25 20:10:13 +01:00
/ * *
* Collects all the information that we want to share
* with the mobile client for syncing purposes
2022-01-07 16:57:33 +01:00
*
2020-11-10 18:30:41 +01:00
* @ returns { Promise < Object > } Parts of the state that we want to syncx
2019-02-25 20:10:13 +01:00
* /
2020-11-03 00:41:28 +01:00
async fetchInfoToSync ( ) {
2019-02-25 20:10:13 +01:00
// Preferences
const {
currentLocale ,
frequentRpcList ,
identities ,
selectedAddress ,
2021-09-10 19:37:19 +02:00
useTokenDetection ,
2021-02-04 19:15:23 +01:00
} = this . preferencesController . store . getState ( ) ;
2019-02-25 20:10:13 +01:00
2021-09-10 19:37:19 +02:00
const { tokenList } = this . tokenListController . state ;
2019-02-25 20:10:13 +01:00
const preferences = {
currentLocale ,
frequentRpcList ,
identities ,
selectedAddress ,
2021-02-04 19:15:23 +01:00
} ;
2019-02-25 20:10:13 +01:00
2021-09-10 19:37:19 +02:00
// Tokens
const { allTokens , allIgnoredTokens } = this . tokensController . state ;
// Filter ERC20 tokens
const allERC20Tokens = { } ;
Object . keys ( allTokens ) . forEach ( ( chainId ) => {
allERC20Tokens [ chainId ] = { } ;
Object . keys ( allTokens [ chainId ] ) . forEach ( ( accountAddress ) => {
const checksummedAccountAddress = toChecksumHexAddress ( accountAddress ) ;
allERC20Tokens [ chainId ] [ checksummedAccountAddress ] = allTokens [ chainId ] [
checksummedAccountAddress
] . filter ( ( asset ) => {
if ( asset . isERC721 === undefined ) {
2021-09-11 05:55:23 +02:00
// since the token.address from allTokens is checksumaddress
// asset.address have to be changed to lowercase when we are using dynamic list
2021-09-10 19:37:19 +02:00
const address = useTokenDetection
2021-09-11 05:55:23 +02:00
? asset . address . toLowerCase ( )
: asset . address ;
// the tokenList will be holding only erc20 tokens
if ( tokenList [ address ] !== undefined ) {
2021-09-10 19:37:19 +02:00
return true ;
}
} else if ( asset . isERC721 === false ) {
return true ;
}
return false ;
} ) ;
} ) ;
} ) ;
2019-02-25 20:10:13 +01:00
// Accounts
2021-02-04 19:15:23 +01:00
const hdKeyring = this . keyringController . getKeyringsByType (
'HD Key Tree' ,
) [ 0 ] ;
2020-11-03 00:41:28 +01:00
const simpleKeyPairKeyrings = this . keyringController . getKeyringsByType (
'Simple Key Pair' ,
2021-02-04 19:15:23 +01:00
) ;
const hdAccounts = await hdKeyring . getAccounts ( ) ;
2020-06-26 03:04:17 +02:00
const simpleKeyPairKeyringAccounts = await Promise . all (
2020-07-14 17:20:41 +02:00
simpleKeyPairKeyrings . map ( ( keyring ) => keyring . getAccounts ( ) ) ,
2021-02-04 19:15:23 +01:00
) ;
2020-11-03 00:41:28 +01:00
const simpleKeyPairAccounts = simpleKeyPairKeyringAccounts . reduce (
( acc , accounts ) => [ ... acc , ... accounts ] ,
[ ] ,
2021-02-04 19:15:23 +01:00
) ;
2019-02-25 20:10:13 +01:00
const accounts = {
2020-11-03 00:41:28 +01:00
hd : hdAccounts
. filter ( ( item , pos ) => hdAccounts . indexOf ( item ) === pos )
2021-05-17 23:19:39 +02:00
. map ( ( address ) => toChecksumHexAddress ( address ) ) ,
2020-11-03 00:41:28 +01:00
simpleKeyPair : simpleKeyPairAccounts
. filter ( ( item , pos ) => simpleKeyPairAccounts . indexOf ( item ) === pos )
2021-05-17 23:19:39 +02:00
. map ( ( address ) => toChecksumHexAddress ( address ) ) ,
2019-02-25 20:10:13 +01:00
ledger : [ ] ,
trezor : [ ] ,
2021-11-08 15:48:41 +01:00
lattice : [ ] ,
2021-02-04 19:15:23 +01:00
} ;
2019-02-25 20:10:13 +01:00
// transactions
2021-02-04 19:15:23 +01:00
let { transactions } = this . txController . store . getState ( ) ;
2019-02-25 20:10:13 +01:00
// delete tx for other accounts that we're not importing
2021-04-29 19:51:39 +02:00
transactions = Object . values ( transactions ) . filter ( ( tx ) => {
2021-05-17 23:19:39 +02:00
const checksummedTxFrom = toChecksumHexAddress ( tx . txParams . from ) ;
2021-02-04 19:15:23 +01:00
return accounts . hd . includes ( checksummedTxFrom ) ;
} ) ;
2019-02-25 20:10:13 +01:00
return {
accounts ,
preferences ,
transactions ,
2021-09-10 19:37:19 +02:00
tokens : { allTokens : allERC20Tokens , allIgnoredTokens } ,
2019-02-25 20:10:13 +01:00
network : this . networkController . store . getState ( ) ,
2021-02-04 19:15:23 +01:00
} ;
2019-02-25 20:10:13 +01:00
}
2022-01-07 16:57:33 +01:00
/ * *
2018-06-04 22:43:26 +02:00
* Submits the user ' s password and attempts to unlock the vault .
* Also synchronizes the preferencesController , to ensure its schema
* is up to date with known accounts once the vault is decrypted .
*
* @ param { string } password - The user ' s password
2020-11-10 18:30:41 +01:00
* @ returns { Promise < object > } The keyringController update .
2018-06-04 22:43:26 +02:00
* /
2020-11-03 00:41:28 +01:00
async submitPassword ( password ) {
2021-02-04 19:15:23 +01:00
await this . keyringController . submitPassword ( password ) ;
2018-06-04 22:43:26 +02:00
2020-09-09 07:29:24 +02:00
try {
2021-02-04 19:15:23 +01:00
await this . blockTracker . checkForLatestBlock ( ) ;
2020-09-09 07:29:24 +02:00
} catch ( error ) {
2021-02-04 19:15:23 +01:00
log . error ( 'Error while unlocking extension.' , error ) ;
2020-09-09 07:29:24 +02:00
}
2019-09-16 19:11:01 +02:00
2019-10-01 15:01:57 +02:00
try {
2021-02-04 19:15:23 +01:00
const threeBoxSyncingAllowed = this . threeBoxController . getThreeBoxSyncingState ( ) ;
2019-10-01 15:01:57 +02:00
if ( threeBoxSyncingAllowed && ! this . threeBoxController . box ) {
2019-10-02 21:12:20 +02:00
// 'await' intentionally omitted to avoid waiting for initialization
2021-02-04 19:15:23 +01:00
this . threeBoxController . init ( ) ;
this . threeBoxController . turnThreeBoxSyncingOn ( ) ;
2019-10-01 15:01:57 +02:00
} else if ( threeBoxSyncingAllowed && this . threeBoxController . box ) {
2021-02-04 19:15:23 +01:00
this . threeBoxController . turnThreeBoxSyncingOn ( ) ;
2019-10-01 15:01:57 +02:00
}
} catch ( error ) {
2021-02-04 19:15:23 +01:00
log . error ( 'Error while unlocking extension.' , error ) ;
2019-09-16 19:11:01 +02:00
}
2021-04-26 20:05:48 +02:00
// This must be set as soon as possible to communicate to the
// keyring's iframe and have the setting initialized properly
// Optimistically called to not block Metamask login due to
// Ledger Keyring GitHub downtime
2021-10-21 21:17:03 +02:00
const transportPreference = this . preferencesController . getLedgerTransportPreference ( ) ;
this . setLedgerTransportPreference ( transportPreference ) ;
2021-04-26 20:05:48 +02:00
2021-02-04 19:15:23 +01:00
return this . keyringController . fullUpdate ( ) ;
2018-06-04 22:43:26 +02:00
}
2020-07-25 00:47:40 +02:00
/ * *
* Submits a user ' s password to check its validity .
*
2022-01-07 16:57:33 +01:00
* @ param { string } password - The user ' s password
2020-07-25 00:47:40 +02:00
* /
2020-11-03 00:41:28 +01:00
async verifyPassword ( password ) {
2021-02-04 19:15:23 +01:00
await this . keyringController . verifyPassword ( password ) ;
2020-07-25 00:47:40 +02:00
}
2018-04-19 02:54:50 +02:00
/ * *
* @ type Identity
* @ property { string } name - The account nickname .
* @ property { string } address - The account ' s ethereum address , in lower case .
* @ property { boolean } mayBeFauceting - Whether this account is currently
* receiving funds from our automatic Ropsten faucet .
* /
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 05:33:51 +02:00
* Sets the first address in the state to the selected address
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
selectFirstIdentity ( ) {
2021-02-04 19:15:23 +01:00
const { identities } = this . preferencesController . store . getState ( ) ;
const address = Object . keys ( identities ) [ 0 ] ;
this . preferencesController . setSelectedAddress ( address ) ;
2017-10-17 22:19:57 +02:00
}
2022-02-15 01:02:51 +01:00
/ * *
* Gets the mnemonic of the user ' s primary keyring .
* /
getPrimaryKeyringMnemonic ( ) {
const keyring = this . keyringController . getKeyringsByType ( 'HD Key Tree' ) [ 0 ] ;
if ( ! keyring . mnemonic ) {
throw new Error ( 'Primary keyring mnemonic unavailable.' ) ;
}
return keyring . mnemonic ;
}
2018-06-10 09:52:32 +02:00
//
// Hardware
//
2020-11-03 00:41:28 +01:00
async getKeyringForDevice ( deviceName , hdPath = null ) {
2021-02-04 19:15:23 +01:00
let keyringName = null ;
2018-08-11 03:54:34 +02:00
switch ( deviceName ) {
2021-11-23 18:28:39 +01:00
case DEVICE _NAMES . TREZOR :
2021-02-04 19:15:23 +01:00
keyringName = TrezorKeyring . type ;
break ;
2021-11-23 18:28:39 +01:00
case DEVICE _NAMES . LEDGER :
2021-02-04 19:15:23 +01:00
keyringName = LedgerBridgeKeyring . type ;
break ;
2021-11-23 18:28:39 +01:00
case DEVICE _NAMES . QR :
keyringName = QRHardwareKeyring . type ;
break ;
case DEVICE _NAMES . LATTICE :
2021-11-08 15:48:41 +01:00
keyringName = LatticeKeyring . type ;
break ;
2018-08-11 03:54:34 +02:00
default :
2020-11-03 00:41:28 +01:00
throw new Error (
'MetamaskController:getKeyringForDevice - Unknown device' ,
2021-02-04 19:15:23 +01:00
) ;
2018-08-11 03:54:34 +02:00
}
2021-02-04 19:15:23 +01:00
let keyring = await this . keyringController . getKeyringsByType (
keyringName ,
) [ 0 ] ;
2018-08-11 03:54:34 +02:00
if ( ! keyring ) {
2021-02-04 19:15:23 +01:00
keyring = await this . keyringController . addNewKeyring ( keyringName ) ;
2018-08-11 03:54:34 +02:00
}
2018-08-14 09:42:23 +02:00
if ( hdPath && keyring . setHdPath ) {
2021-02-04 19:15:23 +01:00
keyring . setHdPath ( hdPath ) ;
2018-08-14 01:29:43 +02:00
}
2021-11-23 18:28:39 +01:00
if ( deviceName === DEVICE _NAMES . LATTICE ) {
2021-11-08 15:48:41 +01:00
keyring . appName = 'MetaMask' ;
}
2022-02-16 21:54:30 +01:00
if ( deviceName === DEVICE _NAMES . TREZOR ) {
2021-11-30 15:28:28 +01:00
const model = keyring . getModel ( ) ;
this . appStateController . setTrezorModel ( model ) ;
}
2021-02-04 19:15:23 +01:00
keyring . network = this . networkController . getProviderConfig ( ) . type ;
2018-08-14 07:26:18 +02:00
2021-02-04 19:15:23 +01:00
return keyring ;
2018-08-11 03:54:34 +02:00
}
2021-11-04 19:19:53 +01:00
async attemptLedgerTransportCreation ( ) {
2022-02-16 21:54:30 +01:00
const keyring = await this . getKeyringForDevice ( DEVICE _NAMES . LEDGER ) ;
2021-11-04 19:19:53 +01:00
return await keyring . attemptMakeApp ( ) ;
}
2021-11-05 17:13:29 +01:00
async establishLedgerTransportPreference ( ) {
const transportPreference = this . preferencesController . getLedgerTransportPreference ( ) ;
return await this . setLedgerTransportPreference ( transportPreference ) ;
}
2018-08-11 03:54:34 +02:00
2018-06-10 09:52:32 +02:00
/ * *
* Fetch account list from a trezor device .
*
2022-01-07 16:57:33 +01:00
* @ param deviceName
* @ param page
* @ param hdPath
2018-06-10 09:52:32 +02:00
* @ returns [ ] accounts
* /
2020-11-03 00:41:28 +01:00
async connectHardware ( deviceName , page , hdPath ) {
2021-02-04 19:15:23 +01:00
const keyring = await this . getKeyringForDevice ( deviceName , hdPath ) ;
let accounts = [ ] ;
2018-08-11 03:54:34 +02:00
switch ( page ) {
2019-07-31 22:17:11 +02:00
case - 1 :
2021-02-04 19:15:23 +01:00
accounts = await keyring . getPreviousPage ( ) ;
break ;
2019-07-31 22:17:11 +02:00
case 1 :
2021-02-04 19:15:23 +01:00
accounts = await keyring . getNextPage ( ) ;
break ;
2019-07-31 22:17:11 +02:00
default :
2021-02-04 19:15:23 +01:00
accounts = await keyring . getFirstPage ( ) ;
2018-06-13 08:09:25 +02:00
}
2018-08-11 03:54:34 +02:00
// Merge with existing accounts
// and make sure addresses are not repeated
2021-02-04 19:15:23 +01:00
const oldAccounts = await this . keyringController . getAccounts ( ) ;
2020-11-03 00:41:28 +01:00
const accountsToTrack = [
... new Set (
oldAccounts . concat ( accounts . map ( ( a ) => a . address . toLowerCase ( ) ) ) ,
) ,
2021-02-04 19:15:23 +01:00
] ;
this . accountTracker . syncWithAddresses ( accountsToTrack ) ;
return accounts ;
2018-06-10 09:52:32 +02:00
}
2018-07-17 01:36:08 +02:00
/ * *
* Check if the device is unlocked
*
2022-01-07 16:57:33 +01:00
* @ param deviceName
* @ param hdPath
2018-07-17 01:36:08 +02:00
* @ returns { Promise < boolean > }
* /
2020-11-03 00:41:28 +01:00
async checkHardwareStatus ( deviceName , hdPath ) {
2021-02-04 19:15:23 +01:00
const keyring = await this . getKeyringForDevice ( deviceName , hdPath ) ;
return keyring . isUnlocked ( ) ;
2018-07-12 03:21:36 +02:00
}
2018-07-17 01:36:08 +02:00
/ * *
* Clear
*
2022-01-07 16:57:33 +01:00
* @ param deviceName
2018-07-17 01:36:08 +02:00
* @ returns { Promise < boolean > }
* /
2020-11-03 00:41:28 +01:00
async forgetDevice ( deviceName ) {
2021-02-04 19:15:23 +01:00
const keyring = await this . getKeyringForDevice ( deviceName ) ;
keyring . forgetDevice ( ) ;
return true ;
2018-07-12 03:21:36 +02:00
}
2022-02-23 16:15:41 +01:00
/ * *
* Retrieves the keyring for the selected address and using the . type returns
* a subtype for the account . Either 'hardware' , 'imported' or 'MetaMask' .
*
* @ param { string } address - Address to retrieve keyring for
* @ returns { 'hardware' | 'imported' | 'MetaMask' }
* /
async getAccountType ( address ) {
const keyring = await this . keyringController . getKeyringForAccount ( address ) ;
switch ( keyring . type ) {
case KEYRING _TYPES . TREZOR :
case KEYRING _TYPES . LATTICE :
case KEYRING _TYPES . QR :
case KEYRING _TYPES . LEDGER :
return 'hardware' ;
case KEYRING _TYPES . IMPORTED :
return 'imported' ;
default :
return 'MetaMask' ;
}
}
/ * *
* Retrieves the keyring for the selected address and using the . type
* determines if a more specific name for the device is available . Returns
* 'N/A' for non hardware wallets .
*
* @ param { string } address - Address to retrieve keyring for
* @ returns { 'ledger' | 'lattice' | 'N/A' | string }
* /
async getDeviceModel ( address ) {
const keyring = await this . keyringController . getKeyringForAccount ( address ) ;
switch ( keyring . type ) {
case KEYRING _TYPES . TREZOR :
return keyring . getModel ( ) ;
case KEYRING _TYPES . QR :
return keyring . getName ( ) ;
case KEYRING _TYPES . LEDGER :
// TODO: get model after ledger keyring exposes method
return DEVICE _NAMES . LEDGER ;
case KEYRING _TYPES . LATTICE :
// TODO: get model after lattice keyring exposes method
return DEVICE _NAMES . LATTICE ;
default :
return 'N/A' ;
}
}
2021-11-23 18:28:39 +01:00
/ * *
* get hardware account label
*
2022-01-07 16:57:33 +01:00
* @ returns string label
* /
2021-11-23 18:28:39 +01:00
getAccountLabel ( name , index , hdPathDescription ) {
return ` ${ name [ 0 ] . toUpperCase ( ) } ${ name . slice ( 1 ) } ${
parseInt ( index , 10 ) + 1
} $ { hdPathDescription || '' } ` .trim();
}
2018-06-10 09:52:32 +02:00
/ * *
2021-03-09 21:39:16 +01:00
* Imports an account from a Trezor or Ledger device .
2018-06-10 09:52:32 +02:00
*
2022-01-07 16:57:33 +01:00
* @ param index
* @ param deviceName
* @ param hdPath
* @ param hdPathDescription
2018-06-10 09:52:32 +02:00
* @ returns { } keyState
* /
2021-03-09 21:39:16 +01:00
async unlockHardwareWalletAccount (
index ,
deviceName ,
hdPath ,
hdPathDescription ,
) {
2021-02-04 19:15:23 +01:00
const keyring = await this . getKeyringForDevice ( deviceName , hdPath ) ;
2018-06-10 09:52:32 +02:00
2021-02-04 19:15:23 +01:00
keyring . setAccountToUnlock ( index ) ;
const oldAccounts = await this . keyringController . getAccounts ( ) ;
const keyState = await this . keyringController . addNewAccount ( keyring ) ;
const newAccounts = await this . keyringController . getAccounts ( ) ;
this . preferencesController . setAddresses ( newAccounts ) ;
2020-02-15 21:34:12 +01:00
newAccounts . forEach ( ( address ) => {
2018-06-10 09:52:32 +02:00
if ( ! oldAccounts . includes ( address ) ) {
2021-11-23 18:28:39 +01:00
const label = this . getAccountLabel (
deviceName === DEVICE _NAMES . QR ? keyring . getName ( ) : deviceName ,
index ,
hdPathDescription ,
) ;
// Set the account label to Trezor 1 / Ledger 1 / QR Hardware 1, etc
2021-03-09 21:39:16 +01:00
this . preferencesController . setAccountLabel ( address , label ) ;
2018-08-21 06:04:30 +02:00
// Select the account
2021-02-04 19:15:23 +01:00
this . preferencesController . setSelectedAddress ( address ) ;
2018-06-10 09:52:32 +02:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2018-06-10 09:52:32 +02:00
2021-02-04 19:15:23 +01:00
const { identities } = this . preferencesController . store . getState ( ) ;
return { ... keyState , identities } ;
2019-07-31 22:17:11 +02:00
}
2018-06-13 08:09:25 +02:00
2018-04-19 02:54:50 +02:00
//
// Account Management
2017-01-27 07:30:12 +01:00
//
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 02:54:50 +02:00
* Adds a new account to the default ( first ) HD seed phrase Keyring .
2018-03-28 03:07:51 +02:00
*
2018-03-15 23:27:10 +01:00
* @ returns { } keyState
* /
2020-11-03 00:41:28 +01:00
async addNewAccount ( ) {
const primaryKeyring = this . keyringController . getKeyringsByType (
'HD Key Tree' ,
2021-02-04 19:15:23 +01:00
) [ 0 ] ;
2018-03-06 15:56:27 +01:00
if ( ! primaryKeyring ) {
2021-02-04 19:15:23 +01:00
throw new Error ( 'MetamaskController - No HD Key Tree found' ) ;
2018-03-06 15:56:27 +01:00
}
2021-02-04 19:15:23 +01:00
const { keyringController } = this ;
const oldAccounts = await keyringController . getAccounts ( ) ;
const keyState = await keyringController . addNewAccount ( primaryKeyring ) ;
const newAccounts = await keyringController . getAccounts ( ) ;
2017-10-19 21:15:26 +02:00
2021-02-04 19:15:23 +01:00
await this . verifySeedPhrase ( ) ;
2018-03-06 15:56:27 +01:00
2021-02-04 19:15:23 +01:00
this . preferencesController . setAddresses ( newAccounts ) ;
2017-10-19 21:15:26 +02:00
newAccounts . forEach ( ( address ) => {
if ( ! oldAccounts . includes ( address ) ) {
2021-02-04 19:15:23 +01:00
this . preferencesController . setSelectedAddress ( address ) ;
2017-10-19 21:15:26 +02:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2017-10-19 21:15:26 +02:00
2021-02-04 19:15:23 +01:00
const { identities } = this . preferencesController . store . getState ( ) ;
return { ... keyState , identities } ;
2017-01-27 07:30:12 +01:00
}
2018-03-15 23:27:10 +01:00
/ * *
* Verifies the validity of the current vault ' s seed phrase .
2018-03-28 03:07:51 +02:00
*
2018-03-16 01:29:53 +01:00
* Validity : seed phrase restores the accounts belonging to the current vault .
2018-03-15 23:27:10 +01:00
*
* Called when the first account is created and on unlocking the vault .
2018-04-19 02:54:50 +02:00
*
2021-07-30 23:37:40 +02:00
* @ returns { Promise < number [ ] > } The seed phrase to be confirmed by the user ,
* encoded as an array of UTF - 8 bytes .
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
async verifySeedPhrase ( ) {
const primaryKeyring = this . keyringController . getKeyringsByType (
'HD Key Tree' ,
2021-02-04 19:15:23 +01:00
) [ 0 ] ;
2018-03-06 15:56:27 +01:00
if ( ! primaryKeyring ) {
2021-02-04 19:15:23 +01:00
throw new Error ( 'MetamaskController - No HD Key Tree found' ) ;
2018-03-06 15:56:27 +01:00
}
2021-02-04 19:15:23 +01:00
const serialized = await primaryKeyring . serialize ( ) ;
2021-07-30 23:37:40 +02:00
const seedPhraseAsBuffer = Buffer . from ( serialized . mnemonic ) ;
2018-03-06 15:56:27 +01:00
2021-02-04 19:15:23 +01:00
const accounts = await primaryKeyring . getAccounts ( ) ;
2018-03-06 15:56:27 +01:00
if ( accounts . length < 1 ) {
2021-02-04 19:15:23 +01:00
throw new Error ( 'MetamaskController - No accounts found' ) ;
2018-03-06 15:56:27 +01:00
}
try {
2021-07-30 23:37:40 +02:00
await seedPhraseVerifier . verifyAccounts ( accounts , seedPhraseAsBuffer ) ;
return Array . from ( seedPhraseAsBuffer . values ( ) ) ;
2018-03-06 15:56:27 +01:00
} catch ( err ) {
2021-02-04 19:15:23 +01:00
log . error ( err . message ) ;
throw err ;
2018-03-06 15:56:27 +01:00
}
2017-01-27 07:30:12 +01:00
}
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 02:54:50 +02:00
* Clears the transaction history , to allow users to force - reset their nonces .
* Mostly used in development environments , when networks are restarted with
* the same network ID .
*
2020-11-10 18:30:41 +01:00
* @ returns { Promise < string > } The current selected address .
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
async resetAccount ( ) {
2021-02-04 19:15:23 +01:00
const selectedAddress = this . preferencesController . getSelectedAddress ( ) ;
this . txController . wipeTransactions ( selectedAddress ) ;
this . networkController . resetConnection ( ) ;
2018-03-28 03:07:51 +02:00
2021-02-04 19:15:23 +01:00
return selectedAddress ;
2018-01-31 09:33:15 +01:00
}
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
/ * *
* Gets the permitted accounts for the specified origin . Returns an empty
* array if no accounts are permitted .
*
* @ param { string } origin - The origin whose exposed accounts to retrieve .
2022-04-29 15:05:14 +02:00
* @ param { boolean } [ suppressUnauthorizedError ] - Suppresses the unauthorized error .
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
* @ returns { Promise < string [ ] > } The origin ' s permitted accounts , or an empty
* array .
* /
2022-04-29 15:05:14 +02:00
async getPermittedAccounts (
origin ,
{ suppressUnauthorizedError = true } = { } ,
) {
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
try {
return await this . permissionController . executeRestrictedMethod (
origin ,
RestrictedMethods . eth _accounts ,
) ;
} catch ( error ) {
2022-04-29 15:05:14 +02:00
if (
suppressUnauthorizedError &&
error . code === rpcErrorCodes . provider . unauthorized
) {
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
return [ ] ;
}
throw error ;
}
}
/ * *
* Stops exposing the account with the specified address to all third parties .
* Exposed accounts are stored in caveats of the eth _accounts permission . This
* method uses ` PermissionController.updatePermissionsByCaveat ` to
* remove the specified address from every eth _accounts permission . If a
* permission only included this address , the permission is revoked entirely .
*
* @ param { string } targetAccount - The address of the account to stop exposing
* to third parties .
* /
removeAllAccountPermissions ( targetAccount ) {
this . permissionController . updatePermissionsByCaveat (
CaveatTypes . restrictReturnedAccounts ,
( existingAccounts ) =>
CaveatMutatorFactories [
CaveatTypes . restrictReturnedAccounts
] . removeAccount ( targetAccount , existingAccounts ) ,
) ;
}
2018-07-11 06:20:40 +02:00
/ * *
2018-07-12 02:01:44 +02:00
* Removes an account from state / storage .
2018-07-11 06:20:40 +02:00
*
2020-01-13 19:36:36 +01:00
* @ param { string [ ] } address - A hex address
2018-07-11 06:20:40 +02:00
* /
2020-11-03 00:41:28 +01:00
async removeAccount ( address ) {
2020-06-15 15:27:27 +02:00
// Remove all associated permissions
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
this . removeAllAccountPermissions ( address ) ;
2018-07-12 02:01:44 +02:00
// Remove account from the preferences controller
2021-02-04 19:15:23 +01:00
this . preferencesController . removeAddress ( address ) ;
2018-07-12 02:01:44 +02:00
// Remove account from the account tracker controller
2021-02-04 19:15:23 +01:00
this . accountTracker . removeAccount ( [ address ] ) ;
2018-08-21 06:04:07 +02:00
2018-07-12 02:01:44 +02:00
// Remove account from the keyring
2021-02-04 19:15:23 +01:00
await this . keyringController . removeAccount ( address ) ;
return address ;
2018-07-11 06:20:40 +02:00
}
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 02:54:50 +02:00
* Imports an account with the specified import strategy .
* These are defined in app / scripts / account - import - strategies
* Each strategy represents a different way of serializing an Ethereum key pair .
2018-03-28 03:07:51 +02:00
*
2020-11-10 18:30:41 +01:00
* @ param { string } strategy - A unique identifier for an account import strategy .
* @ param { any } args - The data required by that strategy to import an account .
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
async importAccountWithStrategy ( strategy , args ) {
2021-02-04 19:15:23 +01:00
const privateKey = await accountImporter . importAccount ( strategy , args ) ;
2020-11-03 00:41:28 +01:00
const keyring = await this . keyringController . addNewKeyring (
'Simple Key Pair' ,
[ privateKey ] ,
2021-02-04 19:15:23 +01:00
) ;
const accounts = await keyring . getAccounts ( ) ;
2018-05-29 07:58:14 +02:00
// update accounts in preferences controller
2021-02-04 19:15:23 +01:00
const allAccounts = await this . keyringController . getAccounts ( ) ;
this . preferencesController . setAddresses ( allAccounts ) ;
2018-05-29 07:58:14 +02:00
// set new account as selected
2021-02-04 19:15:23 +01:00
await this . preferencesController . setSelectedAddress ( accounts [ 0 ] ) ;
2017-01-27 07:30:12 +01:00
}
2018-03-16 01:29:53 +01:00
// ---------------------------------------------------------------------------
2018-04-19 02:54:50 +02:00
// Identity Management (signature operations)
2018-08-17 18:56:07 +02:00
/ * *
* Called when a Dapp suggests a new tx to be signed .
* this wrapper needs to exist so we can provide a reference to
* "newUnapprovedTransaction" before "txController" is instantiated
*
2022-01-07 16:57:33 +01:00
* @ param { Object } txParams - The transaction parameters .
* @ param { Object } [ req ] - The original request , containing the origin .
2018-08-17 18:56:07 +02:00
* /
2020-11-03 00:41:28 +01:00
async newUnapprovedTransaction ( txParams , req ) {
2021-02-04 19:15:23 +01:00
return await this . txController . newUnapprovedTransaction ( txParams , req ) ;
2018-08-17 18:56:07 +02:00
}
2018-04-19 02:54:50 +02:00
// eth_sign methods:
2017-01-27 07:30:12 +01:00
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 02:54:50 +02:00
* Called when a Dapp uses the eth _sign method , to request user approval .
* eth _sign is a pure signature of arbitrary data . It is on a deprecation
* path , since this data can be a transaction , or can leak private key
* information .
*
* @ param { Object } msgParams - The params passed to eth _sign .
2022-01-07 16:57:33 +01:00
* @ param { Object } [ req ] - The original request , containing the origin .
2018-03-15 23:27:10 +01:00
* /
2021-11-19 17:05:24 +01:00
async newUnsignedMessage ( msgParams , req ) {
const data = normalizeMsgData ( msgParams . data ) ;
let promise ;
// 64 hex + "0x" at the beginning
// This is needed because Ethereum's EcSign works only on 32 byte numbers
// For 67 length see: https://github.com/MetaMask/metamask-extension/pull/12679/files#r749479607
if ( data . length === 66 || data . length === 67 ) {
promise = this . messageManager . addUnapprovedMessageAsync ( msgParams , req ) ;
this . sendUpdate ( ) ;
this . opts . showUserConfirmation ( ) ;
} else {
throw ethErrors . rpc . invalidParams (
'eth_sign requires 32 byte message hash' ,
) ;
}
return await promise ;
2018-04-19 02:54:50 +02:00
}
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
/ * *
* Gets an "app key" corresponding to an Ethereum address . An app key is more
* or less an addrdess hashed together with some string , in this case a
* subject identifier / origin .
*
* @ todo Figure out a way to derive app keys that doesn 't depend on the user' s
* Ethereum addresses .
* @ param { string } subject - The identifier of the subject whose app key to
* retrieve .
* @ param { string } [ requestedAccount ] - The account whose app key to retrieve .
* The first account in the keyring will be used by default .
* /
async getAppKeyForSubject ( subject , requestedAccount ) {
let account ;
if ( requestedAccount ) {
account = requestedAccount ;
} else {
account = ( await this . keyringController . getAccounts ( ) ) [ 0 ] ;
}
return this . keyringController . exportAppKeyForAddress ( account , subject ) ;
}
///: END:ONLY_INCLUDE_IN
2018-04-19 02:54:50 +02:00
/ * *
* Signifies user intent to complete an eth _sign method .
*
2020-11-10 18:30:41 +01:00
* @ param { Object } msgParams - The params passed to eth _call .
* @ returns { Promise < Object > } Full state update .
2018-04-19 02:54:50 +02:00
* /
2021-11-19 17:05:24 +01:00
async signMessage ( msgParams ) {
2021-02-04 19:15:23 +01:00
log . info ( 'MetaMaskController - signMessage' ) ;
const msgId = msgParams . metamaskId ;
2021-11-19 17:05:24 +01:00
try {
// sets the status op the message to 'approved'
// and removes the metamaskId for signing
const cleanMsgParams = await this . messageManager . approveMessage (
msgParams ,
) ;
const rawSig = await this . keyringController . signMessage ( cleanMsgParams ) ;
this . messageManager . setMsgStatusSigned ( msgId , rawSig ) ;
return this . getState ( ) ;
} catch ( error ) {
log . info ( 'MetaMaskController - eth_sign failed' , error ) ;
this . messageManager . errorMessage ( msgId , error ) ;
throw error ;
}
2016-06-24 22:05:21 +02:00
}
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Used to cancel a message submitted via eth _sign .
*
2018-04-20 18:26:24 +02:00
* @ param { string } msgId - The id of the message to cancel .
2018-04-19 02:54:50 +02:00
* /
2021-12-08 22:36:53 +01:00
cancelMessage ( msgId ) {
2021-02-04 19:15:23 +01:00
const { messageManager } = this ;
messageManager . rejectMsg ( msgId ) ;
2021-12-08 22:36:53 +01:00
return this . getState ( ) ;
2018-04-19 02:54:50 +02:00
}
// personal_sign methods:
2018-03-28 03:07:51 +02:00
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Called when a dapp uses the personal _sign method .
* This is identical to the Geth eth _sign method , and may eventually replace
* eth _sign .
*
* We currently define our eth _sign and personal _sign mostly for legacy Dapps .
2018-03-28 03:07:51 +02:00
*
2018-04-19 02:54:50 +02:00
* @ param { Object } msgParams - The params of the message to sign & return to the Dapp .
2022-01-07 16:57:33 +01:00
* @ param { Object } [ req ] - The original request , containing the origin .
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
async newUnsignedPersonalMessage ( msgParams , req ) {
const promise = this . personalMessageManager . addUnapprovedMessageAsync (
msgParams ,
req ,
2021-02-04 19:15:23 +01:00
) ;
this . sendUpdate ( ) ;
this . opts . showUserConfirmation ( ) ;
return promise ;
2017-02-21 23:25:47 +01:00
}
2018-03-28 03:07:51 +02:00
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 02:54:50 +02:00
* Signifies a user ' s approval to sign a personal _sign message in queue .
* Triggers signing , and the callback function from newUnsignedPersonalMessage .
*
* @ param { Object } msgParams - The params of the message to sign & return to the Dapp .
2020-11-10 18:30:41 +01:00
* @ returns { Promise < Object > } A full state update .
2018-03-15 23:27:10 +01:00
* /
2021-11-19 17:05:24 +01:00
async signPersonalMessage ( msgParams ) {
2021-02-04 19:15:23 +01:00
log . info ( 'MetaMaskController - signPersonalMessage' ) ;
const msgId = msgParams . metamaskId ;
2017-02-21 23:25:47 +01:00
// sets the status op the message to 'approved'
// and removes the metamaskId for signing
2021-11-19 17:05:24 +01:00
try {
const cleanMsgParams = await this . personalMessageManager . approveMessage (
msgParams ,
) ;
const rawSig = await this . keyringController . signPersonalMessage (
cleanMsgParams ,
) ;
// tells the listener that the message has been signed
// and can be returned to the dapp
this . personalMessageManager . setMsgStatusSigned ( msgId , rawSig ) ;
return this . getState ( ) ;
} catch ( error ) {
log . info ( 'MetaMaskController - eth_personalSign failed' , error ) ;
this . personalMessageManager . errorMessage ( msgId , error ) ;
throw error ;
}
2017-02-21 23:25:47 +01:00
}
2018-03-28 03:07:51 +02:00
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Used to cancel a personal _sign type message .
2022-01-07 16:57:33 +01:00
*
2018-04-20 18:26:24 +02:00
* @ param { string } msgId - The ID of the message to cancel .
2018-04-19 02:54:50 +02:00
* /
2021-12-08 22:36:53 +01:00
cancelPersonalMessage ( msgId ) {
2021-02-04 19:15:23 +01:00
const messageManager = this . personalMessageManager ;
messageManager . rejectMsg ( msgId ) ;
2021-12-08 22:36:53 +01:00
return this . getState ( ) ;
2018-04-19 02:54:50 +02:00
}
2020-02-19 19:24:16 +01:00
// eth_decrypt methods
/ * *
2020-11-03 00:41:28 +01:00
* Called when a dapp uses the eth _decrypt method .
*
* @ param { Object } msgParams - The params of the message to sign & return to the Dapp .
* @ param { Object } req - ( optional ) the original request , containing the origin
* Passed back to the requesting Dapp .
* /
async newRequestDecryptMessage ( msgParams , req ) {
const promise = this . decryptMessageManager . addUnapprovedMessageAsync (
msgParams ,
req ,
2021-02-04 19:15:23 +01:00
) ;
this . sendUpdate ( ) ;
this . opts . showUserConfirmation ( ) ;
return promise ;
2020-02-19 19:24:16 +01:00
}
/ * *
2020-11-03 00:41:28 +01:00
* Only decrypt message and don ' t touch transaction state
*
* @ param { Object } msgParams - The params of the message to decrypt .
2020-11-10 18:30:41 +01:00
* @ returns { Promise < Object > } A full state update .
2020-11-03 00:41:28 +01:00
* /
async decryptMessageInline ( msgParams ) {
2021-02-04 19:15:23 +01:00
log . info ( 'MetaMaskController - decryptMessageInline' ) ;
2020-02-19 19:24:16 +01:00
// decrypt the message inline
2021-02-04 19:15:23 +01:00
const msgId = msgParams . metamaskId ;
const msg = this . decryptMessageManager . getMsg ( msgId ) ;
2020-02-19 19:24:16 +01:00
try {
2021-04-16 17:05:13 +02:00
const stripped = stripHexPrefix ( msgParams . data ) ;
2021-02-04 19:15:23 +01:00
const buff = Buffer . from ( stripped , 'hex' ) ;
msgParams . data = JSON . parse ( buff . toString ( 'utf8' ) ) ;
2020-02-19 19:24:16 +01:00
2021-02-04 19:15:23 +01:00
msg . rawData = await this . keyringController . decryptMessage ( msgParams ) ;
2020-02-19 19:24:16 +01:00
} catch ( e ) {
2021-02-04 19:15:23 +01:00
msg . error = e . message ;
2020-02-19 19:24:16 +01:00
}
2021-02-04 19:15:23 +01:00
this . decryptMessageManager . _updateMsg ( msg ) ;
2020-02-19 19:24:16 +01:00
2021-02-04 19:15:23 +01:00
return this . getState ( ) ;
2020-02-19 19:24:16 +01:00
}
/ * *
2020-11-03 00:41:28 +01:00
* Signifies a user ' s approval to decrypt a message in queue .
* Triggers decrypt , and the callback function from newUnsignedDecryptMessage .
*
* @ param { Object } msgParams - The params of the message to decrypt & return to the Dapp .
2020-11-10 18:30:41 +01:00
* @ returns { Promise < Object > } A full state update .
2020-11-03 00:41:28 +01:00
* /
async decryptMessage ( msgParams ) {
2021-02-04 19:15:23 +01:00
log . info ( 'MetaMaskController - decryptMessage' ) ;
const msgId = msgParams . metamaskId ;
2020-02-19 19:24:16 +01:00
// sets the status op the message to 'approved'
// and removes the metamaskId for decryption
try {
2020-11-03 00:41:28 +01:00
const cleanMsgParams = await this . decryptMessageManager . approveMessage (
msgParams ,
2021-02-04 19:15:23 +01:00
) ;
2020-02-19 19:24:16 +01:00
2021-04-16 17:05:13 +02:00
const stripped = stripHexPrefix ( cleanMsgParams . data ) ;
2021-02-04 19:15:23 +01:00
const buff = Buffer . from ( stripped , 'hex' ) ;
cleanMsgParams . data = JSON . parse ( buff . toString ( 'utf8' ) ) ;
2020-02-19 19:24:16 +01:00
// decrypt the message
2020-11-03 00:41:28 +01:00
const rawMess = await this . keyringController . decryptMessage (
cleanMsgParams ,
2021-02-04 19:15:23 +01:00
) ;
2020-02-19 19:24:16 +01:00
// tells the listener that the message has been decrypted and can be returned to the dapp
2021-02-04 19:15:23 +01:00
this . decryptMessageManager . setMsgStatusDecrypted ( msgId , rawMess ) ;
2020-02-19 19:24:16 +01:00
} catch ( error ) {
2021-02-04 19:15:23 +01:00
log . info ( 'MetaMaskController - eth_decrypt failed.' , error ) ;
this . decryptMessageManager . errorMessage ( msgId , error ) ;
2020-02-19 19:24:16 +01:00
}
2021-02-04 19:15:23 +01:00
return this . getState ( ) ;
2020-02-19 19:24:16 +01:00
}
/ * *
* Used to cancel a eth _decrypt type message .
2022-01-07 16:57:33 +01:00
*
2020-02-19 19:24:16 +01:00
* @ param { string } msgId - The ID of the message to cancel .
* /
2021-12-08 22:36:53 +01:00
cancelDecryptMessage ( msgId ) {
2021-02-04 19:15:23 +01:00
const messageManager = this . decryptMessageManager ;
messageManager . rejectMsg ( msgId ) ;
2021-12-08 22:36:53 +01:00
return this . getState ( ) ;
2020-02-19 19:24:16 +01:00
}
// eth_getEncryptionPublicKey methods
/ * *
2020-11-03 00:41:28 +01:00
* Called when a dapp uses the eth _getEncryptionPublicKey method .
*
* @ param { Object } msgParams - The params of the message to sign & return to the Dapp .
* @ param { Object } req - ( optional ) the original request , containing the origin
* Passed back to the requesting Dapp .
* /
async newRequestEncryptionPublicKey ( msgParams , req ) {
2021-02-04 19:15:23 +01:00
const address = msgParams ;
const keyring = await this . keyringController . getKeyringForAccount ( address ) ;
2021-02-02 16:25:30 +01:00
switch ( keyring . type ) {
2021-06-28 19:29:08 +02:00
case KEYRING _TYPES . LEDGER : {
2021-02-02 16:25:30 +01:00
return new Promise ( ( _ , reject ) => {
reject (
new Error ( 'Ledger does not support eth_getEncryptionPublicKey.' ) ,
2021-02-04 19:15:23 +01:00
) ;
} ) ;
2021-02-02 16:25:30 +01:00
}
2021-06-28 19:29:08 +02:00
case KEYRING _TYPES . TREZOR : {
2021-02-02 16:25:30 +01:00
return new Promise ( ( _ , reject ) => {
reject (
new Error ( 'Trezor does not support eth_getEncryptionPublicKey.' ) ,
2021-02-04 19:15:23 +01:00
) ;
} ) ;
2021-02-02 16:25:30 +01:00
}
2021-11-08 15:48:41 +01:00
case KEYRING _TYPES . LATTICE : {
return new Promise ( ( _ , reject ) => {
reject (
new Error ( 'Lattice does not support eth_getEncryptionPublicKey.' ) ,
) ;
} ) ;
}
2021-11-23 18:28:39 +01:00
case KEYRING _TYPES . QR : {
return Promise . reject (
new Error ( 'QR hardware does not support eth_getEncryptionPublicKey.' ) ,
) ;
}
2021-02-02 16:25:30 +01:00
default : {
const promise = this . encryptionPublicKeyManager . addUnapprovedMessageAsync (
msgParams ,
req ,
2021-02-04 19:15:23 +01:00
) ;
this . sendUpdate ( ) ;
this . opts . showUserConfirmation ( ) ;
return promise ;
2021-02-02 16:25:30 +01:00
}
2021-02-01 21:39:09 +01:00
}
2020-02-19 19:24:16 +01:00
}
/ * *
2020-11-03 00:41:28 +01:00
* Signifies a user ' s approval to receiving encryption public key in queue .
* Triggers receiving , and the callback function from newUnsignedEncryptionPublicKey .
*
* @ param { Object } msgParams - The params of the message to receive & return to the Dapp .
2020-11-10 18:30:41 +01:00
* @ returns { Promise < Object > } A full state update .
2020-11-03 00:41:28 +01:00
* /
async encryptionPublicKey ( msgParams ) {
2021-02-04 19:15:23 +01:00
log . info ( 'MetaMaskController - encryptionPublicKey' ) ;
const msgId = msgParams . metamaskId ;
2020-02-19 19:24:16 +01:00
// sets the status op the message to 'approved'
// and removes the metamaskId for decryption
try {
2020-11-03 00:41:28 +01:00
const params = await this . encryptionPublicKeyManager . approveMessage (
msgParams ,
2021-02-04 19:15:23 +01:00
) ;
2020-02-19 19:24:16 +01:00
// EncryptionPublicKey message
2020-11-03 00:41:28 +01:00
const publicKey = await this . keyringController . getEncryptionPublicKey (
params . data ,
2021-02-04 19:15:23 +01:00
) ;
2020-02-19 19:24:16 +01:00
// tells the listener that the message has been processed
// and can be returned to the dapp
2021-02-04 19:15:23 +01:00
this . encryptionPublicKeyManager . setMsgStatusReceived ( msgId , publicKey ) ;
2020-02-19 19:24:16 +01:00
} catch ( error ) {
2021-02-04 19:15:23 +01:00
log . info (
'MetaMaskController - eth_getEncryptionPublicKey failed.' ,
error ,
) ;
this . encryptionPublicKeyManager . errorMessage ( msgId , error ) ;
2020-02-19 19:24:16 +01:00
}
2021-02-04 19:15:23 +01:00
return this . getState ( ) ;
2020-02-19 19:24:16 +01:00
}
/ * *
* Used to cancel a eth _getEncryptionPublicKey type message .
2022-01-07 16:57:33 +01:00
*
2020-02-19 19:24:16 +01:00
* @ param { string } msgId - The ID of the message to cancel .
* /
2021-12-08 22:36:53 +01:00
cancelEncryptionPublicKey ( msgId ) {
2021-02-04 19:15:23 +01:00
const messageManager = this . encryptionPublicKeyManager ;
messageManager . rejectMsg ( msgId ) ;
2021-12-08 22:36:53 +01:00
return this . getState ( ) ;
2020-02-19 19:24:16 +01:00
}
2018-04-19 02:54:50 +02:00
// eth_signTypedData methods
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Called when a dapp uses the eth _signTypedData method , per EIP 712.
*
* @ param { Object } msgParams - The params passed to eth _signTypedData .
2022-01-07 16:57:33 +01:00
* @ param { Object } [ req ] - The original request , containing the origin .
* @ param version
2018-04-19 02:54:50 +02:00
* /
2020-11-03 00:41:28 +01:00
newUnsignedTypedMessage ( msgParams , req , version ) {
const promise = this . typedMessageManager . addUnapprovedMessageAsync (
msgParams ,
req ,
version ,
2021-02-04 19:15:23 +01:00
) ;
this . sendUpdate ( ) ;
this . opts . showUserConfirmation ( ) ;
return promise ;
2018-04-19 02:54:50 +02:00
}
2018-03-15 23:27:10 +01:00
/ * *
2018-04-19 02:54:50 +02:00
* The method for a user approving a call to eth _signTypedData , per EIP 712.
* Triggers the callback in newUnsignedTypedMessage .
*
2020-11-10 18:30:41 +01:00
* @ param { Object } msgParams - The params passed to eth _signTypedData .
* @ returns { Object } Full state update .
2018-03-15 23:27:10 +01:00
* /
2020-11-03 00:41:28 +01:00
async signTypedMessage ( msgParams ) {
2021-02-04 19:15:23 +01:00
log . info ( 'MetaMaskController - eth_signTypedData' ) ;
const msgId = msgParams . metamaskId ;
const { version } = msgParams ;
2018-09-10 23:11:57 +02:00
try {
2020-11-03 00:41:28 +01:00
const cleanMsgParams = await this . typedMessageManager . approveMessage (
msgParams ,
2021-02-04 19:15:23 +01:00
) ;
2019-10-22 20:33:49 +02:00
2019-10-22 23:53:25 +02:00
// For some reason every version after V1 used stringified params.
2019-10-22 20:33:49 +02:00
if ( version !== 'V1' ) {
2019-10-22 23:53:25 +02:00
// But we don't have to require that. We can stop suggesting it now:
if ( typeof cleanMsgParams . data === 'string' ) {
2021-02-04 19:15:23 +01:00
cleanMsgParams . data = JSON . parse ( cleanMsgParams . data ) ;
2019-10-22 23:53:25 +02:00
}
2018-09-10 23:11:57 +02:00
}
2019-10-22 20:33:49 +02:00
2020-11-03 00:41:28 +01:00
const signature = await this . keyringController . signTypedMessage (
cleanMsgParams ,
{ version } ,
2021-02-04 19:15:23 +01:00
) ;
this . typedMessageManager . setMsgStatusSigned ( msgId , signature ) ;
return this . getState ( ) ;
2018-09-10 23:11:57 +02:00
} catch ( error ) {
2021-02-04 19:15:23 +01:00
log . info ( 'MetaMaskController - eth_signTypedData failed.' , error ) ;
this . typedMessageManager . errorMessage ( msgId , error ) ;
throw error ;
2018-09-10 23:11:57 +02:00
}
2017-09-29 18:24:08 +02:00
}
2018-03-28 03:07:51 +02:00
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Used to cancel a eth _signTypedData type message .
2022-01-07 16:57:33 +01:00
*
2018-04-20 18:26:24 +02:00
* @ param { string } msgId - The ID of the message to cancel .
2018-04-19 02:54:50 +02:00
* /
2021-12-08 22:36:53 +01:00
cancelTypedMessage ( msgId ) {
2021-02-04 19:15:23 +01:00
const messageManager = this . typedMessageManager ;
messageManager . rejectMsg ( msgId ) ;
2021-12-08 22:36:53 +01:00
return this . getState ( ) ;
2018-04-19 02:54:50 +02:00
}
2021-06-28 19:29:08 +02:00
/ * *
* @ returns { boolean } true if the keyring type supports EIP - 1559
* /
2021-12-09 03:46:54 +01:00
async getCurrentAccountEIP1559Compatibility ( ) {
2021-11-30 15:28:28 +01:00
return true ;
2021-06-28 19:29:08 +02:00
}
2019-07-31 22:17:11 +02:00
//=============================================================================
// END (VAULT / KEYRING RELATED METHODS)
//=============================================================================
2018-03-16 01:29:53 +01:00
2018-09-09 19:07:23 +02:00
/ * *
2021-07-08 20:48:23 +02:00
* Allows a user to attempt to cancel a previously submitted transaction
* by creating a new transaction .
2022-01-07 16:57:33 +01:00
*
2021-07-08 20:48:23 +02:00
* @ param { number } originalTxId - the id of the txMeta that you want to
* attempt to cancel
* @ param { import (
* './controllers/transactions'
* ) . CustomGasSettings } [ customGasSettings ] - overrides to use for gas params
* instead of allowing this method to generate them
2022-01-07 16:57:33 +01:00
* @ param newTxMetaProps
2020-11-10 18:30:41 +01:00
* @ returns { Object } MetaMask state
2018-09-09 19:07:23 +02:00
* /
2021-08-07 00:18:53 +02:00
async createCancelTransaction (
originalTxId ,
customGasSettings ,
newTxMetaProps ,
) {
2020-11-03 00:41:28 +01:00
await this . txController . createCancelTransaction (
originalTxId ,
2021-07-08 20:48:23 +02:00
customGasSettings ,
2021-08-07 00:18:53 +02:00
newTxMetaProps ,
2021-02-04 19:15:23 +01:00
) ;
const state = await this . getState ( ) ;
return state ;
2017-12-07 05:20:15 +01:00
}
2021-07-08 20:48:23 +02:00
/ * *
* Allows a user to attempt to speed up a previously submitted transaction
* by creating a new transaction .
2022-01-07 16:57:33 +01:00
*
2021-07-08 20:48:23 +02:00
* @ param { number } originalTxId - the id of the txMeta that you want to
* attempt to speed up
* @ param { import (
* './controllers/transactions'
* ) . CustomGasSettings } [ customGasSettings ] - overrides to use for gas params
* instead of allowing this method to generate them
2022-01-07 16:57:33 +01:00
* @ param newTxMetaProps
2021-07-08 20:48:23 +02:00
* @ returns { Object } MetaMask state
* /
2021-08-07 00:18:53 +02:00
async createSpeedUpTransaction (
originalTxId ,
customGasSettings ,
newTxMetaProps ,
) {
2020-11-03 00:41:28 +01:00
await this . txController . createSpeedUpTransaction (
originalTxId ,
2021-07-08 20:48:23 +02:00
customGasSettings ,
2021-08-07 00:18:53 +02:00
newTxMetaProps ,
2021-02-04 19:15:23 +01:00
) ;
const state = await this . getState ( ) ;
return state ;
2018-10-26 06:42:59 +02:00
}
2020-11-03 00:41:28 +01:00
estimateGas ( estimateGasParams ) {
2018-05-23 18:43:25 +02:00
return new Promise ( ( resolve , reject ) => {
2020-11-03 00:41:28 +01:00
return this . txController . txGasUtil . query . estimateGas (
estimateGasParams ,
( err , res ) => {
if ( err ) {
2021-02-04 19:15:23 +01:00
return reject ( err ) ;
2020-11-03 00:41:28 +01:00
}
2018-05-23 18:43:25 +02:00
2021-06-10 02:48:05 +02:00
return resolve ( res . toString ( 16 ) ) ;
2020-11-03 00:41:28 +01:00
} ,
2021-02-04 19:15:23 +01:00
) ;
} ) ;
2018-05-23 18:43:25 +02:00
}
2019-07-31 22:17:11 +02:00
//=============================================================================
// PASSWORD MANAGEMENT
//=============================================================================
2017-01-27 07:30:12 +01:00
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Allows a user to begin the seed phrase recovery process .
* /
2021-12-08 22:36:53 +01:00
markPasswordForgotten ( ) {
2021-02-04 19:15:23 +01:00
this . preferencesController . setPasswordForgotten ( true ) ;
this . sendUpdate ( ) ;
2018-02-08 01:38:55 +01:00
}
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Allows a user to end the seed phrase recovery process .
* /
2021-12-08 22:36:53 +01:00
unMarkPasswordForgotten ( ) {
2021-02-04 19:15:23 +01:00
this . preferencesController . setPasswordForgotten ( false ) ;
this . sendUpdate ( ) ;
2018-02-08 01:38:55 +01:00
}
2019-07-31 22:17:11 +02:00
//=============================================================================
// SETUP
//=============================================================================
2017-01-28 04:35:03 +01:00
2019-12-20 16:32:31 +01:00
/ * *
* A runtime . MessageSender object , as provided by the browser :
2022-01-07 16:57:33 +01:00
*
2019-12-20 16:32:31 +01:00
* @ see https : //developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/runtime/MessageSender
* @ typedef { Object } MessageSender
2022-01-07 16:57:33 +01:00
* @ property { string } - The URL of the page or frame hosting the script that sent the message .
2019-12-20 16:32:31 +01:00
* /
2022-02-15 01:02:51 +01:00
/ * *
* A Snap sender object .
*
* @ typedef { Object } SnapSender
* @ property { string } snapId - The ID of the snap .
* /
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Used to create a multiplexed stream for connecting to an untrusted context
* like a Dapp or other extension .
2022-01-07 16:57:33 +01:00
*
2022-01-28 22:42:32 +01:00
* @ param options - Options bag .
* @ param { ReadableStream } options . connectionStream - The Duplex stream to connect to .
* @ param { MessageSender | SnapSender } options . sender - The sender of the messages on this stream .
* @ param { string } [ options . subjectType ] - The type of the sender , i . e . subject .
2018-04-19 02:54:50 +02:00
* /
2022-01-28 22:42:32 +01:00
setupUntrustedCommunication ( { connectionStream , sender , subjectType } ) {
2021-02-04 19:15:23 +01:00
const { usePhishDetect } = this . preferencesController . store . getState ( ) ;
2022-02-15 01:02:51 +01:00
2022-01-28 22:42:32 +01:00
let _subjectType ;
if ( subjectType ) {
_subjectType = subjectType ;
} else if ( sender . id && sender . id !== this . extension . runtime . id ) {
_subjectType = SUBJECT _TYPES . EXTENSION ;
} else {
_subjectType = SUBJECT _TYPES . WEBSITE ;
}
if ( sender . url ) {
const { hostname } = new URL ( sender . url ) ;
// Check if new connection is blocked if phishing detection is on
if ( usePhishDetect && this . phishingController . test ( hostname ) ) {
log . debug ( 'MetaMask - sending phishing warning for' , hostname ) ;
this . sendPhishingWarning ( connectionStream , hostname ) ;
return ;
}
2016-06-24 22:05:21 +02:00
}
2018-03-16 17:37:56 +01:00
// setup multiplexing
2021-02-04 19:15:23 +01:00
const mux = setupMultiplex ( connectionStream ) ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
// messages between inpage and background
2022-01-28 22:42:32 +01:00
this . setupProviderConnection (
mux . createStream ( 'metamask-provider' ) ,
sender ,
_subjectType ,
) ;
2021-01-13 02:43:45 +01:00
// TODO:LegacyProvider: Delete
2022-01-28 22:42:32 +01:00
if ( sender . url ) {
// legacy streams
this . setupPublicConfig ( mux . createStream ( 'publicConfig' ) ) ;
}
2016-06-24 22:05:21 +02:00
}
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Used to create a multiplexed stream for connecting to a trusted context ,
* like our own user interfaces , which have the provider APIs , but also
* receive the exported API from this controller , which includes trusted
* functions , like the ability to approve transactions or sign messages .
*
* @ param { * } connectionStream - The duplex stream to connect to .
2019-12-20 16:32:31 +01:00
* @ param { MessageSender } sender - The sender of the messages on this stream
2018-04-19 02:54:50 +02:00
* /
2020-11-03 00:41:28 +01:00
setupTrustedCommunication ( connectionStream , sender ) {
2018-03-16 17:37:56 +01:00
// setup multiplexing
2021-02-04 19:15:23 +01:00
const mux = setupMultiplex ( connectionStream ) ;
2018-03-16 17:37:56 +01:00
// connect features
2021-02-04 19:15:23 +01:00
this . setupControllerConnection ( mux . createStream ( 'controller' ) ) ;
2022-01-28 22:42:32 +01:00
this . setupProviderConnection (
mux . createStream ( 'provider' ) ,
sender ,
SUBJECT _TYPES . INTERNAL ,
) ;
2018-03-16 17:37:56 +01:00
}
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* Called when we detect a suspicious domain . Requests the browser redirects
* to our anti - phishing page .
*
* @ private
* @ param { * } connectionStream - The duplex stream to the per - page script ,
* for sending the reload attempt to .
2020-06-02 01:24:27 +02:00
* @ param { string } hostname - The hostname that triggered the suspicion .
2018-04-19 02:54:50 +02:00
* /
2020-11-03 00:41:28 +01:00
sendPhishingWarning ( connectionStream , hostname ) {
2021-02-04 19:15:23 +01:00
const mux = setupMultiplex ( connectionStream ) ;
const phishingStream = mux . createStream ( 'phishing' ) ;
phishingStream . write ( { hostname } ) ;
2018-03-16 17:37:56 +01:00
}
2018-04-20 18:26:24 +02:00
/ * *
2021-03-18 19:23:46 +01:00
* A method for providing our API over a stream using JSON - RPC .
2022-01-07 16:57:33 +01:00
*
2018-04-19 02:54:50 +02:00
* @ param { * } outStream - The stream to provide our API over .
* /
2020-11-03 00:41:28 +01:00
setupControllerConnection ( outStream ) {
2021-02-04 19:15:23 +01:00
const api = this . getApi ( ) ;
2021-03-18 19:23:46 +01:00
2018-08-22 01:30:11 +02:00
// report new active controller connection
2021-02-04 19:15:23 +01:00
this . activeControllerConnections += 1 ;
this . emit ( 'controllerConnectionChanged' , this . activeControllerConnections ) ;
2021-03-18 19:23:46 +01:00
// set up postStream transport
outStream . on ( 'data' , createMetaRPCHandler ( api , outStream ) ) ;
const handleUpdate = ( update ) => {
2021-05-13 00:12:46 +02:00
if ( outStream . _writableState . ended ) {
return ;
}
2021-03-18 19:23:46 +01:00
// send notification to client-side
outStream . write ( {
jsonrpc : '2.0' ,
method : 'sendUpdate' ,
params : [ update ] ,
} ) ;
} ;
this . on ( 'update' , handleUpdate ) ;
outStream . on ( 'end' , ( ) => {
2021-02-04 19:15:23 +01:00
this . activeControllerConnections -= 1 ;
this . emit (
'controllerConnectionChanged' ,
this . activeControllerConnections ,
) ;
2021-03-18 19:23:46 +01:00
this . removeListener ( 'update' , handleUpdate ) ;
2021-02-04 19:15:23 +01:00
} ) ;
2017-01-28 04:35:03 +01:00
}
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* A method for serving our ethereum provider over a given stream .
2022-01-07 16:57:33 +01:00
*
2018-04-19 02:54:50 +02:00
* @ param { * } outStream - The stream to provide over .
2022-02-15 01:02:51 +01:00
* @ param { MessageSender | SnapSender } sender - The sender of the messages on this stream
2022-01-28 22:42:32 +01:00
* @ param { string } subjectType - The type of the sender , i . e . subject .
2018-04-19 02:54:50 +02:00
* /
2022-01-28 22:42:32 +01:00
setupProviderConnection ( outStream , sender , subjectType ) {
let origin ;
if ( subjectType === SUBJECT _TYPES . INTERNAL ) {
2022-04-26 19:07:39 +02:00
origin = ORIGIN _METAMASK ;
2022-02-15 01:02:51 +01:00
}
///: BEGIN:ONLY_INCLUDE_IN(flask)
else if ( subjectType === SUBJECT _TYPES . SNAP ) {
origin = sender . snapId ;
}
///: END:ONLY_INCLUDE_IN
else {
2022-01-28 22:42:32 +01:00
origin = new URL ( sender . url ) . origin ;
}
if ( sender . id && sender . id !== this . extension . runtime . id ) {
this . subjectMetadataController . addSubjectMetadata ( {
origin ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
extensionId : sender . id ,
2021-12-13 21:10:20 +01:00
subjectType : SUBJECT _TYPES . EXTENSION ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
} ) ;
2019-12-20 16:32:31 +01:00
}
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
2021-02-04 19:15:23 +01:00
let tabId ;
2019-12-20 16:32:31 +01:00
if ( sender . tab && sender . tab . id ) {
2021-02-04 19:15:23 +01:00
tabId = sender . tab . id ;
2019-12-20 16:32:31 +01:00
}
2020-11-03 00:41:28 +01:00
const engine = this . setupProviderEngine ( {
origin ,
2022-01-28 22:42:32 +01:00
sender ,
2021-12-09 00:37:29 +01:00
subjectType ,
2022-02-15 01:02:51 +01:00
tabId ,
2021-02-04 19:15:23 +01:00
} ) ;
2019-07-16 01:28:04 +02:00
// setup connection
2021-02-04 19:15:23 +01:00
const providerStream = createEngineStream ( { engine } ) ;
2019-07-16 01:28:04 +02:00
2021-02-04 19:15:23 +01:00
const connectionId = this . addConnection ( origin , { engine } ) ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
2020-11-03 00:41:28 +01:00
pump ( outStream , providerStream , outStream , ( err ) => {
// handle any middleware cleanup
engine . _middleware . forEach ( ( mid ) => {
if ( mid . destroy && typeof mid . destroy === 'function' ) {
2021-02-04 19:15:23 +01:00
mid . destroy ( ) ;
2019-11-20 01:03:20 +01:00
}
2021-02-04 19:15:23 +01:00
} ) ;
connectionId && this . removeConnection ( origin , connectionId ) ;
2020-11-03 00:41:28 +01:00
if ( err ) {
2021-02-04 19:15:23 +01:00
log . error ( err ) ;
2020-11-03 00:41:28 +01:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2019-07-16 01:28:04 +02:00
}
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
/ * *
* For snaps running in workers .
*
* @ param snapId
* @ param connectionStream
* /
setupSnapProvider ( snapId , connectionStream ) {
this . setupUntrustedCommunication ( {
connectionStream ,
sender : { snapId } ,
subjectType : SUBJECT _TYPES . SNAP ,
} ) ;
}
///: END:ONLY_INCLUDE_IN
2019-07-16 01:28:04 +02:00
/ * *
2021-12-09 00:37:29 +01:00
* A method for creating a provider that is safely restricted for the requesting subject .
*
2019-12-20 16:32:31 +01:00
* @ param { Object } options - Provider engine options
2020-06-02 01:24:27 +02:00
* @ param { string } options . origin - The origin of the sender
2022-01-28 22:42:32 +01:00
* @ param { MessageSender | SnapSender } options . sender - The sender object .
2021-12-09 00:37:29 +01:00
* @ param { string } options . subjectType - The type of the sender subject .
2019-12-20 16:32:31 +01:00
* @ param { tabId } [ options . tabId ] - The tab ID of the sender - if the sender is within a tab
2022-01-07 16:57:33 +01:00
* /
2022-01-28 22:42:32 +01:00
setupProviderEngine ( { origin , subjectType , sender , tabId } ) {
2018-03-16 17:37:56 +01:00
// setup json rpc engine stack
2021-02-04 19:15:23 +01:00
const engine = new JsonRpcEngine ( ) ;
2022-01-28 22:42:32 +01:00
const { blockTracker , provider } = this ;
2018-03-16 17:37:56 +01:00
// create filter polyfill middleware
2021-02-04 19:15:23 +01:00
const filterMiddleware = createFilterMiddleware ( { provider , blockTracker } ) ;
2019-07-16 01:28:04 +02:00
2018-10-08 17:55:07 +02:00
// create subscription polyfill middleware
2020-11-03 00:41:28 +01:00
const subscriptionManager = createSubscriptionManager ( {
provider ,
blockTracker ,
2021-02-04 19:15:23 +01:00
} ) ;
2020-11-03 00:41:28 +01:00
subscriptionManager . events . on ( 'notification' , ( message ) =>
engine . emit ( 'notification' , message ) ,
2021-02-04 19:15:23 +01:00
) ;
2018-03-16 17:37:56 +01:00
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
// append origin to each request
2021-02-04 19:15:23 +01:00
engine . push ( createOriginMiddleware ( { origin } ) ) ;
2022-02-15 01:02:51 +01:00
2020-02-20 23:39:00 +01:00
// append tabId to each request if it exists
if ( tabId ) {
2021-02-04 19:15:23 +01:00
engine . push ( createTabIdMiddleware ( { tabId } ) ) ;
2020-02-20 23:39:00 +01:00
}
2022-02-15 01:02:51 +01:00
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
// logging
2021-02-04 19:15:23 +01:00
engine . push ( createLoggerMiddleware ( { origin } ) ) ;
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
engine . push ( this . permissionLogController . createMiddleware ( ) ) ;
2022-02-15 01:02:51 +01:00
2022-04-04 21:26:13 +02:00
engine . push (
createRPCMethodTrackingMiddleware ( {
trackEvent : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
) ,
getMetricsState : this . metaMetricsController . store . getState . bind (
this . metaMetricsController . store ,
) ,
} ) ,
) ;
2022-01-28 22:42:32 +01:00
// onboarding
if ( subjectType === SUBJECT _TYPES . WEBSITE ) {
engine . push (
createOnboardingMiddleware ( {
location : sender . url ,
registerOnboarding : this . onboardingController . registerOnboarding ,
} ) ,
) ;
}
2022-02-15 01:02:51 +01:00
// Unrestricted/permissionless RPC method implementations
2020-11-03 00:41:28 +01:00
engine . push (
createMethodMiddleware ( {
origin ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
2021-12-09 00:37:29 +01:00
subjectType ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
// Miscellaneous
addSubjectMetadata : this . subjectMetadataController . addSubjectMetadata . bind (
this . subjectMetadataController ,
) ,
2020-12-08 20:48:47 +01:00
getProviderState : this . getProviderState . bind ( this ) ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
getUnlockPromise : this . appStateController . getUnlockPromise . bind (
this . appStateController ,
2020-12-08 17:10:55 +01:00
) ,
2021-09-10 19:37:19 +02:00
handleWatchAssetRequest : this . tokensController . watchAsset . bind (
this . tokensController ,
2020-12-02 17:49:49 +01:00
) ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
requestUserApproval : this . approvalController . addAndShowApprovalRequest . bind (
this . approvalController ,
2020-12-11 00:40:29 +01:00
) ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
sendMetrics : this . metaMetricsController . trackEvent . bind (
this . metaMetricsController ,
2020-12-11 00:40:29 +01:00
) ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
// Permission-related
getAccounts : this . getPermittedAccounts . bind ( this , origin ) ,
getPermissionsForOrigin : this . permissionController . getPermissions . bind (
this . permissionController ,
origin ,
2021-02-23 19:33:33 +01:00
) ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
hasPermission : this . permissionController . hasPermission . bind (
this . permissionController ,
origin ,
2021-02-12 16:25:58 +01:00
) ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
requestAccountsPermission : this . permissionController . requestPermissions . bind (
this . permissionController ,
{ origin } ,
{ eth _accounts : { } } ,
2021-06-10 00:18:38 +02:00
) ,
2022-01-04 21:57:18 +01:00
requestPermissionsForOrigin : this . permissionController . requestPermissions . bind (
this . permissionController ,
{ origin } ,
) ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
// Custom RPC-related
2021-02-12 16:25:58 +01:00
addCustomRpc : async ( {
chainId ,
blockExplorerUrl ,
ticker ,
chainName ,
rpcUrl ,
} = { } ) => {
await this . preferencesController . addToFrequentRpcList (
rpcUrl ,
chainId ,
ticker ,
chainName ,
{
blockExplorerUrl ,
} ,
) ;
} ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
findCustomRpcBy : this . findCustomRpcBy . bind ( this ) ,
getCurrentChainId : this . networkController . getCurrentChainId . bind (
this . networkController ,
) ,
setProviderType : this . networkController . setProviderType . bind (
this . networkController ,
) ,
updateRpcTarget : ( { rpcUrl , chainId , ticker , nickname } ) => {
this . networkController . setRpcTarget (
rpcUrl ,
chainId ,
ticker ,
nickname ,
) ;
} ,
// Web3 shim-related
getWeb3ShimUsageState : this . alertController . getWeb3ShimUsageState . bind (
this . alertController ,
) ,
setWeb3ShimUsageRecorded : this . alertController . setWeb3ShimUsageRecorded . bind (
this . alertController ,
) ,
2020-11-03 00:41:28 +01:00
} ) ,
2021-02-04 19:15:23 +01:00
) ;
2022-02-15 01:02:51 +01:00
///: BEGIN:ONLY_INCLUDE_IN(flask)
engine . push (
createSnapMethodMiddleware ( subjectType === SUBJECT _TYPES . SNAP , {
getAppKey : this . getAppKeyForSubject . bind ( this , origin ) ,
getSnaps : this . snapController . getPermittedSnaps . bind (
this . snapController ,
origin ,
) ,
requestPermissions : async ( requestedPermissions ) => {
const [
approvedPermissions ,
] = await this . permissionController . requestPermissions (
{ origin } ,
requestedPermissions ,
) ;
return Object . values ( approvedPermissions ) ;
} ,
2022-04-28 18:17:28 +02:00
getPermissions : this . permissionController . getPermissions . bind (
this . permissionController ,
origin ,
) ,
2022-02-15 01:02:51 +01:00
getAccounts : this . getPermittedAccounts . bind ( this , origin ) ,
installSnaps : this . snapController . installSnaps . bind (
this . snapController ,
origin ,
) ,
} ) ,
) ;
///: END:ONLY_INCLUDE_IN
2018-10-08 17:55:07 +02:00
// filter and subscription polyfills
2021-02-04 19:15:23 +01:00
engine . push ( filterMiddleware ) ;
engine . push ( subscriptionManager . middleware ) ;
2021-12-09 00:37:29 +01:00
if ( subjectType !== SUBJECT _TYPES . INTERNAL ) {
2020-05-29 19:53:31 +02:00
// permissions
2020-11-03 00:41:28 +01:00
engine . push (
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
this . permissionController . createPermissionMiddleware ( {
origin ,
} ) ,
2021-02-04 19:15:23 +01:00
) ;
2020-05-29 19:53:31 +02:00
}
2022-02-15 01:02:51 +01:00
2018-10-08 17:55:07 +02:00
// forward to metamask primary provider
2021-02-04 19:15:23 +01:00
engine . push ( providerAsMiddleware ( provider ) ) ;
return engine ;
2018-03-16 17:37:56 +01:00
}
2021-01-13 02:43:45 +01:00
/ * *
* TODO : LegacyProvider : Delete
* A method for providing our public config info over a stream .
* This includes info we like to be synchronous if possible , like
* the current selected account , and network ID .
*
* Since synchronous methods have been deprecated in web3 ,
* this is a good candidate for deprecation .
*
* @ param { * } outStream - The stream to provide public config over .
* /
setupPublicConfig ( outStream ) {
2021-02-04 19:15:23 +01:00
const configStream = storeAsStream ( this . publicConfigStore ) ;
2021-01-13 02:43:45 +01:00
pump ( configStream , outStream , ( err ) => {
2021-02-04 19:15:23 +01:00
configStream . destroy ( ) ;
2021-01-13 02:43:45 +01:00
if ( err ) {
2021-02-04 19:15:23 +01:00
log . error ( err ) ;
2021-01-13 02:43:45 +01:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2021-01-13 02:43:45 +01:00
}
2019-05-03 19:32:05 +02:00
/ * *
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
* Adds a reference to a connection by origin . Ignores the 'metamask' origin .
* Caller must ensure that the returned id is stored such that the reference
* can be deleted later .
2019-05-03 19:32:05 +02:00
*
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
* @ param { string } origin - The connection ' s origin string .
* @ param { Object } options - Data associated with the connection
* @ param { Object } options . engine - The connection ' s JSON Rpc Engine
2020-11-10 18:30:41 +01:00
* @ returns { string } The connection ' s id ( so that it can be deleted later )
2019-05-03 19:32:05 +02:00
* /
2020-11-03 00:41:28 +01:00
addConnection ( origin , { engine } ) {
2022-04-26 19:07:39 +02:00
if ( origin === ORIGIN _METAMASK ) {
2021-02-04 19:15:23 +01:00
return null ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
}
2019-05-03 19:32:05 +02:00
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
if ( ! this . connections [ origin ] ) {
2021-02-04 19:15:23 +01:00
this . connections [ origin ] = { } ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
}
2019-05-03 19:32:05 +02:00
2021-02-04 19:15:23 +01:00
const id = nanoid ( ) ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
this . connections [ origin ] [ id ] = {
engine ,
2021-02-04 19:15:23 +01:00
} ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
2021-02-04 19:15:23 +01:00
return id ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
}
/ * *
* Deletes a reference to a connection , by origin and id .
* Ignores unknown origins .
*
* @ param { string } origin - The connection ' s origin string .
* @ param { string } id - The connection ' s id , as returned from addConnection .
* /
2020-11-03 00:41:28 +01:00
removeConnection ( origin , id ) {
2021-02-04 19:15:23 +01:00
const connections = this . connections [ origin ] ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
if ( ! connections ) {
2021-02-04 19:15:23 +01:00
return ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
}
2021-02-04 19:15:23 +01:00
delete connections [ id ] ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
2020-08-04 22:02:48 +02:00
if ( Object . keys ( connections ) . length === 0 ) {
2021-02-04 19:15:23 +01:00
delete this . connections [ origin ] ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
}
}
2022-02-15 01:02:51 +01:00
/ * *
* Closes all connections for the given origin , and removes the references
* to them .
* Ignores unknown origins .
*
* @ param { string } origin - The origin string .
* /
removeAllConnections ( origin ) {
const connections = this . connections [ origin ] ;
if ( ! connections ) {
return ;
}
Object . keys ( connections ) . forEach ( ( id ) => {
this . removeConnection ( origin , id ) ;
} ) ;
}
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
/ * *
* Causes the RPC engines associated with the connections to the given origin
* to emit a notification event with the given payload .
2020-12-08 20:48:47 +01:00
*
* The caller is responsible for ensuring that only permitted notifications
* are sent .
*
* Ignores unknown origins .
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
*
* @ param { string } origin - The connection ' s origin string .
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
* @ param { unknown } payload - The event payload .
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
* /
2020-11-03 00:41:28 +01:00
notifyConnections ( origin , payload ) {
2021-02-04 19:15:23 +01:00
const connections = this . connections [ origin ] ;
2019-05-03 19:32:05 +02:00
2020-12-08 20:48:47 +01:00
if ( connections ) {
Object . values ( connections ) . forEach ( ( conn ) => {
if ( conn . engine ) {
2021-02-04 19:15:23 +01:00
conn . engine . emit ( 'notification' , payload ) ;
2020-12-08 20:48:47 +01:00
}
2021-02-04 19:15:23 +01:00
} ) ;
2020-12-08 20:48:47 +01:00
}
2019-05-03 19:32:05 +02:00
}
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
/ * *
* Causes the RPC engines associated with all connections to emit a
* notification event with the given payload .
*
2020-12-08 20:48:47 +01:00
* If the "payload" parameter is a function , the payload for each connection
* will be the return value of that function called with the connection ' s
* origin .
*
* The caller is responsible for ensuring that only permitted notifications
* are sent .
*
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
* @ param { unknown } payload - The event payload , or payload getter function .
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
* /
2020-11-03 00:41:28 +01:00
notifyAllConnections ( payload ) {
2020-12-08 20:48:47 +01:00
const getPayload =
typeof payload === 'function'
? ( origin ) => payload ( origin )
2021-02-04 19:15:23 +01:00
: ( ) => payload ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
2021-10-14 19:50:07 +02:00
Object . keys ( this . connections ) . forEach ( ( origin ) => {
Object . values ( this . connections [ origin ] ) . forEach ( async ( conn ) => {
2020-12-08 20:48:47 +01:00
if ( conn . engine ) {
2021-10-14 19:50:07 +02:00
conn . engine . emit ( 'notification' , await getPayload ( origin ) ) ;
2020-12-08 20:48:47 +01:00
}
2021-02-04 19:15:23 +01:00
} ) ;
} ) ;
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
}
// handlers
2018-04-20 18:26:24 +02:00
/ * *
2018-08-16 17:29:39 +02:00
* Handle a KeyringController update
2022-01-07 16:57:33 +01:00
*
2020-01-13 19:36:36 +01:00
* @ param { Object } state - the KC state
* @ returns { Promise < void > }
2018-08-16 17:29:39 +02:00
* @ private
* /
2020-11-03 00:41:28 +01:00
async _onKeyringControllerUpdate ( state ) {
2021-02-04 19:15:23 +01:00
const { keyrings } = state ;
2020-11-03 00:41:28 +01:00
const addresses = keyrings . reduce (
( acc , { accounts } ) => acc . concat ( accounts ) ,
[ ] ,
2021-02-04 19:15:23 +01:00
) ;
2018-08-16 17:29:39 +02:00
if ( ! addresses . length ) {
2021-02-04 19:15:23 +01:00
return ;
2018-08-16 17:29:39 +02:00
}
// Ensure preferences + identities controller know about all addresses
2021-02-04 19:15:23 +01:00
this . preferencesController . syncAddresses ( addresses ) ;
this . accountTracker . syncWithAddresses ( addresses ) ;
2018-08-16 17:29:39 +02:00
}
2020-12-08 20:48:47 +01:00
/ * *
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
* Handle global application unlock .
* Notifies all connections that the extension is unlocked , and which
* account ( s ) are currently accessible , if any .
2020-12-08 20:48:47 +01:00
* /
_onUnlock ( ) {
2021-10-14 19:50:07 +02:00
this . notifyAllConnections ( async ( origin ) => {
2020-12-08 20:48:47 +01:00
return {
method : NOTIFICATION _NAMES . unlockStateChanged ,
params : {
isUnlocked : true ,
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
accounts : await this . getPermittedAccounts ( origin ) ,
2020-12-08 20:48:47 +01:00
} ,
2021-02-04 19:15:23 +01:00
} ;
} ) ;
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
// In the current implementation, this handler is triggered by a
// KeyringController event. Other controllers subscribe to the 'unlock'
// event of the MetaMaskController itself.
2021-02-04 19:15:23 +01:00
this . emit ( 'unlock' ) ;
2020-12-08 20:48:47 +01:00
}
/ * *
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
* Handle global application lock .
2020-12-08 20:48:47 +01:00
* Notifies all connections that the extension is locked .
* /
_onLock ( ) {
this . notifyAllConnections ( {
method : NOTIFICATION _NAMES . unlockStateChanged ,
params : {
isUnlocked : false ,
} ,
2021-02-04 19:15:23 +01:00
} ) ;
Permission System 2.0 (#12243)
# Permission System 2.0
## Background
This PR migrates the extension permission system to [the new `PermissionController`](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions).
The original permission system, based on [`rpc-cap`](https://github.com/MetaMask/rpc-cap), introduced [`ZCAP-LD`](https://w3c-ccg.github.io/zcap-ld/)-like permissions to our JSON-RPC stack.
We used it to [implement](https://github.com/MetaMask/metamask-extension/pull/7004) what we called "LoginPerSite" in [version 7.7.0](https://github.com/MetaMask/metamask-extension/releases/tag/v7.7.0) of the extension, which enabled the user to choose which accounts, if any, should be exposed to each dapp.
While that was a worthwhile feature in and of itself, we wanted a permission _system_ in order to enable everything we are going to with Snaps.
Unfortunately, the original permission system was difficult to use, and necessitated the creation of the original `PermissionsController` (note the "s"), which was more or less a wrapper for `rpc-cap`.
With this PR, we shake off the yoke of the original permission system, in favor of the modular, self-contained, ergonomic, and more mature permission system 2.0.
Note that [the `PermissionController` readme](https://github.com/MetaMask/snaps-skunkworks/tree/main/packages/controllers/src/permissions/README.md) explains how the new permission system works.
The `PermissionController` and `SubjectMetadataController` are currently shipped via `@metamask/snap-controllers`. This is a temporary state of affairs, and we'll move them to `@metamask/controllers` once they've landed in prod.
## Changes in Detail
First, the changes in this PR are not as big as they seem. Roughly half of the additions in this PR are fixtures in the test for the new migration (number 68), and a significant portion of the remaining ~2500 lines are due to find-and-replace changes in other test fixtures and UI files.
- The extension `PermissionsController` has been deleted, and completely replaced with the new `PermissionController` from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The original `PermissionsController` "domain metadata" functionality is now managed by the new `SubjectMetadataController`, also from [`@metamask/snap-controllers`](https://www.npmjs.com/package/@metamask/snap-controllers).
- The permission activity and history log controller has been renamed `PermissionLogController` and has its own top-level state key, but is otherwise functionally equivalent to the existing implementation.
- Migration number 68 has been added to account for the new state changes.
- The tests in `app/scripts/controllers/permissions` have been migrated from `mocha` to `jest`.
Reviewers should focus their attention on the following files:
- `app/scripts/`
- `metamask-controller.js`
- This is where most of the integration work for the new `PermissionController` occurs.
Some functions that were internal to the original controller were moved here.
- `controllers/permissions/`
- `selectors.js`
- These selectors are for `ControllerMessenger` selector subscriptions. The actual subscriptions occur in `metamask-controller.js`. See the `ControllerMessenger` implementation for details.
- `specifications.js`
- The caveat and permission specifications are required by the new `PermissionController`, and are used to specify the `eth_accounts` permission and its JSON-RPC method implementation.
See the `PermissionController` readme for details.
- `migrations/068.js`
- The new state should be cross-referenced with the controllers that manage it.
The accompanying tests should also be thoroughly reviewed.
Some files may appear new but have just moved and/or been renamed:
- `app/scripts/lib/rpc-method-middleware/handlers/request-accounts.js`
- This was previously implemented in `controllers/permissions/permissionsMethodMiddleware.js`.
- `test/mocks/permissions.js`
- A truncated version of `test/mocks/permission-controller.js`.
Co-authored-by: Mark Stacey <markjstacey@gmail.com>
2021-12-07 04:16:49 +01:00
// In the current implementation, this handler is triggered by a
// KeyringController event. Other controllers subscribe to the 'lock'
// event of the MetaMaskController itself.
2021-02-04 19:15:23 +01:00
this . emit ( 'lock' ) ;
2020-12-08 20:48:47 +01:00
}
/ * *
* Handle memory state updates .
* - Ensure isClientOpenAndUnlocked is updated
* - Notifies all connections with the new provider network state
* - The external providers handle diffing the state
2022-01-07 16:57:33 +01:00
*
* @ param newState
2020-12-08 20:48:47 +01:00
* /
_onStateUpdate ( newState ) {
2021-02-04 19:15:23 +01:00
this . isClientOpenAndUnlocked = newState . isUnlocked && this . _isClientOpen ;
2020-12-08 20:48:47 +01:00
this . notifyAllConnections ( {
method : NOTIFICATION _NAMES . chainChanged ,
params : this . getProviderNetworkState ( newState ) ,
2021-02-04 19:15:23 +01:00
} ) ;
2020-12-08 20:48:47 +01:00
}
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
// misc
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* A method for emitting the full MetaMask state to all registered listeners .
2022-01-07 16:57:33 +01:00
*
2018-04-19 02:54:50 +02:00
* @ private
* /
2020-11-03 00:41:28 +01:00
privateSendUpdate ( ) {
2021-02-04 19:15:23 +01:00
this . emit ( 'update' , this . getState ( ) ) ;
2018-03-16 17:37:56 +01:00
}
2020-03-23 17:25:55 +01:00
/ * *
* @ returns { boolean } Whether the extension is unlocked .
* /
2020-11-03 00:41:28 +01:00
isUnlocked ( ) {
2021-02-04 19:15:23 +01:00
return this . keyringController . memStore . getState ( ) . isUnlocked ;
2020-03-23 17:25:55 +01:00
}
Connect distinct accounts per site (#7004)
* add PermissionsController
remove provider approval controller
integrate rpc-cap
create PermissionsController
move provider approval functionality to permissions controller
add permissions approval ui, settings page
add permissions activity and history
move some functionality to metamask-inpage-provider
rename siteMetadata -> domainMetadata
add accountsChange notification to inpage provider
move functionality to inpage provider
update inpage provider
Remove 'Connections' settings page (#7369)
add hooks for exposing accounts in settings
rename unused messages in non-English locales
Add external extension id to metadata (#7396)
update inpage provider, rpc-cap
add eth_requestAccounts handling to background
prevent notifying connections if extension is locked
update inpage provider
Fix lint errors
add migration
review fixes
transaction controller review updates
removed unused messages
* Login Per Site UI (#7368)
* LoginPerSite original UI changes to keep
* First commit
* Get necessary connected tab info for redirect and icon display for permissioned sites
* Fix up designs and add missing features
* Some lint fixes
* More lint fixes
* Ensures the tx controller + tx-state-manager orders transactions in the order they are received
* Code cleanup for LoginPerSite-ui
* Update e2e tests to use new connection flow
* Fix display of connect screen and app header after login when connect request present
* Update metamask-responsive-ui.spec for new item in accounts dropdown
* Fix approve container by replacing approvedOrigins with domainMetaData
* Adds test/e2e/permissions.spec.js
* Correctly handle cancellation of a permissions request
* Redirect to home after disconnecting all sites / cancelling all permissions
* Fix display of site icons in menu
* Fix height of permissions page container
* Remove unused locale messages
* Set default values for openExternalTabs and tabIdOrigins in account-menu.container
* More code cleanup for LoginPerSite-ui
* Use extensions api to close tab in permissions-connect
* Remove unnecessary change in domIsReady() in contentscript
* Remove unnecessary private function markers and class methods (for background tab info) in metamask-controller.
* Adds getOriginOfCurrentTab selector
* Adds IconWithFallback component and substitutes for appropriate cases
* Add and utilize font mixins
* Remove unused method in disconnect-all.container.js
* Simplify buttonSizeLarge code in page-container-footer.component.js
* Add and utilize getAccountsWithLabels selector
* Remove console.log in ui/app/store/actions.js
* Change last connected time format to yyyy-M-d
* Fix css associated with IconWithFallback change
* Ensure tracked openNonMetamaskTabsIDs are correctly set to inactive on tab changes
* Code cleanup for LoginPerSite-ui
* Use reusable function for modifying openNonMetamaskTabsIDs in background.js
* Enables automatic switching to connected account when connected domain is open
* Prevent exploit of tabIdOriginMap in background.js
* Remove unneeded code from contentscript.js
* Simplify current tab origin and window opener logic using remotePort listener tabs.queryTabs
* Design and styling fixes for LoginPerSite-ui
* Fix permissionHistory and permission logging for eth_requestAccounts and eth_accounts
* Front end changes to support display of lastConnected time in connected and permissions screens
* Fix lint errors
* Refactor structure of permissionsHistory
* Fix default values and object modifications for domain and permissionsHistory related data
* Fix connecting to new accounts from modal
* Replace retweet.svg with connect-white.svg
* Fix signature-request.spec
* Update metamask-inpage-provider version
* Fix permissions e2e tests
* Remove unneeded delay from test/e2e/signature-request.spec.js
* Add delay before attempting to retrieve network id in dapp in ethereum-on=.spec
* Use requestAccountTabIds strategy for determining tab id that opened a given window
* Improve default values for permissions requests
* Add some message descriptions to app/_locales/en/messages.json
* Code clean up in permission controller
* Stopped deep cloning object in mapObjectValues
* Bump metamask-inpage-provider version
* Add missing description in app/_locales/en/messages.json
* Return promises from queryTabs and switchToTab of extension.js
* Remove unused getAllPermissions function
* Use default props in icon-with-fallback.component.js
* Stop passing to permissions controller
* Delete no longer used clear-approved-origins modal code
* Remove duplicate imports in ui/app/components/app/index.scss
* Use URL instead of regex in getOriginFromUrl()
* Add runtime error checking to platform, promise based extension.tab methods
* Support permission requests from external extensions
* Improve font size and colour of the domain origin on the permission confirmation screen
* Add support for toggling permissions
* Ensure getRenderablePermissionsDomains only returns domains with exposedAccount caveat permissions
* Remove unused code from LoginPerSite-ui branch
* Ensure modal closes on Enter press for new-account-modal.component.js
* Lint fix
* fixup! Login Per Site UI (#7368)
* Some code cleanup for LoginPerSite
* Adds UX for connecting to dapps via the connected sites screen (#7593)
* Adds UX for connecting to dapps via the connected sites screen
* Use openMetaMaskTabIds from background.js to determine if current active tab is MetaMask
* Delete unused permissions controller methods
* Fixes two small bugs in the LoginPerSite ui (#7595)
* Restore `providerRequest` message translations (#7600)
This message was removed, but it was replaced with a very similar
message called `likeToConnect`. The only difference is that the new
message has "MetaMask" in it. Preserving these messages without
"MetaMask" is probably better than deleting them, so these messages
have all been restored and renamed to `likeToConnect`.
* Login per site no sitemetadata fix (#7610)
* Support connected sites for which we have no site metadata.
* Change property containing subtitle info often populated by origin to a more accurate of purpose name
* Lint fix
* Improve disconnection modal messages (#7612)
* Improve disconnectAccountModalDescription and disconnectAllModalDescription messages
* Update disconnectAccountModalDescription app/_locales/en/messages.json
Co-Authored-By: Mark Stacey <markjstacey@gmail.com>
* Improve disconnectAccount modal message clarity
* Adds cancel button to the account selection screen of the permissions request flow (#7613)
* Fix eth_accounts permission language & selectability (#7614)
* fix eth_accounts language & selectability
* fix MetaMask capitalization in all messages
* Close sidebar when opening connected sites (#7611)
The 'Connected Sites' button in the accounts details now closes the
sidebar, if it is open. This was accomplished by pulling the click
handler for that button up to the wallet view component, where another
button already followed a similar pattern of closing the sidebar.
It seemed confusing to me that one handler was in the `AccountsDetails`
container component, and one was handed down from above, so I added
PropTypes to the container component.
I'm not sure that the WalletView component is the best place for this
logic, but I've put it there for now to be consistent with the add
token button.
* Reject permissions request upon tab close (#7618)
Permissions requests are now rejected when the page is closed. This
only applies to the full-screen view, as that is the view permission
requests should be handled in. The case where the user deals with the
request through a different view is handled in #7617
* Handle tab update failure (#7619)
`extension.tabs.update` can sometimes fail if the user interacts with
the tabs directly around the same time. The redirect flow has been
updated to ensure that the permissions tab is still closed in that
case. The user is on their own to find the dapp tab again in that case.
* Login per site tab popup fixes (#7617)
* Handle redirect in response to state update in permissions-connect
* Ensure origin is available to permissions-connect subcomponents during redirect
* Hide app bar whenever on redirect route
* Improvements to handling of redirects in permissions-connect
* Ensure permission request id change handling only happens when page is not null
* Lint fix
* Decouple confirm transaction screen from the selected address (#7622)
* Avoid race condtion that could prevent contextual account switching (#7623)
There was a race condition in the logic responsible for switching the
selected account based upon the active tab. It was asynchronously
querying the active tab, then assuming it had been retrieved later.
The active tab info itself was already in the redux store in another
spot, one that is guaranteed to be set before the UI renders. The
race condition was avoided by deleting the duplicate state, and using
the other active tab state.
* Only redirect back to dapp if current tab is active (#7621)
The "redirect back to dapp" behaviour can be disruptive when the
permissions connect tab is not active. The purpose of the redirect was
to maintain context between the dapp and the permissions request, but
if the user has already moved to another tab, that no longer applies.
* Fix JSX style lint errors
* Remove unused state
2019-12-03 18:35:56 +01:00
//=============================================================================
// MISCELLANEOUS
//=============================================================================
2022-02-18 17:48:38 +01:00
getExternalPendingTransactions ( address ) {
return this . smartTransactionsController . getTransactions ( {
addressFrom : address ,
status : 'pending' ,
} ) ;
}
2018-09-21 19:34:21 +02:00
/ * *
* Returns the nonce that will be associated with a transaction once approved
2022-01-07 16:57:33 +01:00
*
2020-01-13 19:36:36 +01:00
* @ param { string } address - The hex string address for the transaction
* @ returns { Promise < number > }
2018-09-21 19:34:21 +02:00
* /
2020-11-03 00:41:28 +01:00
async getPendingNonce ( address ) {
const {
nonceDetails ,
releaseLock ,
2021-02-04 19:15:23 +01:00
} = await this . txController . nonceTracker . getNonceLock ( address ) ;
const pendingNonce = nonceDetails . params . highestSuggested ;
2018-09-21 19:34:21 +02:00
2021-02-04 19:15:23 +01:00
releaseLock ( ) ;
return pendingNonce ;
2018-09-21 19:34:21 +02:00
}
2019-10-02 20:12:04 +02:00
/ * *
* Returns the next nonce according to the nonce - tracker
2022-01-07 16:57:33 +01:00
*
2020-01-13 19:36:36 +01:00
* @ param { string } address - The hex string address for the transaction
* @ returns { Promise < number > }
2019-10-02 20:12:04 +02:00
* /
2020-11-03 00:41:28 +01:00
async getNextNonce ( address ) {
2021-02-04 19:15:23 +01:00
const nonceLock = await this . txController . nonceTracker . getNonceLock (
address ,
) ;
nonceLock . releaseLock ( ) ;
return nonceLock . nextNonce ;
2019-10-02 20:12:04 +02:00
}
Update address book state upon custom RPC chainId edit (#9493)
When the `chainId` for a custom RPC endpoint is edited, we now migrate
the corresponding address book entries to ensure they are not orphaned.
The address book entries are grouped by the `metamask.network` state,
which unfortunately was sometimes the `chainId`, and sometimes the
`networkId`. It was always the `networkId` for built-in Infura
networks, but for custom RPC endpoints it would be set to the user-set
`chainId` field, with a fallback to the `networkId` of the network.
A recent change will force users to enter valid `chainId`s on all
custom networks, which will be normalized to be hex-prefixed. As a
result, address book contacts will now be keyed by a different string.
The contact entries are now migrated when this edit takes place.
There are some edge cases where two separate entries share the same set
of contacts. For example, if two entries have the same `chainId`, or if
they had the same `networkId` and had no `chainId` set. When the
`chainId` is edited in such cases, the contacts are duplicated on both
networks. This is the best we can do, as we don't have any way to know
which network the contacts _should_ be on.
The `typed-message-manager` unit tests have also been updated as part
of this commit because the addition of `sinon.restore()` to the
preferences controller tests ended up clearing a test object in-between
individual tests in that file. The test object is now re-constructed
before each individual test.
2020-10-07 19:32:17 +02:00
/ * *
* Migrate address book state from old to new chainId .
*
* Address book state is keyed by the ` networkStore ` state from the network controller . This value is set to the
* ` networkId ` for our built - in Infura networks , but it ' s set to the ` chainId ` for custom networks .
* When this ` chainId ` value is changed for custom RPC endpoints , we need to migrate any contacts stored under the
* old key to the new key .
*
* The ` duplicate ` parameter is used to specify that the contacts under the old key should not be removed . This is
* useful in the case where two RPC endpoints shared the same set of contacts , and we ' re not sure which one each
* contact belongs under . Duplicating the contacts under both keys is the only way to ensure they are not lost .
*
* @ param { string } oldChainId - The old chainId
* @ param { string } newChainId - The new chainId
* @ param { boolean } [ duplicate ] - Whether to duplicate the addresses on both chainIds ( default : false )
* /
2020-11-03 00:41:28 +01:00
async migrateAddressBookState ( oldChainId , newChainId , duplicate = false ) {
2021-02-04 19:15:23 +01:00
const { addressBook } = this . addressBookController . state ;
Update address book state upon custom RPC chainId edit (#9493)
When the `chainId` for a custom RPC endpoint is edited, we now migrate
the corresponding address book entries to ensure they are not orphaned.
The address book entries are grouped by the `metamask.network` state,
which unfortunately was sometimes the `chainId`, and sometimes the
`networkId`. It was always the `networkId` for built-in Infura
networks, but for custom RPC endpoints it would be set to the user-set
`chainId` field, with a fallback to the `networkId` of the network.
A recent change will force users to enter valid `chainId`s on all
custom networks, which will be normalized to be hex-prefixed. As a
result, address book contacts will now be keyed by a different string.
The contact entries are now migrated when this edit takes place.
There are some edge cases where two separate entries share the same set
of contacts. For example, if two entries have the same `chainId`, or if
they had the same `networkId` and had no `chainId` set. When the
`chainId` is edited in such cases, the contacts are duplicated on both
networks. This is the best we can do, as we don't have any way to know
which network the contacts _should_ be on.
The `typed-message-manager` unit tests have also been updated as part
of this commit because the addition of `sinon.restore()` to the
preferences controller tests ended up clearing a test object in-between
individual tests in that file. The test object is now re-constructed
before each individual test.
2020-10-07 19:32:17 +02:00
if ( ! addressBook [ oldChainId ] ) {
2021-02-04 19:15:23 +01:00
return ;
Update address book state upon custom RPC chainId edit (#9493)
When the `chainId` for a custom RPC endpoint is edited, we now migrate
the corresponding address book entries to ensure they are not orphaned.
The address book entries are grouped by the `metamask.network` state,
which unfortunately was sometimes the `chainId`, and sometimes the
`networkId`. It was always the `networkId` for built-in Infura
networks, but for custom RPC endpoints it would be set to the user-set
`chainId` field, with a fallback to the `networkId` of the network.
A recent change will force users to enter valid `chainId`s on all
custom networks, which will be normalized to be hex-prefixed. As a
result, address book contacts will now be keyed by a different string.
The contact entries are now migrated when this edit takes place.
There are some edge cases where two separate entries share the same set
of contacts. For example, if two entries have the same `chainId`, or if
they had the same `networkId` and had no `chainId` set. When the
`chainId` is edited in such cases, the contacts are duplicated on both
networks. This is the best we can do, as we don't have any way to know
which network the contacts _should_ be on.
The `typed-message-manager` unit tests have also been updated as part
of this commit because the addition of `sinon.restore()` to the
preferences controller tests ended up clearing a test object in-between
individual tests in that file. The test object is now re-constructed
before each individual test.
2020-10-07 19:32:17 +02:00
}
for ( const address of Object . keys ( addressBook [ oldChainId ] ) ) {
2021-02-04 19:15:23 +01:00
const entry = addressBook [ oldChainId ] [ address ] ;
2020-11-03 00:41:28 +01:00
this . addressBookController . set (
address ,
entry . name ,
newChainId ,
entry . memo ,
2021-02-04 19:15:23 +01:00
) ;
Update address book state upon custom RPC chainId edit (#9493)
When the `chainId` for a custom RPC endpoint is edited, we now migrate
the corresponding address book entries to ensure they are not orphaned.
The address book entries are grouped by the `metamask.network` state,
which unfortunately was sometimes the `chainId`, and sometimes the
`networkId`. It was always the `networkId` for built-in Infura
networks, but for custom RPC endpoints it would be set to the user-set
`chainId` field, with a fallback to the `networkId` of the network.
A recent change will force users to enter valid `chainId`s on all
custom networks, which will be normalized to be hex-prefixed. As a
result, address book contacts will now be keyed by a different string.
The contact entries are now migrated when this edit takes place.
There are some edge cases where two separate entries share the same set
of contacts. For example, if two entries have the same `chainId`, or if
they had the same `networkId` and had no `chainId` set. When the
`chainId` is edited in such cases, the contacts are duplicated on both
networks. This is the best we can do, as we don't have any way to know
which network the contacts _should_ be on.
The `typed-message-manager` unit tests have also been updated as part
of this commit because the addition of `sinon.restore()` to the
preferences controller tests ended up clearing a test object in-between
individual tests in that file. The test object is now re-constructed
before each individual test.
2020-10-07 19:32:17 +02:00
if ( ! duplicate ) {
2021-02-04 19:15:23 +01:00
this . addressBookController . delete ( oldChainId , address ) ;
Update address book state upon custom RPC chainId edit (#9493)
When the `chainId` for a custom RPC endpoint is edited, we now migrate
the corresponding address book entries to ensure they are not orphaned.
The address book entries are grouped by the `metamask.network` state,
which unfortunately was sometimes the `chainId`, and sometimes the
`networkId`. It was always the `networkId` for built-in Infura
networks, but for custom RPC endpoints it would be set to the user-set
`chainId` field, with a fallback to the `networkId` of the network.
A recent change will force users to enter valid `chainId`s on all
custom networks, which will be normalized to be hex-prefixed. As a
result, address book contacts will now be keyed by a different string.
The contact entries are now migrated when this edit takes place.
There are some edge cases where two separate entries share the same set
of contacts. For example, if two entries have the same `chainId`, or if
they had the same `networkId` and had no `chainId` set. When the
`chainId` is edited in such cases, the contacts are duplicated on both
networks. This is the best we can do, as we don't have any way to know
which network the contacts _should_ be on.
The `typed-message-manager` unit tests have also been updated as part
of this commit because the addition of `sinon.restore()` to the
preferences controller tests ended up clearing a test object in-between
individual tests in that file. The test object is now re-constructed
before each individual test.
2020-10-07 19:32:17 +02:00
}
}
}
2019-07-31 22:17:11 +02:00
//=============================================================================
// CONFIG
//=============================================================================
2016-06-24 22:05:21 +02:00
2017-01-28 04:35:03 +01:00
// Log blocks
2016-10-06 12:24:28 +02:00
2019-01-29 19:13:51 +01:00
/ * *
* A method for selecting a custom URL for an ethereum RPC provider and updating it
2022-01-07 16:57:33 +01:00
*
2019-01-29 19:13:51 +01:00
* @ param { string } rpcUrl - A URL for a valid Ethereum RPC API .
2020-07-08 23:05:09 +02:00
* @ param { string } chainId - The chainId of the selected network .
2019-01-29 19:13:51 +01:00
* @ param { string } ticker - The ticker symbol of the selected network .
2021-02-12 16:25:58 +01:00
* @ param { string } [ nickname ] - Nickname of the selected network .
* @ param { Object } [ rpcPrefs ] - RPC preferences .
* @ param { string } [ rpcPrefs . blockExplorerUrl ] - URL of block explorer for the chain .
2022-01-07 16:57:33 +01:00
* @ returns { Promise < string > } The RPC Target URL confirmed .
2019-01-29 19:13:51 +01:00
* /
2020-11-03 00:41:28 +01:00
async updateAndSetCustomRpc (
rpcUrl ,
chainId ,
ticker = 'ETH' ,
nickname ,
rpcPrefs ,
) {
2021-01-21 00:37:18 +01:00
this . networkController . setRpcTarget (
2020-11-03 00:41:28 +01:00
rpcUrl ,
chainId ,
ticker ,
nickname ,
rpcPrefs ,
2021-02-04 19:15:23 +01:00
) ;
2021-01-21 00:37:18 +01:00
await this . preferencesController . updateRpc ( {
2020-11-03 00:41:28 +01:00
rpcUrl ,
chainId ,
ticker ,
nickname ,
rpcPrefs ,
2021-02-04 19:15:23 +01:00
} ) ;
return rpcUrl ;
2019-01-29 19:13:51 +01:00
}
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* A method for selecting a custom URL for an ethereum RPC provider .
2022-01-07 16:57:33 +01:00
*
2020-10-06 19:57:02 +02:00
* @ param { string } rpcUrl - A URL for a valid Ethereum RPC API .
2020-07-08 23:05:09 +02:00
* @ param { string } chainId - The chainId of the selected network .
2018-10-26 10:26:43 +02:00
* @ param { string } ticker - The ticker symbol of the selected network .
* @ param { string } nickname - Optional nickname of the selected network .
2022-01-07 16:57:33 +01:00
* @ param rpcPrefs
* @ returns { Promise < string > } The RPC Target URL confirmed .
2018-04-19 02:54:50 +02:00
* /
2020-11-03 00:41:28 +01:00
async setCustomRpc (
rpcUrl ,
chainId ,
ticker = 'ETH' ,
nickname = '' ,
rpcPrefs = { } ,
) {
2021-02-04 19:15:23 +01:00
const frequentRpcListDetail = this . preferencesController . getFrequentRpcListDetail ( ) ;
2020-11-03 00:41:28 +01:00
const rpcSettings = frequentRpcListDetail . find (
( rpc ) => rpcUrl === rpc . rpcUrl ,
2021-02-04 19:15:23 +01:00
) ;
2019-01-29 19:13:51 +01:00
if ( rpcSettings ) {
2020-11-03 00:41:28 +01:00
this . networkController . setRpcTarget (
rpcSettings . rpcUrl ,
rpcSettings . chainId ,
rpcSettings . ticker ,
rpcSettings . nickname ,
rpcPrefs ,
2021-02-04 19:15:23 +01:00
) ;
2019-01-29 19:13:51 +01:00
} else {
2020-11-03 00:41:28 +01:00
this . networkController . setRpcTarget (
rpcUrl ,
chainId ,
ticker ,
nickname ,
rpcPrefs ,
2021-02-04 19:15:23 +01:00
) ;
2020-11-03 00:41:28 +01:00
await this . preferencesController . addToFrequentRpcList (
rpcUrl ,
chainId ,
ticker ,
nickname ,
rpcPrefs ,
2021-02-04 19:15:23 +01:00
) ;
2019-01-29 19:13:51 +01:00
}
2021-02-04 19:15:23 +01:00
return rpcUrl ;
2016-12-22 02:21:10 +01:00
}
2017-09-30 01:09:38 +02:00
2018-09-28 21:53:58 +02:00
/ * *
* A method for deleting a selected custom URL .
2022-01-07 16:57:33 +01:00
*
2020-10-06 19:57:02 +02:00
* @ param { string } rpcUrl - A RPC URL to delete .
2018-09-28 21:53:58 +02:00
* /
2020-11-03 00:41:28 +01:00
async delCustomRpc ( rpcUrl ) {
2021-02-04 19:15:23 +01:00
await this . preferencesController . removeFromFrequentRpcList ( rpcUrl ) ;
2018-09-28 21:53:58 +02:00
}
2021-02-12 16:25:58 +01:00
/ * *
* Returns the first RPC info object that matches at least one field of the
* provided search criteria . Returns null if no match is found
*
* @ param { Object } rpcInfo - The RPC endpoint properties and values to check .
* @ returns { Object } rpcInfo found in the frequentRpcList
* /
findCustomRpcBy ( rpcInfo ) {
const frequentRpcListDetail = this . preferencesController . getFrequentRpcListDetail ( ) ;
for ( const existingRpcInfo of frequentRpcListDetail ) {
for ( const key of Object . keys ( rpcInfo ) ) {
if ( existingRpcInfo [ key ] === rpcInfo [ key ] ) {
return existingRpcInfo ;
}
}
}
return null ;
}
2020-11-03 00:41:28 +01:00
async initializeThreeBox ( ) {
2021-02-04 19:15:23 +01:00
await this . threeBoxController . init ( ) ;
2019-09-16 19:11:01 +02:00
}
2021-04-26 20:05:48 +02:00
/ * *
* Sets the Ledger Live preference to use for Ledger hardware wallet support
2022-01-07 16:57:33 +01:00
*
* @ param { string } transportType - The Ledger transport type .
2021-04-26 20:05:48 +02:00
* /
2021-10-21 21:17:03 +02:00
async setLedgerTransportPreference ( transportType ) {
const currentValue = this . preferencesController . getLedgerTransportPreference ( ) ;
const newValue = this . preferencesController . setLedgerTransportPreference (
transportType ,
) ;
2021-04-26 20:05:48 +02:00
2022-02-16 21:54:30 +01:00
const keyring = await this . getKeyringForDevice ( DEVICE _NAMES . LEDGER ) ;
2021-04-26 20:05:48 +02:00
if ( keyring ? . updateTransportMethod ) {
2021-10-21 21:17:03 +02:00
return keyring . updateTransportMethod ( newValue ) . catch ( ( e ) => {
2021-04-26 20:05:48 +02:00
// If there was an error updating the transport, we should
// fall back to the original value
2021-10-21 21:17:03 +02:00
this . preferencesController . setLedgerTransportPreference ( currentValue ) ;
2021-04-26 20:05:48 +02:00
throw e ;
} ) ;
}
return undefined ;
}
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* A method for initializing storage the first time .
2022-01-07 16:57:33 +01:00
*
2018-04-19 02:54:50 +02:00
* @ param { Object } initState - The default state to initialize with .
* @ private
* /
2020-11-03 00:41:28 +01:00
recordFirstTimeInfo ( initState ) {
2017-11-28 20:14:57 +01:00
if ( ! ( 'firstTimeInfo' in initState ) ) {
2021-02-04 19:15:23 +01:00
const version = this . platform . getVersion ( ) ;
2017-11-28 20:14:57 +01:00
initState . firstTimeInfo = {
version ,
date : Date . now ( ) ,
2021-02-04 19:15:23 +01:00
} ;
2017-11-28 20:14:57 +01:00
}
}
2018-08-22 21:05:41 +02:00
// TODO: Replace isClientOpen methods with `controllerConnectionChanged` events.
2020-10-22 19:06:44 +02:00
/* eslint-disable accessor-pairs */
2018-04-20 18:26:24 +02:00
/ * *
2018-04-19 02:54:50 +02:00
* A method for recording whether the MetaMask user interface is open or not .
2022-01-07 16:57:33 +01:00
*
2018-04-20 18:26:24 +02:00
* @ param { boolean } open
2018-04-19 02:54:50 +02:00
* /
2020-11-03 00:41:28 +01:00
set isClientOpen ( open ) {
2021-02-04 19:15:23 +01:00
this . _isClientOpen = open ;
this . detectTokensController . isOpen = open ;
2018-04-16 23:45:18 +02:00
}
2020-10-22 19:06:44 +02:00
/* eslint-enable accessor-pairs */
2018-04-16 23:45:18 +02:00
2021-08-04 23:53:13 +02:00
/ * *
* A method that is called by the background when all instances of metamask are closed .
* Currently used to stop polling in the gasFeeController .
* /
onClientClosed ( ) {
try {
this . gasFeeController . stopPolling ( ) ;
this . appStateController . clearPollingTokens ( ) ;
} catch ( error ) {
console . error ( error ) ;
}
}
/ * *
* A method that is called by the background when a particular environment type is closed ( fullscreen , popup , notification ) .
* Currently used to stop polling in the gasFeeController for only that environement type
2022-01-07 16:57:33 +01:00
*
* @ param environmentType
2021-08-04 23:53:13 +02:00
* /
onEnvironmentTypeClosed ( environmentType ) {
const appStatePollingTokenType =
POLLING _TOKEN _ENVIRONMENT _TYPES [ environmentType ] ;
const pollingTokensToDisconnect = this . appStateController . store . getState ( ) [
appStatePollingTokenType
] ;
pollingTokensToDisconnect . forEach ( ( pollingToken ) => {
this . gasFeeController . disconnectPoller ( pollingToken ) ;
this . appStateController . removePollingToken (
pollingToken ,
appStatePollingTokenType ,
) ;
} ) ;
}
2018-10-02 01:35:57 +02:00
/ * *
2020-06-08 20:06:37 +02:00
* Adds a domain to the PhishingController safelist
2022-01-07 16:57:33 +01:00
*
2020-06-08 20:06:37 +02:00
* @ param { string } hostname - the domain to safelist
2018-10-02 01:35:57 +02:00
* /
2020-11-03 00:41:28 +01:00
safelistPhishingDomain ( hostname ) {
2021-02-04 19:15:23 +01:00
return this . phishingController . bypass ( hostname ) ;
2018-10-02 01:35:57 +02:00
}
2018-10-29 21:55:13 +01:00
2018-10-29 22:28:59 +01:00
/ * *
* Locks MetaMask
* /
2020-11-03 00:41:28 +01:00
setLocked ( ) {
2021-12-08 18:25:27 +01:00
const [ trezorKeyring ] = this . keyringController . getKeyringsByType (
KEYRING _TYPES . TREZOR ,
) ;
if ( trezorKeyring ) {
trezorKeyring . dispose ( ) ;
}
2022-05-12 18:06:14 +02:00
const [ ledgerKeyring ] = this . keyringController . getKeyringsByType (
KEYRING _TYPES . LEDGER ,
) ;
ledgerKeyring ? . destroy ? . ( ) ;
2021-02-04 19:15:23 +01:00
return this . keyringController . setLocked ( ) ;
2018-10-29 21:55:13 +01:00
}
2017-09-22 00:47:25 +02:00
}