Skip to content

Commit

Permalink
feat: add scopes field to KeyringAccount (#29195)
Browse files Browse the repository at this point in the history
## **Description**

Testing the new `scopes` added on the `KeyringAccount`.

[![Open in GitHub
Codespaces](https://github.com/codespaces/badge.svg)](https://codespaces.new/MetaMask/metamask-extension/pull/29195?quickstart=1)

## **Related issues**

Requires this PR to be merged first:
- [x] #28861

Related to:
- MetaMask/accounts#101
- MetaMask/core#5066
- MetaMask/snap-bitcoin-wallet#364

## **Manual testing steps**

- Use a previous stable version
```console
git checkout Version-v12.10.0 # Or use a release build
```

- Run it:
```console
yarn
yarn start:flask
```

- Create a bunch of accounts (EVM, non-EVM (Solana/Bitcoin),
hardware-wallet, Snap EVM accounts like the SSK)

![Screenshot 2025-01-16 at 17 11
55](https://github.com/user-attachments/assets/815303e6-2682-4c6b-9969-8f4a8c11e0d7)

- Save your extension logs (Settings > Advanced)
- Now disable your extension (chrome://extensions)
- Stops your `yarn start:flask`
- Now, update your extension by going back to this PR (or by using the
latest RC if you're validating an RC version)

```console
git checkout feat/keyring-account-scopes
```
- Re-run it:
```console
yarn
yarn start:flask
```
- Re-enable your extension (chrome://extensions)
- Open up your console logs (looking at the `service worker`)
- You should now see some migrations running like:

![Screenshot 2025-01-16 at 17 14
03](https://github.com/user-attachments/assets/35c08ba9-83f4-4827-aac5-97b9ee055732)

- You should also see some other migrations from the Snap keyring this
like so:

![Screenshot 2025-01-16 at 18 52
48](https://github.com/user-attachments/assets/5c74700c-18a4-4452-8a47-77d1434c96ad)

- Save your extension logs again (Settings > Advanced, and use a
different filename)
- Now, compare your 2 `.json` files

## **Screenshots/Recordings**

### **Before**

### **After**

## **Pre-merge author checklist**

- [ ] I've followed [MetaMask Contributor
Docs](https://github.com/MetaMask/contributor-docs) and [MetaMask
Extension Coding
Standards](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/CODING_GUIDELINES.md).
- [ ] I've completed the PR template to the best of my ability
- [ ] I’ve included tests if applicable
- [ ] I’ve documented my code using [JSDoc](https://jsdoc.app/) format
if applicable
- [ ] I’ve applied the right labels on the PR (see [labeling
guidelines](https://github.com/MetaMask/metamask-extension/blob/main/.github/guidelines/LABELING_GUIDELINES.md)).
Not required for external contributors.

## **Pre-merge reviewer checklist**

- [ ] I've manually tested the PR (e.g. pull and build branch, run the
app, test code being changed).
- [ ] I confirm that this PR addresses all acceptance criteria described
in the ticket it closes and includes the necessary testing evidence such
as recordings and or screenshots.

---------

Co-authored-by: Howard Braham <[email protected]>
Co-authored-by: MetaMask Bot <[email protected]>
  • Loading branch information
3 people authored and matteoscurati committed Jan 27, 2025
1 parent b5d2bf9 commit 20994e9
Show file tree
Hide file tree
Showing 23 changed files with 276 additions and 305 deletions.
1 change: 1 addition & 0 deletions app/scripts/controllers/alert-controller.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ describe('AlertController', () => {
address: '0x1234567',
options: {},
methods: [],
scopes: ['eip155'],
type: 'eip155:eoa',
metadata: {
name: '',
Expand Down
1 change: 1 addition & 0 deletions app/scripts/lib/snap-keyring/snap-keyring.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -40,6 +40,7 @@ const mockAccount = {
id: '3afa663e-0600-4d93-868a-61c2e553013b',
address,
methods: [],
scopes: ['eip155'],
options: {},
};
const mockInternalAccount = {
Expand Down
10 changes: 2 additions & 8 deletions app/scripts/migrations/105.test.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
import { v4 as uuid } from 'uuid';
import { sha256FromString } from 'ethereumjs-util';
import { InternalAccount } from '@metamask/keyring-internal-api';
import { ETH_EOA_METHODS } from '../../../shared/constants/eth-methods';
import { migrate } from './105';
import type { Identity, InternalAccountV1 } from './105';

const MOCK_ADDRESS = '0x0';
const MOCK_ADDRESS_2 = '0x1';
Expand All @@ -22,12 +22,6 @@ function addressToUUID(address: string): string {
});
}

type Identity = {
name: string;
address: string;
lastSelected?: number;
};

type Identities = {
[key: string]: Identity;
};
Expand Down Expand Up @@ -62,7 +56,7 @@ function expectedInternalAccount(
address: string,
nickname: string,
lastSelected?: number,
): InternalAccount {
): InternalAccountV1 {
return {
address,
id: addressToUUID(address),
Expand Down
16 changes: 10 additions & 6 deletions app/scripts/migrations/105.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
import { EthAccountType } from '@metamask/keyring-api';
import { InternalAccount } from '@metamask/keyring-internal-api';
import type { InternalAccount } from '@metamask/keyring-internal-api';
import { sha256FromString } from 'ethereumjs-util';
import { v4 as uuid } from 'uuid';
import { cloneDeep } from 'lodash';
Expand All @@ -10,12 +10,16 @@ type VersionedData = {
data: Record<string, unknown>;
};

type Identity = {
export type Identity = {
name: string;
address: string;
lastSelected?: number;
};

// The `InternalAccount` has been updated with `@metamask/[email protected]`, so we
// omit the new field to re-use the original type for that migration.
export type InternalAccountV1 = Omit<InternalAccount, 'scopes'>;

export const version = 105;

/**
Expand Down Expand Up @@ -51,11 +55,11 @@ function findInternalAccountByAddress(
// eslint-disable-next-line @typescript-eslint/no-explicit-any
state: Record<string, any>,
address: string,
): InternalAccount | undefined {
return Object.values<InternalAccount>(
): InternalAccountV1 | undefined {
return Object.values<InternalAccountV1>(
state.AccountsController.internalAccounts.accounts,
).find(
(account: InternalAccount) =>
(account: InternalAccountV1) =>
account.address.toLowerCase() === address.toLowerCase(),
);
}
Expand Down Expand Up @@ -84,7 +88,7 @@ function createInternalAccountsForAccountsController(
return;
}

const accounts: Record<string, InternalAccount> = {};
const accounts: Record<string, InternalAccountV1> = {};

Object.values(identities).forEach((identity) => {
const expectedId = uuid({
Expand Down
57 changes: 11 additions & 46 deletions lavamoat/browserify/beta/policy.json
Original file line number Diff line number Diff line change
Expand Up @@ -818,7 +818,7 @@
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/abi-utils": {
"packages": {
"@metamask/utils>@metamask/superstruct": true,
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/abi-utils>@metamask/utils": true
"@metamask/eth-snap-keyring>@metamask/utils": true
}
},
"@metamask/eth-trezor-keyring>@metamask/eth-sig-util>@metamask/abi-utils": {
Expand Down Expand Up @@ -846,7 +846,7 @@
"@metamask/eth-snap-keyring": true,
"@metamask/keyring-api": true,
"@metamask/keyring-controller": true,
"@metamask/utils": true,
"@metamask/accounts-controller>@metamask/utils": true,
"@ethereumjs/tx>ethereum-cryptography": true,
"uuid": true
}
Expand Down Expand Up @@ -1137,7 +1137,7 @@
"packages": {
"@ethereumjs/tx>@ethereumjs/util": true,
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/abi-utils": true,
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/utils": true,
"@metamask/eth-snap-keyring>@metamask/utils": true,
"@metamask/utils>@scure/base": true,
"browserify>buffer": true,
"@ethereumjs/tx>ethereum-cryptography": true,
Expand Down Expand Up @@ -1190,13 +1190,15 @@
"@metamask/eth-snap-keyring": {
"globals": {
"URL": true,
"console.error": true
"console.error": true,
"console.info": true
},
"packages": {
"@ethereumjs/tx": true,
"@metamask/eth-snap-keyring>@metamask/eth-sig-util": true,
"@metamask/keyring-api": true,
"@metamask/eth-snap-keyring>@metamask/keyring-internal-snap-client": true,
"@metamask/keyring-api>@metamask/keyring-utils": true,
"@metamask/utils>@metamask/superstruct": true,
"@metamask/eth-snap-keyring>@metamask/utils": true,
"webpack>events": true,
Expand Down Expand Up @@ -1352,14 +1354,6 @@
"@metamask/keyring-api>bech32": true
}
},
"@metamask/profile-sync-controller>@metamask/keyring-api": {
"packages": {
"@metamask/keyring-api>@metamask/keyring-utils": true,
"@metamask/utils>@metamask/superstruct": true,
"@metamask/profile-sync-controller>@metamask/keyring-api>@metamask/utils": true,
"@metamask/keyring-api>bech32": true
}
},
"@metamask/keyring-controller": {
"packages": {
"@ethereumjs/tx>@ethereumjs/util": true,
Expand Down Expand Up @@ -1392,7 +1386,8 @@
},
"packages": {
"@metamask/utils>@metamask/superstruct": true,
"@metamask/keyring-api>@metamask/keyring-utils>@metamask/utils": true
"@metamask/keyring-api>@metamask/keyring-utils>@metamask/utils": true,
"bitcoin-address-validation": true
}
},
"@metamask/logging-controller": {
Expand Down Expand Up @@ -1622,7 +1617,7 @@
},
"packages": {
"@metamask/base-controller": true,
"@metamask/profile-sync-controller>@metamask/keyring-api": true,
"@metamask/keyring-api": true,
"@metamask/keyring-controller": true,
"@metamask/network-controller": true,
"@metamask/profile-sync-controller>@noble/ciphers": true,
Expand Down Expand Up @@ -1930,7 +1925,7 @@
"semver": true
}
},
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/abi-utils>@metamask/utils": {
"@metamask/signature-controller>@metamask/eth-sig-util>@metamask/abi-utils>@metamask/utils": {
"globals": {
"TextDecoder": true,
"TextEncoder": true
Expand All @@ -1945,7 +1940,7 @@
"semver": true
}
},
"@metamask/signature-controller>@metamask/eth-sig-util>@metamask/abi-utils>@metamask/utils": {
"@metamask/accounts-controller>@metamask/utils": {
"globals": {
"TextDecoder": true,
"TextEncoder": true
Expand Down Expand Up @@ -2095,21 +2090,6 @@
"semver": true
}
},
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/utils": {
"globals": {
"TextDecoder": true,
"TextEncoder": true
},
"packages": {
"@metamask/utils>@metamask/superstruct": true,
"@noble/hashes": true,
"@metamask/utils>@scure/base": true,
"browserify>buffer": true,
"nock>debug": true,
"@metamask/utils>pony-cause": true,
"semver": true
}
},
"@metamask/eth-trezor-keyring>@metamask/eth-sig-util>@metamask/utils": {
"globals": {
"TextDecoder": true,
Expand Down Expand Up @@ -2230,21 +2210,6 @@
"semver": true
}
},
"@metamask/profile-sync-controller>@metamask/keyring-api>@metamask/utils": {
"globals": {
"TextDecoder": true,
"TextEncoder": true
},
"packages": {
"@metamask/utils>@metamask/superstruct": true,
"@noble/hashes": true,
"@metamask/utils>@scure/base": true,
"browserify>buffer": true,
"nock>debug": true,
"@metamask/utils>pony-cause": true,
"semver": true
}
},
"@metamask/keyring-controller>@metamask/utils": {
"globals": {
"TextDecoder": true,
Expand Down
57 changes: 11 additions & 46 deletions lavamoat/browserify/flask/policy.json
Original file line number Diff line number Diff line change
Expand Up @@ -818,7 +818,7 @@
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/abi-utils": {
"packages": {
"@metamask/utils>@metamask/superstruct": true,
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/abi-utils>@metamask/utils": true
"@metamask/eth-snap-keyring>@metamask/utils": true
}
},
"@metamask/eth-trezor-keyring>@metamask/eth-sig-util>@metamask/abi-utils": {
Expand Down Expand Up @@ -846,7 +846,7 @@
"@metamask/eth-snap-keyring": true,
"@metamask/keyring-api": true,
"@metamask/keyring-controller": true,
"@metamask/utils": true,
"@metamask/accounts-controller>@metamask/utils": true,
"@ethereumjs/tx>ethereum-cryptography": true,
"uuid": true
}
Expand Down Expand Up @@ -1137,7 +1137,7 @@
"packages": {
"@ethereumjs/tx>@ethereumjs/util": true,
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/abi-utils": true,
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/utils": true,
"@metamask/eth-snap-keyring>@metamask/utils": true,
"@metamask/utils>@scure/base": true,
"browserify>buffer": true,
"@ethereumjs/tx>ethereum-cryptography": true,
Expand Down Expand Up @@ -1190,13 +1190,15 @@
"@metamask/eth-snap-keyring": {
"globals": {
"URL": true,
"console.error": true
"console.error": true,
"console.info": true
},
"packages": {
"@ethereumjs/tx": true,
"@metamask/eth-snap-keyring>@metamask/eth-sig-util": true,
"@metamask/keyring-api": true,
"@metamask/eth-snap-keyring>@metamask/keyring-internal-snap-client": true,
"@metamask/keyring-api>@metamask/keyring-utils": true,
"@metamask/utils>@metamask/superstruct": true,
"@metamask/eth-snap-keyring>@metamask/utils": true,
"webpack>events": true,
Expand Down Expand Up @@ -1352,14 +1354,6 @@
"@metamask/keyring-api>bech32": true
}
},
"@metamask/profile-sync-controller>@metamask/keyring-api": {
"packages": {
"@metamask/keyring-api>@metamask/keyring-utils": true,
"@metamask/utils>@metamask/superstruct": true,
"@metamask/profile-sync-controller>@metamask/keyring-api>@metamask/utils": true,
"@metamask/keyring-api>bech32": true
}
},
"@metamask/keyring-controller": {
"packages": {
"@ethereumjs/tx>@ethereumjs/util": true,
Expand Down Expand Up @@ -1392,7 +1386,8 @@
},
"packages": {
"@metamask/utils>@metamask/superstruct": true,
"@metamask/keyring-api>@metamask/keyring-utils>@metamask/utils": true
"@metamask/keyring-api>@metamask/keyring-utils>@metamask/utils": true,
"bitcoin-address-validation": true
}
},
"@metamask/logging-controller": {
Expand Down Expand Up @@ -1622,7 +1617,7 @@
},
"packages": {
"@metamask/base-controller": true,
"@metamask/profile-sync-controller>@metamask/keyring-api": true,
"@metamask/keyring-api": true,
"@metamask/keyring-controller": true,
"@metamask/network-controller": true,
"@metamask/profile-sync-controller>@noble/ciphers": true,
Expand Down Expand Up @@ -1930,7 +1925,7 @@
"semver": true
}
},
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/abi-utils>@metamask/utils": {
"@metamask/signature-controller>@metamask/eth-sig-util>@metamask/abi-utils>@metamask/utils": {
"globals": {
"TextDecoder": true,
"TextEncoder": true
Expand All @@ -1945,7 +1940,7 @@
"semver": true
}
},
"@metamask/signature-controller>@metamask/eth-sig-util>@metamask/abi-utils>@metamask/utils": {
"@metamask/accounts-controller>@metamask/utils": {
"globals": {
"TextDecoder": true,
"TextEncoder": true
Expand Down Expand Up @@ -2095,21 +2090,6 @@
"semver": true
}
},
"@metamask/eth-snap-keyring>@metamask/eth-sig-util>@metamask/utils": {
"globals": {
"TextDecoder": true,
"TextEncoder": true
},
"packages": {
"@metamask/utils>@metamask/superstruct": true,
"@noble/hashes": true,
"@metamask/utils>@scure/base": true,
"browserify>buffer": true,
"nock>debug": true,
"@metamask/utils>pony-cause": true,
"semver": true
}
},
"@metamask/eth-trezor-keyring>@metamask/eth-sig-util>@metamask/utils": {
"globals": {
"TextDecoder": true,
Expand Down Expand Up @@ -2230,21 +2210,6 @@
"semver": true
}
},
"@metamask/profile-sync-controller>@metamask/keyring-api>@metamask/utils": {
"globals": {
"TextDecoder": true,
"TextEncoder": true
},
"packages": {
"@metamask/utils>@metamask/superstruct": true,
"@noble/hashes": true,
"@metamask/utils>@scure/base": true,
"browserify>buffer": true,
"nock>debug": true,
"@metamask/utils>pony-cause": true,
"semver": true
}
},
"@metamask/keyring-controller>@metamask/utils": {
"globals": {
"TextDecoder": true,
Expand Down
Loading

0 comments on commit 20994e9

Please sign in to comment.