@metamask-previews/preferences-controller 13.0.2-preview-9edcf0e0 → 13.0.2-preview-9d310688

package/dist/PreferencesController.cjs

@@ -0,0 +1,333 @@
+"use strict";
+var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
+    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
+    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
+    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
+};
+var _PreferencesController_instances, _PreferencesController_syncIdentities;
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PreferencesController = exports.getDefaultPreferencesState = void 0;
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+const constants_1 = require("./constants.cjs");
+const metadata = {
+    featureFlags: { persist: true, anonymous: true },
+    identities: { persist: true, anonymous: false },
+    ipfsGateway: { persist: true, anonymous: false },
+    isIpfsGatewayEnabled: { persist: true, anonymous: true },
+    isMultiAccountBalancesEnabled: { persist: true, anonymous: true },
+    lostIdentities: { persist: true, anonymous: false },
+    openSeaEnabled: { persist: true, anonymous: true },
+    securityAlertsEnabled: { persist: true, anonymous: true },
+    selectedAddress: { persist: true, anonymous: false },
+    showTestNetworks: { persist: true, anonymous: true },
+    showIncomingTransactions: { persist: true, anonymous: true },
+    useNftDetection: { persist: true, anonymous: true },
+    useTokenDetection: { persist: true, anonymous: true },
+    smartTransactionsOptInStatus: { persist: true, anonymous: false },
+    useTransactionSimulations: { persist: true, anonymous: true },
+};
+const name = 'PreferencesController';
+/**
+ * Get the default PreferencesController state.
+ *
+ * @returns The default PreferencesController state.
+ */
+function getDefaultPreferencesState() {
+    return {
+        featureFlags: {},
+        identities: {},
+        ipfsGateway: 'https://ipfs.io/ipfs/',
+        isIpfsGatewayEnabled: true,
+        isMultiAccountBalancesEnabled: true,
+        lostIdentities: {},
+        openSeaEnabled: false,
+        securityAlertsEnabled: false,
+        selectedAddress: '',
+        showIncomingTransactions: {
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.MAINNET]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.GOERLI]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.BSC]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.BSC_TESTNET]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.OPTIMISM]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.OPTIMISM_SEPOLIA]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.POLYGON]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.POLYGON_TESTNET]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.AVALANCHE]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.AVALANCHE_TESTNET]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.FANTOM]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.FANTOM_TESTNET]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.SEPOLIA]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.LINEA_GOERLI]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.LINEA_SEPOLIA]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.LINEA_MAINNET]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.MOONBEAM]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.MOONBEAM_TESTNET]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.MOONRIVER]: true,
+            [constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS.GNOSIS]: true,
+        },
+        showTestNetworks: false,
+        useNftDetection: false,
+        useTokenDetection: true,
+        smartTransactionsOptInStatus: false,
+        useTransactionSimulations: true,
+    };
+}
+exports.getDefaultPreferencesState = getDefaultPreferencesState;
+/**
+ * Controller that stores shared settings and exposes convenience methods
+ */
+class PreferencesController extends base_controller_1.BaseController {
+    /**
+     * Creates a PreferencesController instance.
+     *
+     * @param args - Arguments
+     * @param args.messenger - The preferences controller messenger.
+     * @param args.state - Preferences controller state.
+     */
+    constructor({ messenger, state, }) {
+        super({
+            name,
+            metadata,
+            messenger,
+            state: {
+                ...getDefaultPreferencesState(),
+                ...state,
+            },
+        });
+        _PreferencesController_instances.add(this);
+        messenger.subscribe('KeyringController:stateChange', (keyringState) => {
+            const accounts = new Set();
+            for (const keyring of keyringState.keyrings) {
+                for (const account of keyring.accounts) {
+                    accounts.add(account);
+                }
+            }
+            if (accounts.size > 0) {
+                __classPrivateFieldGet(this, _PreferencesController_instances, "m", _PreferencesController_syncIdentities).call(this, Array.from(accounts));
+            }
+        });
+    }
+    /**
+     * Adds identities to state.
+     *
+     * @param addresses - List of addresses to use to generate new identities.
+     */
+    addIdentities(addresses) {
+        const checksummedAddresses = addresses.map((address) => (0, controller_utils_1.toChecksumHexAddress)(address));
+        this.update((state) => {
+            const { identities } = state;
+            for (const address of checksummedAddresses) {
+                if (identities[address]) {
+                    continue;
+                }
+                const identityCount = Object.keys(identities).length;
+                identities[address] = {
+                    name: `Account ${identityCount + 1}`,
+                    address,
+                    importTime: Date.now(),
+                };
+            }
+        });
+    }
+    /**
+     * Removes an identity from state.
+     *
+     * @param address - Address of the identity to remove.
+     */
+    removeIdentity(address) {
+        address = (0, controller_utils_1.toChecksumHexAddress)(address);
+        const { identities } = this.state;
+        if (!identities[address]) {
+            return;
+        }
+        this.update((state) => {
+            delete state.identities[address];
+            if (address === state.selectedAddress) {
+                state.selectedAddress = Object.keys(state.identities)[0];
+            }
+        });
+    }
+    /**
+     * Associates a new label with an identity.
+     *
+     * @param address - Address of the identity to associate.
+     * @param label - New label to assign.
+     */
+    setAccountLabel(address, label) {
+        address = (0, controller_utils_1.toChecksumHexAddress)(address);
+        this.update((state) => {
+            const identity = state.identities[address] || {};
+            identity.name = label;
+            state.identities[address] = identity;
+        });
+    }
+    /**
+     * Enable or disable a specific feature flag.
+     *
+     * @param feature - Feature to toggle.
+     * @param activated - Value to assign.
+     */
+    setFeatureFlag(feature, activated) {
+        this.update((state) => {
+            state.featureFlags[feature] = activated;
+        });
+    }
+    /**
+     * Sets selected address.
+     *
+     * @param selectedAddress - Ethereum address.
+     */
+    setSelectedAddress(selectedAddress) {
+        this.update((state) => {
+            state.selectedAddress = (0, controller_utils_1.toChecksumHexAddress)(selectedAddress);
+        });
+    }
+    /**
+     * Sets new IPFS gateway.
+     *
+     * @param ipfsGateway - IPFS gateway string.
+     */
+    setIpfsGateway(ipfsGateway) {
+        this.update((state) => {
+            state.ipfsGateway = ipfsGateway;
+        });
+    }
+    /**
+     * Toggle the token detection setting.
+     *
+     * @param useTokenDetection - Boolean indicating user preference on token detection.
+     */
+    setUseTokenDetection(useTokenDetection) {
+        this.update((state) => {
+            state.useTokenDetection = useTokenDetection;
+        });
+    }
+    /**
+     * Toggle the NFT detection setting.
+     *
+     * @param useNftDetection - Boolean indicating user preference on NFT detection.
+     */
+    setUseNftDetection(useNftDetection) {
+        if (useNftDetection && !this.state.openSeaEnabled) {
+            throw new Error('useNftDetection cannot be enabled if openSeaEnabled is false');
+        }
+        this.update((state) => {
+            state.useNftDetection = useNftDetection;
+        });
+    }
+    /**
+     * Toggle the opensea enabled setting.
+     *
+     * @param openSeaEnabled - Boolean indicating user preference on using OpenSea's API.
+     */
+    setOpenSeaEnabled(openSeaEnabled) {
+        this.update((state) => {
+            state.openSeaEnabled = openSeaEnabled;
+            if (!openSeaEnabled) {
+                state.useNftDetection = false;
+            }
+        });
+    }
+    /**
+     * Toggle the security alert enabled setting.
+     *
+     * @param securityAlertsEnabled - Boolean indicating user preference on using security alerts.
+     */
+    setSecurityAlertsEnabled(securityAlertsEnabled) {
+        this.update((state) => {
+            state.securityAlertsEnabled = securityAlertsEnabled;
+        });
+    }
+    /**
+     * A setter for the user preferences to enable/disable fetch of multiple accounts balance.
+     *
+     * @param isMultiAccountBalancesEnabled - true to enable multiple accounts balance fetch, false to fetch only selectedAddress.
+     */
+    setIsMultiAccountBalancesEnabled(isMultiAccountBalancesEnabled) {
+        this.update((state) => {
+            state.isMultiAccountBalancesEnabled = isMultiAccountBalancesEnabled;
+        });
+    }
+    /**
+     * A setter for the user have the test networks visible/hidden.
+     *
+     * @param showTestNetworks - true to show test networks, false to hidden.
+     */
+    setShowTestNetworks(showTestNetworks) {
+        this.update((state) => {
+            state.showTestNetworks = showTestNetworks;
+        });
+    }
+    /**
+     * A setter for the user allow to be fetched IPFS content
+     *
+     * @param isIpfsGatewayEnabled - true to enable ipfs source
+     */
+    setIsIpfsGatewayEnabled(isIpfsGatewayEnabled) {
+        this.update((state) => {
+            state.isIpfsGatewayEnabled = isIpfsGatewayEnabled;
+        });
+    }
+    /**
+     * A setter for the user allow to be fetched IPFS content
+     *
+     * @param chainId - On hexadecimal format to enable the incoming transaction network
+     * @param isIncomingTransactionNetworkEnable - true to enable incoming transactions
+     */
+    setEnableNetworkIncomingTransactions(chainId, isIncomingTransactionNetworkEnable) {
+        if (Object.values(constants_1.ETHERSCAN_SUPPORTED_CHAIN_IDS).includes(chainId)) {
+            this.update((state) => {
+                state.showIncomingTransactions = {
+                    ...this.state.showIncomingTransactions,
+                    [chainId]: isIncomingTransactionNetworkEnable,
+                };
+            });
+        }
+    }
+    /**
+     * A setter for the user to opt into smart transactions
+     *
+     * @param smartTransactionsOptInStatus - true to opt into smart transactions
+     */
+    setSmartTransactionsOptInStatus(smartTransactionsOptInStatus) {
+        this.update((state) => {
+            state.smartTransactionsOptInStatus = smartTransactionsOptInStatus;
+        });
+    }
+    /**
+     * A setter for the user preferences to enable/disable transaction simulations.
+     *
+     * @param useTransactionSimulations - true to enable transaction simulations, false to disable it.
+     */
+    setUseTransactionSimulations(useTransactionSimulations) {
+        this.update((state) => {
+            state.useTransactionSimulations = useTransactionSimulations;
+        });
+    }
+}
+exports.PreferencesController = PreferencesController;
+_PreferencesController_instances = new WeakSet(), _PreferencesController_syncIdentities = function _PreferencesController_syncIdentities(addresses) {
+    addresses = addresses.map((address) => (0, controller_utils_1.toChecksumHexAddress)(address));
+    this.update((state) => {
+        const { identities } = state;
+        const newlyLost = {};
+        for (const [address, identity] of Object.entries(identities)) {
+            if (!addresses.includes(address)) {
+                newlyLost[address] = identity;
+                delete identities[address];
+            }
+        }
+        for (const [address, identity] of Object.entries(newlyLost)) {
+            state.lostIdentities[address] = identity;
+        }
+    });
+    this.addIdentities(addresses);
+    if (!addresses.includes(this.state.selectedAddress)) {
+        this.update((state) => {
+            state.selectedAddress = addresses[0];
+        });
+    }
+};
+exports.default = PreferencesController;
+//# sourceMappingURL=PreferencesController.cjs.map

