Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Add useSafeChainsListValidation and useMultiRpcMigration to PreferencesController #4732

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ describe('PreferencesController', () => {
showTestNetworks: false,
isIpfsGatewayEnabled: true,
useTransactionSimulations: true,
useSafeChainsListValidation: true,
useMultiRpcMigration: true,
showIncomingTransactions: Object.values(
ETHERSCAN_SUPPORTED_CHAIN_IDS,
).reduce((acc, curr) => {
Expand Down Expand Up @@ -368,6 +370,18 @@ describe('PreferencesController', () => {
);
});

it('should set useSafeChainsListValidation', () => {
const controller = setupPreferencesController();
controller.setUseSafeChainsListValidation(true);
expect(controller.state.useSafeChainsListValidation).toBe(true);
});

it('should set useMultiRpcMigration', () => {
const controller = setupPreferencesController();
controller.setUseMultiRpcMigration(true);
expect(controller.state.useMultiRpcMigration).toBe(true);
});

it('should set featureFlags', () => {
const controller = setupPreferencesController();
controller.setFeatureFlag('Feature A', true);
Expand Down
37 changes: 37 additions & 0 deletions packages/preferences-controller/src/PreferencesController.ts
Original file line number Diff line number Diff line change
Expand Up @@ -110,6 +110,14 @@ export type PreferencesState = {
* Controls whether transaction simulations are enabled
*/
useTransactionSimulations: boolean;
/**
* Controls whether Multi rpc modal is displayed or not
*/
useMultiRpcMigration: boolean;
/**
* Controls whether chain validation is enabled or not
*/
useSafeChainsListValidation: boolean;
};

const metadata = {
Expand All @@ -128,6 +136,8 @@ const metadata = {
useTokenDetection: { persist: true, anonymous: true },
smartTransactionsOptInStatus: { persist: true, anonymous: false },
useTransactionSimulations: { persist: true, anonymous: true },
useMultiRpcMigration: { persist: true, anonymous: true },
useSafeChainsListValidation: { persist: true, anonymous: true },
};

const name = 'PreferencesController';
Expand Down Expand Up @@ -197,6 +207,8 @@ export function getDefaultPreferencesState() {
showTestNetworks: false,
useNftDetection: false,
useTokenDetection: true,
useMultiRpcMigration: true,
useSafeChainsListValidation: true,
smartTransactionsOptInStatus: false,
useTransactionSimulations: true,
};
Expand Down Expand Up @@ -483,6 +495,31 @@ export class PreferencesController extends BaseController<
}
}

/**
* Toggle the use safe chains list validation.
*
* @param useSafeChainsListValidation - Boolean indicating user preference on using chainid.network third part to check safe networks.
*/
setUseSafeChainsListValidation(useSafeChainsListValidation: boolean) {
this.update((state) => {
state.useSafeChainsListValidation = useSafeChainsListValidation;
});
}

/**
* Toggle multi rpc migration modal.
*
* @param useMultiRpcMigration - Boolean indicating if the multi rpc modal will be displayed or not.
*/
setUseMultiRpcMigration(useMultiRpcMigration: boolean) {
this.update((state) => {
state.useMultiRpcMigration = useMultiRpcMigration;
if (!useMultiRpcMigration) {
state.useMultiRpcMigration = false;
}
});
}

/**
* A setter for the user to opt into smart transactions
*
Expand Down
Loading