Merge branch 'main' into feat/srp-flow-review

Author: HowardBraham

.github/workflows/cla.yml

@@ -23,7 +23,7 @@ jobs:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         with:
           path-to-signatures: 'cla.json'
-          url-to-cladocument: 'https://metamask.io/cla.html'
+          url-to-cladocument: 'https://metamask.io/cla'
           # This branch can't have protections, commits are made directly to the specified branch.
           branch: 'cla-signatures'
           allowlist: 'dependabot[bot],metamaskbot,crowdin-bot,runway-github[bot]'

app/_locales/en/messages.json

@@ -428,6 +428,10 @@ export const METAMASK_CONTROLLER_EVENTS = {
     'NotificationServicesController:markNotificationsAsRead',
 };
 
+/**
+ * @typedef {import('../../ui/store/store').MetaMaskReduxState} MetaMaskReduxState
+ */
+
 // Types of APIs
 const API_TYPE = {
   EIP1193: 'eip-1193',
@@ -3338,7 +3342,7 @@ export default class MetamaskController extends EventEmitter {
   /**
    * The metamask-state of the various controllers, made available to the UI
    *
-   * @returns {object} status
+   * @returns {MetaMaskReduxState["metamask"]} status
    */
   getState() {
     const { vault } = this.keyringController.state;

app/_locales/en_GB/messages.json

@@ -58,6 +58,14 @@ export default class ExtensionPlatform {
     return browser.runtime.getManifest().version;
   }
 
+  /**
+   * Returns the absolute URL of the extension's home.html page, optionally with
+   * a route and query string.
+   *
+   * @param {string | null} route
+   * @param {string | null} queryString
+   * @returns { string }
+   */
   getExtensionURL(route = null, queryString = null) {
     let extensionURL = browser.runtime.getURL('home.html');
 
@@ -72,6 +80,12 @@ export default class ExtensionPlatform {
     return extensionURL;
   }
 
+  /**
+   *
+   * @param {string | null} route
+   * @param {string | null} queryString
+   * @param {boolean} [keepWindowOpen] - defaults to false
+   */
   openExtensionInBrowser(
     route = null,
     queryString = null,

app/scripts/metamask-controller.js

@@ -55,7 +55,7 @@ export const DAPP_ONE_URL = `http://${DAPP_ONE_ADDRESS}`;
 export const DEFAULT_BTC_ADDRESS = 'bc1qg6whd6pc0cguh6gpp3ewujm53hv32ta9hdp252';
 
 /* Default BTC Account name */
-export const DEFAULT_ACCOUNT_NAME = 'Bitcoin Account 1';
+export const DEFAULT_BTC_ACCOUNT_NAME = 'Bitcoin Account 1';
 
 /* Default (mocked) BTC balance used by the Bitcoin RPC provider */
 export const DEFAULT_BTC_BALANCE = 1; // BTC

app/scripts/platforms/extension.js

@@ -1,64 +1,29 @@
 import { strict as assert } from 'assert';
 import { Suite } from 'mocha';
-import { DEFAULT_ACCOUNT_NAME, DEFAULT_BTC_BALANCE } from '../../constants';
+import { DEFAULT_BTC_ACCOUNT_NAME, DEFAULT_BTC_BALANCE } from '../../constants';
+import AssetListPage from '../../page-objects/pages/home/asset-list';
 import BitcoinHomepage from '../../page-objects/pages/home/bitcoin-homepage';
 import { withBtcAccountSnap } from './common-btc';
 
 describe('BTC Account - Overview', function (this: Suite) {
   it('has balance displayed and has portfolio button enabled for BTC accounts', async function () {
     await withBtcAccountSnap(async (driver) => {
-      await driver.findElement({
-        css: '[data-testid="account-menu-icon"]',
-        text: DEFAULT_ACCOUNT_NAME,
-      });
-
-      await driver.waitForSelector({
-        text: 'Send',
-        tag: 'button',
-        css: '[data-testid="coin-overview-send"]',
-      });
-
-      await driver.waitForSelector({
-        text: 'Swap',
-        tag: 'button',
-        css: '[disabled]',
-      });
-
-      await driver.waitForSelector({
-        text: 'Bridge',
-        tag: 'button',
-        css: '[disabled]',
-      });
-
-      // buy sell button
-      await driver.findClickableElement('[data-testid="coin-overview-buy"]');
-
-      // portfolio button
-      await driver.findClickableElement('[data-testid="portfolio-link"]');
-    }, this.test?.fullTitle());
-  });
-
-  it('has balance', async function () {
-    await withBtcAccountSnap(async (driver) => {
-      await driver.waitForSelector({
-        testId: 'account-value-and-suffix',
-        text: `${DEFAULT_BTC_BALANCE}`,
-      });
-
-      await driver.waitForSelector({
-        testId: 'multichain-token-list-item-value',
-        text: `${DEFAULT_BTC_BALANCE} BTC`,
-      });
       const homePage = new BitcoinHomepage(driver);
       await homePage.check_pageIsLoaded();
-      await homePage.headerNavbar.check_accountLabel(DEFAULT_ACCOUNT_NAME);
-      await homePage.check_isExpectedBitcoinBalanceDisplayed(
-        DEFAULT_BTC_BALANCE,
-      );
-      assert.equal(await homePage.check_isBridgeButtonEnabled(), false);
+      await homePage.headerNavbar.check_accountLabel(DEFAULT_BTC_ACCOUNT_NAME);
+
       assert.equal(await homePage.check_isSwapButtonEnabled(), false);
+      assert.equal(await homePage.check_isBridgeButtonEnabled(), false);
       assert.equal(await homePage.check_isBuySellButtonEnabled(), true);
       assert.equal(await homePage.check_isReceiveButtonEnabled(), true);
+      await homePage.check_portfolioLinkIsDisplayed();
+
+      await homePage.check_isExpectedBitcoinBalanceDisplayed(
+        DEFAULT_BTC_BALANCE,
+      );
+      await new AssetListPage(driver).check_tokenAmountIsDisplayed(
+        `${DEFAULT_BTC_BALANCE} BTC`,
+      );
     }, this.test?.fullTitle());
   });
 });

test/e2e/constants.ts

@@ -8,15 +8,15 @@ import LoginPage from '../../page-objects/pages/login-page';
 import PrivacySettings from '../../page-objects/pages/settings/privacy-settings';
 import ResetPasswordPage from '../../page-objects/pages/reset-password-page';
 import SettingsPage from '../../page-objects/pages/settings/settings-page';
-import { ACCOUNT_TYPE, DEFAULT_ACCOUNT_NAME } from '../../constants';
+import { ACCOUNT_TYPE, DEFAULT_BTC_ACCOUNT_NAME } from '../../constants';
 import { withBtcAccountSnap } from './common-btc';
 
 describe('Create BTC Account', function (this: Suite) {
   it('create BTC account from the menu', async function () {
     await withBtcAccountSnap(async (driver) => {
       const headerNavbar = new HeaderNavbar(driver);
       await headerNavbar.check_pageIsLoaded();
-      await headerNavbar.check_accountLabel(DEFAULT_ACCOUNT_NAME);
+      await headerNavbar.check_accountLabel(DEFAULT_BTC_ACCOUNT_NAME);
     }, this.test?.fullTitle());
   });
 
@@ -25,7 +25,7 @@ describe('Create BTC Account', function (this: Suite) {
       // check that we have one BTC account
       const headerNavbar = new HeaderNavbar(driver);
       await headerNavbar.check_pageIsLoaded();
-      await headerNavbar.check_accountLabel(DEFAULT_ACCOUNT_NAME);
+      await headerNavbar.check_accountLabel(DEFAULT_BTC_ACCOUNT_NAME);
 
       // check user cannot create second BTC account
       await headerNavbar.openAccountMenu();
@@ -45,14 +45,14 @@ describe('Create BTC Account', function (this: Suite) {
       // check that we have one BTC account
       const headerNavbar = new HeaderNavbar(driver);
       await headerNavbar.check_pageIsLoaded();
-      await headerNavbar.check_accountLabel(DEFAULT_ACCOUNT_NAME);
+      await headerNavbar.check_accountLabel(DEFAULT_BTC_ACCOUNT_NAME);
 
       // check user can cancel the removal of the BTC account
       await headerNavbar.openAccountMenu();
       const accountListPage = new AccountListPage(driver);
       await accountListPage.check_pageIsLoaded();
-      await accountListPage.removeAccount(DEFAULT_ACCOUNT_NAME, false);
-      await headerNavbar.check_accountLabel(DEFAULT_ACCOUNT_NAME);
+      await accountListPage.removeAccount(DEFAULT_BTC_ACCOUNT_NAME, false);
+      await headerNavbar.check_accountLabel(DEFAULT_BTC_ACCOUNT_NAME);
 
       // check the number of accounts. it should be 2.
       await headerNavbar.openAccountMenu();
@@ -66,19 +66,19 @@ describe('Create BTC Account', function (this: Suite) {
       // check that we have one BTC account
       const headerNavbar = new HeaderNavbar(driver);
       await headerNavbar.check_pageIsLoaded();
-      await headerNavbar.check_accountLabel(DEFAULT_ACCOUNT_NAME);
+      await headerNavbar.check_accountLabel(DEFAULT_BTC_ACCOUNT_NAME);
 
       // get the address of the BTC account and remove it
       await headerNavbar.openAccountMenu();
       const accountListPage = new AccountListPage(driver);
       await accountListPage.check_pageIsLoaded();
-      await accountListPage.openAccountDetailsModal(DEFAULT_ACCOUNT_NAME);
+      await accountListPage.openAccountDetailsModal(DEFAULT_BTC_ACCOUNT_NAME);
 
       const accountDetailsModal = new AccountDetailsModal(driver);
       await accountDetailsModal.check_pageIsLoaded();
       const accountAddress = await accountDetailsModal.getAccountAddress();
       await headerNavbar.openAccountMenu();
-      await accountListPage.removeAccount(DEFAULT_ACCOUNT_NAME);
+      await accountListPage.removeAccount(DEFAULT_BTC_ACCOUNT_NAME);
 
       // Recreate account and check that the address is the same
       await headerNavbar.openAccountMenu();
@@ -90,11 +90,11 @@ describe('Create BTC Account', function (this: Suite) {
       await accountListPage.closeAccountModal();
       await headerNavbar.openAccountMenu();
       await accountListPage.addAccount({ accountType: ACCOUNT_TYPE.Bitcoin });
-      await headerNavbar.check_accountLabel(DEFAULT_ACCOUNT_NAME);
+      await headerNavbar.check_accountLabel(DEFAULT_BTC_ACCOUNT_NAME);
 
       await headerNavbar.openAccountMenu();
       await accountListPage.check_pageIsLoaded();
-      await accountListPage.openAccountDetailsModal(DEFAULT_ACCOUNT_NAME);
+      await accountListPage.openAccountDetailsModal(DEFAULT_BTC_ACCOUNT_NAME);
       await accountDetailsModal.check_pageIsLoaded();
       const recreatedAccountAddress =
         await accountDetailsModal.getAccountAddress();
@@ -108,12 +108,12 @@ describe('Create BTC Account', function (this: Suite) {
       // check that we have one BTC account
       const headerNavbar = new HeaderNavbar(driver);
       await headerNavbar.check_pageIsLoaded();
-      await headerNavbar.check_accountLabel(DEFAULT_ACCOUNT_NAME);
+      await headerNavbar.check_accountLabel(DEFAULT_BTC_ACCOUNT_NAME);
 
       await headerNavbar.openAccountMenu();
       const accountListPage = new AccountListPage(driver);
       await accountListPage.check_pageIsLoaded();
-      await accountListPage.openAccountDetailsModal(DEFAULT_ACCOUNT_NAME);
+      await accountListPage.openAccountDetailsModal(DEFAULT_BTC_ACCOUNT_NAME);
       const accountDetailsModal = new AccountDetailsModal(driver);
       await accountDetailsModal.check_pageIsLoaded();
       const accountAddress = await accountDetailsModal.getAccountAddress();
@@ -141,7 +141,7 @@ describe('Create BTC Account', function (this: Suite) {
       // check discovered account address is the same
       await headerNavbar.openAccountMenu();
       await accountListPage.check_pageIsLoaded();
-      await accountListPage.openAccountDetailsModal(DEFAULT_ACCOUNT_NAME);
+      await accountListPage.openAccountDetailsModal(DEFAULT_BTC_ACCOUNT_NAME);
       await accountDetailsModal.check_pageIsLoaded();
       const discoveredAccountAddress =
         await accountDetailsModal.getAccountAddress();

test/e2e/flask/btc/btc-account-overview.spec.ts

@@ -32,22 +32,12 @@ describe('BTC Account - Send', function (this: Suite) {
 
       const bitcoinReviewTxPage = new BitcoinReviewTxPage(driver);
       await bitcoinReviewTxPage.check_pageIsLoaded();
-      await driver.waitForSelector({
-        text: `Sending ${sendAmount} BTC`,
-        tag: 'h2',
-      });
-      await driver.waitForSelector({
-        text: `${expectedFee} sats`,
-        tag: 'p',
-      });
-      await driver.waitForSelector({
-        text: `${Math.floor(DEFAULT_BTC_FEE_RATE)} sat/vB`,
-        tag: 'p',
-      });
-      await driver.waitForSelector({
-        text: `${expectedTotal} BTC`,
-        tag: 'p',
-      });
+      await bitcoinReviewTxPage.check_sendAmountIsDisplayed(sendAmount);
+      await bitcoinReviewTxPage.check_networkFeeIsDisplayed(expectedFee);
+      await bitcoinReviewTxPage.check_feeRateIsDisplayed(
+        Math.floor(DEFAULT_BTC_FEE_RATE).toString(),
+      );
+      await bitcoinReviewTxPage.check_totalAmountIsDisplayed(expectedTotal);
       await bitcoinReviewTxPage.clickSendButton();
 
       // TODO: Test that the transaction appears in the activity tab once activity tab is implemented for Bitcoin
@@ -77,14 +67,12 @@ describe('BTC Account - Send', function (this: Suite) {
 
       const bitcoinReviewTxPage = new BitcoinReviewTxPage(driver);
       await bitcoinReviewTxPage.check_pageIsLoaded();
-      await driver.waitForSelector({
-        text: `Sending ${DEFAULT_BTC_BALANCE - expectedFee} BTC`,
-        tag: 'h2',
-      });
-      await driver.waitForSelector({
-        text: `${DEFAULT_BTC_BALANCE} BTC`,
-        tag: 'p',
-      });
+      await bitcoinReviewTxPage.check_sendAmountIsDisplayed(
+        (DEFAULT_BTC_BALANCE - expectedFee).toString(),
+      );
+      await bitcoinReviewTxPage.check_totalAmountIsDisplayed(
+        DEFAULT_BTC_BALANCE.toString(),
+      );
       await bitcoinReviewTxPage.clickSendButton();
 
       // TODO: Test that the transaction appears in the activity tab once activity tab is implemented for Bitcoin

test/e2e/flask/btc/btc-create-account.spec.ts

@@ -46,9 +46,6 @@ const ALLOWLISTED_URLS = [
   'https://metamask.github.io/vault-decryptor/bundle.js',
 ];
 
-const ALLOWLISTED_HOSTS = [
-  'accounts.api.cx.metamask.io',
-  'token.api.cx.metamask.io',
-];
+const ALLOWLISTED_HOSTS = ['token.api.cx.metamask.io'];
 
 module.exports = { ALLOWLISTED_HOSTS, ALLOWLISTED_URLS };