2017-01-12 07:47:56 +01:00
|
|
|
// Migrations must start at version 1 or later.
|
|
|
|
// They are objects with a `version` number
|
|
|
|
// and a `migrate` function.
|
|
|
|
//
|
|
|
|
// The `migrate` function receives the previous
|
|
|
|
// config data format, and returns the new one.
|
|
|
|
|
2021-07-14 00:11:53 +02:00
|
|
|
import m002 from './002';
|
|
|
|
import m003 from './003';
|
|
|
|
import m004 from './004';
|
|
|
|
import m005 from './005';
|
|
|
|
import m006 from './006';
|
|
|
|
import m007 from './007';
|
|
|
|
import m008 from './008';
|
|
|
|
import m009 from './009';
|
|
|
|
import m010 from './010';
|
|
|
|
import m011 from './011';
|
|
|
|
import m012 from './012';
|
|
|
|
import m013 from './013';
|
|
|
|
import m014 from './014';
|
|
|
|
import m015 from './015';
|
|
|
|
import m016 from './016';
|
|
|
|
import m017 from './017';
|
|
|
|
import m018 from './018';
|
|
|
|
import m019 from './019';
|
|
|
|
import m020 from './020';
|
|
|
|
import m021 from './021';
|
|
|
|
import m022 from './022';
|
|
|
|
import m023 from './023';
|
|
|
|
import m024 from './024';
|
|
|
|
import m025 from './025';
|
|
|
|
import m026 from './026';
|
|
|
|
import m027 from './027';
|
|
|
|
import m028 from './028';
|
|
|
|
import m029 from './029';
|
|
|
|
import m030 from './030';
|
|
|
|
import m031 from './031';
|
|
|
|
import m032 from './032';
|
|
|
|
import m033 from './033';
|
|
|
|
import m034 from './034';
|
|
|
|
import m035 from './035';
|
|
|
|
import m036 from './036';
|
|
|
|
import m037 from './037';
|
|
|
|
import m038 from './038';
|
|
|
|
import m039 from './039';
|
|
|
|
import m040 from './040';
|
|
|
|
import m041 from './041';
|
|
|
|
import m042 from './042';
|
|
|
|
import m043 from './043';
|
|
|
|
import m044 from './044';
|
|
|
|
import m045 from './045';
|
|
|
|
import m046 from './046';
|
|
|
|
import m047 from './047';
|
|
|
|
import m048 from './048';
|
|
|
|
import m049 from './049';
|
|
|
|
import m050 from './050';
|
|
|
|
import m051 from './051';
|
|
|
|
import m052 from './052';
|
|
|
|
import m053 from './053';
|
|
|
|
import m054 from './054';
|
|
|
|
import m055 from './055';
|
|
|
|
import m056 from './056';
|
|
|
|
import m057 from './057';
|
|
|
|
import m058 from './058';
|
|
|
|
import m059 from './059';
|
|
|
|
import m060 from './060';
|
|
|
|
import m061 from './061';
|
|
|
|
import m062 from './062';
|
2021-09-10 19:37:19 +02:00
|
|
|
import m063 from './063';
|
2021-09-15 23:54:51 +02:00
|
|
|
import m064 from './064';
|
2021-10-15 20:52:52 +02:00
|
|
|
import m065 from './065';
|
2021-10-21 21:17:03 +02:00
|
|
|
import m066 from './066';
|
2021-11-15 20:20:33 +01:00
|
|
|
import m067 from './067';
|
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 m068 from './068';
|
2021-12-09 00:37:29 +01:00
|
|
|
import m069 from './069';
|
2022-04-21 17:44:15 +02:00
|
|
|
import m070 from './070';
|
2022-04-27 10:36:32 +02:00
|
|
|
import m071 from './071';
|
2022-06-17 23:11:09 +02:00
|
|
|
import m072 from './072';
|
2022-07-26 19:01:14 +02:00
|
|
|
import m073 from './073';
|
2022-09-29 05:26:01 +02:00
|
|
|
import m074 from './074';
|
2022-10-31 17:20:50 +01:00
|
|
|
import m075 from './075';
|
2022-11-15 19:49:42 +01:00
|
|
|
import m076 from './076';
|
2022-11-18 19:35:42 +01:00
|
|
|
import m077 from './077';
|
2023-03-06 14:36:01 +01:00
|
|
|
import * as m078 from './078';
|
2023-02-21 16:32:08 +01:00
|
|
|
import m079 from './079';
|
2023-03-06 14:36:01 +01:00
|
|
|
import m080 from './080';
|
2023-03-08 19:29:23 +01:00
|
|
|
import * as m081 from './081';
|
2023-03-09 22:00:28 +01:00
|
|
|
import * as m082 from './082';
|
NetworkController: Split `network` into `networkId` and `networkStatus` (#17556)
The `network` store of the network controller crams two types of data
into one place. It roughly tracks whether we have enough information to
make requests to the network and whether the network is capable of
receiving requests, but it also stores the ID of the network (as
obtained via `net_version`).
Generally we shouldn't be using the network ID for anything, as it has
been completely replaced by chain ID, which all custom RPC endpoints
have been required to support for over a year now. However, as the
network ID is used in various places within the extension codebase,
removing it entirely would be a non-trivial effort. So, minimally, this
commit splits `network` into two stores: `networkId` and
`networkStatus`. But it also expands the concept of network status.
Previously, the network was in one of two states: "loading" and
"not-loading". But now it can be in one of four states:
- `available`: The network is able to receive and respond to requests.
- `unavailable`: The network is not able to receive and respond to
requests for unknown reasons.
- `blocked`: The network is actively blocking requests based on the
user's geolocation. (This is specific to Infura.)
- `unknown`: We don't know whether the network can receive and respond
to requests, either because we haven't checked or we tried to check
and were unsuccessful.
This commit also changes how the network status is determined —
specifically, how many requests are used to determine that status, when
they occur, and whether they are awaited. Previously, the network
controller would make 2 to 3 requests during the course of running
`lookupNetwork`.
* First, if it was an Infura network, it would make a request for
`eth_blockNumber` to determine whether Infura was blocking requests or
not, then emit an appropriate event. This operation was not awaited.
* Then, regardless of the network, it would fetch the network ID via
`net_version`. This operation was awaited.
* Finally, regardless of the network, it would fetch the latest block
via `eth_getBlockByNumber`, then use the result to determine whether
the network supported EIP-1559. This operation was awaited.
Now:
* One fewer request is made, specifically `eth_blockNumber`, as we don't
need to make an extra request to determine whether Infura is blocking
requests; we can reuse `eth_getBlockByNumber`;
* All requests are awaited, which makes `lookupNetwork` run fully
in-band instead of partially out-of-band; and
* Both requests for `net_version` and `eth_getBlockByNumber` are
performed in parallel to make `lookupNetwork` run slightly faster.
2023-03-31 00:49:12 +02:00
|
|
|
import * as m083 from './083';
|
2023-04-11 21:16:31 +02:00
|
|
|
import * as m084 from './084';
|
2023-04-14 20:54:57 +02:00
|
|
|
import * as m085 from './085';
|
2023-05-02 17:53:20 +02:00
|
|
|
import * as m086 from './086';
|
2023-06-05 22:13:22 +02:00
|
|
|
import * as m087 from './087';
|
2023-06-09 22:48:48 +02:00
|
|
|
import * as m088 from './088';
|
2023-07-26 01:47:57 +02:00
|
|
|
import * as m089 from './089';
|
2023-07-31 14:48:48 +02:00
|
|
|
import * as m090 from './090';
|
2023-08-02 00:54:02 +02:00
|
|
|
import * as m091 from './091';
|
2023-08-02 23:22:35 +02:00
|
|
|
import * as m092 from './092';
|
2023-08-17 13:34:30 +02:00
|
|
|
import * as m092point1 from './092.1';
|
2023-08-28 18:55:56 +02:00
|
|
|
import * as m092point2 from './092.2';
|
2023-08-27 02:58:26 +02:00
|
|
|
import * as m092point3 from './092.3';
|
2023-08-03 17:42:21 +02:00
|
|
|
import * as m093 from './093';
|
2023-08-03 19:31:35 +02:00
|
|
|
import * as m094 from './094';
|
2023-08-22 11:17:07 +02:00
|
|
|
import * as m095 from './095';
|
2023-08-24 12:27:42 +02:00
|
|
|
import * as m096 from './096';
|
2021-07-14 00:11:53 +02:00
|
|
|
|
2020-01-09 04:34:58 +01:00
|
|
|
const migrations = [
|
2021-07-14 00:11:53 +02:00
|
|
|
m002,
|
|
|
|
m003,
|
|
|
|
m004,
|
|
|
|
m005,
|
|
|
|
m006,
|
|
|
|
m007,
|
|
|
|
m008,
|
|
|
|
m009,
|
|
|
|
m010,
|
|
|
|
m011,
|
|
|
|
m012,
|
|
|
|
m013,
|
|
|
|
m014,
|
|
|
|
m015,
|
|
|
|
m016,
|
|
|
|
m017,
|
|
|
|
m018,
|
|
|
|
m019,
|
|
|
|
m020,
|
|
|
|
m021,
|
|
|
|
m022,
|
|
|
|
m023,
|
|
|
|
m024,
|
|
|
|
m025,
|
|
|
|
m026,
|
|
|
|
m027,
|
|
|
|
m028,
|
|
|
|
m029,
|
|
|
|
m030,
|
|
|
|
m031,
|
|
|
|
m032,
|
|
|
|
m033,
|
|
|
|
m034,
|
|
|
|
m035,
|
|
|
|
m036,
|
|
|
|
m037,
|
|
|
|
m038,
|
|
|
|
m039,
|
|
|
|
m040,
|
|
|
|
m041,
|
|
|
|
m042,
|
|
|
|
m043,
|
|
|
|
m044,
|
|
|
|
m045,
|
|
|
|
m046,
|
|
|
|
m047,
|
|
|
|
m048,
|
|
|
|
m049,
|
|
|
|
m050,
|
|
|
|
m051,
|
|
|
|
m052,
|
|
|
|
m053,
|
|
|
|
m054,
|
|
|
|
m055,
|
|
|
|
m056,
|
|
|
|
m057,
|
|
|
|
m058,
|
|
|
|
m059,
|
|
|
|
m060,
|
|
|
|
m061,
|
|
|
|
m062,
|
2021-09-10 19:37:19 +02:00
|
|
|
m063,
|
2021-09-15 23:54:51 +02:00
|
|
|
m064,
|
2021-10-15 20:52:52 +02:00
|
|
|
m065,
|
2021-10-21 21:17:03 +02:00
|
|
|
m066,
|
2021-11-15 20:20:33 +01:00
|
|
|
m067,
|
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
|
|
|
m068,
|
2021-12-09 00:37:29 +01:00
|
|
|
m069,
|
2022-04-21 17:44:15 +02:00
|
|
|
m070,
|
2022-04-27 10:36:32 +02:00
|
|
|
m071,
|
2022-06-17 23:11:09 +02:00
|
|
|
m072,
|
2022-07-26 19:01:14 +02:00
|
|
|
m073,
|
2022-09-29 05:26:01 +02:00
|
|
|
m074,
|
2022-10-31 17:20:50 +01:00
|
|
|
m075,
|
2022-11-15 19:49:42 +01:00
|
|
|
m076,
|
2022-11-18 19:35:42 +01:00
|
|
|
m077,
|
2023-02-16 20:23:29 +01:00
|
|
|
m078,
|
2023-02-21 16:32:08 +01:00
|
|
|
m079,
|
2023-02-24 16:09:00 +01:00
|
|
|
m080,
|
2023-03-08 19:29:23 +01:00
|
|
|
m081,
|
2023-03-09 22:00:28 +01:00
|
|
|
m082,
|
NetworkController: Split `network` into `networkId` and `networkStatus` (#17556)
The `network` store of the network controller crams two types of data
into one place. It roughly tracks whether we have enough information to
make requests to the network and whether the network is capable of
receiving requests, but it also stores the ID of the network (as
obtained via `net_version`).
Generally we shouldn't be using the network ID for anything, as it has
been completely replaced by chain ID, which all custom RPC endpoints
have been required to support for over a year now. However, as the
network ID is used in various places within the extension codebase,
removing it entirely would be a non-trivial effort. So, minimally, this
commit splits `network` into two stores: `networkId` and
`networkStatus`. But it also expands the concept of network status.
Previously, the network was in one of two states: "loading" and
"not-loading". But now it can be in one of four states:
- `available`: The network is able to receive and respond to requests.
- `unavailable`: The network is not able to receive and respond to
requests for unknown reasons.
- `blocked`: The network is actively blocking requests based on the
user's geolocation. (This is specific to Infura.)
- `unknown`: We don't know whether the network can receive and respond
to requests, either because we haven't checked or we tried to check
and were unsuccessful.
This commit also changes how the network status is determined —
specifically, how many requests are used to determine that status, when
they occur, and whether they are awaited. Previously, the network
controller would make 2 to 3 requests during the course of running
`lookupNetwork`.
* First, if it was an Infura network, it would make a request for
`eth_blockNumber` to determine whether Infura was blocking requests or
not, then emit an appropriate event. This operation was not awaited.
* Then, regardless of the network, it would fetch the network ID via
`net_version`. This operation was awaited.
* Finally, regardless of the network, it would fetch the latest block
via `eth_getBlockByNumber`, then use the result to determine whether
the network supported EIP-1559. This operation was awaited.
Now:
* One fewer request is made, specifically `eth_blockNumber`, as we don't
need to make an extra request to determine whether Infura is blocking
requests; we can reuse `eth_getBlockByNumber`;
* All requests are awaited, which makes `lookupNetwork` run fully
in-band instead of partially out-of-band; and
* Both requests for `net_version` and `eth_getBlockByNumber` are
performed in parallel to make `lookupNetwork` run slightly faster.
2023-03-31 00:49:12 +02:00
|
|
|
m083,
|
2023-04-11 21:16:31 +02:00
|
|
|
m084,
|
2023-04-14 20:54:57 +02:00
|
|
|
m085,
|
2023-05-02 17:53:20 +02:00
|
|
|
m086,
|
2023-06-05 22:13:22 +02:00
|
|
|
m087,
|
2023-06-09 22:48:48 +02:00
|
|
|
m088,
|
2023-07-26 01:47:57 +02:00
|
|
|
m089,
|
2023-07-31 14:48:48 +02:00
|
|
|
m090,
|
2023-08-02 00:54:02 +02:00
|
|
|
m091,
|
2023-08-02 23:22:35 +02:00
|
|
|
m092,
|
2023-08-17 13:34:30 +02:00
|
|
|
m092point1,
|
2023-08-28 18:55:56 +02:00
|
|
|
m092point2,
|
2023-08-27 02:58:26 +02:00
|
|
|
m092point3,
|
2023-08-03 17:42:21 +02:00
|
|
|
m093,
|
2023-08-03 19:31:35 +02:00
|
|
|
m094,
|
2023-08-22 11:17:07 +02:00
|
|
|
m095,
|
2023-08-24 12:27:42 +02:00
|
|
|
m096,
|
2021-02-04 19:15:23 +01:00
|
|
|
];
|
|
|
|
export default migrations;
|