package/dist/PreferencesController.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreferencesController.cjs","sourceRoot":"","sources":["../src/PreferencesController.ts"],"names":[],"mappings":";;;;;;;;;AAAA,+DAKmC;AACnC,iEAAkE;AAMlE,+CAA4D;AAsG5D,MAAM,QAAQ,GAAG;IACf,YAAY,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAChD,UAAU,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAC/C,WAAW,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IAChD,oBAAoB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACxD,6BAA6B,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACjE,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACnD,cAAc,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAClD,qBAAqB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACzD,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACpD,gBAAgB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACpD,wBAAwB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IAC5D,eAAe,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACnD,iBAAiB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;IACrD,4BAA4B,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,KAAK,EAAE;IACjE,yBAAyB,EAAE,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE;CAC9D,CAAC;AAEF,MAAM,IAAI,GAAG,uBAAuB,CAAC;AA0BrC;;;;GAIG;AACH,SAAgB,0BAA0B;IACxC,OAAO;QACL,YAAY,EAAE,EAAE;QAChB,UAAU,EAAE,EAAE;QACd,WAAW,EAAE,uBAAuB;QACpC,oBAAoB,EAAE,IAAI;QAC1B,6BAA6B,EAAE,IAAI;QACnC,cAAc,EAAE,EAAE;QAClB,cAAc,EAAE,KAAK;QACrB,qBAAqB,EAAE,KAAK;QAC5B,eAAe,EAAE,EAAE;QACnB,wBAAwB,EAAE;YACxB,CAAC,yCAA6B,CAAC,OAAO,CAAC,EAAE,IAAI;YAC7C,CAAC,yCAA6B,CAAC,MAAM,CAAC,EAAE,IAAI;YAC5C,CAAC,yCAA6B,CAAC,GAAG,CAAC,EAAE,IAAI;YACzC,CAAC,yCAA6B,CAAC,WAAW,CAAC,EAAE,IAAI;YACjD,CAAC,yCAA6B,CAAC,QAAQ,CAAC,EAAE,IAAI;YAC9C,CAAC,yCAA6B,CAAC,gBAAgB,CAAC,EAAE,IAAI;YACtD,CAAC,yCAA6B,CAAC,OAAO,CAAC,EAAE,IAAI;YAC7C,CAAC,yCAA6B,CAAC,eAAe,CAAC,EAAE,IAAI;YACrD,CAAC,yCAA6B,CAAC,SAAS,CAAC,EAAE,IAAI;YAC/C,CAAC,yCAA6B,CAAC,iBAAiB,CAAC,EAAE,IAAI;YACvD,CAAC,yCAA6B,CAAC,MAAM,CAAC,EAAE,IAAI;YAC5C,CAAC,yCAA6B,CAAC,cAAc,CAAC,EAAE,IAAI;YACpD,CAAC,yCAA6B,CAAC,OAAO,CAAC,EAAE,IAAI;YAC7C,CAAC,yCAA6B,CAAC,YAAY,CAAC,EAAE,IAAI;YAClD,CAAC,yCAA6B,CAAC,aAAa,CAAC,EAAE,IAAI;YACnD,CAAC,yCAA6B,CAAC,aAAa,CAAC,EAAE,IAAI;YACnD,CAAC,yCAA6B,CAAC,QAAQ,CAAC,EAAE,IAAI;YAC9C,CAAC,yCAA6B,CAAC,gBAAgB,CAAC,EAAE,IAAI;YACtD,CAAC,yCAA6B,CAAC,SAAS,CAAC,EAAE,IAAI;YAC/C,CAAC,yCAA6B,CAAC,MAAM,CAAC,EAAE,IAAI;SAC7C;QACD,gBAAgB,EAAE,KAAK;QACvB,eAAe,EAAE,KAAK;QACtB,iBAAiB,EAAE,IAAI;QACvB,4BAA4B,EAAE,KAAK;QACnC,yBAAyB,EAAE,IAAI;KAChC,CAAC;AACJ,CAAC;AAvCD,gEAuCC;AAED;;GAEG;AACH,MAAa,qBAAsB,SAAQ,gCAI1C;IACC;;;;;;OAMG;IACH,YAAY,EACV,SAAS,EACT,KAAK,GAIN;QACC,KAAK,CAAC;YACJ,IAAI;YACJ,QAAQ;YACR,SAAS;YACT,KAAK,EAAE;gBACL,GAAG,0BAA0B,EAAE;gBAC/B,GAAG,KAAK;aACT;SACF,CAAC,CAAC;;QAEH,SAAS,CAAC,SAAS,CACjB,+BAA+B,EAC/B,CAAC,YAAoC,EAAE,EAAE;YACvC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAU,CAAC;YACnC,KAAK,MAAM,OAAO,IAAI,YAAY,CAAC,QAAQ,EAAE;gBAC3C,KAAK,MAAM,OAAO,IAAI,OAAO,CAAC,QAAQ,EAAE;oBACtC,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;iBACvB;aACF;YACD,IAAI,QAAQ,CAAC,IAAI,GAAG,CAAC,EAAE;gBACrB,uBAAA,IAAI,+EAAgB,MAApB,IAAI,EAAiB,KAAK,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC;aAC5C;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,aAAa,CAAC,SAAmB;QAC/B,MAAM,oBAAoB,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CACrD,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAC9B,CAAC;QACF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;YAC7B,KAAK,MAAM,OAAO,IAAI,oBAAoB,EAAE;gBAC1C,IAAI,UAAU,CAAC,OAAO,CAAC,EAAE;oBACvB,SAAS;iBACV;gBACD,MAAM,aAAa,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC;gBAErD,UAAU,CAAC,OAAO,CAAC,GAAG;oBACpB,IAAI,EAAE,WAAW,aAAa,GAAG,CAAC,EAAE;oBACpC,OAAO;oBACP,UAAU,EAAE,IAAI,CAAC,GAAG,EAAE;iBACvB,CAAC;aACH;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,OAAe;QAC5B,OAAO,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;QACxC,MAAM,EAAE,UAAU,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAClC,IAAI,CAAC,UAAU,CAAC,OAAO,CAAC,EAAE;YACxB,OAAO;SACR;QACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,OAAO,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,CAAC;YACjC,IAAI,OAAO,KAAK,KAAK,CAAC,eAAe,EAAE;gBACrC,KAAK,CAAC,eAAe,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,CAAC;aAC1D;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,eAAe,CAAC,OAAe,EAAE,KAAa;QAC5C,OAAO,GAAG,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAAC;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,MAAM,QAAQ,GAAG,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;YACjD,QAAQ,CAAC,IAAI,GAAG,KAAK,CAAC;YACtB,KAAK,CAAC,UAAU,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;QACvC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,cAAc,CAAC,OAAe,EAAE,SAAkB;QAChD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,YAAY,CAAC,OAAO,CAAC,GAAG,SAAS,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAoCD;;;;OAIG;IACH,kBAAkB,CAAC,eAAuB;QACxC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,eAAe,GAAG,IAAA,uCAAoB,EAAC,eAAe,CAAC,CAAC;QAChE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,cAAc,CAAC,WAAmB;QAChC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,WAAW,GAAG,WAAW,CAAC;QAClC,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,oBAAoB,CAAC,iBAA0B;QAC7C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,iBAAiB,GAAG,iBAAiB,CAAC;QAC9C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,kBAAkB,CAAC,eAAwB;QACzC,IAAI,eAAe,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,cAAc,EAAE;YACjD,MAAM,IAAI,KAAK,CACb,8DAA8D,CAC/D,CAAC;SACH;QACD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,eAAe,GAAG,eAAe,CAAC;QAC1C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,iBAAiB,CAAC,cAAuB;QACvC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,cAAc,GAAG,cAAc,CAAC;YACtC,IAAI,CAAC,cAAc,EAAE;gBACnB,KAAK,CAAC,eAAe,GAAG,KAAK,CAAC;aAC/B;QACH,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,wBAAwB,CAAC,qBAA8B;QACrD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,qBAAqB,GAAG,qBAAqB,CAAC;QACtD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,gCAAgC,CAAC,6BAAsC;QACrE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,6BAA6B,GAAG,6BAA6B,CAAC;QACtE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,mBAAmB,CAAC,gBAAyB;QAC3C,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;QAC5C,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,uBAAuB,CAAC,oBAA6B;QACnD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,oBAAoB,GAAG,oBAAoB,CAAC;QACpD,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;;OAKG;IACH,oCAAoC,CAClC,OAAqC,EACrC,kCAA2C;QAE3C,IAAI,MAAM,CAAC,MAAM,CAAC,yCAA6B,CAAC,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;YAClE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;gBACpB,KAAK,CAAC,wBAAwB,GAAG;oBAC/B,GAAG,IAAI,CAAC,KAAK,CAAC,wBAAwB;oBACtC,CAAC,OAAO,CAAC,EAAE,kCAAkC;iBAC9C,CAAC;YACJ,CAAC,CAAC,CAAC;SACJ;IACH,CAAC;IAED;;;;OAIG;IACH,+BAA+B,CAAC,4BAAqC;QACnE,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,4BAA4B,GAAG,4BAA4B,CAAC;QACpE,CAAC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,4BAA4B,CAAC,yBAAkC;QAC7D,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,yBAAyB,GAAG,yBAAyB,CAAC;QAC9D,CAAC,CAAC,CAAC;IACL,CAAC;CACF;AA3SD,sDA2SC;yIAjLiB,SAAmB;IACjC,SAAS,GAAG,SAAS,CAAC,GAAG,CAAC,CAAC,OAAe,EAAE,EAAE,CAC5C,IAAA,uCAAoB,EAAC,OAAO,CAAC,CAC9B,CAAC;IAEF,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;QACpB,MAAM,EAAE,UAAU,EAAE,GAAG,KAAK,CAAC;QAC7B,MAAM,SAAS,GAAoC,EAAE,CAAC;QAEtD,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,UAAU,CAAC,EAAE;YAC5D,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,OAAO,CAAC,EAAE;gBAChC,SAAS,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;gBAC9B,OAAO,UAAU,CAAC,OAAO,CAAC,CAAC;aAC5B;SACF;QAED,KAAK,MAAM,CAAC,OAAO,EAAE,QAAQ,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE;YAC3D,KAAK,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,QAAQ,CAAC;SAC1C;IACH,CAAC,CAAC,CAAC;IACH,IAAI,CAAC,aAAa,CAAC,SAAS,CAAC,CAAC;IAE9B,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,EAAE;QACnD,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE;YACpB,KAAK,CAAC,eAAe,GAAG,SAAS,CAAC,CAAC,CAAC,CAAC;QACvC,CAAC,CAAC,CAAC;KACJ;AACH,CAAC;AAwJH,kBAAe,qBAAqB,CAAC","sourcesContent":["import {\n  BaseController,\n  type ControllerStateChangeEvent,\n  type ControllerGetStateAction,\n  type RestrictedControllerMessenger,\n} from '@metamask/base-controller';\nimport { toChecksumHexAddress } from '@metamask/controller-utils';\nimport type {\n  KeyringControllerState,\n  KeyringControllerStateChangeEvent,\n} from '@metamask/keyring-controller';\n\nimport { ETHERSCAN_SUPPORTED_CHAIN_IDS } from './constants';\n\n/**\n * A representation of a MetaMask identity\n */\nexport type Identity = {\n  /**\n   * The address of the identity\n   */\n  address: string;\n  /**\n   * The timestamp for when this identity was first added\n   */\n  importTime?: number;\n  /**\n   * The name of the identity\n   */\n  name: string;\n};\n\n/**\n * A type union of the name for each chain that is supported by Etherscan or\n * an Etherscan-compatible service.\n */\nexport type EtherscanSupportedChains =\n  keyof typeof ETHERSCAN_SUPPORTED_CHAIN_IDS;\n\n/**\n * A type union of the chain ID for each chain that is supported by Etherscan\n * or an Etherscan-compatible service.\n */\nexport type EtherscanSupportedHexChainId =\n  (typeof ETHERSCAN_SUPPORTED_CHAIN_IDS)[EtherscanSupportedChains];\n\n/**\n * Preferences controller state\n */\nexport type PreferencesState = {\n  /**\n   * Map of specific features to enable or disable\n   */\n  featureFlags: { [feature: string]: boolean };\n  /**\n   * Map of addresses to Identity objects\n   */\n  identities: { [address: string]: Identity };\n  /**\n   * The configured IPFS gateway\n   */\n  ipfsGateway: string;\n  /**\n   * Controls whether IPFS is enabled or not\n   */\n  isIpfsGatewayEnabled: boolean;\n  /**\n   * Controls whether multi-account balances are enabled or not\n   */\n  isMultiAccountBalancesEnabled: boolean;\n  /**\n   * Map of lost addresses to Identity objects\n   */\n  lostIdentities: { [address: string]: Identity };\n  /**\n   * Controls whether the OpenSea API is used\n   */\n  openSeaEnabled: boolean;\n  /**\n   * Controls whether \"security alerts\" are enabled\n   */\n  securityAlertsEnabled: boolean;\n  /**\n   * The current selected address\n   */\n  selectedAddress: string;\n  /**\n   * Controls whether incoming transactions are enabled, per-chain (for Etherscan-supported chains)\n   */\n  showIncomingTransactions: {\n    [chainId in EtherscanSupportedHexChainId]: boolean;\n  };\n  /**\n   * Controls whether test networks are shown in the wallet\n   */\n  showTestNetworks: boolean;\n  /**\n   * Controls whether NFT detection is enabled\n   */\n  useNftDetection: boolean;\n  /**\n   * Controls whether token detection is enabled\n   */\n  useTokenDetection: boolean;\n  /**\n   * Controls whether smart transactions are opted into\n   */\n  smartTransactionsOptInStatus: boolean;\n  /**\n   * Controls whether transaction simulations are enabled\n   */\n  useTransactionSimulations: boolean;\n};\n\nconst metadata = {\n  featureFlags: { persist: true, anonymous: true },\n  identities: { persist: true, anonymous: false },\n  ipfsGateway: { persist: true, anonymous: false },\n  isIpfsGatewayEnabled: { persist: true, anonymous: true },\n  isMultiAccountBalancesEnabled: { persist: true, anonymous: true },\n  lostIdentities: { persist: true, anonymous: false },\n  openSeaEnabled: { persist: true, anonymous: true },\n  securityAlertsEnabled: { persist: true, anonymous: true },\n  selectedAddress: { persist: true, anonymous: false },\n  showTestNetworks: { persist: true, anonymous: true },\n  showIncomingTransactions: { persist: true, anonymous: true },\n  useNftDetection: { persist: true, anonymous: true },\n  useTokenDetection: { persist: true, anonymous: true },\n  smartTransactionsOptInStatus: { persist: true, anonymous: false },\n  useTransactionSimulations: { persist: true, anonymous: true },\n};\n\nconst name = 'PreferencesController';\n\nexport type PreferencesControllerGetStateAction = ControllerGetStateAction<\n  typeof name,\n  PreferencesState\n>;\n\nexport type PreferencesControllerStateChangeEvent = ControllerStateChangeEvent<\n  typeof name,\n  PreferencesState\n>;\n\nexport type PreferencesControllerActions = PreferencesControllerGetStateAction;\n\nexport type PreferencesControllerEvents = PreferencesControllerStateChangeEvent;\n\nexport type AllowedEvents = KeyringControllerStateChangeEvent;\n\nexport type PreferencesControllerMessenger = RestrictedControllerMessenger<\n  typeof name,\n  PreferencesControllerActions,\n  PreferencesControllerEvents | AllowedEvents,\n  never,\n  AllowedEvents['type']\n>;\n\n/**\n * Get the default PreferencesController state.\n *\n * @returns The default PreferencesController state.\n */\nexport function getDefaultPreferencesState() {\n  return {\n    featureFlags: {},\n    identities: {},\n    ipfsGateway: 'https://ipfs.io/ipfs/',\n    isIpfsGatewayEnabled: true,\n    isMultiAccountBalancesEnabled: true,\n    lostIdentities: {},\n    openSeaEnabled: false,\n    securityAlertsEnabled: false,\n    selectedAddress: '',\n    showIncomingTransactions: {\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.MAINNET]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.GOERLI]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.BSC]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.BSC_TESTNET]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.OPTIMISM]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.OPTIMISM_SEPOLIA]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.POLYGON]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.POLYGON_TESTNET]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.AVALANCHE]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.AVALANCHE_TESTNET]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.FANTOM]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.FANTOM_TESTNET]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.SEPOLIA]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.LINEA_GOERLI]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.LINEA_SEPOLIA]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.LINEA_MAINNET]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.MOONBEAM]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.MOONBEAM_TESTNET]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.MOONRIVER]: true,\n      [ETHERSCAN_SUPPORTED_CHAIN_IDS.GNOSIS]: true,\n    },\n    showTestNetworks: false,\n    useNftDetection: false,\n    useTokenDetection: true,\n    smartTransactionsOptInStatus: false,\n    useTransactionSimulations: true,\n  };\n}\n\n/**\n * Controller that stores shared settings and exposes convenience methods\n */\nexport class PreferencesController extends BaseController<\n  typeof name,\n  PreferencesState,\n  PreferencesControllerMessenger\n> {\n  /**\n   * Creates a PreferencesController instance.\n   *\n   * @param args - Arguments\n   * @param args.messenger - The preferences controller messenger.\n   * @param args.state - Preferences controller state.\n   */\n  constructor({\n    messenger,\n    state,\n  }: {\n    messenger: PreferencesControllerMessenger;\n    state?: Partial<PreferencesState>;\n  }) {\n    super({\n      name,\n      metadata,\n      messenger,\n      state: {\n        ...getDefaultPreferencesState(),\n        ...state,\n      },\n    });\n\n    messenger.subscribe(\n      'KeyringController:stateChange',\n      (keyringState: KeyringControllerState) => {\n        const accounts = new Set<string>();\n        for (const keyring of keyringState.keyrings) {\n          for (const account of keyring.accounts) {\n            accounts.add(account);\n          }\n        }\n        if (accounts.size > 0) {\n          this.#syncIdentities(Array.from(accounts));\n        }\n      },\n    );\n  }\n\n  /**\n   * Adds identities to state.\n   *\n   * @param addresses - List of addresses to use to generate new identities.\n   */\n  addIdentities(addresses: string[]) {\n    const checksummedAddresses = addresses.map((address) =>\n      toChecksumHexAddress(address),\n    );\n    this.update((state) => {\n      const { identities } = state;\n      for (const address of checksummedAddresses) {\n        if (identities[address]) {\n          continue;\n        }\n        const identityCount = Object.keys(identities).length;\n\n        identities[address] = {\n          name: `Account ${identityCount + 1}`,\n          address,\n          importTime: Date.now(),\n        };\n      }\n    });\n  }\n\n  /**\n   * Removes an identity from state.\n   *\n   * @param address - Address of the identity to remove.\n   */\n  removeIdentity(address: string) {\n    address = toChecksumHexAddress(address);\n    const { identities } = this.state;\n    if (!identities[address]) {\n      return;\n    }\n    this.update((state) => {\n      delete state.identities[address];\n      if (address === state.selectedAddress) {\n        state.selectedAddress = Object.keys(state.identities)[0];\n      }\n    });\n  }\n\n  /**\n   * Associates a new label with an identity.\n   *\n   * @param address - Address of the identity to associate.\n   * @param label - New label to assign.\n   */\n  setAccountLabel(address: string, label: string) {\n    address = toChecksumHexAddress(address);\n    this.update((state) => {\n      const identity = state.identities[address] || {};\n      identity.name = label;\n      state.identities[address] = identity;\n    });\n  }\n\n  /**\n   * Enable or disable a specific feature flag.\n   *\n   * @param feature - Feature to toggle.\n   * @param activated - Value to assign.\n   */\n  setFeatureFlag(feature: string, activated: boolean) {\n    this.update((state) => {\n      state.featureFlags[feature] = activated;\n    });\n  }\n\n  /**\n   * Synchronizes the current identity list with new identities.\n   *\n   * @param addresses - List of addresses corresponding to identities to sync.\n   */\n  #syncIdentities(addresses: string[]) {\n    addresses = addresses.map((address: string) =>\n      toChecksumHexAddress(address),\n    );\n\n    this.update((state) => {\n      const { identities } = state;\n      const newlyLost: { [address: string]: Identity } = {};\n\n      for (const [address, identity] of Object.entries(identities)) {\n        if (!addresses.includes(address)) {\n          newlyLost[address] = identity;\n          delete identities[address];\n        }\n      }\n\n      for (const [address, identity] of Object.entries(newlyLost)) {\n        state.lostIdentities[address] = identity;\n      }\n    });\n    this.addIdentities(addresses);\n\n    if (!addresses.includes(this.state.selectedAddress)) {\n      this.update((state) => {\n        state.selectedAddress = addresses[0];\n      });\n    }\n  }\n\n  /**\n   * Sets selected address.\n   *\n   * @param selectedAddress - Ethereum address.\n   */\n  setSelectedAddress(selectedAddress: string) {\n    this.update((state) => {\n      state.selectedAddress = toChecksumHexAddress(selectedAddress);\n    });\n  }\n\n  /**\n   * Sets new IPFS gateway.\n   *\n   * @param ipfsGateway - IPFS gateway string.\n   */\n  setIpfsGateway(ipfsGateway: string) {\n    this.update((state) => {\n      state.ipfsGateway = ipfsGateway;\n    });\n  }\n\n  /**\n   * Toggle the token detection setting.\n   *\n   * @param useTokenDetection - Boolean indicating user preference on token detection.\n   */\n  setUseTokenDetection(useTokenDetection: boolean) {\n    this.update((state) => {\n      state.useTokenDetection = useTokenDetection;\n    });\n  }\n\n  /**\n   * Toggle the NFT detection setting.\n   *\n   * @param useNftDetection - Boolean indicating user preference on NFT detection.\n   */\n  setUseNftDetection(useNftDetection: boolean) {\n    if (useNftDetection && !this.state.openSeaEnabled) {\n      throw new Error(\n        'useNftDetection cannot be enabled if openSeaEnabled is false',\n      );\n    }\n    this.update((state) => {\n      state.useNftDetection = useNftDetection;\n    });\n  }\n\n  /**\n   * Toggle the opensea enabled setting.\n   *\n   * @param openSeaEnabled - Boolean indicating user preference on using OpenSea's API.\n   */\n  setOpenSeaEnabled(openSeaEnabled: boolean) {\n    this.update((state) => {\n      state.openSeaEnabled = openSeaEnabled;\n      if (!openSeaEnabled) {\n        state.useNftDetection = false;\n      }\n    });\n  }\n\n  /**\n   * Toggle the security alert enabled setting.\n   *\n   * @param securityAlertsEnabled - Boolean indicating user preference on using security alerts.\n   */\n  setSecurityAlertsEnabled(securityAlertsEnabled: boolean) {\n    this.update((state) => {\n      state.securityAlertsEnabled = securityAlertsEnabled;\n    });\n  }\n\n  /**\n   * A setter for the user preferences to enable/disable fetch of multiple accounts balance.\n   *\n   * @param isMultiAccountBalancesEnabled - true to enable multiple accounts balance fetch, false to fetch only selectedAddress.\n   */\n  setIsMultiAccountBalancesEnabled(isMultiAccountBalancesEnabled: boolean) {\n    this.update((state) => {\n      state.isMultiAccountBalancesEnabled = isMultiAccountBalancesEnabled;\n    });\n  }\n\n  /**\n   * A setter for the user have the test networks visible/hidden.\n   *\n   * @param showTestNetworks - true to show test networks, false to hidden.\n   */\n  setShowTestNetworks(showTestNetworks: boolean) {\n    this.update((state) => {\n      state.showTestNetworks = showTestNetworks;\n    });\n  }\n\n  /**\n   * A setter for the user allow to be fetched IPFS content\n   *\n   * @param isIpfsGatewayEnabled - true to enable ipfs source\n   */\n  setIsIpfsGatewayEnabled(isIpfsGatewayEnabled: boolean) {\n    this.update((state) => {\n      state.isIpfsGatewayEnabled = isIpfsGatewayEnabled;\n    });\n  }\n\n  /**\n   * A setter for the user allow to be fetched IPFS content\n   *\n   * @param chainId - On hexadecimal format to enable the incoming transaction network\n   * @param isIncomingTransactionNetworkEnable - true to enable incoming transactions\n   */\n  setEnableNetworkIncomingTransactions(\n    chainId: EtherscanSupportedHexChainId,\n    isIncomingTransactionNetworkEnable: boolean,\n  ) {\n    if (Object.values(ETHERSCAN_SUPPORTED_CHAIN_IDS).includes(chainId)) {\n      this.update((state) => {\n        state.showIncomingTransactions = {\n          ...this.state.showIncomingTransactions,\n          [chainId]: isIncomingTransactionNetworkEnable,\n        };\n      });\n    }\n  }\n\n  /**\n   * A setter for the user to opt into smart transactions\n   *\n   * @param smartTransactionsOptInStatus - true to opt into smart transactions\n   */\n  setSmartTransactionsOptInStatus(smartTransactionsOptInStatus: boolean) {\n    this.update((state) => {\n      state.smartTransactionsOptInStatus = smartTransactionsOptInStatus;\n    });\n  }\n\n  /**\n   * A setter for the user preferences to enable/disable transaction simulations.\n   *\n   * @param useTransactionSimulations - true to enable transaction simulations, false to disable it.\n   */\n  setUseTransactionSimulations(useTransactionSimulations: boolean) {\n    this.update((state) => {\n      state.useTransactionSimulations = useTransactionSimulations;\n    });\n  }\n}\n\nexport default PreferencesController;\n"]}

package/dist/{types/PreferencesController.d.ts → PreferencesController.d.cts}

@@ -1,6 +1,6 @@
-import { BaseController, type ControllerStateChangeEvent, type ControllerGetStateAction, type RestrictedControllerMessenger } from '@metamask/base-controller';
-import type { KeyringControllerStateChangeEvent } from '@metamask/keyring-controller';
-import { ETHERSCAN_SUPPORTED_CHAIN_IDS } from './constants';
+import { BaseController, type ControllerStateChangeEvent, type ControllerGetStateAction, type RestrictedControllerMessenger } from "@metamask/base-controller";
+import type { KeyringControllerStateChangeEvent } from "@metamask/keyring-controller";
+import { ETHERSCAN_SUPPORTED_CHAIN_IDS } from "./constants.cjs";
 /**
  * A representation of a MetaMask identity
  */
@@ -268,4 +268,4 @@ export declare class PreferencesController extends BaseController<typeof name, P
     setUseTransactionSimulations(useTransactionSimulations: boolean): void;
 }
 export default PreferencesController;
-//# sourceMappingURL=PreferencesController.d.ts.map
+//# sourceMappingURL=PreferencesController.d.cts.map

package/dist/PreferencesController.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"PreferencesController.d.cts","sourceRoot":"","sources":["../src/PreferencesController.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,cAAc,EACd,KAAK,0BAA0B,EAC/B,KAAK,wBAAwB,EAC7B,KAAK,6BAA6B,EACnC,kCAAkC;AAEnC,OAAO,KAAK,EAEV,iCAAiC,EAClC,qCAAqC;AAEtC,OAAO,EAAE,6BAA6B,EAAE,wBAAoB;AAE5D;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,wBAAwB,GAClC,MAAM,OAAO,6BAA6B,CAAC;AAE7C;;;GAGG;AACH,MAAM,MAAM,4BAA4B,GACtC,CAAC,OAAO,6BAA6B,CAAC,CAAC,wBAAwB,CAAC,CAAC;AAEnE;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG;IAC7B;;OAEG;IACH,YAAY,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;IAC7C;;OAEG;IACH,UAAU,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAC;IAC5C;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IACpB;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAC;IAC9B;;OAEG;IACH,6BAA6B,EAAE,OAAO,CAAC;IACvC;;OAEG;IACH,cAAc,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAAA;KAAE,CAAC;IAChD;;OAEG;IACH,cAAc,EAAE,OAAO,CAAC;IACxB;;OAEG;IACH,qBAAqB,EAAE,OAAO,CAAC;IAC/B;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IACxB;;OAEG;IACH,wBAAwB,EAAE;SACvB,OAAO,IAAI,4BAA4B,GAAG,OAAO;KACnD,CAAC;IACF;;OAEG;IACH,gBAAgB,EAAE,OAAO,CAAC;IAC1B;;OAEG;IACH,eAAe,EAAE,OAAO,CAAC;IACzB;;OAEG;IACH,iBAAiB,EAAE,OAAO,CAAC;IAC3B;;OAEG;IACH,4BAA4B,EAAE,OAAO,CAAC;IACtC;;OAEG;IACH,yBAAyB,EAAE,OAAO,CAAC;CACpC,CAAC;AAoBF,QAAA,MAAM,IAAI,0BAA0B,CAAC;AAErC,MAAM,MAAM,mCAAmC,GAAG,wBAAwB,CACxE,OAAO,IAAI,EACX,gBAAgB,CACjB,CAAC;AAEF,MAAM,MAAM,qCAAqC,GAAG,0BAA0B,CAC5E,OAAO,IAAI,EACX,gBAAgB,CACjB,CAAC;AAEF,MAAM,MAAM,4BAA4B,GAAG,mCAAmC,CAAC;AAE/E,MAAM,MAAM,2BAA2B,GAAG,qCAAqC,CAAC;AAEhF,MAAM,MAAM,aAAa,GAAG,iCAAiC,CAAC;AAE9D,MAAM,MAAM,8BAA8B,GAAG,6BAA6B,CACxE,OAAO,IAAI,EACX,4BAA4B,EAC5B,2BAA2B,GAAG,aAAa,EAC3C,KAAK,EACL,aAAa,CAAC,MAAM,CAAC,CACtB,CAAC;AAEF;;;;GAIG;AACH,wBAAgB,0BAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAuCzC;AAED;;GAEG;AACH,qBAAa,qBAAsB,SAAQ,cAAc,CACvD,OAAO,IAAI,EACX,gBAAgB,EAChB,8BAA8B,CAC/B;;IACC;;;;;;OAMG;gBACS,EACV,SAAS,EACT,KAAK,GACN,EAAE;QACD,SAAS,EAAE,8BAA8B,CAAC;QAC1C,KAAK,CAAC,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC;KACnC;IA2BD;;;;OAIG;IACH,aAAa,CAAC,SAAS,EAAE,MAAM,EAAE;IAqBjC;;;;OAIG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM;IAc9B;;;;;OAKG;IACH,eAAe,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM;IAS9C;;;;;OAKG;IACH,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,SAAS,EAAE,OAAO;IAwClD;;;;OAIG;IACH,kBAAkB,CAAC,eAAe,EAAE,MAAM;IAM1C;;;;OAIG;IACH,cAAc,CAAC,WAAW,EAAE,MAAM;IAMlC;;;;OAIG;IACH,oBAAoB,CAAC,iBAAiB,EAAE,OAAO;IAM/C;;;;OAIG;IACH,kBAAkB,CAAC,eAAe,EAAE,OAAO;IAW3C;;;;OAIG;IACH,iBAAiB,CAAC,cAAc,EAAE,OAAO;IASzC;;;;OAIG;IACH,wBAAwB,CAAC,qBAAqB,EAAE,OAAO;IAMvD;;;;OAIG;IACH,gCAAgC,CAAC,6BAA6B,EAAE,OAAO;IAMvE;;;;OAIG;IACH,mBAAmB,CAAC,gBAAgB,EAAE,OAAO;IAM7C;;;;OAIG;IACH,uBAAuB,CAAC,oBAAoB,EAAE,OAAO;IAMrD;;;;;OAKG;IACH,oCAAoC,CAClC,OAAO,EAAE,4BAA4B,EACrC,kCAAkC,EAAE,OAAO;IAY7C;;;;OAIG;IACH,+BAA+B,CAAC,4BAA4B,EAAE,OAAO;IAMrE;;;;OAIG;IACH,4BAA4B,CAAC,yBAAyB,EAAE,OAAO;CAKhE;AAED,eAAe,qBAAqB,CAAC"}

package/dist/PreferencesController.d.mts

@@ -0,0 +1,271 @@
+import { BaseController, type ControllerStateChangeEvent, type ControllerGetStateAction, type RestrictedControllerMessenger } from "@metamask/base-controller";
+import type { KeyringControllerStateChangeEvent } from "@metamask/keyring-controller";
+import { ETHERSCAN_SUPPORTED_CHAIN_IDS } from "./constants.mjs";
+/**
+ * A representation of a MetaMask identity
+ */
+export type Identity = {
+    /**
+     * The address of the identity
+     */
+    address: string;
+    /**
+     * The timestamp for when this identity was first added
+     */
+    importTime?: number;
+    /**
+     * The name of the identity
+     */
+    name: string;
+};
+/**
+ * A type union of the name for each chain that is supported by Etherscan or
+ * an Etherscan-compatible service.
+ */
+export type EtherscanSupportedChains = keyof typeof ETHERSCAN_SUPPORTED_CHAIN_IDS;
+/**
+ * A type union of the chain ID for each chain that is supported by Etherscan
+ * or an Etherscan-compatible service.
+ */
+export type EtherscanSupportedHexChainId = (typeof ETHERSCAN_SUPPORTED_CHAIN_IDS)[EtherscanSupportedChains];
+/**
+ * Preferences controller state
+ */
+export type PreferencesState = {
+    /**
+     * Map of specific features to enable or disable
+     */
+    featureFlags: {
+        [feature: string]: boolean;
+    };
+    /**
+     * Map of addresses to Identity objects
+     */
+    identities: {
+        [address: string]: Identity;
+    };
+    /**
+     * The configured IPFS gateway
+     */
+    ipfsGateway: string;
+    /**
+     * Controls whether IPFS is enabled or not
+     */
+    isIpfsGatewayEnabled: boolean;
+    /**
+     * Controls whether multi-account balances are enabled or not
+     */
+    isMultiAccountBalancesEnabled: boolean;
+    /**
+     * Map of lost addresses to Identity objects
+     */
+    lostIdentities: {
+        [address: string]: Identity;
+    };
+    /**
+     * Controls whether the OpenSea API is used
+     */
+    openSeaEnabled: boolean;
+    /**
+     * Controls whether "security alerts" are enabled
+     */
+    securityAlertsEnabled: boolean;
+    /**
+     * The current selected address
+     */
+    selectedAddress: string;
+    /**
+     * Controls whether incoming transactions are enabled, per-chain (for Etherscan-supported chains)
+     */
+    showIncomingTransactions: {
+        [chainId in EtherscanSupportedHexChainId]: boolean;
+    };
+    /**
+     * Controls whether test networks are shown in the wallet
+     */
+    showTestNetworks: boolean;
+    /**
+     * Controls whether NFT detection is enabled
+     */
+    useNftDetection: boolean;
+    /**
+     * Controls whether token detection is enabled
+     */
+    useTokenDetection: boolean;
+    /**
+     * Controls whether smart transactions are opted into
+     */
+    smartTransactionsOptInStatus: boolean;
+    /**
+     * Controls whether transaction simulations are enabled
+     */
+    useTransactionSimulations: boolean;
+};
+declare const name = "PreferencesController";
+export type PreferencesControllerGetStateAction = ControllerGetStateAction<typeof name, PreferencesState>;
+export type PreferencesControllerStateChangeEvent = ControllerStateChangeEvent<typeof name, PreferencesState>;
+export type PreferencesControllerActions = PreferencesControllerGetStateAction;
+export type PreferencesControllerEvents = PreferencesControllerStateChangeEvent;
+export type AllowedEvents = KeyringControllerStateChangeEvent;
+export type PreferencesControllerMessenger = RestrictedControllerMessenger<typeof name, PreferencesControllerActions, PreferencesControllerEvents | AllowedEvents, never, AllowedEvents['type']>;
+/**
+ * Get the default PreferencesController state.
+ *
+ * @returns The default PreferencesController state.
+ */
+export declare function getDefaultPreferencesState(): {
+    featureFlags: {};
+    identities: {};
+    ipfsGateway: string;
+    isIpfsGatewayEnabled: boolean;
+    isMultiAccountBalancesEnabled: boolean;
+    lostIdentities: {};
+    openSeaEnabled: boolean;
+    securityAlertsEnabled: boolean;
+    selectedAddress: string;
+    showIncomingTransactions: {
+        "0x1": boolean;
+        "0x5": boolean;
+        "0x38": boolean;
+        "0x61": boolean;
+        "0xa": boolean;
+        "0xaa37dc": boolean;
+        "0x89": boolean;
+        "0x13881": boolean;
+        "0xa86a": boolean;
+        "0xa869": boolean;
+        "0xfa": boolean;
+        "0xfa2": boolean;
+        "0xaa36a7": boolean;
+        "0xe704": boolean;
+        "0xe705": boolean;
+        "0xe708": boolean;
+        "0x504": boolean;
+        "0x507": boolean;
+        "0x505": boolean;
+        "0x64": boolean;
+    };
+    showTestNetworks: boolean;
+    useNftDetection: boolean;
+    useTokenDetection: boolean;
+    smartTransactionsOptInStatus: boolean;
+    useTransactionSimulations: boolean;
+};
+/**
+ * Controller that stores shared settings and exposes convenience methods
+ */
+export declare class PreferencesController extends BaseController<typeof name, PreferencesState, PreferencesControllerMessenger> {
+    #private;
+    /**
+     * Creates a PreferencesController instance.
+     *
+     * @param args - Arguments
+     * @param args.messenger - The preferences controller messenger.
+     * @param args.state - Preferences controller state.
+     */
+    constructor({ messenger, state, }: {
+        messenger: PreferencesControllerMessenger;
+        state?: Partial<PreferencesState>;
+    });
+    /**
+     * Adds identities to state.
+     *
+     * @param addresses - List of addresses to use to generate new identities.
+     */
+    addIdentities(addresses: string[]): void;
+    /**
+     * Removes an identity from state.
+     *
+     * @param address - Address of the identity to remove.
+     */
+    removeIdentity(address: string): void;
+    /**
+     * Associates a new label with an identity.
+     *
+     * @param address - Address of the identity to associate.
+     * @param label - New label to assign.
+     */
+    setAccountLabel(address: string, label: string): void;
+    /**
+     * Enable or disable a specific feature flag.
+     *
+     * @param feature - Feature to toggle.
+     * @param activated - Value to assign.
+     */
+    setFeatureFlag(feature: string, activated: boolean): void;
+    /**
+     * Sets selected address.
+     *
+     * @param selectedAddress - Ethereum address.
+     */
+    setSelectedAddress(selectedAddress: string): void;
+    /**
+     * Sets new IPFS gateway.
+     *
+     * @param ipfsGateway - IPFS gateway string.
+     */
+    setIpfsGateway(ipfsGateway: string): void;
+    /**
+     * Toggle the token detection setting.
+     *
+     * @param useTokenDetection - Boolean indicating user preference on token detection.
+     */
+    setUseTokenDetection(useTokenDetection: boolean): void;
+    /**
+     * Toggle the NFT detection setting.
+     *
+     * @param useNftDetection - Boolean indicating user preference on NFT detection.
+     */
+    setUseNftDetection(useNftDetection: boolean): void;
+    /**
+     * Toggle the opensea enabled setting.
+     *
+     * @param openSeaEnabled - Boolean indicating user preference on using OpenSea's API.
+     */
+    setOpenSeaEnabled(openSeaEnabled: boolean): void;
+    /**
+     * Toggle the security alert enabled setting.
+     *
+     * @param securityAlertsEnabled - Boolean indicating user preference on using security alerts.
+     */
+    setSecurityAlertsEnabled(securityAlertsEnabled: boolean): void;
+    /**
+     * A setter for the user preferences to enable/disable fetch of multiple accounts balance.
+     *
+     * @param isMultiAccountBalancesEnabled - true to enable multiple accounts balance fetch, false to fetch only selectedAddress.
+     */
+    setIsMultiAccountBalancesEnabled(isMultiAccountBalancesEnabled: boolean): void;
+    /**
+     * A setter for the user have the test networks visible/hidden.
+     *
+     * @param showTestNetworks - true to show test networks, false to hidden.
+     */
+    setShowTestNetworks(showTestNetworks: boolean): void;
+    /**
+     * A setter for the user allow to be fetched IPFS content
+     *
+     * @param isIpfsGatewayEnabled - true to enable ipfs source
+     */
+    setIsIpfsGatewayEnabled(isIpfsGatewayEnabled: boolean): void;
+    /**
+     * A setter for the user allow to be fetched IPFS content
+     *
+     * @param chainId - On hexadecimal format to enable the incoming transaction network
+     * @param isIncomingTransactionNetworkEnable - true to enable incoming transactions
+     */
+    setEnableNetworkIncomingTransactions(chainId: EtherscanSupportedHexChainId, isIncomingTransactionNetworkEnable: boolean): void;
+    /**
+     * A setter for the user to opt into smart transactions
+     *
+     * @param smartTransactionsOptInStatus - true to opt into smart transactions
+     */
+    setSmartTransactionsOptInStatus(smartTransactionsOptInStatus: boolean): void;
+    /**
+     * A setter for the user preferences to enable/disable transaction simulations.
+     *
+     * @param useTransactionSimulations - true to enable transaction simulations, false to disable it.
+     */
+    setUseTransactionSimulations(useTransactionSimulations: boolean): void;
+}
+export default PreferencesController;
+//# sourceMappingURL=PreferencesController.d.mts.map