@metamask/assets-controllers 1.0.0

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.0.0]
+### Added
+- Initial release
+  - As a result of converting our shared controllers repo into a monorepo ([#831](https://github.com/MetaMask/controllers/pull/831)), we've created this package from select parts of [`@metamask/controllers` v33.0.0](https://github.com/MetaMask/controllers/tree/v33.0.0), namely:
+    - Everything in `src/assets`
+    - Asset-related functions from `src/util.ts` and accompanying tests
+
+    All changes listed after this point were applied to this package following the monorepo conversion.
+
+### Changed
+- Use Ethers for AssetsContractController ([#845](https://github.com/MetaMask/controllers/pull/845))
+
+[Unreleased]: https://github.com/MetaMask/controllers/compare/@metamask/assets-controllers@1.0.0...HEAD
+[1.0.0]: https://github.com/MetaMask/controllers/releases/tag/@metamask/assets-controllers@1.0.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2018 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

package/README.md

@@ -0,0 +1,30 @@
+# `@metamask/assets-controllers`
+
+Controllers which manage interactions involving ERC-20, ERC-721, and ERC-1155 tokens (including NFTs).
+
+## Installation
+
+`yarn add @metamask/assets-controllers`
+
+or
+
+`npm install @metamask/assets-controllers`
+
+## Controllers
+
+This package features the following controllers:
+
+- [**AccountTrackerController**](src/AccountTrackerController.ts) keeps a updated list of the accounts in the currently selected keychain which is updated automatically on a schedule or on demand.
+- [**AssetsContractController**](src/AssetsContractController.ts) provides a set of convenience methods that use contracts to retrieve information about tokens, read token balances, and transfer tokens.
+- [**CollectibleDetectionController**](src/CollectibleDetectionController.ts) keeps a periodically updated list of ERC-721 tokens assigned to the currently selected address.
+- [**CollectiblesController**](src/CollectiblesController.ts) tracks ERC-721 and ERC-1155 tokens assigned to the currently selected address, using OpenSea to retrieve token information.
+- [**CurrencyRateController**](src/CurrencyRateController.ts) keeps a periodically updated value of the exchange rate from the currently selected "native" currency to another (handling testnet tokens specially).
+- [**TokenBalancesController**](src/TokenBalancesController.ts) keeps a periodically updated set of balances for the current set of ERC-20 tokens.
+- [**TokenDetectionController**](src/TokenDetectionController.ts) keeps a periodically updated list of ERC-20 tokens assigned to the currently selected address.
+- [**TokenListController**](src/TokenListController.ts) uses the MetaSwap API to keep a periodically updated list of known ERC-20 tokens along with their metadata.
+- [**TokenRatesController**](src/TokenRatesController.ts) keeps a periodically updated list of exchange rates for known ERC-20 tokens relative to the currently selected native currency.
+- [**TokensController**](src/TokensController.ts) stores the ERC-20 and ERC-721 tokens, along with their metadata, that are listed in the wallet under the currently selected address on the currently selected chain.
+
+## Contributing
+
+This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/controllers#readme).

package/dist/AccountTrackerController.d.ts

@@ -0,0 +1,88 @@
+import { BaseConfig, BaseController, BaseState } from '@metamask/base-controller';
+import { PreferencesState } from '@metamask/preferences-controller';
+/**
+ * @type AccountInformation
+ *
+ * Account information object
+ * @property balance - Hex string of an account balancec in wei
+ */
+export interface AccountInformation {
+    balance: string;
+}
+/**
+ * @type AccountTrackerConfig
+ *
+ * Account tracker controller configuration
+ * @property provider - Provider used to create a new underlying EthQuery instance
+ */
+export interface AccountTrackerConfig extends BaseConfig {
+    interval: number;
+    provider?: any;
+}
+/**
+ * @type AccountTrackerState
+ *
+ * Account tracker controller state
+ * @property accounts - Map of addresses to account information
+ */
+export interface AccountTrackerState extends BaseState {
+    accounts: {
+        [address: string]: AccountInformation;
+    };
+}
+/**
+ * Controller that tracks the network balances for all user accounts.
+ */
+export declare class AccountTrackerController extends BaseController<AccountTrackerConfig, AccountTrackerState> {
+    private ethQuery;
+    private mutex;
+    private handle?;
+    private syncAccounts;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    private getIdentities;
+    /**
+     * Creates an AccountTracker instance.
+     *
+     * @param options - The controller options.
+     * @param options.onPreferencesStateChange - Allows subscribing to preference controller state changes.
+     * @param options.getIdentities - Gets the identities from the Preferences store.
+     * @param config - Initial options used to configure this controller.
+     * @param state - Initial state to set on this controller.
+     */
+    constructor({ onPreferencesStateChange, getIdentities, }: {
+        onPreferencesStateChange: (listener: (preferencesState: PreferencesState) => void) => void;
+        getIdentities: () => PreferencesState['identities'];
+    }, config?: Partial<AccountTrackerConfig>, state?: Partial<AccountTrackerState>);
+    /**
+     * Sets a new provider.
+     *
+     * TODO: Replace this wth a method.
+     *
+     * @param provider - Provider used to create a new underlying EthQuery instance.
+     */
+    set provider(provider: any);
+    get provider(): any;
+    /**
+     * Starts a new polling interval.
+     *
+     * @param interval - Polling interval trigger a 'refresh'.
+     */
+    poll(interval?: number): Promise<void>;
+    /**
+     * Refreshes all accounts in the current keychain.
+     */
+    refresh: () => Promise<void>;
+    /**
+     * Sync accounts balances with some additional addresses.
+     *
+     * @param addresses - the additional addresses, may be hardware wallet addresses.
+     * @returns accounts - addresses with synced balance
+     */
+    syncBalanceWithAddresses(addresses: string[]): Promise<Record<string, {
+        balance: string;
+    }>>;
+}
+export default AccountTrackerController;

package/dist/AccountTrackerController.js

@@ -0,0 +1,138 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.AccountTrackerController = void 0;
+const eth_query_1 = __importDefault(require("eth-query"));
+const async_mutex_1 = require("async-mutex");
+const base_controller_1 = require("@metamask/base-controller");
+const controller_utils_1 = require("@metamask/controller-utils");
+/**
+ * Controller that tracks the network balances for all user accounts.
+ */
+class AccountTrackerController extends base_controller_1.BaseController {
+    /**
+     * Creates an AccountTracker instance.
+     *
+     * @param options - The controller options.
+     * @param options.onPreferencesStateChange - Allows subscribing to preference controller state changes.
+     * @param options.getIdentities - Gets the identities from the Preferences store.
+     * @param config - Initial options used to configure this controller.
+     * @param state - Initial state to set on this controller.
+     */
+    constructor({ onPreferencesStateChange, getIdentities, }, config, state) {
+        super(config, state);
+        this.mutex = new async_mutex_1.Mutex();
+        /**
+         * Name of this controller used during composition
+         */
+        this.name = 'AccountTrackerController';
+        /**
+         * Refreshes all accounts in the current keychain.
+         */
+        this.refresh = () => __awaiter(this, void 0, void 0, function* () {
+            this.syncAccounts();
+            const accounts = Object.assign({}, this.state.accounts);
+            for (const address in accounts) {
+                yield (0, controller_utils_1.safelyExecuteWithTimeout)(() => __awaiter(this, void 0, void 0, function* () {
+                    const balance = yield (0, controller_utils_1.query)(this.ethQuery, 'getBalance', [address]);
+                    accounts[address] = { balance: (0, controller_utils_1.BNToHex)(balance) };
+                }));
+            }
+            this.update({ accounts });
+        });
+        this.defaultConfig = {
+            interval: 10000,
+        };
+        this.defaultState = { accounts: {} };
+        this.initialize();
+        this.getIdentities = getIdentities;
+        onPreferencesStateChange(() => {
+            this.refresh();
+        });
+        this.poll();
+    }
+    syncAccounts() {
+        const { accounts } = this.state;
+        const addresses = Object.keys(this.getIdentities());
+        const existing = Object.keys(accounts);
+        const newAddresses = addresses.filter((address) => existing.indexOf(address) === -1);
+        const oldAddresses = existing.filter((address) => addresses.indexOf(address) === -1);
+        newAddresses.forEach((address) => {
+            accounts[address] = { balance: '0x0' };
+        });
+        oldAddresses.forEach((address) => {
+            delete accounts[address];
+        });
+        this.update({ accounts: Object.assign({}, accounts) });
+    }
+    /**
+     * Sets a new provider.
+     *
+     * TODO: Replace this wth a method.
+     *
+     * @param provider - Provider used to create a new underlying EthQuery instance.
+     */
+    set provider(provider) {
+        this.ethQuery = new eth_query_1.default(provider);
+    }
+    get provider() {
+        throw new Error('Property only used for setting');
+    }
+    /**
+     * Starts a new polling interval.
+     *
+     * @param interval - Polling interval trigger a 'refresh'.
+     */
+    poll(interval) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const releaseLock = yield this.mutex.acquire();
+            interval && this.configure({ interval }, false, false);
+            this.handle && clearTimeout(this.handle);
+            yield this.refresh();
+            this.handle = setTimeout(() => {
+                releaseLock();
+                this.poll(this.config.interval);
+            }, this.config.interval);
+        });
+    }
+    /**
+     * Sync accounts balances with some additional addresses.
+     *
+     * @param addresses - the additional addresses, may be hardware wallet addresses.
+     * @returns accounts - addresses with synced balance
+     */
+    syncBalanceWithAddresses(addresses) {
+        return __awaiter(this, void 0, void 0, function* () {
+            return yield Promise.all(addresses.map((address) => {
+                return (0, controller_utils_1.safelyExecuteWithTimeout)(() => __awaiter(this, void 0, void 0, function* () {
+                    const balance = yield (0, controller_utils_1.query)(this.ethQuery, 'getBalance', [address]);
+                    return [address, balance];
+                }));
+            })).then((value) => {
+                return value.reduce((obj, item) => {
+                    if (!item) {
+                        return obj;
+                    }
+                    const [address, balance] = item;
+                    return Object.assign(Object.assign({}, obj), { [address]: {
+                            balance,
+                        } });
+                }, {});
+            });
+        });
+    }
+}
+exports.AccountTrackerController = AccountTrackerController;
+exports.default = AccountTrackerController;
+//# sourceMappingURL=AccountTrackerController.js.map

package/dist/AccountTrackerController.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"AccountTrackerController.js","sourceRoot":"","sources":["../src/AccountTrackerController.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;AAAA,0DAAiC;AACjC,6CAAoC;AACpC,+DAImC;AAEnC,iEAIoC;AAiCpC;;GAEG;AACH,MAAa,wBAAyB,SAAQ,gCAG7C;IAkCC;;;;;;;;OAQG;IACH,YACE,EACE,wBAAwB,EACxB,aAAa,GAMd,EACD,MAAsC,EACtC,KAAoC;QAEpC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;QArDf,UAAK,GAAG,IAAI,mBAAK,EAAE,CAAC;QAwB5B;;WAEG;QACM,SAAI,GAAG,0BAA0B,CAAC;QAsE3C;;WAEG;QACH,YAAO,GAAG,GAAS,EAAE;YACnB,IAAI,CAAC,YAAY,EAAE,CAAC;YACpB,MAAM,QAAQ,qBAAQ,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAE,CAAC;YAC5C,KAAK,MAAM,OAAO,IAAI,QAAQ,EAAE;gBAC9B,MAAM,IAAA,2CAAwB,EAAC,GAAS,EAAE;oBACxC,MAAM,OAAO,GAAG,MAAM,IAAA,wBAAK,EAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;oBACpE,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,IAAA,0BAAO,EAAC,OAAO,CAAC,EAAE,CAAC;gBACpD,CAAC,CAAA,CAAC,CAAC;aACJ;YACD,IAAI,CAAC,MAAM,CAAC,EAAE,QAAQ,EAAE,CAAC,CAAC;QAC5B,CAAC,CAAA,CAAC;QAxDA,IAAI,CAAC,aAAa,GAAG;YACnB,QAAQ,EAAE,KAAK;SAChB,CAAC;QACF,IAAI,CAAC,YAAY,GAAG,EAAE,QAAQ,EAAE,EAAE,EAAE,CAAC;QACrC,IAAI,CAAC,UAAU,EAAE,CAAC;QAClB,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,wBAAwB,CAAC,GAAG,EAAE;YAC5B,IAAI,CAAC,OAAO,EAAE,CAAC;QACjB,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,IAAI,EAAE,CAAC;IACd,CAAC;IA5DO,YAAY;QAClB,MAAM,EAAE,QAAQ,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC;QAChC,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,aAAa,EAAE,CAAC,CAAC;QACpD,MAAM,QAAQ,GAAG,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;QACvC,MAAM,YAAY,GAAG,SAAS,CAAC,MAAM,CACnC,CAAC,OAAO,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAC9C,CAAC;QACF,MAAM,YAAY,GAAG,QAAQ,CAAC,MAAM,CAClC,CAAC,OAAO,EAAE,EAAE,CAAC,SAAS,CAAC,OAAO,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,CAC/C,CAAC;QACF,YAAY,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC/B,QAAQ,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,EAAE,KAAK,EAAE,CAAC;QACzC,CAAC,CAAC,CAAC;QAEH,YAAY,CAAC,OAAO,CAAC,CAAC,OAAO,EAAE,EAAE;YAC/B,OAAO,QAAQ,CAAC,OAAO,CAAC,CAAC;QAC3B,CAAC,CAAC,CAAC;QACH,IAAI,CAAC,MAAM,CAAC,EAAE,QAAQ,oBAAO,QAAQ,CAAE,EAAE,CAAC,CAAC;IAC7C,CAAC;IA4CD;;;;;;OAMG;IACH,IAAI,QAAQ,CAAC,QAAa;QACxB,IAAI,CAAC,QAAQ,GAAG,IAAI,mBAAQ,CAAC,QAAQ,CAAC,CAAC;IACzC,CAAC;IAED,IAAI,QAAQ;QACV,MAAM,IAAI,KAAK,CAAC,gCAAgC,CAAC,CAAC;IACpD,CAAC;IAED;;;;OAIG;IACG,IAAI,CAAC,QAAiB;;YAC1B,MAAM,WAAW,GAAG,MAAM,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;YAC/C,QAAQ,IAAI,IAAI,CAAC,SAAS,CAAC,EAAE,QAAQ,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,CAAC;YACvD,IAAI,CAAC,MAAM,IAAI,YAAY,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;YACzC,MAAM,IAAI,CAAC,OAAO,EAAE,CAAC;YACrB,IAAI,CAAC,MAAM,GAAG,UAAU,CAAC,GAAG,EAAE;gBAC5B,WAAW,EAAE,CAAC;gBACd,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;YAClC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC;QAC3B,CAAC;KAAA;IAiBD;;;;;OAKG;IACG,wBAAwB,CAC5B,SAAmB;;YAEnB,OAAO,MAAM,OAAO,CAAC,GAAG,CACtB,SAAS,CAAC,GAAG,CAAC,CAAC,OAAO,EAAyC,EAAE;gBAC/D,OAAO,IAAA,2CAAwB,EAAC,GAAS,EAAE;oBACzC,MAAM,OAAO,GAAG,MAAM,IAAA,wBAAK,EAAC,IAAI,CAAC,QAAQ,EAAE,YAAY,EAAE,CAAC,OAAO,CAAC,CAAC,CAAC;oBACpE,OAAO,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;gBAC5B,CAAC,CAAA,CAAC,CAAC;YACL,CAAC,CAAC,CACH,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;gBACf,OAAO,KAAK,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,IAAI,EAAE,EAAE;oBAChC,IAAI,CAAC,IAAI,EAAE;wBACT,OAAO,GAAG,CAAC;qBACZ;oBAED,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,IAAI,CAAC;oBAChC,uCACK,GAAG,KACN,CAAC,OAAO,CAAC,EAAE;4BACT,OAAO;yBACR,IACD;gBACJ,CAAC,EAAE,EAAE,CAAC,CAAC;YACT,CAAC,CAAC,CAAC;QACL,CAAC;KAAA;CACF;AAtJD,4DAsJC;AAED,kBAAe,wBAAwB,CAAC","sourcesContent":["import EthQuery from 'eth-query';\nimport { Mutex } from 'async-mutex';\nimport {\n  BaseConfig,\n  BaseController,\n  BaseState,\n} from '@metamask/base-controller';\nimport { PreferencesState } from '@metamask/preferences-controller';\nimport {\n  BNToHex,\n  query,\n  safelyExecuteWithTimeout,\n} from '@metamask/controller-utils';\n\n/**\n * @type AccountInformation\n *\n * Account information object\n * @property balance - Hex string of an account balancec in wei\n */\nexport interface AccountInformation {\n  balance: string;\n}\n\n/**\n * @type AccountTrackerConfig\n *\n * Account tracker controller configuration\n * @property provider - Provider used to create a new underlying EthQuery instance\n */\nexport interface AccountTrackerConfig extends BaseConfig {\n  interval: number;\n  provider?: any;\n}\n\n/**\n * @type AccountTrackerState\n *\n * Account tracker controller state\n * @property accounts - Map of addresses to account information\n */\nexport interface AccountTrackerState extends BaseState {\n  accounts: { [address: string]: AccountInformation };\n}\n\n/**\n * Controller that tracks the network balances for all user accounts.\n */\nexport class AccountTrackerController extends BaseController<\n  AccountTrackerConfig,\n  AccountTrackerState\n> {\n  private ethQuery: any;\n\n  private mutex = new Mutex();\n\n  private handle?: ReturnType<typeof setTimeout>;\n\n  private syncAccounts() {\n    const { accounts } = this.state;\n    const addresses = Object.keys(this.getIdentities());\n    const existing = Object.keys(accounts);\n    const newAddresses = addresses.filter(\n      (address) => existing.indexOf(address) === -1,\n    );\n    const oldAddresses = existing.filter(\n      (address) => addresses.indexOf(address) === -1,\n    );\n    newAddresses.forEach((address) => {\n      accounts[address] = { balance: '0x0' };\n    });\n\n    oldAddresses.forEach((address) => {\n      delete accounts[address];\n    });\n    this.update({ accounts: { ...accounts } });\n  }\n\n  /**\n   * Name of this controller used during composition\n   */\n  override name = 'AccountTrackerController';\n\n  private getIdentities: () => PreferencesState['identities'];\n\n  /**\n   * Creates an AccountTracker instance.\n   *\n   * @param options - The controller options.\n   * @param options.onPreferencesStateChange - Allows subscribing to preference controller state changes.\n   * @param options.getIdentities - Gets the identities from the Preferences store.\n   * @param config - Initial options used to configure this controller.\n   * @param state - Initial state to set on this controller.\n   */\n  constructor(\n    {\n      onPreferencesStateChange,\n      getIdentities,\n    }: {\n      onPreferencesStateChange: (\n        listener: (preferencesState: PreferencesState) => void,\n      ) => void;\n      getIdentities: () => PreferencesState['identities'];\n    },\n    config?: Partial<AccountTrackerConfig>,\n    state?: Partial<AccountTrackerState>,\n  ) {\n    super(config, state);\n    this.defaultConfig = {\n      interval: 10000,\n    };\n    this.defaultState = { accounts: {} };\n    this.initialize();\n    this.getIdentities = getIdentities;\n    onPreferencesStateChange(() => {\n      this.refresh();\n    });\n    this.poll();\n  }\n\n  /**\n   * Sets a new provider.\n   *\n   * TODO: Replace this wth a method.\n   *\n   * @param provider - Provider used to create a new underlying EthQuery instance.\n   */\n  set provider(provider: any) {\n    this.ethQuery = new EthQuery(provider);\n  }\n\n  get provider() {\n    throw new Error('Property only used for setting');\n  }\n\n  /**\n   * Starts a new polling interval.\n   *\n   * @param interval - Polling interval trigger a 'refresh'.\n   */\n  async poll(interval?: number): Promise<void> {\n    const releaseLock = await this.mutex.acquire();\n    interval && this.configure({ interval }, false, false);\n    this.handle && clearTimeout(this.handle);\n    await this.refresh();\n    this.handle = setTimeout(() => {\n      releaseLock();\n      this.poll(this.config.interval);\n    }, this.config.interval);\n  }\n\n  /**\n   * Refreshes all accounts in the current keychain.\n   */\n  refresh = async () => {\n    this.syncAccounts();\n    const accounts = { ...this.state.accounts };\n    for (const address in accounts) {\n      await safelyExecuteWithTimeout(async () => {\n        const balance = await query(this.ethQuery, 'getBalance', [address]);\n        accounts[address] = { balance: BNToHex(balance) };\n      });\n    }\n    this.update({ accounts });\n  };\n\n  /**\n   * Sync accounts balances with some additional addresses.\n   *\n   * @param addresses - the additional addresses, may be hardware wallet addresses.\n   * @returns accounts - addresses with synced balance\n   */\n  async syncBalanceWithAddresses(\n    addresses: string[],\n  ): Promise<Record<string, { balance: string }>> {\n    return await Promise.all(\n      addresses.map((address): Promise<[string, string] | undefined> => {\n        return safelyExecuteWithTimeout(async () => {\n          const balance = await query(this.ethQuery, 'getBalance', [address]);\n          return [address, balance];\n        });\n      }),\n    ).then((value) => {\n      return value.reduce((obj, item) => {\n        if (!item) {\n          return obj;\n        }\n\n        const [address, balance] = item;\n        return {\n          ...obj,\n          [address]: {\n            balance,\n          },\n        };\n      }, {});\n    });\n  }\n}\n\nexport default AccountTrackerController;\n"]}

package/dist/AssetsContractController.d.ts

@@ -0,0 +1,176 @@
+/// <reference types="bn.js" />
+import { BN } from 'ethereumjs-util';
+import { BaseController, BaseConfig, BaseState } from '@metamask/base-controller';
+import type { PreferencesState } from '@metamask/preferences-controller';
+import { NetworkState } from '@metamask/network-controller';
+/**
+ * Check if token detection is enabled for certain networks
+ *
+ * @param chainId - ChainID of network
+ * @returns Whether the current network supports token detection
+ */
+export declare const SINGLE_CALL_BALANCES_ADDRESS_BY_CHAINID: Record<string, string>;
+export declare const MISSING_PROVIDER_ERROR = "AssetsContractController failed to set the provider correctly. A provider must be set for this method to be available";
+/**
+ * @type AssetsContractConfig
+ *
+ * Assets Contract controller configuration
+ * @property provider - Provider used to create a new web3 instance
+ */
+export interface AssetsContractConfig extends BaseConfig {
+    provider: any;
+    ipfsGateway: string;
+    chainId: string;
+}
+/**
+ * @type BalanceMap
+ *
+ * Key value object containing the balance for each tokenAddress
+ * @property [tokenAddress] - Address of the token
+ */
+export interface BalanceMap {
+    [tokenAddress: string]: BN;
+}
+/**
+ * Controller that interacts with contracts on mainnet through web3
+ */
+export declare class AssetsContractController extends BaseController<AssetsContractConfig, BaseState> {
+    private _provider?;
+    private erc721Standard?;
+    private erc1155Standard?;
+    private erc20Standard?;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    /**
+     * Creates a AssetsContractController instance.
+     *
+     * @param options - The controller options.
+     * @param options.onPreferencesStateChange - Allows subscribing to preference controller state changes.
+     * @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
+     * @param config - Initial options used to configure this controller.
+     * @param state - Initial state to set on this controller.
+     */
+    constructor({ onPreferencesStateChange, onNetworkStateChange, }: {
+        onPreferencesStateChange: (listener: (preferencesState: PreferencesState) => void) => void;
+        onNetworkStateChange: (listener: (networkState: NetworkState) => void) => void;
+    }, config?: Partial<AssetsContractConfig>, state?: Partial<BaseState>);
+    /**
+     * Sets a new provider.
+     *
+     * TODO: Replace this wth a method.
+     *
+     * @property provider - Provider used to create a new underlying Web3 instance
+     */
+    set provider(provider: any);
+    get provider(): any;
+    /**
+     * Get balance or count for current account on specific asset contract.
+     *
+     * @param address - Asset ERC20 contract address.
+     * @param selectedAddress - Current account public address.
+     * @returns Promise resolving to BN object containing balance for current account on specific asset contract.
+     */
+    getERC20BalanceOf(address: string, selectedAddress: string): Promise<BN>;
+    /**
+     * Query for the decimals for a given ERC20 asset.
+     *
+     * @param address - ERC20 asset contract address.
+     * @returns Promise resolving to the 'decimals'.
+     */
+    getERC20TokenDecimals(address: string): Promise<string>;
+    /**
+     * Enumerate assets assigned to an owner.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param selectedAddress - Current account public address.
+     * @param index - An NFT counter less than `balanceOf(selectedAddress)`.
+     * @returns Promise resolving to token identifier for the 'index'th asset assigned to 'selectedAddress'.
+     */
+    getERC721NftTokenId(address: string, selectedAddress: string, index: number): Promise<string>;
+    /**
+     * Enumerate assets assigned to an owner.
+     *
+     * @param tokenAddress - ERC721 asset contract address.
+     * @param userAddress - Current account public address.
+     * @param tokenId - ERC721 asset identifier.
+     * @returns Promise resolving to an object containing the token standard and a set of details which depend on which standard the token supports.
+     */
+    getTokenStandardAndDetails(tokenAddress: string, userAddress?: string, tokenId?: string): Promise<{
+        standard: string;
+        tokenURI?: string | undefined;
+        symbol?: string | undefined;
+        name?: string | undefined;
+        decimals?: string | undefined;
+        balance?: BN | undefined;
+    }>;
+    /**
+     * Query for tokenURI for a given ERC721 asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param tokenId - ERC721 asset identifier.
+     * @returns Promise resolving to the 'tokenURI'.
+     */
+    getERC721TokenURI(address: string, tokenId: string): Promise<string>;
+    /**
+     * Query for name for a given asset.
+     *
+     * @param address - ERC721 or ERC20 asset contract address.
+     * @returns Promise resolving to the 'name'.
+     */
+    getERC721AssetName(address: string): Promise<string>;
+    /**
+     * Query for symbol for a given asset.
+     *
+     * @param address - ERC721 or ERC20 asset contract address.
+     * @returns Promise resolving to the 'symbol'.
+     */
+    getERC721AssetSymbol(address: string): Promise<string>;
+    /**
+     * Query for owner for a given ERC721 asset.
+     *
+     * @param address - ERC721 asset contract address.
+     * @param tokenId - ERC721 asset identifier.
+     * @returns Promise resolving to the owner address.
+     */
+    getERC721OwnerOf(address: string, tokenId: string): Promise<string>;
+    /**
+     * Query for tokenURI for a given asset.
+     *
+     * @param address - ERC1155 asset contract address.
+     * @param tokenId - ERC1155 asset identifier.
+     * @returns Promise resolving to the 'tokenURI'.
+     */
+    getERC1155TokenURI(address: string, tokenId: string): Promise<string>;
+    /**
+     * Query for balance of a given ERC 1155 token.
+     *
+     * @param userAddress - Wallet public address.
+     * @param nftAddress - ERC1155 asset contract address.
+     * @param nftId - ERC1155 asset identifier.
+     * @returns Promise resolving to the 'balanceOf'.
+     */
+    getERC1155BalanceOf(userAddress: string, nftAddress: string, nftId: string): Promise<BN>;
+    /**
+     * Transfer single ERC1155 token.
+     *
+     * @param nftAddress - ERC1155 token address.
+     * @param senderAddress - ERC1155 token sender.
+     * @param recipientAddress - ERC1155 token recipient.
+     * @param nftId - ERC1155 token id.
+     * @param qty - Quantity of tokens to be sent.
+     * @returns Promise resolving to the 'transferSingle' ERC1155 token.
+     */
+    transferSingleERC1155(nftAddress: string, senderAddress: string, recipientAddress: string, nftId: string, qty: string): Promise<void>;
+    /**
+     * Get the token balance for a list of token addresses in a single call. Only non-zero balances
+     * are returned.
+     *
+     * @param selectedAddress - The address to check token balances for.
+     * @param tokensToDetect - The token addresses to detect balances for.
+     * @returns The list of non-zero token balances.
+     */
+    getBalancesInSingleCall(selectedAddress: string, tokensToDetect: string[]): Promise<BalanceMap>;
+}
+export default AssetsContractController;