- {showStatus ? ( // TODO: Move the connection status menu icon to the correct position in header once we implement the new header
+ {showStatus ? (
history.push(CONNECTED_ACCOUNTS_ROUTE)}
/>
@@ -58,18 +57,12 @@ export default function MenuBar() {
}}
/>
- {accountOptionsMenuOpen &&
- (process.env.MULTICHAIN ? (
- setAccountOptionsMenuOpen(false)}
- />
- ) : (
- setAccountOptionsMenuOpen(false)}
- />
- ))}
+ {accountOptionsMenuOpen && (
+ setAccountOptionsMenuOpen(false)}
+ />
+ )}
);
}
diff --git a/ui/components/multichain/account-list-menu/account-list-menu.js b/ui/components/multichain/account-list-menu/account-list-menu.js
index fcb7d1046f92..7ffbcf5fa61b 100644
--- a/ui/components/multichain/account-list-menu/account-list-menu.js
+++ b/ui/components/multichain/account-list-menu/account-list-menu.js
@@ -103,7 +103,6 @@ export const AccountListMenu = ({ onClose }) => {
},
});
dispatch(setSelectedAccount(account.address));
- onClose();
}}
identity={account}
key={account.address}
diff --git a/ui/components/multichain/app-header/__snapshots__/app-header.test.js.snap b/ui/components/multichain/app-header/__snapshots__/app-header.test.js.snap
new file mode 100644
index 000000000000..d4d1cc8da2bb
--- /dev/null
+++ b/ui/components/multichain/app-header/__snapshots__/app-header.test.js.snap
@@ -0,0 +1,224 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`App Header should match snapshot 1`] = `
+
+
+`;
diff --git a/ui/components/multichain/app-header/app-header.js b/ui/components/multichain/app-header/app-header.js
new file mode 100644
index 000000000000..d7f278530c9f
--- /dev/null
+++ b/ui/components/multichain/app-header/app-header.js
@@ -0,0 +1,215 @@
+import React, { useContext, useState, useRef } from 'react';
+import PropTypes from 'prop-types';
+import browser from 'webextension-polyfill';
+import { useDispatch, useSelector } from 'react-redux';
+import { useHistory } from 'react-router-dom';
+import { MetaMetricsContext } from '../../../contexts/metametrics';
+import {
+ MetaMetricsEventCategory,
+ MetaMetricsEventName,
+} from '../../../../shared/constants/metametrics';
+import {
+ CONNECTED_ACCOUNTS_ROUTE,
+ DEFAULT_ROUTE,
+} from '../../../helpers/constants/routes';
+
+import {
+ AlignItems,
+ BackgroundColor,
+ BLOCK_SIZES,
+ DISPLAY,
+ JustifyContent,
+ Size,
+} from '../../../helpers/constants/design-system';
+import { AvatarNetwork, Button, PickerNetwork } from '../../component-library';
+import { ButtonIcon } from '../../component-library/button-icon/deprecated';
+import { ICON_NAMES } from '../../component-library/icon/deprecated';
+import {
+ getCurrentNetwork,
+ getOriginOfCurrentTab,
+ getSelectedIdentity,
+} from '../../../selectors';
+import { GlobalMenu, AccountPicker } from '..';
+
+import Box from '../../ui/box/box';
+import { toggleAccountMenu, toggleNetworkMenu } from '../../../store/actions';
+import MetafoxLogo from '../../ui/metafox-logo';
+import { getEnvironmentType } from '../../../../app/scripts/lib/util';
+import { ENVIRONMENT_TYPE_POPUP } from '../../../../shared/constants/app';
+import ConnectedStatusIndicator from '../../app/connected-status-indicator';
+
+export const AppHeader = ({ onClick }) => {
+ const trackEvent = useContext(MetaMetricsContext);
+ const [accountOptionsMenuOpen, setAccountOptionsMenuOpen] = useState(false);
+ const menuRef = useRef(false);
+ const origin = useSelector(getOriginOfCurrentTab);
+ const history = useHistory();
+ const isUnlocked = useSelector((state) => state.metamask.isUnlocked);
+
+ // Used for account picker
+ const identity = useSelector(getSelectedIdentity);
+ const dispatch = useDispatch();
+
+ // Used for network icon / dropdown
+ const currentNetwork = useSelector(getCurrentNetwork);
+
+ // used to get the environment and connection status
+ const popupStatus = getEnvironmentType() === ENVIRONMENT_TYPE_POPUP;
+ const showStatus =
+ getEnvironmentType() === ENVIRONMENT_TYPE_POPUP &&
+ origin &&
+ origin !== browser.runtime.id;
+
+ return (
+ <>
+ {isUnlocked && !popupStatus ? (
+
+
+
+
+
+
+
+ 
+
+
+
- toggleAccountMenu()} />
) : null}
+ {process.env.MULTICHAIN && isNetworkMenuOpen ? (
+ toggleNetworkMenu()} />
+ ) : null}
{isLoading ?
Date: Thu, 13 Apr 2023 22:54:33 +0530
Subject: [PATCH 04/23] Improvement on approval pages (#18545)
---
.../custom-spending-cap/custom-spending-cap.js | 14 ++++++++++++--
ui/components/ui/form-field/form-field.js | 7 +++++++
.../numeric-input/numeric-input.component.js | 3 +++
.../confirm-approve-content.component.js | 11 +++++++++++
.../confirm-approve-content.component.test.js | 18 ++++++++++++++++++
ui/pages/token-allowance/token-allowance.js | 11 +++++++++++
.../token-allowance/token-allowance.test.js | 18 ++++++++++++++++++
7 files changed, 80 insertions(+), 2 deletions(-)
diff --git a/ui/components/app/custom-spending-cap/custom-spending-cap.js b/ui/components/app/custom-spending-cap/custom-spending-cap.js
index 12f1ddce431b..7f4a46c26225 100644
--- a/ui/components/app/custom-spending-cap/custom-spending-cap.js
+++ b/ui/components/app/custom-spending-cap/custom-spending-cap.js
@@ -1,4 +1,4 @@
-import React, { useState, useContext, useEffect } from 'react';
+import React, { useState, useContext, useEffect, useRef } from 'react';
import { useDispatch, useSelector } from 'react-redux';
import PropTypes from 'prop-types';
import classnames from 'classnames';
@@ -41,6 +41,7 @@ export default function CustomSpendingCap({
}) {
const t = useContext(I18nContext);
const dispatch = useDispatch();
+ const inputRef = useRef(null);
const value = useSelector(getCustomTokenAmount);
@@ -139,6 +140,15 @@ export default function CustomSpendingCap({
passTheErrorText(error);
}, [error, passTheErrorText]);
+ useEffect(() => {
+ if (inputRef.current) {
+ inputRef.current.focus({
+ preventScroll: true,
+ });
+ }
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, [inputRef.current]);
+
const chooseTooltipContentText = decConversionGreaterThan(
value,
currentTokenBalance,
@@ -182,8 +192,8 @@ export default function CustomSpendingCap({
}
>
+ {(txData?.securityProviderResponse?.flagAsDangerous !== undefined &&
+ txData?.securityProviderResponse?.flagAsDangerous !==
+ SECURITY_PROVIDER_MESSAGE_SEVERITIES.NOT_MALICIOUS) ||
+ (txData?.securityProviderResponse &&
+ Object.keys(txData.securityProviderResponse).length === 0) ? (
+
+ {(txData?.securityProviderResponse?.flagAsDangerous !== undefined &&
+ txData?.securityProviderResponse?.flagAsDangerous !==
+ SECURITY_PROVIDER_MESSAGE_SEVERITIES.NOT_MALICIOUS) ||
+ (txData?.securityProviderResponse &&
+ Object.keys(txData.securityProviderResponse).length === 0) ? (
+ {
expect(queryByText('Prior to clicking confirm:')).toBeNull();
});
+
+ it('should render security provider response if transaction is malicious', () => {
+ const securityProviderResponse = {
+ flagAsDangerous: 1,
+ reason:
+ 'This has been flagged as potentially suspicious. If you sign, you could lose access to all of your NFTs and any funds or other assets in your wallet.',
+ reason_header: 'Warning',
+ };
+ const { getByText } = renderWithProvider(
+
Date: Thu, 13 Apr 2023 23:07:33 +0530
Subject: [PATCH 05/23] updated copy Address (#18557)
Co-authored-by: Danica Shen
---
ui/components/app/wallet-overview/wallet-overview.js | 12 +++++++++++-
1 file changed, 11 insertions(+), 1 deletion(-)
diff --git a/ui/components/app/wallet-overview/wallet-overview.js b/ui/components/app/wallet-overview/wallet-overview.js
index 9265e31b08ea..5be0ef73b537 100644
--- a/ui/components/app/wallet-overview/wallet-overview.js
+++ b/ui/components/app/wallet-overview/wallet-overview.js
@@ -1,12 +1,22 @@
import React from 'react';
import PropTypes from 'prop-types';
import classnames from 'classnames';
+import { useSelector } from 'react-redux';
+import { toChecksumHexAddress } from '../../../../shared/modules/hexstring-utils';
+import { getSelectedIdentity } from '../../../selectors';
+import { AddressCopyButton } from '../../multichain';
const WalletOverview = ({ balance, buttons, className, icon, loading }) => {
+ const selectedIdentity = useSelector(getSelectedIdentity);
+ const checksummedAddress = toChecksumHexAddress(selectedIdentity?.address);
return (
Date: Thu, 13 Apr 2023 15:24:47 -0700
Subject: [PATCH 06/23] Update multichain Icon imports (#18536)
* Update multichain Icon imports
* replace ButtonIcon with updated version
* Buttons with Icon TODO added
* update header to use TS version Icon
---
.../account-list-item-menu.js | 9 ++++-----
.../account-list-item/account-list-item.js | 12 +++++-------
.../account-list-menu/account-list-menu.js | 1 +
.../multichain/account-picker/account-picker.js | 5 +++--
.../address-copy-button/address-copy-button.js | 1 +
ui/components/multichain/app-header/app-header.js | 13 +++++++++----
.../multichain/global-menu/global-menu.js | 14 +++++++-------
.../multichain-connected-site-menu.js | 5 ++---
.../multichain-import-token-link.js | 1 +
.../network-list-item/network-list-item.js | 11 +++++++----
ui/components/ui/menu/menu-item.js | 5 ++---
11 files changed, 42 insertions(+), 35 deletions(-)
diff --git a/ui/components/multichain/account-list-item-menu/account-list-item-menu.js b/ui/components/multichain/account-list-item-menu/account-list-item-menu.js
index ac65bcd5b4bf..df3cece9a576 100644
--- a/ui/components/multichain/account-list-item-menu/account-list-item-menu.js
+++ b/ui/components/multichain/account-list-item-menu/account-list-item-menu.js
@@ -12,8 +12,7 @@ import {
} from '../../../selectors';
import { NETWORKS_ROUTE } from '../../../helpers/constants/routes';
import { Menu, MenuItem } from '../../ui/menu';
-import { Text } from '../../component-library';
-import { ICON_NAMES } from '../../component-library/icon/deprecated';
+import { Text, IconName } from '../../component-library';
import {
MetaMetricsEventCategory,
MetaMetricsEventLinkType,
@@ -74,7 +73,7 @@ export const AccountListItemMenu = ({
: openBlockExplorer
}
subtitle={blockExplorerUrlSubTitle || null}
- iconName={ICON_NAMES.EXPORT}
+ iconName={IconName.Export}
data-testid="account-list-menu-open-explorer"
>
{t('viewOnExplorer')}
@@ -92,7 +91,7 @@ export const AccountListItemMenu = ({
onClose();
closeMenu?.();
}}
- iconName={ICON_NAMES.SCAN_BARCODE}
+ iconName={IconName.ScanBarcode}
>
{t('accountDetails')}
@@ -108,7 +107,7 @@ export const AccountListItemMenu = ({
);
onClose();
}}
- iconName={ICON_NAMES.TRASH}
+ iconName={IconName.Trash}
>
{t('removeAccount')}
diff --git a/ui/components/multichain/account-list-item/account-list-item.js b/ui/components/multichain/account-list-item/account-list-item.js
index deeddff19eed..05a33ea0aacf 100644
--- a/ui/components/multichain/account-list-item/account-list-item.js
+++ b/ui/components/multichain/account-list-item/account-list-item.js
@@ -15,12 +15,10 @@ import {
AvatarFavicon,
Tag,
ButtonLink,
+ ButtonIcon,
+ IconName,
+ IconSize,
} from '../../component-library';
-import { ButtonIcon } from '../../component-library/button-icon/deprecated';
-import {
- ICON_NAMES,
- ICON_SIZES,
-} from '../../component-library/icon/deprecated';
import {
Color,
TEXT_ALIGN,
@@ -197,8 +195,8 @@ export const AccountListItem = ({
{
e.stopPropagation();
setAccountOptionsMenuOpen(true);
diff --git a/ui/components/multichain/account-list-menu/account-list-menu.js b/ui/components/multichain/account-list-menu/account-list-menu.js
index 7ffbcf5fa61b..aea2e81c6ff0 100644
--- a/ui/components/multichain/account-list-menu/account-list-menu.js
+++ b/ui/components/multichain/account-list-menu/account-list-menu.js
@@ -5,6 +5,7 @@ import Fuse from 'fuse.js';
import { useDispatch, useSelector } from 'react-redux';
import Box from '../../ui/box/box';
import { ButtonLink, TextFieldSearch, Text } from '../../component-library';
+// TODO: Replace ICON_NAMES with IconName when ButtonBase/Buttons have been updated
import { ICON_NAMES } from '../../component-library/icon/deprecated';
import { AccountListItem } from '..';
import {
diff --git a/ui/components/multichain/account-picker/account-picker.js b/ui/components/multichain/account-picker/account-picker.js
index 72b522893895..5701249a1c8d 100644
--- a/ui/components/multichain/account-picker/account-picker.js
+++ b/ui/components/multichain/account-picker/account-picker.js
@@ -5,9 +5,10 @@ import {
Button,
AvatarAccount,
AvatarAccountVariant,
+ Icon,
+ IconName,
Text,
} from '../../component-library';
-import { ICON_NAMES, Icon } from '../../component-library/icon/deprecated';
import {
AlignItems,
BackgroundColor,
@@ -47,7 +48,7 @@ export const AccountPicker = ({ address, name, onClick }) => {
{name}
{
diff --git a/ui/components/multichain/global-menu/global-menu.js b/ui/components/multichain/global-menu/global-menu.js
index 7500c3046d87..2d89cf688bc4 100644
--- a/ui/components/multichain/global-menu/global-menu.js
+++ b/ui/components/multichain/global-menu/global-menu.js
@@ -9,7 +9,7 @@ import {
} from '../../../helpers/constants/routes';
import { lockMetamask } from '../../../store/actions';
import { useI18nContext } from '../../../hooks/useI18nContext';
-import { ICON_NAMES } from '../../component-library/icon/deprecated';
+import { IconName } from '../../component-library';
import { Menu, MenuItem } from '../../ui/menu';
import { getEnvironmentType } from '../../../../app/scripts/lib/util';
import { ENVIRONMENT_TYPE_FULLSCREEN } from '../../../../shared/constants/app';
@@ -31,7 +31,7 @@ export const GlobalMenu = ({ closeMenu, anchorElement }) => {
return (
`;
diff --git a/ui/pages/institutional/confirm-add-institutional-feature/confirm-add-institutional-feature.js b/ui/pages/institutional/confirm-add-institutional-feature/confirm-add-institutional-feature.js
index 25a52fc16188..0e89910e286e 100644
--- a/ui/pages/institutional/confirm-add-institutional-feature/confirm-add-institutional-feature.js
+++ b/ui/pages/institutional/confirm-add-institutional-feature/confirm-add-institutional-feature.js
@@ -7,12 +7,17 @@ import PulseLoader from '../../../components/ui/pulse-loader';
import { INSTITUTIONAL_FEATURES_DONE_ROUTE } from '../../../helpers/constants/routes';
import { MetaMetricsContext } from '../../../contexts/metametrics';
import { getMostRecentOverviewPage } from '../../../ducks/history/history';
-import { Text } from '../../../components/component-library';
+import {
+ Text,
+ BUTTON_SIZES,
+ BUTTON_TYPES,
+} from '../../../components/component-library';
import {
TextColor,
TextVariant,
OVERFLOW_WRAP,
TEXT_ALIGN,
+ DISPLAY,
} from '../../../helpers/constants/design-system';
import Box from '../../../components/ui/box';
import { mmiActionsFactory } from '../../../store/institutional/institution-background';
@@ -169,16 +174,15 @@ export default function ConfirmAddInstitutionalFeature({ history }) {
)}
-
+
{isLoading ? (
-
+
)}
From 26db0aee46ad5dcac7753fe5cd685ca14c21c20d Mon Sep 17 00:00:00 2001
From: Elliot Winkler
Date: Fri, 14 Apr 2023 10:21:29 -0600
Subject: [PATCH 12/23] Convert NetworkController net client tests to TS
(#18490)
In order to be able to better compare differences between the version of
NetworkController in this repo and the version in the `core` repo before
we replace this version with the `core` version, this commit converts
the NetworkController network client tests to TypeScript.
The added types here are copied from the `core` repo. We plan on
making more improvements on the `core` side at some point to polish the
tests and types and reduce some of the duplication, but for now we're
just trying to keep things as similar as possible.
---
.eslintrc.js | 2 +-
....test.js => create-network-client.test.ts} | 0
...-response.js => block-hash-in-response.ts} | 18 +-
.../{block-param.js => block-param.ts} | 19 +-
.../{helpers.js => helpers.ts} | 404 ++++++++++--------
.../{no-block-param.js => no-block-param.ts} | 13 +-
...leware.js => not-handled-by-middleware.ts} | 18 +-
.../{shared-tests.js => shared-tests.ts} | 14 +-
package.json | 1 +
yarn.lock | 8 +
10 files changed, 299 insertions(+), 198 deletions(-)
rename app/scripts/controllers/network/{create-network-client.test.js => create-network-client.test.ts} (100%)
rename app/scripts/controllers/network/provider-api-tests/{block-hash-in-response.js => block-hash-in-response.ts} (96%)
rename app/scripts/controllers/network/provider-api-tests/{block-param.js => block-param.ts} (99%)
rename app/scripts/controllers/network/provider-api-tests/{helpers.js => helpers.ts} (56%)
rename app/scripts/controllers/network/provider-api-tests/{no-block-param.js => no-block-param.ts} (99%)
rename app/scripts/controllers/network/provider-api-tests/{not-handled-by-middleware.js => not-handled-by-middleware.ts} (83%)
rename app/scripts/controllers/network/provider-api-tests/{shared-tests.js => shared-tests.ts} (98%)
diff --git a/.eslintrc.js b/.eslintrc.js
index bcbfb44b7f8c..89578fa19033 100644
--- a/.eslintrc.js
+++ b/.eslintrc.js
@@ -267,7 +267,7 @@ module.exports = {
'app/scripts/controllers/app-state.test.js',
'app/scripts/controllers/network/**/*.test.js',
'app/scripts/controllers/network/**/*.test.ts',
- 'app/scripts/controllers/network/provider-api-tests/*.js',
+ 'app/scripts/controllers/network/provider-api-tests/*.ts',
'app/scripts/controllers/permissions/**/*.test.js',
'app/scripts/lib/**/*.test.js',
'app/scripts/migrations/*.test.js',
diff --git a/app/scripts/controllers/network/create-network-client.test.js b/app/scripts/controllers/network/create-network-client.test.ts
similarity index 100%
rename from app/scripts/controllers/network/create-network-client.test.js
rename to app/scripts/controllers/network/create-network-client.test.ts
diff --git a/app/scripts/controllers/network/provider-api-tests/block-hash-in-response.js b/app/scripts/controllers/network/provider-api-tests/block-hash-in-response.ts
similarity index 96%
rename from app/scripts/controllers/network/provider-api-tests/block-hash-in-response.js
rename to app/scripts/controllers/network/provider-api-tests/block-hash-in-response.ts
index c1778f6283b2..4ee0f633dc9b 100644
--- a/app/scripts/controllers/network/provider-api-tests/block-hash-in-response.js
+++ b/app/scripts/controllers/network/provider-api-tests/block-hash-in-response.ts
@@ -1,6 +1,15 @@
/* eslint-disable jest/require-top-level-describe, jest/no-export */
-import { withMockedCommunications, withNetworkClient } from './helpers';
+import {
+ ProviderType,
+ withMockedCommunications,
+ withNetworkClient,
+} from './helpers';
+
+type TestsForRpcMethodThatCheckForBlockHashInResponseOptions = {
+ providerType: ProviderType;
+ numberOfParameters: number;
+};
/**
* Defines tests which exercise the behavior exhibited by an RPC method that
@@ -15,8 +24,11 @@ import { withMockedCommunications, withNetworkClient } from './helpers';
* either `infura` or `custom` (default: "infura").
*/
export function testsForRpcMethodsThatCheckForBlockHashInResponse(
- method,
- { numberOfParameters, providerType },
+ method: string,
+ {
+ numberOfParameters,
+ providerType,
+ }: TestsForRpcMethodThatCheckForBlockHashInResponseOptions,
) {
if (providerType !== 'infura' && providerType !== 'custom') {
throw new Error(
diff --git a/app/scripts/controllers/network/provider-api-tests/block-param.js b/app/scripts/controllers/network/provider-api-tests/block-param.ts
similarity index 99%
rename from app/scripts/controllers/network/provider-api-tests/block-param.js
rename to app/scripts/controllers/network/provider-api-tests/block-param.ts
index 49bd6e772a0b..92fb65f0450d 100644
--- a/app/scripts/controllers/network/provider-api-tests/block-param.js
+++ b/app/scripts/controllers/network/provider-api-tests/block-param.ts
@@ -3,6 +3,7 @@
import {
buildMockParams,
buildRequestWithReplacedBlockParam,
+ ProviderType,
waitForPromiseToBeFulfilledAfterRunningAllTimers,
withMockedCommunications,
withNetworkClient,
@@ -13,6 +14,12 @@ import {
buildJsonRpcEngineEmptyResponseErrorMessage,
} from './shared-tests';
+type TestsForRpcMethodSupportingBlockParam = {
+ providerType: ProviderType;
+ blockParamIndex: number;
+ numberOfParameters: number;
+};
+
/**
* Defines tests which exercise the behavior exhibited by an RPC method that
* takes a block parameter. The value of this parameter can be either a block
@@ -28,8 +35,12 @@ import {
*/
/* eslint-disable-next-line jest/no-export */
export function testsForRpcMethodSupportingBlockParam(
- method,
- { blockParamIndex, numberOfParameters, providerType },
+ method: string,
+ {
+ blockParamIndex,
+ numberOfParameters,
+ providerType,
+ }: TestsForRpcMethodSupportingBlockParam,
) {
describe.each([
['given no block tag', undefined],
@@ -1718,9 +1729,9 @@ export function testsForRpcMethodSupportingBlockParam(
[
['less than the current block number', '0x200'],
['equal to the curent block number', '0x100'],
- ],
+ ] as any,
'%s',
- (_nestedDesc, currentBlockNumber) => {
+ (_nestedDesc: string, currentBlockNumber: string) => {
it('makes an additional request to the RPC endpoint', async () => {
await withMockedCommunications({ providerType }, async (comms) => {
const request = {
diff --git a/app/scripts/controllers/network/provider-api-tests/helpers.js b/app/scripts/controllers/network/provider-api-tests/helpers.ts
similarity index 56%
rename from app/scripts/controllers/network/provider-api-tests/helpers.js
rename to app/scripts/controllers/network/provider-api-tests/helpers.ts
index afa91a7bba6c..edcc1ca0258f 100644
--- a/app/scripts/controllers/network/provider-api-tests/helpers.js
+++ b/app/scripts/controllers/network/provider-api-tests/helpers.ts
@@ -1,14 +1,13 @@
-import nock from 'nock';
+import nock, { Scope as NockScope } from 'nock';
import sinon from 'sinon';
+import type { JSONRPCResponse } from '@json-rpc-specification/meta-schema';
import EthQuery from 'eth-query';
-import { createNetworkClient } from '../create-network-client';
-
-/**
- * @typedef {import('nock').Scope} NockScope
- *
- * A object returned by the `nock` function for mocking requests to a particular
- * base URL.
- */
+import { Hex } from '@metamask/utils';
+import { BuiltInInfuraNetwork } from '../../../../../shared/constants/network';
+import {
+ createNetworkClient,
+ NetworkClientType,
+} from '../create-network-client';
/**
* A dummy value for the `infuraProjectId` option that `createInfuraClient`
@@ -41,9 +40,9 @@ const originalSetTimeout = setTimeout;
* keeps failing, you can set `process.env.DEBUG_PROVIDER_TESTS` to `1`. This
* will turn on some extra logging.
*
- * @param {any[]} args - The arguments that `console.log` takes.
+ * @param args - The arguments that `console.log` takes.
*/
-function debug(...args) {
+function debug(...args: any) {
if (process.env.DEBUG_PROVIDER_TESTS === '1') {
console.log(...args);
}
@@ -52,96 +51,89 @@ function debug(...args) {
/**
* Builds a Nock scope object for mocking provider requests.
*
- * @param {string} rpcUrl - The URL of the RPC endpoint.
- * @returns {NockScope} The nock scope.
+ * @param rpcUrl - The URL of the RPC endpoint.
+ * @returns The nock scope.
*/
-function buildScopeForMockingRequests(rpcUrl) {
+function buildScopeForMockingRequests(rpcUrl: string): NockScope {
return nock(rpcUrl).filteringRequestBody((body) => {
debug('Nock Received Request: ', body);
return body;
});
}
-/**
- * @typedef {{ nockScope: NockScope, blockNumber: string }} MockBlockTrackerRequestOptions
- *
- * The options to `mockNextBlockTrackerRequest` and `mockAllBlockTrackerRequests`.
- */
-
-/**
- * Mocks the next request for the latest block that the block tracker will make.
- *
- * @param {MockBlockTrackerRequestOptions} args - The arguments.
- * @param {NockScope} args.nockScope - A nock scope (a set of mocked requests
- * scoped to a certain base URL).
- * @param {string} args.blockNumber - The block number that the block tracker
- * should report, as a 0x-prefixed hex string.
- */
-async function mockNextBlockTrackerRequest({
- nockScope,
- blockNumber = DEFAULT_LATEST_BLOCK_NUMBER,
-}) {
- await mockRpcCall({
- nockScope,
- request: { method: 'eth_blockNumber', params: [] },
- response: { result: blockNumber },
- });
-}
-
-/**
- * Mocks all requests for the latest block that the block tracker will make.
- *
- * @param {MockBlockTrackerRequestOptions} args - The arguments.
- * @param {NockScope} args.nockScope - A nock scope (a set of mocked requests
- * scoped to a certain base URL).
- * @param {string} args.blockNumber - The block number that the block tracker
- * should report, as a 0x-prefixed hex string.
- */
-async function mockAllBlockTrackerRequests({
- nockScope,
- blockNumber = DEFAULT_LATEST_BLOCK_NUMBER,
-}) {
- await mockRpcCall({
- nockScope,
- request: { method: 'eth_blockNumber', params: [] },
- response: { result: blockNumber },
- }).persist();
-}
-
-/**
- * @typedef {{ nockScope: NockScope, request: object, response: object, delay?: number }} MockRpcCallOptions
- *
- * The options to `mockRpcCall`.
- */
+type Request = { method: string; params?: any[] };
+type Response = {
+ id?: number | string;
+ jsonrpc?: '2.0';
+ error?: any;
+ result?: any;
+ httpStatus?: number;
+};
+type ResponseBody = { body: JSONRPCResponse };
+type BodyOrResponse = ResponseBody | Response;
+type CurriedMockRpcCallOptions = {
+ request: Request;
+ // The response data.
+ response?: BodyOrResponse;
+ /**
+ * An error to throw while making the request.
+ * Takes precedence over `response`.
+ */
+ error?: Error | string;
+ /**
+ * The amount of time that should pass before the
+ * request resolves with the response.
+ */
+ delay?: number;
+ /**
+ * The number of times that the request is
+ * expected to be made.
+ */
+ times?: number;
+};
+
+type MockRpcCallOptions = {
+ // A nock scope (a set of mocked requests scoped to a certain base URL).
+ nockScope: nock.Scope;
+} & CurriedMockRpcCallOptions;
+
+type MockRpcCallResult = nock.Interceptor | nock.Scope;
/**
* Mocks a JSON-RPC request sent to the provider with the given response.
* Provider type is inferred from the base url set on the nockScope.
*
- * @param {MockRpcCallOptions} args - The arguments.
- * @param {NockScope} args.nockScope - A nock scope (a set of mocked requests
- * scoped to a certain base URL).
- * @param {object} args.request - The request data.
- * @param {{body: string} | {httpStatus?: number; id?: number; method?: string; params?: string[]}} [args.response] - Information
- * concerning the response that the request should have. If a `body` property is
- * present, this is taken as the complete response body. If an `httpStatus`
- * property is present, then it is taken as the HTTP status code to respond
- * with. Properties other than these two are used to build a complete response
- * body (including `id` and `jsonrpc` properties).
- * @param {Error | string} [args.error] - An error to throw while making the
- * request. Takes precedence over `response`.
- * @param {number} [args.delay] - The amount of time that should pass before the
- * request resolves with the response.
- * @param {number} [args.times] - The number of times that the request is
- * expected to be made.
- * @returns {NockScope} The nock scope.
+ * @param args - The arguments.
+ * @param args.nockScope - A nock scope (a set of mocked requests scoped to a
+ * certain base URL).
+ * @param args.request - The request data.
+ * @param args.response - Information concerning the response that the request
+ * should have. If a `body` property is present, this is taken as the complete
+ * response body. If an `httpStatus` property is present, then it is taken as
+ * the HTTP status code to respond with. Properties other than these two are
+ * used to build a complete response body (including `id` and `jsonrpc`
+ * properties).
+ * @param args.error - An error to throw while making the request. Takes
+ * precedence over `response`.
+ * @param args.delay - The amount of time that should pass before the request
+ * resolves with the response.
+ * @param args.times - The number of times that the request is expected to be
+ * made.
+ * @returns The nock scope.
*/
-function mockRpcCall({ nockScope, request, response, error, delay, times }) {
+function mockRpcCall({
+ nockScope,
+ request,
+ response,
+ error,
+ delay,
+ times,
+}: MockRpcCallOptions): MockRpcCallResult {
// eth-query always passes `params`, so even if we don't supply this property,
// for consistency with makeRpcCall, assume that the `body` contains it
const { method, params = [], ...rest } = request;
let httpStatus = 200;
- let completeResponse = { id: 2, jsonrpc: '2.0' };
+ let completeResponse: JSONRPCResponse = { id: 2, jsonrpc: '2.0' };
if (response !== undefined) {
if ('body' in response) {
completeResponse = response.body;
@@ -156,6 +148,7 @@ function mockRpcCall({ nockScope, request, response, error, delay, times }) {
}
}
}
+ /* @ts-expect-error The types for Nock do not include `basePath` in the interface for Nock.Scope. */
const url = nockScope.basePath.includes('infura.io')
? `/v3/${MOCK_INFURA_PROJECT_ID}`
: '/';
@@ -189,7 +182,7 @@ function mockRpcCall({ nockScope, request, response, error, delay, times }) {
if (error !== undefined) {
return nockRequest.replyWithError(error);
} else if (completeResponse !== undefined) {
- return nockRequest.reply(httpStatus, (_, requestBody) => {
+ return nockRequest.reply(httpStatus, (_, requestBody: any) => {
if (response !== undefined && !('body' in response)) {
if (response.id === undefined) {
completeResponse.id = requestBody.id;
@@ -204,16 +197,72 @@ function mockRpcCall({ nockScope, request, response, error, delay, times }) {
return nockRequest;
}
+type MockBlockTrackerRequestOptions = {
+ /**
+ * A nock scope (a set of mocked requests scoped to a certain base url).
+ */
+ nockScope: NockScope;
+ /**
+ * The block number that the block tracker should report, as a 0x-prefixed hex
+ * string.
+ */
+ blockNumber: string;
+};
+
+/**
+ * Mocks the next request for the latest block that the block tracker will make.
+ *
+ * @param args - The arguments.
+ * @param args.nockScope - A nock scope (a set of mocked requests scoped to a
+ * certain base URL).
+ * @param args.blockNumber - The block number that the block tracker should
+ * report, as a 0x-prefixed hex string.
+ */
+function mockNextBlockTrackerRequest({
+ nockScope,
+ blockNumber = DEFAULT_LATEST_BLOCK_NUMBER,
+}: MockBlockTrackerRequestOptions) {
+ mockRpcCall({
+ nockScope,
+ request: { method: 'eth_blockNumber', params: [] },
+ response: { result: blockNumber },
+ });
+}
+
+/**
+ * Mocks all requests for the latest block that the block tracker will make.
+ *
+ * @param args - The arguments.
+ * @param args.nockScope - A nock scope (a set of mocked requests scoped to a
+ * certain base URL).
+ * @param args.blockNumber - The block number that the block tracker should
+ * report, as a 0x-prefixed hex string.
+ */
+async function mockAllBlockTrackerRequests({
+ nockScope,
+ blockNumber = DEFAULT_LATEST_BLOCK_NUMBER,
+}: MockBlockTrackerRequestOptions) {
+ const result = await mockRpcCall({
+ nockScope,
+ request: { method: 'eth_blockNumber', params: [] },
+ response: { result: blockNumber },
+ });
+
+ if ('persist' in result) {
+ result.persist();
+ }
+}
+
/**
* Makes a JSON-RPC call through the given eth-query object.
*
- * @param {any} ethQuery - The eth-query object.
- * @param {object} request - The request data.
- * @returns {Promise} A promise that either resolves with the result from
- * the JSON-RPC response if it is successful or rejects with the error from the
- * JSON-RPC response otherwise.
+ * @param ethQuery - The eth-query object.
+ * @param request - The request data.
+ * @returns A promise that either resolves with the result from the JSON-RPC
+ * response if it is successful or rejects with the error from the JSON-RPC
+ * response otherwise.
*/
-function makeRpcCall(ethQuery, request) {
+function makeRpcCall(ethQuery: EthQuery, request: Request) {
return new Promise((resolve, reject) => {
debug('[makeRpcCall] making request', request);
ethQuery.sendAsync(request, (error, result) => {
@@ -227,41 +276,43 @@ function makeRpcCall(ethQuery, request) {
});
}
-/**
- * @typedef {{providerType: 'infura' | 'custom', infuraNetwork?: string}} WithMockedCommunicationsOptions
- *
- * The options bag that `Communications` takes.
- */
+export type ProviderType = 'infura' | 'custom';
-/**
- * @typedef {{mockNextBlockTrackerRequest: (options: Omit) => void, mockAllBlockTrackerRequests: (options: Omit) => void, mockRpcCall: (options: Omit) => NockScope, rpcUrl: string, infuraNetwork: string}} Communications
- *
- * Provides methods to mock different kinds of requests to the provider.
- */
+export type MockOptions = {
+ infuraNetwork?: BuiltInInfuraNetwork;
+ providerType: ProviderType;
+ customRpcUrl?: string;
+ customChainId?: Hex;
+};
-/**
- * @typedef {(comms: Communications) => Promise} WithMockedCommunicationsCallback
- *
- * The callback that `mockingCommunications` takes.
- */
+export type MockCommunications = {
+ mockNextBlockTrackerRequest: (options?: any) => void;
+ mockAllBlockTrackerRequests: (options?: any) => void;
+ mockRpcCall: (options: CurriedMockRpcCallOptions) => MockRpcCallResult;
+ rpcUrl: string;
+ infuraNetwork: BuiltInInfuraNetwork;
+};
/**
* Sets up request mocks for requests to the provider.
*
- * @param {WithMockedCommunicationsOptions} options - An options bag.
- * @param {"infura" | "custom"} options.providerType - The type of network
- * client being tested.
- * @param {string} [options.infuraNetwork] - The name of the Infura network being
- * tested, assuming that `providerType` is "infura" (default: "mainnet").
- * @param {string} [options.customRpcUrl] - The URL of the custom RPC endpoint,
- * assuming that `providerType` is "custom".
- * @param {WithMockedCommunicationsCallback} fn - A function which will be
- * called with an object that allows interaction with the network client.
- * @returns {Promise} The return value of the given function.
+ * @param options - An options bag.
+ * @param options.providerType - The type of network client being tested.
+ * @param options.infuraNetwork - The name of the Infura network being tested,
+ * assuming that `providerType` is "infura" (default: "mainnet").
+ * @param options.customRpcUrl - The URL of the custom RPC endpoint, assuming
+ * that `providerType` is "custom".
+ * @param fn - A function which will be called with an object that allows
+ * interaction with the network client.
+ * @returns The return value of the given function.
*/
export async function withMockedCommunications(
- { providerType, infuraNetwork = 'mainnet', customRpcUrl = MOCK_RPC_URL },
- fn,
+ {
+ providerType,
+ infuraNetwork = 'mainnet',
+ customRpcUrl = MOCK_RPC_URL,
+ }: MockOptions,
+ fn: (comms: MockCommunications) => Promise,
) {
if (providerType !== 'infura' && providerType !== 'custom') {
throw new Error(
@@ -274,11 +325,11 @@ export async function withMockedCommunications(
? `https://${infuraNetwork}.infura.io`
: customRpcUrl;
const nockScope = buildScopeForMockingRequests(rpcUrl);
- const curriedMockNextBlockTrackerRequest = (localOptions) =>
+ const curriedMockNextBlockTrackerRequest = (localOptions: any) =>
mockNextBlockTrackerRequest({ nockScope, ...localOptions });
- const curriedMockAllBlockTrackerRequests = (localOptions) =>
+ const curriedMockAllBlockTrackerRequests = (localOptions: any) =>
mockAllBlockTrackerRequests({ nockScope, ...localOptions });
- const curriedMockRpcCall = (localOptions) =>
+ const curriedMockRpcCall = (localOptions: any) =>
mockRpcCall({ nockScope, ...localOptions });
const comms = {
@@ -297,12 +348,12 @@ export async function withMockedCommunications(
}
}
-/**
- * @typedef {{blockTracker: import('eth-block-tracker').PollingBlockTracker, clock: sinon.SinonFakeTimers, makeRpcCall: (request: Partial) => Promise, makeRpcCallsInSeries: (requests: Partial[]) => Promise}} MockNetworkClient
- *
- * Provides methods to interact with the suite of middleware that
- * `createInfuraClient` or `createJsonRpcClient` exposes.
- */
+type MockNetworkClient = {
+ blockTracker: any;
+ clock: sinon.SinonFakeTimers;
+ makeRpcCall: (request: Request) => Promise;
+ makeRpcCallsInSeries: (requests: Request[]) => Promise;
+};
/**
* Some middleware contain logic which retries the request if some condition
@@ -321,14 +372,14 @@ export async function withMockedCommunications(
* `setTimeout` handler.
*/
export async function waitForPromiseToBeFulfilledAfterRunningAllTimers(
- promise,
- clock,
+ promise: any,
+ clock: any,
) {
let hasPromiseBeenFulfilled = false;
let numTimesClockHasBeenAdvanced = 0;
promise
- .catch((error) => {
+ .catch((error: any) => {
// This is used to silence Node.js warnings about the rejection
// being handled asynchronously. The error is handled later when
// `promise` is awaited, but we log it here anyway in case it gets
@@ -350,36 +401,22 @@ export async function waitForPromiseToBeFulfilledAfterRunningAllTimers(
return promise;
}
-/**
- * @typedef {{providerType: "infura" | "custom", infuraNetwork?: string, customRpcUrl?: string, customChainId?: string}} WithClientOptions
- *
- * The options bag that `withNetworkClient` takes.
- */
-
-/**
- * @typedef {(client: MockNetworkClient) => Promise} WithClientCallback
- *
- * The callback that `withNetworkClient` takes.
- */
-
/**
* Builds a provider from the middleware (for the provider type) along with a
* block tracker, runs the given function with those two things, and then
* ensures the block tracker is stopped at the end.
*
- * @param {WithClientOptions} options - An options bag.
- * @param {"infura" | "custom"} options.providerType - The type of network
- * client being tested.
- * @param {string} [options.infuraNetwork] - The name of the Infura network being
- * tested, assuming that `providerType` is "infura" (default: "mainnet").
- * @param {string} [options.customRpcUrl] - The URL of the custom RPC endpoint,
- * assuming that `providerType` is "custom".
- * @param {string} [options.customChainId] - The chain id belonging to the
- * custom RPC endpoint, assuming that `providerType` is "custom" (default:
- * "0x1").
- * @param {WithClientCallback} fn - A function which will be called with an
- * object that allows interaction with the network client.
- * @returns {Promise} The return value of the given function.
+ * @param options - An options bag.
+ * @param options.providerType - The type of network client being tested.
+ * @param options.infuraNetwork - The name of the Infura network being tested,
+ * assuming that `providerType` is "infura" (default: "mainnet").
+ * @param options.customRpcUrl - The URL of the custom RPC endpoint, assuming
+ * that `providerType` is "custom".
+ * @param options.customChainId - The chain id belonging to the custom RPC
+ * endpoint, assuming that `providerType` is "custom" (default: "0x1").
+ * @param fn - A function which will be called with an object that allows
+ * interaction with the network client.
+ * @returns The return value of the given function.
*/
export async function withNetworkClient(
{
@@ -387,8 +424,8 @@ export async function withNetworkClient(
infuraNetwork = 'mainnet',
customRpcUrl = MOCK_RPC_URL,
customChainId = '0x1',
- },
- fn,
+ }: MockOptions,
+ fn: (client: MockNetworkClient) => Promise,
) {
if (providerType !== 'infura' && providerType !== 'custom') {
throw new Error(
@@ -414,20 +451,21 @@ export async function withNetworkClient(
? createNetworkClient({
network: infuraNetwork,
infuraProjectId: MOCK_INFURA_PROJECT_ID,
- type: 'infura',
+ type: NetworkClientType.Infura,
})
: createNetworkClient({
chainId: customChainId,
rpcUrl: customRpcUrl,
- type: 'custom',
+ type: NetworkClientType.Custom,
});
process.env.IN_TEST = inTest;
const { provider, blockTracker } = clientUnderTest;
const ethQuery = new EthQuery(provider);
- const curriedMakeRpcCall = (request) => makeRpcCall(ethQuery, request);
- const makeRpcCallsInSeries = async (requests) => {
+ const curriedMakeRpcCall = (request: Request) =>
+ makeRpcCall(ethQuery, request);
+ const makeRpcCallsInSeries = async (requests: Request[]) => {
const responses = [];
for (const request of requests) {
responses.push(await curriedMakeRpcCall(request));
@@ -451,6 +489,13 @@ export async function withNetworkClient(
}
}
+type BuildMockParamsOptions = {
+ // The block parameter value to set.
+ blockParam: any;
+ // The index of the block parameter.
+ blockParamIndex: number;
+};
+
/**
* Build mock parameters for a JSON-RPC call.
*
@@ -460,16 +505,15 @@ export async function withNetworkClient(
* The block parameter can be set to a custom value. If no value is given, it
* is set as undefined.
*
- * @param {object} args - Arguments.
- * @param {number} args.blockParamIndex - The index of the block parameter.
- * @param {any} [args.blockParam] - The block parameter value to set.
- * @returns {any[]} The mock params.
+ * @param args - Arguments.
+ * @param args.blockParamIndex - The index of the block parameter.
+ * @param args.blockParam - The block parameter value to set.
+ * @returns The mock params.
*/
-export function buildMockParams({ blockParam, blockParamIndex }) {
- if (blockParamIndex === undefined) {
- throw new Error(`Missing 'blockParamIndex'`);
- }
-
+export function buildMockParams({
+ blockParam,
+ blockParamIndex,
+}: BuildMockParamsOptions) {
const params = new Array(blockParamIndex).fill('some value');
params[blockParamIndex] = blockParam;
@@ -480,18 +524,18 @@ export function buildMockParams({ blockParam, blockParamIndex }) {
* Returns a partial JSON-RPC request object, with the "block" param replaced
* with the given value.
*
- * @param {object} request - The request object.
- * @param {string} request.method - The request method.
- * @param {params} [request.params] - The request params.
- * @param {number} blockParamIndex - The index within the `params` array of the
- * block param.
- * @param {any} blockParam - The desired block param value.
- * @returns {object} The updated request object.
+ * @param request - The request object.
+ * @param request.method - The request method.
+ * @param request.params - The request params.
+ * @param blockParamIndex - The index within the `params` array of the block
+ * param.
+ * @param blockParam - The desired block param value.
+ * @returns The updated request object.
*/
export function buildRequestWithReplacedBlockParam(
- { method, params = [] },
- blockParamIndex,
- blockParam,
+ { method, params = [] }: Request,
+ blockParamIndex: number,
+ blockParam: any,
) {
const updatedParams = params.slice();
updatedParams[blockParamIndex] = blockParam;
diff --git a/app/scripts/controllers/network/provider-api-tests/no-block-param.js b/app/scripts/controllers/network/provider-api-tests/no-block-param.ts
similarity index 99%
rename from app/scripts/controllers/network/provider-api-tests/no-block-param.js
rename to app/scripts/controllers/network/provider-api-tests/no-block-param.ts
index 08ae7edd0977..662c7fac92fd 100644
--- a/app/scripts/controllers/network/provider-api-tests/no-block-param.js
+++ b/app/scripts/controllers/network/provider-api-tests/no-block-param.ts
@@ -1,6 +1,7 @@
/* eslint-disable jest/require-top-level-describe, jest/no-export */
import {
+ ProviderType,
waitForPromiseToBeFulfilledAfterRunningAllTimers,
withMockedCommunications,
withNetworkClient,
@@ -11,6 +12,11 @@ import {
buildJsonRpcEngineEmptyResponseErrorMessage,
} from './shared-tests';
+type TestsForRpcMethodAssumingNoBlockParamOptions = {
+ providerType: ProviderType;
+ numberOfParameters: number;
+};
+
/**
* Defines tests which exercise the behavior exhibited by an RPC method which is
* assumed to not take a block parameter. Even if it does, the value of this
@@ -23,8 +29,11 @@ import {
* either `infura` or `custom` (default: "infura").
*/
export function testsForRpcMethodAssumingNoBlockParam(
- method,
- { numberOfParameters, providerType },
+ method: string,
+ {
+ numberOfParameters,
+ providerType,
+ }: TestsForRpcMethodAssumingNoBlockParamOptions,
) {
if (providerType !== 'infura' && providerType !== 'custom') {
throw new Error(
diff --git a/app/scripts/controllers/network/provider-api-tests/not-handled-by-middleware.js b/app/scripts/controllers/network/provider-api-tests/not-handled-by-middleware.ts
similarity index 83%
rename from app/scripts/controllers/network/provider-api-tests/not-handled-by-middleware.js
rename to app/scripts/controllers/network/provider-api-tests/not-handled-by-middleware.ts
index 693d9f779eeb..ee92bb07f217 100644
--- a/app/scripts/controllers/network/provider-api-tests/not-handled-by-middleware.js
+++ b/app/scripts/controllers/network/provider-api-tests/not-handled-by-middleware.ts
@@ -1,7 +1,16 @@
/* eslint-disable jest/require-top-level-describe, jest/no-export */
import { fill } from 'lodash';
-import { withMockedCommunications, withNetworkClient } from './helpers';
+import {
+ ProviderType,
+ withMockedCommunications,
+ withNetworkClient,
+} from './helpers';
+
+type TestsForRpcMethodNotHandledByMiddlewareOptions = {
+ providerType: ProviderType;
+ numberOfParameters: number;
+};
/**
* Defines tests which exercise the behavior exhibited by an RPC method that
@@ -15,8 +24,11 @@ import { withMockedCommunications, withNetworkClient } from './helpers';
* RPC method takes.
*/
export function testsForRpcMethodNotHandledByMiddleware(
- method,
- { providerType, numberOfParameters },
+ method: string,
+ {
+ providerType,
+ numberOfParameters,
+ }: TestsForRpcMethodNotHandledByMiddlewareOptions,
) {
if (providerType !== 'infura' && providerType !== 'custom') {
throw new Error(
diff --git a/app/scripts/controllers/network/provider-api-tests/shared-tests.js b/app/scripts/controllers/network/provider-api-tests/shared-tests.ts
similarity index 98%
rename from app/scripts/controllers/network/provider-api-tests/shared-tests.js
rename to app/scripts/controllers/network/provider-api-tests/shared-tests.ts
index 04412d3f0841..6337bb56a789 100644
--- a/app/scripts/controllers/network/provider-api-tests/shared-tests.js
+++ b/app/scripts/controllers/network/provider-api-tests/shared-tests.ts
@@ -2,7 +2,11 @@
import { testsForRpcMethodsThatCheckForBlockHashInResponse } from './block-hash-in-response';
import { testsForRpcMethodSupportingBlockParam } from './block-param';
-import { withMockedCommunications, withNetworkClient } from './helpers';
+import {
+ ProviderType,
+ withMockedCommunications,
+ withNetworkClient,
+} from './helpers';
import { testsForRpcMethodAssumingNoBlockParam } from './no-block-param';
import { testsForRpcMethodNotHandledByMiddleware } from './not-handled-by-middleware';
@@ -13,7 +17,7 @@ import { testsForRpcMethodNotHandledByMiddleware } from './not-handled-by-middle
* @param reason - The exact reason for failure.
* @returns The error message.
*/
-export function buildInfuraClientRetriesExhaustedErrorMessage(reason) {
+export function buildInfuraClientRetriesExhaustedErrorMessage(reason: string) {
return new RegExp(
`^InfuraProvider - cannot complete request. All retries exhausted\\..+${reason}`,
'us',
@@ -27,7 +31,7 @@ export function buildInfuraClientRetriesExhaustedErrorMessage(reason) {
* @param method - The RPC method.
* @returns The error message.
*/
-export function buildJsonRpcEngineEmptyResponseErrorMessage(method) {
+export function buildJsonRpcEngineEmptyResponseErrorMessage(method: string) {
return new RegExp(
`^JsonRpcEngine: Response has no error or result for request:.+"method": "${method}"`,
'us',
@@ -42,7 +46,7 @@ export function buildJsonRpcEngineEmptyResponseErrorMessage(method) {
* @param reason - The reason.
* @returns The error message.
*/
-export function buildFetchFailedErrorMessage(url, reason) {
+export function buildFetchFailedErrorMessage(url: string, reason: string) {
return new RegExp(
`^request to ${url}(/[^/ ]*)+ failed, reason: ${reason}`,
'us',
@@ -57,7 +61,7 @@ export function buildFetchFailedErrorMessage(url, reason) {
* exposed by `createInfuraClient` is tested; if `custom`, then the middleware
* exposed by `createJsonRpcClient` will be tested.
*/
-export function testsForProviderType(providerType) {
+export function testsForProviderType(providerType: ProviderType) {
// Ethereum JSON-RPC spec:
diff --git a/package.json b/package.json
index c3eb9e56814b..710d9fa118ac 100644
--- a/package.json
+++ b/package.json
@@ -368,6 +368,7 @@
"@babel/preset-typescript": "^7.16.7",
"@babel/register": "^7.5.5",
"@ethersproject/bignumber": "^5.7.0",
+ "@json-rpc-specification/meta-schema": "^1.0.6",
"@lavamoat/allow-scripts": "^2.0.3",
"@lavamoat/lavapack": "^5.0.0",
"@metamask/auto-changelog": "^2.1.0",
diff --git a/yarn.lock b/yarn.lock
index 81c7c68e9915..d6733e961208 100644
--- a/yarn.lock
+++ b/yarn.lock
@@ -3286,6 +3286,13 @@ __metadata:
languageName: node
linkType: hard
+"@json-rpc-specification/meta-schema@npm:^1.0.6":
+ version: 1.0.6
+ resolution: "@json-rpc-specification/meta-schema@npm:1.0.6"
+ checksum: 2eb9c6c6c73bb38350c7180d1ad3c5b8462406926cae753741895b457d7b1b9f0b74148daf3462bb167cef39efdd1d9090308edf4d4938956863acb643c146eb
+ languageName: node
+ linkType: hard
+
"@keystonehq/base-eth-keyring@npm:^0.7.1":
version: 0.7.1
resolution: "@keystonehq/base-eth-keyring@npm:0.7.1"
@@ -24143,6 +24150,7 @@ __metadata:
"@ethersproject/providers": ^5.7.2
"@formatjs/intl-relativetimeformat": ^5.2.6
"@fortawesome/fontawesome-free": ^5.13.0
+ "@json-rpc-specification/meta-schema": ^1.0.6
"@keystonehq/bc-ur-registry-eth": ^0.12.1
"@keystonehq/metamask-airgapped-keyring": ^0.6.1
"@lavamoat/allow-scripts": ^2.0.3
From 40e4a3653ff0fdfb8e6a864f9aa7be284eff2f2d Mon Sep 17 00:00:00 2001
From: vthomas13 <10986371+vthomas13@users.noreply.github.com>
Date: Fri, 14 Apr 2023 12:51:13 -0400
Subject: [PATCH 13/23] Updating Terms of Use, Adding popover and onboarding
flow check (#18221)
* WIP commit
* Moving copy out of messages.json, styling changes
* handling scroll button click and disable logic
* moving scrollButton up to popover component, adding logic for accepting terms of use in popover and onboarding flows
* adding terms of use to e2e wallet creation/import
* adjusting failing unit test
* fixing QR code e2e
* updating welcome test
* setting app state in fixtures
* Update app/scripts/controllers/app-state.js
removing console log
Co-authored-by: Nidhi Kumari
* Update ui/components/app/terms-of-use-popup/terms-of-use-popup.stories.js
adding args to ToU popup storybook
Co-authored-by: Nidhi Kumari
* Update ui/components/app/terms-of-use-popup/terms-of-use-popup.js
Co-authored-by: Nidhi Kumari
* updating DS components in terms of use
* popover styling changes
* adding metametrics tracking
* editing scrollbutton behavior
* adding unit test
* code fencing
---------
Co-authored-by: Nidhi Kumari
---
app/_locales/en/messages.json | 16 +
app/scripts/controllers/app-state.js | 11 +
app/scripts/metamask-controller.js | 2 +
shared/constants/metametrics.ts | 2 +
shared/constants/terms.js | 1 +
test/e2e/fixture-builder.js | 1 +
test/e2e/helpers.js | 12 +
test/e2e/metamask-ui.spec.js | 1 +
test/e2e/tests/incremental-security.spec.js | 2 +
test/e2e/tests/metamask-responsive-ui.spec.js | 2 +
test/e2e/tests/onboarding.spec.js | 5 +
ui/components/app/app-components.scss | 1 +
ui/components/app/terms-of-use-popup/index.js | 1 +
.../app/terms-of-use-popup/index.scss | 30 +
.../terms-of-use-popup/terms-of-use-popup.js | 1181 +++++++++++++++++
.../terms-of-use-popup.stories.js | 16 +
.../terms-of-use-popup.test.js | 48 +
ui/components/app/whats-new-popup/index.scss | 22 -
ui/components/ui/popover/index.scss | 20 +
ui/components/ui/popover/popover.component.js | 25 +-
ui/ducks/app/app.ts | 2 +
ui/pages/home/home.component.js | 29 +-
ui/pages/home/home.container.js | 6 +
ui/pages/onboarding-flow/welcome/index.scss | 5 +
ui/pages/onboarding-flow/welcome/welcome.js | 50 +-
.../onboarding-flow/welcome/welcome.test.js | 17 +-
ui/selectors/selectors.js | 13 +
ui/store/actions.ts | 6 +
28 files changed, 1488 insertions(+), 39 deletions(-)
create mode 100644 shared/constants/terms.js
create mode 100644 ui/components/app/terms-of-use-popup/index.js
create mode 100644 ui/components/app/terms-of-use-popup/index.scss
create mode 100644 ui/components/app/terms-of-use-popup/terms-of-use-popup.js
create mode 100644 ui/components/app/terms-of-use-popup/terms-of-use-popup.stories.js
create mode 100644 ui/components/app/terms-of-use-popup/terms-of-use-popup.test.js
diff --git a/app/_locales/en/messages.json b/app/_locales/en/messages.json
index 5d7a113e0683..e3a0e127deda 100644
--- a/app/_locales/en/messages.json
+++ b/app/_locales/en/messages.json
@@ -109,6 +109,9 @@
"about": {
"message": "About"
},
+ "accept": {
+ "message": "Accept"
+ },
"acceptTermsOfUse": {
"message": "I have read and agree to the $1",
"description": "$1 is the `terms` message"
@@ -305,6 +308,10 @@
"advancedPriorityFeeToolTip": {
"message": "Priority fee (aka “miner tip”) goes directly to miners and incentivizes them to prioritize your transaction."
},
+ "agreeTermsOfUse": {
+ "message": "I agree to Metamask's $1",
+ "description": "$1 is the `terms` link"
+ },
"airgapVault": {
"message": "AirGap Vault"
},
@@ -4310,6 +4317,15 @@
"termsOfUse": {
"message": "terms of use"
},
+ "termsOfUseAgreeText": {
+ "message": " I agree to the Terms of Use, which apply to my use of MetaMask and all of its features"
+ },
+ "termsOfUseFooterText": {
+ "message": "Please scroll to read all sections"
+ },
+ "termsOfUseTitle": {
+ "message": "Our Terms of Use have updated"
+ },
"testNetworks": {
"message": "Test networks"
},
diff --git a/app/scripts/controllers/app-state.js b/app/scripts/controllers/app-state.js
index 3360cd4f92df..cf61daff6292 100644
--- a/app/scripts/controllers/app-state.js
+++ b/app/scripts/controllers/app-state.js
@@ -172,6 +172,17 @@ export default class AppStateController extends EventEmitter {
});
}
+ /**
+ * Record the timestamp of the last time the user has acceoted the terms of use
+ *
+ * @param {number} lastAgreed - timestamp when user last accepted the terms of use
+ */
+ setTermsOfUseLastAgreed(lastAgreed) {
+ this.store.updateState({
+ termsOfUseLastAgreed: lastAgreed,
+ });
+ }
+
/**
* Record the timestamp of the last time the user has seen the outdated browser warning
*
diff --git a/app/scripts/metamask-controller.js b/app/scripts/metamask-controller.js
index 53bba67674b5..1dcea32f1f7d 100644
--- a/app/scripts/metamask-controller.js
+++ b/app/scripts/metamask-controller.js
@@ -2032,6 +2032,8 @@ export default class MetamaskController extends EventEmitter {
appStateController.setRecoveryPhraseReminderLastShown.bind(
appStateController,
),
+ setTermsOfUseLastAgreed:
+ appStateController.setTermsOfUseLastAgreed.bind(appStateController),
setOutdatedBrowserWarningLastShown:
appStateController.setOutdatedBrowserWarningLastShown.bind(
appStateController,
diff --git a/shared/constants/metametrics.ts b/shared/constants/metametrics.ts
index 03626ff61389..44647668b93a 100644
--- a/shared/constants/metametrics.ts
+++ b/shared/constants/metametrics.ts
@@ -510,6 +510,8 @@ export enum MetaMetricsEventName {
SignatureFailed = 'Signature Failed',
SignatureRejected = 'Signature Rejected',
SignatureRequested = 'Signature Requested',
+ TermsOfUseShown = 'Terms of Use Shown',
+ TermsOfUseAccepted = 'Terms of Use Accepted',
TokenImportButtonClicked = 'Import Token Button Clicked',
TokenScreenOpened = 'Token Screen Opened',
SupportLinkClicked = 'Support Link Clicked',
diff --git a/shared/constants/terms.js b/shared/constants/terms.js
new file mode 100644
index 000000000000..5ced85fb529b
--- /dev/null
+++ b/shared/constants/terms.js
@@ -0,0 +1 @@
+export const TERMS_OF_USE_LAST_UPDATED = '2023-03-25';
diff --git a/test/e2e/fixture-builder.js b/test/e2e/fixture-builder.js
index 3ded4081b6cc..aeecb13886c8 100644
--- a/test/e2e/fixture-builder.js
+++ b/test/e2e/fixture-builder.js
@@ -140,6 +140,7 @@ function defaultFixture() {
browserEnvironment: {},
nftsDropdownState: {},
connectedStatusPopoverHasBeenShown: true,
+ termsOfUseLastAgreed: 86400000000000,
defaultHomeActiveTabName: null,
fullScreenGasPollTokens: [],
notificationGasPollTokens: [],
diff --git a/test/e2e/helpers.js b/test/e2e/helpers.js
index 2569dd4a33ed..132003451ceb 100644
--- a/test/e2e/helpers.js
+++ b/test/e2e/helpers.js
@@ -222,6 +222,9 @@ const getWindowHandles = async (driver, handlesCount) => {
};
const importSRPOnboardingFlow = async (driver, seedPhrase, password) => {
+ // agree to terms of use
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
+
// welcome
await driver.clickElement('[data-testid="onboarding-import-wallet"]');
@@ -262,6 +265,9 @@ const completeImportSRPOnboardingFlowWordByWord = async (
seedPhrase,
password,
) => {
+ // agree to terms of use
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
+
// welcome
await driver.clickElement('[data-testid="onboarding-import-wallet"]');
@@ -293,6 +299,9 @@ const completeImportSRPOnboardingFlowWordByWord = async (
};
const completeCreateNewWalletOnboardingFlow = async (driver, password) => {
+ // agree to terms of use
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
+
// welcome
await driver.clickElement('[data-testid="onboarding-create-wallet"]');
@@ -342,6 +351,9 @@ const completeCreateNewWalletOnboardingFlow = async (driver, password) => {
};
const importWrongSRPOnboardingFlow = async (driver, seedPhrase) => {
+ // agree to terms of use
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
+
// welcome
await driver.clickElement('[data-testid="onboarding-import-wallet"]');
diff --git a/test/e2e/metamask-ui.spec.js b/test/e2e/metamask-ui.spec.js
index 6cc81b4008d7..e3a53ffdd0e5 100644
--- a/test/e2e/metamask-ui.spec.js
+++ b/test/e2e/metamask-ui.spec.js
@@ -84,6 +84,7 @@ describe('MetaMask', function () {
describe('Going through the first time flow', function () {
it('clicks the "Create New Wallet" button on the welcome screen', async function () {
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
await driver.clickElement('[data-testid="onboarding-create-wallet"]');
});
diff --git a/test/e2e/tests/incremental-security.spec.js b/test/e2e/tests/incremental-security.spec.js
index 2daf70a91858..2213046e3b9f 100644
--- a/test/e2e/tests/incremental-security.spec.js
+++ b/test/e2e/tests/incremental-security.spec.js
@@ -29,6 +29,8 @@ describe('Incremental Security', function () {
},
async ({ driver }) => {
await driver.navigate();
+ // agree to terms of use
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
// welcome
await driver.clickElement('[data-testid="onboarding-create-wallet"]');
diff --git a/test/e2e/tests/metamask-responsive-ui.spec.js b/test/e2e/tests/metamask-responsive-ui.spec.js
index 4c83081c2ba8..e21668a103e2 100644
--- a/test/e2e/tests/metamask-responsive-ui.spec.js
+++ b/test/e2e/tests/metamask-responsive-ui.spec.js
@@ -15,6 +15,8 @@ describe('MetaMask Responsive UI', function () {
},
async ({ driver }) => {
await driver.navigate();
+ // agree to terms of use
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
// welcome
await driver.clickElement('[data-testid="onboarding-create-wallet"]');
diff --git a/test/e2e/tests/onboarding.spec.js b/test/e2e/tests/onboarding.spec.js
index 7778989d3c56..260857ce9c43 100644
--- a/test/e2e/tests/onboarding.spec.js
+++ b/test/e2e/tests/onboarding.spec.js
@@ -108,6 +108,9 @@ describe('MetaMask onboarding', function () {
async ({ driver }) => {
await driver.navigate();
+ // accept terms of use
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
+
// welcome
await driver.clickElement('[data-testid="onboarding-import-wallet"]');
@@ -145,6 +148,7 @@ describe('MetaMask onboarding', function () {
async ({ driver }) => {
await driver.navigate();
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
await driver.clickElement('[data-testid="onboarding-create-wallet"]');
// metrics
@@ -208,6 +212,7 @@ describe('MetaMask onboarding', function () {
async ({ driver }) => {
await driver.navigate();
+ await driver.clickElement('[data-testid="onboarding-terms-checkbox"]');
await driver.clickElement('[data-testid="onboarding-create-wallet"]');
// metrics
diff --git a/ui/components/app/app-components.scss b/ui/components/app/app-components.scss
index adb1ff1f6066..0fb69b866fc5 100644
--- a/ui/components/app/app-components.scss
+++ b/ui/components/app/app-components.scss
@@ -83,6 +83,7 @@
@import 'transaction-status-label/index';
@import 'wallet-overview/index';
@import 'whats-new-popup/index';
+@import 'terms-of-use-popup/index';
@import 'loading-network-screen/index';
@import 'transaction-decoding/index';
@import 'advanced-gas-fee-popover/index';
diff --git a/ui/components/app/terms-of-use-popup/index.js b/ui/components/app/terms-of-use-popup/index.js
new file mode 100644
index 000000000000..e9333ccd17aa
--- /dev/null
+++ b/ui/components/app/terms-of-use-popup/index.js
@@ -0,0 +1 @@
+export { default } from './terms-of-use-popup';
diff --git a/ui/components/app/terms-of-use-popup/index.scss b/ui/components/app/terms-of-use-popup/index.scss
new file mode 100644
index 000000000000..7ba93df4ab3c
--- /dev/null
+++ b/ui/components/app/terms-of-use-popup/index.scss
@@ -0,0 +1,30 @@
+.popover-wrap.terms-of-use__popover {
+ .terms-of-use {
+ &__terms-list {
+ list-style: decimal none outside;
+ }
+
+ &__footer-text {
+ align-self: center;
+ }
+ }
+
+ .popover-header {
+ &__title {
+ margin-bottom: 0;
+ }
+ }
+
+ .popover-footer {
+ border-top: none;
+ }
+
+ @include screen-sm-min {
+ max-height: 750px;
+ width: 500px;
+ }
+
+ @include screen-sm-max {
+ max-height: 568px;
+ }
+}
diff --git a/ui/components/app/terms-of-use-popup/terms-of-use-popup.js b/ui/components/app/terms-of-use-popup/terms-of-use-popup.js
new file mode 100644
index 000000000000..9fe664303895
--- /dev/null
+++ b/ui/components/app/terms-of-use-popup/terms-of-use-popup.js
@@ -0,0 +1,1181 @@
+import React, { useContext, useEffect, useRef, useState } from 'react';
+import PropTypes from 'prop-types';
+import { I18nContext } from '../../../contexts/i18n';
+import Popover from '../../ui/popover';
+import {
+ AlignItems,
+ FLEX_DIRECTION,
+ TextVariant,
+ Color,
+ TextColor,
+} from '../../../helpers/constants/design-system';
+import {
+ Text,
+ Button,
+ BUTTON_TYPES,
+ ButtonLink,
+ Label,
+} from '../../component-library';
+import Box from '../../ui/box';
+import CheckBox from '../../ui/check-box/check-box.component';
+import {
+ MetaMetricsEventCategory,
+ MetaMetricsEventName,
+} from '../../../../shared/constants/metametrics';
+import { MetaMetricsContext } from '../../../contexts/metametrics';
+
+export default function TermsOfUsePopup({ onAccept }) {
+ const t = useContext(I18nContext);
+ const trackEvent = useContext(MetaMetricsContext);
+ const [isTermsOfUseChecked, setIsTermsOfUseChecked] = useState(false);
+
+ const popoverRef = useRef();
+ const bottomRef = React.createRef();
+
+ const handleScrollDownClick = (e) => {
+ e.stopPropagation();
+ bottomRef.current.scrollIntoView({
+ behavior: 'smooth',
+ });
+ };
+
+ useEffect(() => {
+ trackEvent({
+ category: MetaMetricsEventCategory.Onboarding,
+ event: MetaMetricsEventName.TermsOfUseShown,
+ properties: {
+ location: 'Terms Of Use Popover',
+ },
+ });
+ // eslint-disable-next-line react-hooks/exhaustive-deps
+ }, []);
+
+ return (
+
+
+
+ {t('termsOfUseFooterText')}
+
+
+ }
+ >
+
+
+
+ IMPORTANT NOTICE: THIS AGREEMENT IS SUBJECT TO BINDING ARBITRATION
+ AND A WAIVER OF CLASS ACTION RIGHTS AS DETAILED IN SECTION 11.
+ PLEASE READ THE AGREEMENT CAREFULLY.
+
+
+ ConsenSys Software Inc. (“ConsenSys,” “we,” “us,” or “our”) is the
+ leading blockchain software development company. With a focus on
+ utilizing decentralized technologies, such as Ethereum, our software
+ is powering a revolution in commerce and finance and helping to
+ optimize business processes. ConsenSys hosts a top level domain
+ website, www.consensys.net, that serves information regarding
+ ConsenSys and our Offerings, as defined below, as well as
+ sub-domains for our products or services (the top level domain with
+ the sub-domains collectively referred to as the “Site”), which
+ include text, images, audio, code and other materials or third party
+ information.
+
+
+ These Terms of Use (the “Terms,” “Terms of Use” or “Agreement”)
+ contain the terms and conditions that govern your access to and use
+ of the Site and Offerings provided by us and is an agreement between
+ us and you or the entity you represent (“you” or “your”). Please
+ read these Terms of Use carefully before using the Site or
+ Offerings. By using the Site, clicking a button or checkbox to
+ accept or agree to these Terms where that option is made available,
+ clicking a button to use or access any of the Offerings, completing
+ an Order, or, if earlier, using or otherwise accessing the
+ Offerings (the date on which any of the events listed above occur
+ being the “Effective Date”), you (1) accept and agree to these Terms
+ and any additional terms, rules and conditions of participation
+ issued by ConsenSys from time to time and (2) consent to the
+ collection, use, disclosure and other handling of information as
+ described in our{' '}
+
+ Privacy Policy.
+ {' '}
+ If you do not agree to the Terms or perform any and all obligations
+ you accept under the Terms, then you may not access or use the
+ Offerings.
+
+
+ You represent to us that you are lawfully able to enter into
+ contracts. If you are entering into this Agreement for an entity,
+ such as the company you work for, you represent to us that you have
+ legal authority to bind that entity. Please see Section 13 for
+ definitions of certain capitalized terms used in this Agreement.
+
+
+ In addition, you represent to us that you and your financial
+ institutions, or any party that owns or controls you or your
+ financial institutions, are (1) not subject to sanctions or
+ otherwise designated on any list of prohibited or restricted
+ parties, including but not limited to the lists maintained by the
+ United Nations Security Council, the U.S. Government (i.e., the
+ Specially Designated Nationals List and Foreign Sanctions Evaders
+ List of the U.S. Department of Treasury and the Entity List of the
+ U.S. Department of Commerce), the European Union or its Member
+ States, or other applicable government authority and (2) not located
+ in any country subject to a comprehensive sanctions program
+ implemented by the United States.
+
+
+ 1. The Offerings.
+
+
+ 1.1 Generally. You may access and use the Offerings in accordance
+ with this Agreement. You agree to comply with the terms of this
+ Agreement and all laws, rules and regulations applicable to your use
+ of the Offerings.
+
+
+ 1.2 Offerings and Access. ConsenSys offers a number of products and
+ services, each an “Offering”, under the ConsenSys brand or brands
+ owned by us. These include Codefi, Quorum, Infura, MetaMask and
+ others. Offerings are generally accessed through the Site or through
+ a third party provider of which we approved, such as the Google Play
+ or Apple App Store, unless otherwise agreed in writing. Some
+ Offerings may require you to create an account, enter a valid form
+ of payment, and select a paid plan (a “Paid Plan”), or initiate an
+ Order.
+
+
+ 1.3 Third-Party Content. In certain Offerings, Third-Party Content
+ may be used by you at your election. Third-Party Content is governed
+ by this Agreement and, if applicable, separate terms and conditions
+ accompanying such Third-Party Content, which terms and conditions
+ may include separate fees and charges.
+
+
+ 1.4 Third-Party Offerings. When you use our Offerings, you may also
+ be using the products or services of one or more third parties. Your
+ use of these third party offerings may be subject to the separate
+ policies, terms of use, and fees of these third parties.
+
+
+ 2. Changes.
+
+
+ 2.1 To the Offerings. We may change or discontinue any or all of the
+ Offerings or change or remove functionality of any or all of the
+ Offerings from time to time. We will use commercially reasonable
+ efforts to communicate to you any material change or discontinuation
+ of an Offering through the Site or public communication
+ channels. If you are on a Paid Plan, we will use commercially
+ reasonable efforts to communicate to you any material changes
+ to or discontinuation of the Offering at least 30 days in advance of
+ such change, and we will use commercially reasonable efforts to
+ continue supporting the previous version of the Offering for up to
+ three months after the change or discontinuation, except if doing so
+ (a) would pose an information security or intellectual property
+ issue, (b) is economically or technically burdensome, or (c) would
+ create undue risk of us violating the law.
+
+
+ 2.2 To this Agreement. We reserve the right, at our sole discretion,
+ to modify or replace any part of this Agreement or any Policies at
+ any time. It is your responsibility to check this Agreement
+ periodically for changes, but we will also use commercially
+ reasonable efforts to communicate any material changes to this
+ Agreement through the Site or other public channels. Your continued
+ use of or access to the Offerings following the posting of any
+ changes to this Agreement constitutes acceptance of those changes.
+
+
+ 3. Your Responsibilities.
+
+
+ 3.1 Your Accounts. For those Offerings that require an
+ account, and except to the extent caused by our breach of this
+ Agreement, (a) you are responsible for all activities that occur
+ under your account, regardless of whether the activities are
+ authorized by you or undertaken by you, your employees or a third
+ party (including your contractors, agents or other End Users), and
+ (b) we and our affiliates are not responsible for unauthorized
+ access to your account, including any access that occurred as a
+ result of fraud, phishing, or other criminal activity perpetrated by
+ third parties.
+
+
+ 3.2 Your Use. You are responsible for all activities that occur
+ through your use of those Offerings that do not require an account,
+ except to the extent caused by our breach of this Agreement,
+ regardless of whether the activities are authorized by you or
+ undertaken by you, your employees or a third party (including your
+ contractors, agents or other End Users). We and our affiliates
+ are not responsible for unauthorized access that may occur during
+ your use of the Offerings, including any access that occurred as a
+ result of fraud, phishing, or other criminal activity perpetrated by
+ third parties. You will ensure that your use of the Offerings
+ does not violate any applicable law.
+
+
+ 3.3 Your Security and Backup. You are solely responsible for
+ properly configuring and using the Offerings and otherwise taking
+ appropriate action to secure, protect and backup your accounts
+ and/or Your Content in a manner that will provide appropriate
+ security and protection, which might include use of
+ encryption. This includes your obligation under this Agreement
+ to record and securely maintain any passwords or backup security
+ phrases (i.e. “seed” phrases) that relate to your use of the
+ Offerings. You acknowledge that you will not share with us nor any
+ other third party any password or backup/seed phrase that relates to
+ your use of the Offerings, and that we will not be held responsible
+ if you do share any such phrase or password.
+
+
+ 3.4 Log-In Credentials and API Authentication. To the extent we
+ provide you with log-in credentials and API authentication generated
+ by the Offerings, such log-in credentials and API authentication are
+ for your use only and you will not sell, transfer or sublicense them
+ to any other entity or person, except that you may disclose your
+ password or private key to your agents and subcontractors performing
+ work on your behalf.
+
+
+ 3.5 Applicability to MetaMask Offerings. For the avoidance of doubt,
+ the terms of this Section 3 are applicable to all Offerings,
+ including MetaMask and any accounts you create through MetaMask with
+ Third Party Offerings, such as decentralized applications, or
+ blockchain-based accounts themselves.
+
+
+ 4. Fees and Payment.
+
+
+ 4.1 Publicly Available Offerings. Some Offerings may be offered to
+ the public and licensed on a royalty free basis, including Offerings
+ that require a Paid Plan for software licensing fees above a certain
+ threshold of use.
+
+
+ 4.2 Offering Fees. If your use of an Offering does not require
+ an Order or Paid Plan but software licensing fees are charged
+ contemporaneously with your use of the Offering, those fees will be
+ charged as described on the Site or in the user interface of the
+ Offering. Such fees may be calculated by combining a fee
+ charged by us and a fee charged by a Third Party Offering that
+ provides certain functionality related to the Offering. For
+ those Offerings which entail an Order or Paid Plan, we calculate and
+ bill fees and charges according to your Order or Paid Plan. For such
+ Offerings, on the first day of each billing period, you will pay us
+ the applicable fees (the “Base Fees”) and any applicable taxes based
+ on the Offerings in the Paid Plan. In addition, we may, for
+ particular Orders, issue an invoice to you for all charges above the
+ applicable threshold for your Paid Plan which constitute overage
+ fees for the previous billing period. If you make any other changes
+ to the Offerings during a billing period (e.g. upgrading or
+ downgrading your Paid Plan), we will apply any additional charges or
+ credits to the next billing period. We may bill you more frequently
+ for fees accrued at our discretion upon notice to you. You
+ will pay all fees in U.S. dollars unless the particular Offering
+ specifies a different form of payment or otherwise agreed to in
+ writing. All amounts payable by you under this Agreement will be
+ paid to us without setoff or counterclaim, and without any deduction
+ or withholding. Fees and charges for any new Offering or new feature
+ of an Offering will be effective when we use commercially reasonable
+ efforts to communicate updated fees and charges through our Site or
+ other public channels or, if you are on a Paid Plan, upon
+ commercially reasonable efforts to notify you, unless we expressly
+ state otherwise in a notice. We may increase or add new fees and
+ charges for any existing Offerings you are using by using
+ commercially reasonable efforts to notify users of the Offerings
+ through our Site or other public channels or, if you are on a Paid
+ Plan, by giving you at least 30 days’ prior notice. Unless
+ otherwise specified in an Order, if you are on a Paid Plan, all
+ amounts due under this Agreement are payable within thirty (30) days
+ following receipt of your invoice. We may elect to charge you
+ interest at the rate of 1.5% per month (or the highest rate
+ permitted by law, if less) on all late payments.
+
+
+ 4.3 Taxes. Each party will be responsible, as required under
+ applicable law, for identifying and paying all taxes and other
+ governmental fees and charges (and any penalties, interest, and
+ other additions thereto) that are imposed on that party upon or with
+ respect to the transactions and payments under this Agreement. All
+ fees payable by you are exclusive taxes unless otherwise noted. We
+ reserve the right to withhold taxes where required.
+
+
+ 5. Temporary Suspension; Limiting API Requests.
+
+
+ 5.1 Generally. We may suspend your right to access or use any
+ portion or all of the Offerings immediately if we determine:
+
+
+ (a) your use of the Offerings (i) poses a security risk to the
+ Offerings or any third party, (ii) could adversely impact our
+ systems, the Offerings or the systems of any other user, (iii) could
+ subject us, our affiliates, or any third party to liability, or (iv)
+ could be unlawful;
+
+
+ (b) you are, or any End User is, in breach of this Agreement;
+
+
+ (c) you are in breach of your payment obligations under Section 4
+ and such breach continues for 30 days or longer; or
+
+
+ (d) for entities, you have ceased to operate in the ordinary course,
+ made an assignment for the benefit of creditors or similar
+ disposition of your assets, or become the subject of any bankruptcy,
+ reorganization, liquidation, dissolution or similar proceeding.
+
+
+ 5.2 Effect of Suspension. If we suspend your right to access or use
+ any portion or all of the Offerings:
+
+
+ (a) you remain responsible for all fees and charges you incur during
+ the period of suspension; and
+
+
+ (b) you will not be entitled to any fee credits for any period of
+ suspension.
+
+
+ 5.3 Limiting API Requests. If applicable to a particular Offering,
+ we retain sole discretion to limit your usage of the Offerings
+ (including without limitation by limiting the number of API requests
+ you may submit (“API Requests”)) at any time if your usage of the
+ Offerings exceeds the usage threshold specified in your Paid
+ Plan.
+
+
+ 6. Term; Termination.
+
+
+ 6.1 Term. For Offerings subject to a Paid Plan, the term of this
+ Agreement will commence on the Effective Date and will remain in
+ effect until terminated under this Section 6. Any notice of
+ termination of this Agreement by either party to the other must
+ include a Termination Date that complies with the notice periods in
+ Section 6.2. For Offerings that are not subject to a Paid
+ Plan, the term of this Agreement will commence on the Effective Date
+ and will remain in effect until you stop accessing or using the
+ Offerings.
+
+
+ 6.2 Termination.
+
+
+ (a) Termination for Convenience. If you are not on a Paid Plan, you
+ may terminate this Agreement for any reason by ceasing use of the
+ Offering. If you are on a Paid Plan, each party may terminate this
+ Agreement for any reason by giving the other party at least 30 days’
+ written notice, subject to the provisions in Section 6.2(b).
+
+
+ (b) Termination for Cause.
+
+
+ (i) By Either Party. Either party may terminate this Agreement for
+ cause if the other party is in material breach of this Agreement and
+ the material breach remains uncured for a period of 30 days from
+ receipt of notice by the other party.
+
+
+ (ii) By Us. We may also terminate this Agreement immediately (A) for
+ cause if we have the right to suspend under Section 5, (B) if our
+ relationship with a third-party partner who provides software or
+ other technology we use to provide the Offerings expires, terminates
+ or requires us to change the way we provide the software or other
+ technology as part of the Offerings, or (C) in order to avoid undue
+ risk of violating the law.
+
+
+ 6.3 Effect of Termination. Upon the Termination Date:
+
+
+ (i) all your rights under this Agreement immediately terminate; and
+
+
+ (ii) each party remains responsible for all fees and charges it has
+ incurred through the Termination Date and are responsible for any
+ fees and charges it incurs during the post-termination period;
+
+
+ (iii) the terms and conditions of this Agreement shall survive the
+ expiration or termination of this Agreement to the full extent
+ necessary for their enforcement and for the protection of the party
+ in whose favor they operate. For instance, despite this
+ Agreement between you and us terminating, any dispute raised after
+ you stop accessing or using the Offerings will be subject to the
+ applicable provisions of this Agreement if that dispute relates to
+ your prior access or use.
+
+
+ For any use of the Offerings after the Termination Date, the terms
+ of this Agreement will again apply and, if your use is under a Paid
+ Plan, you will pay the applicable fees at the rates under Section 4.
+
+
+ 7. Proprietary Rights.
+
+
+ 7.1 Your Content. Depending on the Offering, you may share Content
+ with us. Except as provided in this Section 7, we obtain no rights
+ under this Agreement from you (or your licensors) to Your Content.
+ You consent to our use of Your Content to provide the Offerings to
+ you.
+
+
+ 7.2 Offerings License. We or our licensors own all right, title, and
+ interest in and to the Offerings, and all related technology and
+ intellectual property rights. Subject to the terms of this
+ Agreement, we grant you a limited, revocable, non-exclusive,
+ non-sublicensable, non-transferable license to do the following: (a)
+ access and use the Offerings solely in accordance with this
+ Agreement; and (b) copy and use Our Content solely in connection
+ with your permitted use of the Offerings. Except as provided in this
+ Section 7.2, you obtain no rights under this Agreement from us, our
+ affiliates or our licensors to the Offerings, including any related
+ intellectual property rights. Some of Our Content and Third-Party
+ Content may be provided to you under a separate license, such as the
+ Apache License, Version 2.0, or other open source license. In the
+ event of a conflict between this Agreement and any separate license,
+ the separate license will prevail with respect to Our Content or
+ Third-Party Content that is the subject of such separate license.
+
+
+ 7.3 License Restrictions. Neither you nor any End User will use the
+ Offerings in any manner or for any purpose other than as expressly
+ permitted by this Agreement. Except for as authorized, neither you
+ nor any End User will, or will attempt to (a) modify, distribute,
+ alter, tamper with, repair, or otherwise create derivative works of
+ any Content included in the Offerings (except to the extent Content
+ included in the Offerings is provided to you under a separate
+ license that expressly permits the creation of derivative works),
+ (b) reverse engineer, disassemble, or decompile the Offerings or
+ apply any other process or procedure to derive the source code of
+ any software included in the Offerings (except to the extent
+ applicable law doesn’t allow this restriction), (c) access or use
+ the Offerings in a way intended to avoid incurring fees or exceeding
+ usage limits or quotas, (d) use scraping techniques to mine or
+ otherwise scrape data except as permitted by a Plan, or (e) resell
+ or sublicense the Offerings unless otherwise agreed in writing. You
+ will not use Our Marks unless you obtain our prior written consent.
+ You will not misrepresent or embellish the relationship between us
+ and you (including by expressing or implying that we support,
+ sponsor, endorse, or contribute to you or your business endeavors).
+ You will not imply any relationship or affiliation between us and
+ you except as expressly permitted by this Agreement.
+
+
+ 7.4 Suggestions. If you provide any Suggestions to us or our
+ affiliates, we and our affiliates will be entitled to use the
+ Suggestions without restriction. You hereby irrevocably assign to us
+ all right, title, and interest in and to the Suggestions and agree
+ to provide us any assistance we require to document, perfect, and
+ maintain our rights in the Suggestions.
+
+
+ 7.5 U.S. Government Users. If you are a U.S. Government End User, we
+ are licensing the Offerings to you as a “Commercial Item” as that
+ term is defined in the U.S. Code of Federal Regulations (see 48
+ C.F.R. § 2.101), and the rights we grant you to the Offerings are
+ the same as the rights we grant to all others under these Terms of
+ Use.
+
+
+ 8. Indemnification.
+
+
+ 8.1 General.
+
+
+ (a) You will defend, indemnify, and hold harmless us, our affiliates
+ and licensors, and each of their respective employees, officers,
+ directors, and representatives from and against any Losses arising
+ out of or relating to any claim concerning: (a) breach of this
+ Agreement or violation of applicable law by you; and (b) a dispute
+ between you and any of your customers or users. You will reimburse
+ us for reasonable attorneys’ fees and expenses, associated with
+ claims described in (a) and (b) above.
+
+
+ (b) We will defend, indemnify, and hold harmless you and your
+ employees, officers, directors, and representatives from and against
+ any Losses arising out of or relating to any claim concerning our
+ material and intentional breach of this Agreement. We will
+ reimburse you for reasonable attorneys’ fees and expenses associated
+ with the claims described in this paragraph.
+
+
+ 8.2 Intellectual Property.
+
+
+ (a) Subject to the limitations in this Section 8, you will defend
+ ConsenSys, its affiliates, and their respective employees, officers,
+ and directors against any third-party claim alleging that any of
+ Your Content infringes or misappropriates that third party’s
+ intellectual property rights, and will pay the amount of any adverse
+ final judgment or settlement.
+
+
+ (b) Subject to the limitations in this Section 8 and the limitations
+ in Section 10, we will defend you and your employees, officers, and
+ directors against any third-party claim alleging that the Offerings
+ infringe or misappropriate that third party’s intellectual property
+ rights, and will pay the amount of any adverse final judgment or
+ settlement. However, we will not be required to spend more
+ than $200,000 pursuant to this Section 8, including without
+ limitation attorneys’ fees, court costs, settlements, judgments, and
+ reimbursement costs.
+
+
+ (c) Neither party will have obligations or liability under this
+ Section 8.2 arising from infringement by you combining the Offerings
+ with any other product, service, software, data, content or method.
+ In addition, we will have no obligations or liability arising from
+ your use of the Offerings after we have notified you to discontinue
+ such use. The remedies provided in this Section 8.2 are the sole and
+ exclusive remedies for any third-party claims of infringement or
+ misappropriation of intellectual property rights by the Offerings or
+ by Your Content.
+
+
+ 8.3 Process. In no event will a party agree to any settlement of any
+ claim that involves any commitment, other than the payment of money,
+ without the written consent of the other party.
+
+
+ 9. Disclaimers; Risk.
+
+
+ 9.1 DISCLAIMER. THE OFFERINGS ARE PROVIDED “AS IS.” EXCEPT TO THE
+ EXTENT PROHIBITED BY LAW, OR TO THE EXTENT ANY STATUTORY RIGHTS
+ APPLY THAT CANNOT BE EXCLUDED, LIMITED OR WAIVED, WE AND OUR
+ AFFILIATES AND LICENSORS (A) MAKE NO REPRESENTATIONS OR WARRANTIES
+ OF ANY KIND, WHETHER EXPRESS, IMPLIED, STATUTORY OR OTHERWISE
+ REGARDING THE OFFERINGS OR THE THIRD-PARTY CONTENT, AND (B) DISCLAIM
+ ALL WARRANTIES, INCLUDING ANY IMPLIED OR EXPRESS WARRANTIES (I) OF
+ MERCHANTABILITY, SATISFACTORY QUALITY, FITNESS FOR A PARTICULAR
+ PURPOSE, NON-INFRINGEMENT, OR QUIET ENJOYMENT, (II) ARISING OUT OF
+ ANY COURSE OF DEALING OR USAGE OF TRADE, (III) THAT THE OFFERINGS OR
+ THIRD-PARTY CONTENT WILL BE UNINTERRUPTED, ERROR FREE OR FREE OF
+ HARMFUL COMPONENTS, AND (IV) THAT ANY CONTENT WILL BE SECURE OR NOT
+ OTHERWISE LOST OR ALTERED.
+
+
+ 9.2 RISKS. OUR OFFERINGS RELY ON EMERGING TECHNOLOGIES, SUCH AS
+ ETHEREUM. SOME OFFERINGS ARE SUBJECT TO INCREASED RISK THROUGH YOUR
+ POTENTIAL MISUSE OF THINGS SUCH AS PUBLIC/PRIVATE KEY CRYPTOGRAPHY,
+ OR FAILING TO PROPERLY UPDATE OR RUN SOFTWARE TO ACCOMMODATE
+ PROTOCOL UPGRADES, LIKE THE TRANSITION TO PROOF OF STAKE CONSENSUS.
+ BY USING THE OFFERINGS YOU EXPLICITLY ACKNOWLEDGE AND ACCEPT THESE
+ HEIGHTENED RISKS. YOU REPRESENT THAT YOU ARE FINANCIALLY AND
+ TECHNICALLY SOPHISTICATED ENOUGH TO UNDERSTAND THE INHERENT RISKS
+ ASSOCIATED WITH USING CRYPTOGRAPHIC AND BLOCKCHAIN-BASED SYSTEMS AND
+ UPGRADING YOUR SOFTWARE AND PROCESSES TO ACCOMMODATE PROTOCOL
+ UPGRADES, AND THAT YOU HAVE A WORKING KNOWLEDGE OF THE USAGE AND
+ INTRICACIES OF DIGITAL ASSETS SUCH AS ETHER (ETH) AND OTHER DIGITAL
+ TOKENS, SUCH AS THOSE FOLLOWING THE ERC-20 TOKEN STANDARD. IN
+ PARTICULAR, YOU UNDERSTAND THAT WE DO NOT OPERATE THE ETHEREUM
+ PROTOCOL OR ANY OTHER BLOCKCHAIN PROTOCOL, COMMUNICATE OR EXECUTE
+ PROTOCOL UPGRADES, OR APPROVE OR PROCESS BLOCKCHAIN TRANSACTIONS ON
+ BEHALF OF YOU. YOU FURTHER UNDERSTAND THAT BLOCKCHAIN
+ PROTOCOLS PRESENT THEIR OWN RISKS OF USE, THAT SUPPORTING OR
+ PARTICIPATING IN THE PROTOCOL MAY RESULT IN LOSSES IF YOUR
+ PARTICIPATION VIOLATES CERTAIN PROTOCOL RULES, THAT
+ BLOCKCHAIN-BASED TRANSACTIONS ARE IRREVERSIBLE, THAT YOUR PRIVATE
+ KEY AND BACKUP SEED PHRASE MUST BE KEPT SECRET AT ALL TIMES, THAT
+ CONSENSYS WILL NOT STORE A BACKUP OF, NOR WILL BE ABLE TO DISCOVER
+ OR RECOVER, YOUR PRIVATE KEY OR BACKUP SEED PHRASE, AND THAT YOU ARE
+ SOLELY RESPONSIBLE FOR ANY APPROVALS OR PERMISSIONS YOU PROVIDE BY
+ CRYPTOGRAPHICALLY SIGNING BLOCKCHAIN MESSAGES OR TRANSACTIONS.
+
+
+ YOU FURTHER UNDERSTAND AND ACCEPT THAT DIGITAL TOKENS PRESENT MARKET
+ VOLATILITY RISK, TECHNICAL SOFTWARE RISKS, REGULATORY RISKS, AND
+ CYBERSECURITY RISKS. YOU UNDERSTAND THAT THE COST AND SPEED OF
+ A BLOCKCHAIN-BASED SYSTEM IS VARIABLE, THAT COST MAY INCREASE
+ DRAMATICALLY AT ANY TIME, AND THAT COST AND SPEED IS NOT WITHIN THE
+ CAPABILITY OF CONSENSYS TO CONTROL. YOU UNDERSTAND THAT
+ PROTOCOL UPGRADES MAY INADVERTENTLY CONTAIN BUGS OR SECURITY
+ VULNERABILITIES THAT MAY RESULT IN LOSS OF FUNCTIONALITY AND
+ ULTIMATELY FUNDS.
+
+
+ YOU UNDERSTAND AND ACCEPT THAT CONSENSYS DOES NOT CONTROL ANY
+ BLOCKCHAIN PROTOCOL, NOR DOES CONSENSYS CONTROL ANY SMART CONTRACT
+ THAT IS NOT OTHERWISE OFFERED BY CONSENSYS AS PART OF THE
+ OFFERINGS. YOU UNDERSTAND AND ACCEPT THAT CONSENSYS DOES NOT
+ CONTROL AND IS NOT RESPONSIBLE FOR THE TRANSITION OF ANY BLOCKCHAIN
+ PROTOCOL FROM PROOF OF WORK TO PROOF OF STAKE CONSENSUS. YOU
+ AGREE THAT YOU ALONE, AND NOT CONSENSYS, IS RESPONSIBLE FOR ANY
+ TRANSACTIONS THAT YOU ENGAGE IN WITH REGARD TO SUPPORTING ANY
+ BLOCKCHAIN PROTOCOL WHETHER THROUGH TRANSACTION VALIDATION OR
+ OTHERWISE, OR ANY TRANSACTIONS THAT YOU ENGAGE IN WITHANY
+ THIRD-PARTY-DEVELOPED SMART CONTRACT OR TOKEN, INCLUDING TOKENS THAT
+ WERE CREATED BY A THIRD PARTY FOR THE PURPOSE OF FRAUDULENTLY
+ MISREPRESENTING AFFILIATION WITH ANY BLOCKCHAIN PROJECT. YOU
+ AGREE THAT CONSENSYS IS NOT RESPONSIBLE FOR THE REGULATORY STATUS OR
+ TREATMENT OF ANY DIGITAL ASSETS THAT YOU MAY ACCESS OR TRANSACT WITH
+ USING CONSENSYS OFFERINGS. YOU EXPRESSLY ASSUME FULL
+ RESPONSIBILITY FOR ALL OF THE RISKS OF ACCESSING AND USING THE
+ OFFERINGS TO INTERACT WITH BLOCKCHAIN PROTOCOLS.
+
+
+ 10. Limitations of Liability.
+
+
+ 10.1 Limitation of Liability. WITH THE EXCEPTION OF CLAIMS RELATING
+ TO A BREACH OF OUR PROPRIETARY RIGHTS AS GOVERNED BY SECTION 7 AND
+ INTELLECTUAL PROPERTY CLAIMS AS GOVERNED BY SECTION 8, IN NO EVENT
+ SHALL THE AGGREGATE LIABILITY OF EACH PARTY TOGETHER WITH ALL OF ITS
+ AFFILIATES ARISING OUT OF OR RELATED TO THIS AGREEMENT EXCEED THE
+ TOTAL AMOUNT PAID BY YOU HEREUNDER FOR THE OFFERINGS GIVING RISE TO
+ THE LIABILITY IN THE TWELVE MONTHS PRECEDING THE FIRST INCIDENT OUT
+ OF WHICH THE LIABILITY AROSE, OR, IF NO FEES HAVE BEEN PAID,
+ $25,000. THE FOREGOING LIMITATION WILL APPLY WHETHER AN ACTION IS IN
+ CONTRACT OR TORT AND REGARDLESS OF THE THEORY OF LIABILITY, BUT WILL
+ NOT LIMIT YOUR PAYMENT OBLIGATIONS UNDER SECTION 4.
+
+
+ 10.2 Exclusion of Consequential and Related Damages. IN NO EVENT
+ WILL EITHER PARTY OR ITS AFFILIATES HAVE ANY LIABILITY ARISING OUT
+ OF OR RELATED TO THIS AGREEMENT FOR ANY LOST PROFITS, REVENUES,
+ GOODWILL, OR INDIRECT, SPECIAL, INCIDENTAL, CONSEQUENTIAL, COVER,
+ BUSINESS INTERRUPTION OR PUNITIVE DAMAGES, WHETHER AN ACTION IS IN
+ CONTRACT OR TORT AND REGARDLESS OF THE THEORY OF LIABILITY, EVEN IF
+ A PARTY OR ITS AFFILIATES HAVE BEEN ADVISED OF THE POSSIBILITY OF
+ SUCH DAMAGES OR IF A PARTY’S OR ITS AFFILIATES’ REMEDY OTHERWISE
+ FAILS OF ITS ESSENTIAL PURPOSE. THE FOREGOING DISCLAIMER WILL NOT
+ APPLY TO THE EXTENT PROHIBITED BY LAW.
+
+
+ 11. Binding Arbitration and Class Action Waiver.
+
+
+ PLEASE READ THIS SECTION CAREFULLY – IT MAY SIGNIFICANTLY AFFECT
+ YOUR LEGAL RIGHTS, INCLUDING YOUR RIGHT TO FILE A LAWSUIT IN COURT.
+
+
+ 11.1 Binding Arbitration. Any dispute, claim or controversy
+ (“Claim”) relating in any way to this Agreement, the Site, or your
+ use of the Offerings will be resolved by binding arbitration as
+ provided in this Section 11, rather than in court, except that you
+ may assert claims in small claims court if your claims qualify.
+
+
+ 11.1.1 If you are located in the United States: This agreement and
+ any dispute or claim (including non-contractual disputes or claims)
+ arising out of or in connection with it or its subject matter or
+ formation shall be governed by and construed in accordance with the
+ laws of the State of New York. The Federal Arbitration Act and
+ federal arbitration law apply to this Agreement. There is no judge
+ or jury in arbitration, and court review of an arbitration award is
+ limited. However, an arbitrator can award on an individual basis the
+ same damages and relief as a court (including injunctive and
+ declaratory relief or statutory damages), and must follow the terms
+ of this Agreement as a court would. The arbitration will be
+ conducted in accordance with the expedited procedures set forth in
+ the JAMS Comprehensive Arbitration Rules and Procedures (the
+ “Rules”) as those Rules exist on the effective date of this
+ Agreement, including Rules 16.1 and 16.2 of those Rules. The
+ arbitrator’s decision shall be final, binding, and non-appealable.
+ Judgment upon the award may be entered and enforced in any court
+ having jurisdiction. Neither party shall sue the other party other
+ than as provided herein or for enforcement of this clause or of the
+ arbitrator’s award; any such suit may be brought only in a Federal
+ District Court or a New York state court located in New York County,
+ New York. The arbitrator, and not any federal, state, or local
+ court, shall have exclusive authority to resolve any dispute
+ relating to the interpretation, applicability, unconscionability,
+ arbitrability, enforceability, or formation of this Agreement
+ including any claim that all or any part of the Agreement is void or
+ voidable. If for any reason a claim proceeds in court rather
+ than in arbitration we and you waive any right to a jury trial.
+ Notwithstanding the foregoing we and you both agree that you or we
+ may bring suit in court to enjoin infringement or other misuse of
+ intellectual property rights.
+
+
+ 11.1.2 If you are located in the United Kingdom: This agreement and
+ any dispute or claim (including non-contractual disputes or claims)
+ arising out of or in connection with it or its subject matter or
+ formation shall be governed by and construed in accordance with the
+ law of England and Wales. Any dispute, claim or controversy relating
+ in any way to this Agreement, the Offerings, your use of the
+ Offerings, or to any products or services licensed or distributed by
+ us will be resolved by binding arbitration as provided in this
+ clause. Prior to commencing any formal arbitration proceedings,
+ parties shall first seek settlement of any claim by mediation in
+ accordance with the LCIA Mediation Rules, which Rules are deemed to
+ be incorporated by reference into this clause. If the dispute is not
+ settled by mediation within 14 days of the commencement of the
+ mediation, or such further period as the parties shall agree in
+ writing, the dispute shall be referred to and finally resolved by
+ arbitration under the LCIA Rules, which are deemed to be
+ incorporated by reference into this clause. The language to be used
+ in the mediation and in the arbitration shall be English. The seat
+ or legal place of arbitration shall be London.
+
+
+ 11.1.3 If you are located in any territory that is not specifically
+ enumerated in Sections 11.1.1 or 11.1.2, you may elect for either of
+ Section 11.1.1 or 11.1.2 to apply to you, otherwise this Agreement
+ and any Claim (including non-contractual disputes or claims) arising
+ out of or in connection with it or its subject matter or formation
+ shall be governed by and construed in accordance with the law of
+ Ireland. Any Claim relating in any way to this Agreement, the
+ Offerings, your use of the Offerings, or to any products or services
+ licensed or distributed by us will be resolved by binding
+ arbitration as provided in this clause. Prior to commencing any
+ formal arbitration proceedings, parties shall first seek settlement
+ of any claim by mediation in accordance with the LCIA Mediation
+ Rules, which Rules are deemed to be incorporated by reference into
+ this clause. If the dispute is not settled by mediation within 14
+ days of the commencement of the mediation, or such further period as
+ the parties shall agree in writing, the Claim shall be referred to
+ and finally resolved by arbitration under the LCIA Rules, which are
+ deemed to be incorporated by reference into this clause. The
+ language to be used in the mediation and in the arbitration shall be
+ English. The seat or legal place of arbitration shall be Dublin,
+ Ireland.
+
+
+ 11.2 Class Action Waiver. YOU AND WE AGREE THAT EACH MAY BRING
+ CLAIMS AGAINST THE OTHER ONLY ON AN INDIVIDUAL BASIS, AND NOT AS A
+ PLAINTIFF OR CLASS MEMBER IN ANY PURPORTED CLASS OR REPRESENTATIVE
+ PROCEEDING. YOU AND WE EXPRESSLY WAIVE ANY RIGHT TO FILE A CLASS
+ ACTION OR SEEK RELIEF ON A CLASS BASIS. Unless both you and we
+ agree, no arbitrator or judge may consolidate more than one person’s
+ claims or otherwise preside over any form of a representative or
+ class proceeding. The arbitrator may award injunctive relief only in
+ favor of the individual party seeking relief and only to the extent
+ necessary to provide relief warranted by that party’s individual
+ claim. If a court decides that applicable law precludes enforcement
+ of any of this paragraph’s limitations as to a particular claim for
+ relief, then that claim (and only that claim) must be severed from
+ the arbitration and may be brought in court. If any court or
+ arbitrator determines that the class action waiver set forth in this
+ paragraph is void or unenforceable for any reason or that an
+ arbitration can proceed on a class basis, then the arbitration
+ provision set forth above shall be deemed null and void in its
+ entirety and the parties shall be deemed to have not agreed to
+ arbitrate disputes.
+
+
+ 11.3 30-Day Right to Opt Out. You have the right to opt-out and not
+ be bound by the arbitration and class action waiver provisions set
+ forth above by sending written notice of your decision to opt-out to
+ the email address notices@consensys.net with subject line LEGAL OPT
+ OUT. The notice must be sent within 30 days of your first use of the
+ Offerings, otherwise you shall be bound to arbitrate disputes and
+ will be deemed to have agreed to waive any right to pursue a class
+ action in accordance with the terms of those paragraphs. If you
+ opt-out of these provisions, we will also not be bound by them.
+
+
+ 12. Miscellaneous.
+
+
+ 12.1 Assignment. You will not assign or otherwise transfer this
+ Agreement or any of your rights and obligations under this
+ Agreement, without our prior written consent. Any assignment or
+ transfer in violation of this Section 12.1 will be void. We may
+ assign this Agreement without your consent (a) in connection with a
+ merger, acquisition or sale of all or substantially all of our
+ assets, or (b) to any Affiliate or as part of a corporate
+ reorganization; and effective upon such assignment, the assignee is
+ deemed substituted for us as a party to this Agreement and we are
+ fully released from all of our obligations and duties to perform
+ under this Agreement. Subject to the foregoing, this Agreement will
+ be binding upon, and inure to the benefit of the parties and their
+ respective permitted successors and assigns.
+
+
+ 12.2 DAOs. As a blockchain native company, we may interact with and
+ provide certain Offerings to DAOs. Due to the unique nature of DAOs,
+ to the extent the DAO votes in favor of and/or accepts such
+ Offerings from ConsenSys, the DAO has acknowledged and agreed to
+ these Terms in their entirety.
+
+
+ 12.2 Entire Agreement and Modifications. This Agreement incorporates
+ the Policies by reference and is the entire agreement between you
+ and us regarding the subject matter of this Agreement. If the terms
+ of this document are inconsistent with the terms contained in any
+ Policy, the terms contained in this document will control. Any
+ modification to the terms of this Agreement may only be made in
+ writing.
+
+
+ 12.3 Force Majeure. Neither party nor their respective affiliates
+ will be liable for any delay or failure to perform any obligation
+ under this Agreement where the delay or failure results from any
+ cause beyond such party’s reasonable control, including but not
+ limited to acts of God, utilities or other telecommunications
+ failures, cyber attacks, earthquake, storms or other elements of
+ nature, pandemics, blockages, embargoes, riots, acts or orders of
+ government, acts of terrorism, or war.
+
+
+ 12.4 Export and Sanctions Compliance. In connection with this
+ Agreement, you will comply with all applicable import, re-import,
+ sanctions, anti-boycott, export, and re-export control laws and
+ regulations, including all such laws and regulations that may apply.
+ For clarity, you are solely responsible for compliance related to
+ the manner in which you choose to use the Offerings. You may not use
+ any Offering if you are the subject of U.S. sanctions or of
+ sanctions consistent with U.S. law imposed by the governments of the
+ country where you are using the Offering.
+
+
+ 12.5 Independent Contractors; Non-Exclusive Rights. We and you are
+ independent contractors, and this Agreement will not be construed to
+ create a partnership, joint venture, agency, or employment
+ relationship. Neither party, nor any of their respective affiliates,
+ is an agent of the other for any purpose or has the authority to
+ bind the other. Both parties reserve the right (a) to develop or
+ have developed for it products, services, concepts, systems, or
+ techniques that are similar to or compete with the products,
+ services, concepts, systems, or techniques developed or contemplated
+ by the other party, and (b) to assist third party developers or
+ systems integrators who may offer products or services which compete
+ with the other party’s products or services.
+
+
+ 12.6 Eligibility. If you are under the age of majority in your
+ jurisdiction of residence, you may use the Site or Offerings only
+ with the consent of or under the supervision of your parent or legal
+ guardian.
+
+
+ NOTICE TO PARENTS AND GUARDIANS: By granting your minor permission
+ to access the Site or Offerings, you agree to these Terms of Use on
+ behalf of your minor. You are responsible for exercising supervision
+ over your minor’s online activities. If you do not agree to these
+ Terms of Use, do not let your minor use the Site or Offerings.
+
+
+ 12.7 Language. All communications and notices made or given pursuant
+ to this Agreement must be in the English language. If we provide a
+ translation of the English language version of this Agreement, the
+ English language version of the Agreement will control if there is
+ any conflict.
+
+
+ 12.8 Notice.
+
+
+ (a) To You. We may provide any notice to you under this Agreement
+ using commercially reasonable means, including: (i) posting a notice
+ on the Site; (ii) sending a message to the email address then
+ associated with your account; or (iii) using public communication
+ channels . Notices we provide by posting on the Site or using public
+ communication channels will be effective upon posting, and notices
+ we provide by email will be effective when we send the email. It is
+ your responsibility to keep your email address current to the extent
+ you have an account. You will be deemed to have received any email
+ sent to the email address then associated with your account when we
+ send the email, whether or not you actually receive the email.
+
+
+ (b) To Us. To give us notice under this Agreement, you must contact
+ us by email at notices@consensys.net.
+
+
+ 12.9 No Third-Party Beneficiaries. Except as otherwise set forth
+ herein, this Agreement does not create any third-party beneficiary
+ rights in any individual or entity that is not a party to this
+ Agreement.
+
+
+ 12.10 No Waivers. The failure by us to enforce any provision of this
+ Agreement will not constitute a present or future waiver of such
+ provision nor limit our right to enforce such provision at a later
+ time. All waivers by us must be in writing to be effective.
+
+
+ 12.11 Severability. If any portion of this Agreement is held to be
+ invalid or unenforceable, the remaining portions of this Agreement
+ will remain in full force and effect. Any invalid or unenforceable
+ portions will be interpreted to effect and intent of the original
+ portion. If such construction is not possible, the invalid or
+ unenforceable portion will be severed from this Agreement but the
+ rest of the Agreement will remain in full force and effect.
+
+
+ 12.12 Notice and Procedure for Making Claims of Copyright
+ Infringement. If you are a copyright owner or agent of the owner,
+ and you believe that your copyright or the copyright of a person on
+ whose behalf you are authorized to act has been infringed, please
+ provide us a written notice at the address below with the following
+ information:
+
+
+
+ an electronic or physical signature of the person authorized to
+ act on behalf of the owner of the copyright or other intellectual
+ property interest;
+
+
+ a description of the copyrighted work or other intellectual
+ property that you claim has been infringed;
+
+
+ a description of where the material that you claim is infringing
+ is located with respect to the Offerings;
+
+
+ your address, telephone number, and email address;
+
+
+ a statement by you that you have a good faith belief that the
+ disputed use is not authorized by the copyright owner, its agent,
+ or the law;
+
+
+ a statement by you, made under penalty of perjury, that the above
+ information in your notice is accurate and that you are the
+ copyright or intellectual property owner or authorized to act on
+ the copyright or intellectual property owner’s behalf.
+
+
+
+ You can reach us at:
+
+
+ Email: notices@consensys.net
+
+
+ Subject Line: Copyright Notification Mail
+
+
+ Attention: Copyright ℅
+
+
+ ConsenSys Software Inc.
+
+
+ 49 Bogart Street Suite 22 Brooklyn, NY 11206
+
+
+ 13. Definitions.
+
+
+ “Acceptable Use Policy” means the policy set forth below, as it may
+ be updated by us from time to time. You agree not to, and not to
+ allow third parties to, use the Offerings:
+
+
+
+ to violate, or encourage the violation of, the legal rights of
+ others (for example, this may include allowing End Users to
+ infringe or misappropriate the intellectual property rights of
+ others in violation of the Digital Millennium Copyright Act);
+
+
+ to engage in, promote or encourage any illegal or infringing
+ content;
+
+
+ for any unlawful, invasive, infringing, defamatory or fraudulent
+ purpose (for example, this may include phishing, creating a
+ pyramid scheme or mirroring a website);
+
+
+ to intentionally distribute viruses, worms, Trojan horses,
+ corrupted files, hoaxes, or other items of a destructive or
+ deceptive nature;
+
+
+ to interfere with the use of the Offerings, or the equipment used
+ to provide the Offerings, by customers, authorized resellers, or
+ other authorized users;
+
+
+ to disable, interfere with or circumvent any aspect of the
+ Offerings (for example, any thresholds or limits);
+
+
+ to generate, distribute, publish or facilitate unsolicited mass
+ email, promotions, advertising or other solicitation; or
+
+
+ to use the Offerings, or any interfaces provided with the
+ Offerings, to access any other product or service in a manner that
+ violates the terms of service of such other product or service.
+
+
+
+ “API” means an application program interface.
+
+
+ “API Requests” has the meaning set forth in Section 5.3.
+
+
+ “Applicable Threshold” has the meaning set forth in Section 4.2.
+
+
+ “Base Fees” has the meaning set forth in Section 4.2.
+
+
+ “Content” means any data, text, audio, video or images, software
+ (including machine images), and any documentation.
+
+
+ “DAO” means Decentralized Autonomous Organization.
+
+
+ “End User” means any individual or entity that directly or
+ indirectly through another user: (a) accesses or uses Your Content;
+ or (b) otherwise accesses or uses the Offerings under your
+ account.
+
+
+ “Fees” has the meaning set forth in Section 4.2.
+
+
+ “Losses” means any claims, damages, losses, liabilities, costs, and
+ expenses (including reasonable attorneys’ fees).’
+
+
+ “Our Content” means any software (including machine images), data,
+ text, audio, video, images, or documentation that we offer in
+ connection with the Offerings.
+
+
+ “Our Marks” means any trademarks, service marks, service or trade
+ names, logos, and other designations of ConsenSys Software Inc. and
+ their affiliates or licensors that we may make available to you in
+ connection with this Agreement.
+
+
+ “Order” means an order for Offerings executed through an order form
+ directly with ConsenSys, or through a cloud vendor, such as Amazon
+ Web Services, Microsoft Azure, or Google Cloud.
+
+
+ “Offerings” means each of the products and services, including but
+ not limited to Codefi, Infura, MetaMask, Quorum and any other
+ features, tools, materials, or services offered from time to time,
+ by us or our affiliates.
+
+
+ “Policies” means the Acceptable Use Policy, Privacy Policy, any
+ supplemental policies or addendums applicable to any Service as
+ provided to you, and any other policy or terms referenced in or
+ incorporated into this Agreement, each as may be updated by us from
+ time to time.
+
+
+ “Privacy Policy” means the privacy policy located at{' '}
+
+ https://consensys.net/privacy-policy
+ {' '}
+ (and any successor or related locations designated by us), as it may
+ be updated by us from time to time.
+
+
+ “Service Offerings” means the Services (including associated APIs),
+ Our Content, Our Marks, and any other product or service provided by
+ us under this Agreement. Service Offerings do not include
+ Third-Party Content or Third-Party Services.
+
+
+ “Suggestions” means all suggested improvements to the Service
+ Offerings that you provide to us..
+
+
+ “Term” means the term of this Agreement described in Section 6.1.
+
+
+ “Termination Date” means the effective date of termination provided
+ in accordance with Section 6, in a notice from one party to the
+ other.
+
+
+ “Third-Party Content” means Content made available to you by any
+ third party on the Site or in conjunction with the Offerings.
+
+
+ “Your Content” means content that you or any End User transfers to
+ us, storage or hosting by the Offerings in connection with account
+ and any computational results that you or any End User derive from
+ the foregoing through their use of the Offerings, excluding however
+ any information submitted to a blockchain protocol for
+ processing.
+
+
+ {
+ setIsTermsOfUseChecked(!isTermsOfUseChecked);
+ }}
+ />
+
+
+
+
+
+ );
+}
+
+TermsOfUsePopup.propTypes = {
+ onAccept: PropTypes.func.isRequired,
+};
diff --git a/ui/components/app/terms-of-use-popup/terms-of-use-popup.stories.js b/ui/components/app/terms-of-use-popup/terms-of-use-popup.stories.js
new file mode 100644
index 000000000000..18272ab61446
--- /dev/null
+++ b/ui/components/app/terms-of-use-popup/terms-of-use-popup.stories.js
@@ -0,0 +1,16 @@
+import React from 'react';
+import TermsOfUsePopup from '.';
+
+export default {
+ title: 'Components/App/TermsOfUsePopup',
+ component: TermsOfUsePopup,
+ argTypes: {
+ onAccept: {
+ action: 'onAccept',
+ },
+ },
+};
+
+export const DefaultStory = (args) =>
+ {children}
+
+ ) : null}
{showScrollDown ? (
) : null}
- {showArrow ? : null}
- {showHeader &&
- {children}
-
- ) : null}
{footer ? (
; // openMetamaskTabsIDs[tab.id]): true/false
currentWindowTab: Record; // tabs.tab https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/tabs/Tab
showWhatsNewPopup: boolean;
+ showTermsOfUsePopup: boolean;
singleExceptions: {
testKey: string | null;
};
@@ -109,6 +110,7 @@ const initialState: AppState = {
openMetaMaskTabs: {},
currentWindowTab: {},
showWhatsNewPopup: true,
+ showTermsOfUsePopup: true,
singleExceptions: {
testKey: null,
},
diff --git a/ui/pages/home/home.component.js b/ui/pages/home/home.component.js
index 8f874e7dbb0d..616256f215a1 100644
--- a/ui/pages/home/home.component.js
+++ b/ui/pages/home/home.component.js
@@ -2,12 +2,14 @@ import React, { PureComponent } from 'react';
import PropTypes from 'prop-types';
import { Redirect, Route } from 'react-router-dom';
///: BEGIN:ONLY_INCLUDE_IN(main)
+// eslint-disable-next-line import/no-duplicates
+import { MetaMetricsContextProp } from '../../../shared/constants/metametrics';
+///: END:ONLY_INCLUDE_IN
import {
- MetaMetricsContextProp,
MetaMetricsEventCategory,
MetaMetricsEventName,
+ // eslint-disable-next-line import/no-duplicates
} from '../../../shared/constants/metametrics';
-///: END:ONLY_INCLUDE_IN
import AssetList from '../../components/app/asset-list';
import NftsTab from '../../components/app/nfts-tab';
import HomeNotification from '../../components/app/home-notification';
@@ -22,6 +24,7 @@ import ConnectedAccounts from '../connected-accounts';
import { Tabs, Tab } from '../../components/ui/tabs';
import { EthOverview } from '../../components/app/wallet-overview';
import WhatsNewPopup from '../../components/app/whats-new-popup';
+import TermsOfUsePopup from '../../components/app/terms-of-use-popup';
import RecoveryPhraseReminder from '../../components/app/recovery-phrase-reminder';
import ActionableMessage from '../../components/ui/actionable-message/actionable-message';
import {
@@ -111,6 +114,7 @@ export default class Home extends PureComponent {
infuraBlocked: PropTypes.bool.isRequired,
showWhatsNewPopup: PropTypes.bool.isRequired,
hideWhatsNewPopup: PropTypes.func.isRequired,
+ showTermsOfUsePopup: PropTypes.bool.isRequired,
announcementsToShow: PropTypes.bool.isRequired,
///: BEGIN:ONLY_INCLUDE_IN(flask)
errorsToShow: PropTypes.object.isRequired,
@@ -120,6 +124,7 @@ export default class Home extends PureComponent {
showRecoveryPhraseReminder: PropTypes.bool.isRequired,
setRecoveryPhraseReminderHasBeenShown: PropTypes.func.isRequired,
setRecoveryPhraseReminderLastShown: PropTypes.func.isRequired,
+ setTermsOfUseLastAgreed: PropTypes.func.isRequired,
showOutdatedBrowserWarning: PropTypes.bool.isRequired,
setOutdatedBrowserWarningLastShown: PropTypes.func.isRequired,
seedPhraseBackedUp: (props) => {
@@ -243,6 +248,18 @@ export default class Home extends PureComponent {
setRecoveryPhraseReminderLastShown(new Date().getTime());
};
+ onAcceptTermsOfUse = () => {
+ const { setTermsOfUseLastAgreed } = this.props;
+ setTermsOfUseLastAgreed(new Date().getTime());
+ this.context.trackEvent({
+ category: MetaMetricsEventCategory.Onboarding,
+ event: MetaMetricsEventName.TermsOfUseAccepted,
+ properties: {
+ location: 'Terms Of Use Popover',
+ },
+ });
+ };
+
onOutdatedBrowserWarningClose = () => {
const { setOutdatedBrowserWarningLastShown } = this.props;
setOutdatedBrowserWarningLastShown(new Date().getTime());
@@ -600,6 +617,7 @@ export default class Home extends PureComponent {
announcementsToShow,
showWhatsNewPopup,
hideWhatsNewPopup,
+ showTermsOfUsePopup,
seedPhraseBackedUp,
showRecoveryPhraseReminder,
firstTimeFlowType,
@@ -621,6 +639,10 @@ export default class Home extends PureComponent {
showWhatsNewPopup &&
!process.env.IN_TEST &&
!newNetworkAddedConfigurationId;
+
+ const showTermsOfUse =
+ completedOnboarding && !onboardedInThisUISession && showTermsOfUsePopup;
+
return (
- {loading ? null : icon}
+ {process.env.MULTICHAIN ? (
+
{buttons}
From e09028b4e575a6ea95f2099f0998681bd2392b94 Mon Sep 17 00:00:00 2001
From: Garrett Bear -
+
-
+
+ ++ +
+
-
@@ -161,6 +208,7 @@ export default function OnboardingWelcome() {
data-testid="onboarding-import-wallet"
type="secondary"
onClick={onImportClick}
+ disabled={!termsChecked}
>
{t('onboardingImportWallet')}
diff --git a/ui/pages/onboarding-flow/welcome/welcome.test.js b/ui/pages/onboarding-flow/welcome/welcome.test.js
index 8cd699012ff7..c7965efd52f4 100644
--- a/ui/pages/onboarding-flow/welcome/welcome.test.js
+++ b/ui/pages/onboarding-flow/welcome/welcome.test.js
@@ -4,7 +4,10 @@ import configureMockStore from 'redux-mock-store';
import thunk from 'redux-thunk';
import initializedMockState from '../../../../test/data/mock-state.json';
import { renderWithProvider } from '../../../../test/lib/render-helpers';
-import { setFirstTimeFlowType } from '../../../store/actions';
+import {
+ setFirstTimeFlowType,
+ setTermsOfUseLastAgreed,
+} from '../../../store/actions';
import {
ONBOARDING_METAMETRICS,
ONBOARDING_SECURE_YOUR_WALLET_ROUTE,
@@ -21,6 +24,11 @@ jest.mock('../../../store/actions.ts', () => ({
return type;
}),
),
+ setTermsOfUseLastAgreed: jest.fn().mockReturnValue(
+ jest.fn((type) => {
+ return type;
+ }),
+ ),
}));
jest.mock('react-router-dom', () => ({
@@ -81,19 +89,24 @@ describe('Onboarding Welcome Component', () => {
it('should set first time flow to create and route to metametrics', () => {
renderWithProvider(
, mockStore); - + const termsCheckbox = screen.getByTestId('onboarding-terms-checkbox'); + fireEvent.click(termsCheckbox); const createWallet = screen.getByTestId('onboarding-create-wallet'); fireEvent.click(createWallet); + expect(setTermsOfUseLastAgreed).toHaveBeenCalled(); expect(setFirstTimeFlowType).toHaveBeenCalledWith('create'); }); it('should set first time flow to import and route to metametrics', () => { renderWithProvider( , mockStore); + const termsCheckbox = screen.getByTestId('onboarding-terms-checkbox'); + fireEvent.click(termsCheckbox); const createWallet = screen.getByTestId('onboarding-import-wallet'); fireEvent.click(createWallet); + expect(setTermsOfUseLastAgreed).toHaveBeenCalled(); expect(setFirstTimeFlowType).toHaveBeenCalledWith('import'); expect(mockHistoryPush).toHaveBeenCalledWith(ONBOARDING_METAMETRICS); }); diff --git a/ui/selectors/selectors.js b/ui/selectors/selectors.js index 44d2b914d9e5..7c3f6bf6d3db 100644 --- a/ui/selectors/selectors.js +++ b/ui/selectors/selectors.js @@ -57,6 +57,7 @@ import { import { TEMPLATED_CONFIRMATION_MESSAGE_TYPES } from '../pages/confirmation/templates'; import { STATIC_MAINNET_TOKEN_LIST } from '../../shared/constants/tokens'; import { DAY } from '../../shared/constants/time'; +import { TERMS_OF_USE_LAST_UPDATED } from '../../shared/constants/terms'; import { getNativeCurrency, getConversionRate, @@ -995,6 +996,18 @@ export function getShowRecoveryPhraseReminder(state) { return currentTime - recoveryPhraseReminderLastShown >= frequency; } +export function getShowTermsOfUse(state) { + const { termsOfUseLastAgreed } = state.metamask; + + if (!termsOfUseLastAgreed) { + return true; + } + return ( + new Date(termsOfUseLastAgreed).getTime() < + new Date(TERMS_OF_USE_LAST_UPDATED).getTime() + ); +} + export function getShowOutdatedBrowserWarning(state) { const { outdatedBrowserWarningLastShown } = state.metamask; if (!outdatedBrowserWarningLastShown) { diff --git a/ui/store/actions.ts b/ui/store/actions.ts index fe47604c9061..dd897d303880 100644 --- a/ui/store/actions.ts +++ b/ui/store/actions.ts @@ -3980,6 +3980,12 @@ export function setRecoveryPhraseReminderLastShown( }; } +export function setTermsOfUseLastAgreed(lastAgreed: number) { + return async () => { + await submitRequestToBackground('setTermsOfUseLastAgreed', [lastAgreed]); + }; +} + export function setOutdatedBrowserWarningLastShown(lastShown: number) { return async () => { await submitRequestToBackground('setOutdatedBrowserWarningLastShown', [ From d85d2318a354e7390cfbb9dabbb034df13087eae Mon Sep 17 00:00:00 2001 From: Mark Stacey ; + #previousProviderConfig: ProviderConfiguration; /** * Observable store containing the network ID for the current network or null @@ -489,9 +488,7 @@ export class NetworkController extends EventEmitter { this.providerStore = new ObservableStore( state.provider || buildDefaultProviderConfigState(), ); - this.previousProviderStore = new ObservableStore( - this.providerStore.getState(), - ); + this.#previousProviderConfig = this.providerStore.getState(); this.networkIdStore = new ObservableStore(buildDefaultNetworkIdState()); this.networkStatusStore = new ObservableStore( buildDefaultNetworkStatusState(), @@ -511,7 +508,6 @@ export class NetworkController extends EventEmitter { this.store = new ComposedStore ({ provider: this.providerStore, - previousProviderStore: this.previousProviderStore, networkId: this.networkIdStore, networkStatus: this.networkStatusStore, networkDetails: this.networkDetails, @@ -792,7 +788,7 @@ export class NetworkController extends EventEmitter { * calling `resetConnection`). */ rollbackToPreviousProvider(): void { - const config = this.previousProviderStore.getState(); + const config = this.#previousProviderConfig; this.providerStore.putState(config); this._switchNetwork(config); } @@ -871,7 +867,7 @@ export class NetworkController extends EventEmitter { * @param providerConfig - The provider configuration. */ _setProviderConfig(providerConfig: ProviderConfiguration): void { - this.previousProviderStore.putState(this.providerStore.getState()); + this.#previousProviderConfig = this.providerStore.getState(); this.providerStore.putState(providerConfig); this._switchNetwork(providerConfig); } diff --git a/app/scripts/migrations/085.test.js b/app/scripts/migrations/085.test.js new file mode 100644 index 000000000000..6b7b4967d40a --- /dev/null +++ b/app/scripts/migrations/085.test.js @@ -0,0 +1,91 @@ +import { migrate, version } from './085'; + +jest.mock('uuid', () => { + const actual = jest.requireActual('uuid'); + + return { + ...actual, + v4: jest.fn(), + }; +}); + +describe('migration #85', () => { + it('should update the version metadata', async () => { + const oldStorage = { + meta: { + version: 84, + }, + data: {}, + }; + + const newStorage = await migrate(oldStorage); + expect(newStorage.meta).toStrictEqual({ + version, + }); + }); + + it('should return state unaltered if there is no network controller state', async () => { + const oldData = { + other: 'data', + }; + const oldStorage = { + meta: { + version: 84, + }, + data: oldData, + }; + + const newStorage = await migrate(oldStorage); + expect(newStorage.data).toStrictEqual(oldData); + }); + + it('should return state unaltered if there is no network controller previous provider state', async () => { + const oldData = { + other: 'data', + NetworkController: { + provider: { + some: 'provider', + }, + }, + }; + const oldStorage = { + meta: { + version: 84, + }, + data: oldData, + }; + + const newStorage = await migrate(oldStorage); + expect(newStorage.data).toStrictEqual(oldData); + }); + + it('should remove the previous provider state', async () => { + const oldData = { + other: 'data', + NetworkController: { + previousProviderStore: { + example: 'config', + }, + provider: { + some: 'provider', + }, + }, + }; + const oldStorage = { + meta: { + version: 84, + }, + data: oldData, + }; + + const newStorage = await migrate(oldStorage); + expect(newStorage.data).toStrictEqual({ + other: 'data', + NetworkController: { + provider: { + some: 'provider', + }, + }, + }); + }); +}); diff --git a/app/scripts/migrations/085.ts b/app/scripts/migrations/085.ts new file mode 100644 index 000000000000..03499d2b2c49 --- /dev/null +++ b/app/scripts/migrations/085.ts @@ -0,0 +1,33 @@ +import { cloneDeep } from 'lodash'; +import { isObject } from '@metamask/utils'; + +export const version = 85; + +/** + * Remove the now-obsolete network controller `previousProviderStore` state. + * + * @param originalVersionedData - Versioned MetaMask extension state, exactly what we persist to dist. + * @param originalVersionedData.meta - State metadata. + * @param originalVersionedData.meta.version - The current state version. + * @param originalVersionedData.data - The persisted MetaMask state, keyed by controller. + * @returns Updated versioned MetaMask extension state. + */ +export async function migrate(originalVersionedData: { + meta: { version: number }; + data: Record ++ )} + {!isSIWEDomainValid && (+ { + return { + __esModule: true, + default: () => { + return ; + }, + }; +}); + const render = (txData = mockProps.txData) => { const store = configureStore(mockStoreInitialState); @@ -110,4 +119,21 @@ describe('SignatureRequestSIWE (Sign in with Ethereum)', () => { expect(bannerAlert).toBeTruthy(); expect(bannerAlert).toHaveTextContent('Deceptive site request.'); }); + + it('should not show Ledger instructions if the address is not a Ledger address', () => { + const { container } = render(); + expect( + container.querySelector('.mock-ledger-instruction-field'), + ).not.toBeTruthy(); + }); + + it('should show Ledger instructions if the address is a Ledger address', () => { + const mockTxData = cloneDeep(mockProps.txData); + mockTxData.msgParams.from = '0xc42edfcc21ed14dda456aa0756c153f7985d8813'; + const { container } = render(mockTxData); + + expect( + container.querySelector('.mock-ledger-instruction-field'), + ).toBeTruthy(); + }); }); From 73efd2edebaee5f86a62b5ec8ffc448535b79736 Mon Sep 17 00:00:00 2001 From: Mark Stacey