@metamask-previews/assets-controllers 11.0.1-preview.d32a7cc

package/dist/TokensController.d.ts

@@ -0,0 +1,250 @@
+/// <reference types="node" />
+import { Contract } from '@ethersproject/contracts';
+import type { AddApprovalRequest } from '@metamask/approval-controller';
+import type { BaseConfig, BaseState, RestrictedControllerMessenger } from '@metamask/base-controller';
+import { BaseController } from '@metamask/base-controller';
+import type { NetworkState } from '@metamask/network-controller';
+import type { PreferencesState } from '@metamask/preferences-controller';
+import type { Hex } from '@metamask/utils';
+import { EventEmitter } from 'events';
+import type { AssetsContractController } from './AssetsContractController';
+import type { TokenListState } from './TokenListController';
+import type { Token } from './TokenRatesController';
+/**
+ * @type TokensConfig
+ *
+ * Tokens controller configuration
+ * @property selectedAddress - Vault selected address
+ */
+export interface TokensConfig extends BaseConfig {
+    selectedAddress: string;
+    chainId: Hex;
+    provider: any;
+}
+/**
+ * @type SuggestedAssetMeta
+ *
+ * Suggested asset by EIP747 meta data
+ * @property id - Generated UUID associated with this suggested asset
+ * @property time - Timestamp associated with this this suggested asset
+ * @property type - Type type this suggested asset
+ * @property asset - Asset suggested object
+ * @property interactingAddress - Account address that requested watch asset
+ */
+declare type SuggestedAssetMeta = {
+    id: string;
+    time: number;
+    type: string;
+    asset: Token;
+    interactingAddress: string;
+};
+/**
+ * @type TokensState
+ *
+ * Assets controller state
+ * @property tokens - List of tokens associated with the active network and address pair
+ * @property ignoredTokens - List of ignoredTokens associated with the active network and address pair
+ * @property detectedTokens - List of detected tokens associated with the active network and address pair
+ * @property allTokens - Object containing tokens by network and account
+ * @property allIgnoredTokens - Object containing hidden/ignored tokens by network and account
+ * @property allDetectedTokens - Object containing tokens detected with non-zero balances
+ */
+export interface TokensState extends BaseState {
+    tokens: Token[];
+    ignoredTokens: string[];
+    detectedTokens: Token[];
+    allTokens: {
+        [chainId: Hex]: {
+            [key: string]: Token[];
+        };
+    };
+    allIgnoredTokens: {
+        [chainId: Hex]: {
+            [key: string]: string[];
+        };
+    };
+    allDetectedTokens: {
+        [chainId: Hex]: {
+            [key: string]: Token[];
+        };
+    };
+}
+/**
+ * The name of the {@link TokensController}.
+ */
+declare const controllerName = "TokensController";
+/**
+ * The external actions available to the {@link TokensController}.
+ */
+declare type AllowedActions = AddApprovalRequest;
+/**
+ * The messenger of the {@link TokensController}.
+ */
+export declare type TokensControllerMessenger = RestrictedControllerMessenger<typeof controllerName, AllowedActions, never, AllowedActions['type'], never>;
+/**
+ * Controller that stores assets and exposes convenience methods
+ */
+export declare class TokensController extends BaseController<TokensConfig, TokensState> {
+    private readonly mutex;
+    private ethersProvider;
+    private abortController;
+    private readonly messagingSystem;
+    /**
+     * Fetch metadata for a token.
+     *
+     * @param tokenAddress - The address of the token.
+     * @returns The token metadata.
+     */
+    private fetchTokenMetadata;
+    /**
+     * EventEmitter instance used to listen to specific EIP747 events
+     */
+    hub: EventEmitter;
+    /**
+     * Name of this controller used during composition
+     */
+    name: string;
+    private readonly getERC20TokenName;
+    /**
+     * Creates a TokensController instance.
+     *
+     * @param options - The controller options.
+     * @param options.chainId - The chain ID of the current network.
+     * @param options.onPreferencesStateChange - Allows subscribing to preference controller state changes.
+     * @param options.onNetworkStateChange - Allows subscribing to network controller state changes.
+     * @param options.onTokenListStateChange - Allows subscribing to token list controller state changes.
+     * @param options.getERC20TokenName - Gets the ERC-20 token name.
+     * @param options.config - Initial options used to configure this controller.
+     * @param options.state - Initial state to set on this controller.
+     * @param options.messenger - The controller messenger.
+     */
+    constructor({ chainId: initialChainId, onPreferencesStateChange, onNetworkStateChange, onTokenListStateChange, getERC20TokenName, config, state, messenger, }: {
+        chainId: Hex;
+        onPreferencesStateChange: (listener: (preferencesState: PreferencesState) => void) => void;
+        onNetworkStateChange: (listener: (networkState: NetworkState) => void) => void;
+        onTokenListStateChange: (listener: (tokenListState: TokenListState) => void) => void;
+        getERC20TokenName: AssetsContractController['getERC20TokenName'];
+        config?: Partial<TokensConfig>;
+        state?: Partial<TokensState>;
+        messenger: TokensControllerMessenger;
+    });
+    _instantiateNewEthersProvider(): any;
+    /**
+     * Adds a token to the stored token list.
+     *
+     * @param address - Hex address of the token contract.
+     * @param symbol - Symbol of the token.
+     * @param decimals - Number of decimals the token uses.
+     * @param options - Object containing name and image of the token
+     * @param options.name - Name of the token
+     * @param options.image - Image of the token
+     * @param options.interactingAddress - The address of the account to add a token to.
+     * @returns Current token list.
+     */
+    addToken(address: string, symbol: string, decimals: number, { name, image, interactingAddress, }?: {
+        name?: string;
+        image?: string;
+        interactingAddress?: string;
+    }): Promise<Token[]>;
+    /**
+     * Add a batch of tokens.
+     *
+     * @param tokensToImport - Array of tokens to import.
+     */
+    addTokens(tokensToImport: Token[]): Promise<void>;
+    /**
+     * Ignore a batch of tokens.
+     *
+     * @param tokenAddressesToIgnore - Array of token addresses to ignore.
+     */
+    ignoreTokens(tokenAddressesToIgnore: string[]): void;
+    /**
+     * Adds a batch of detected tokens to the stored token list.
+     *
+     * @param incomingDetectedTokens - Array of detected tokens to be added or updated.
+     * @param detectionDetails - An object containing the chain ID and address of the currently selected network on which the incomingDetectedTokens were detected.
+     * @param detectionDetails.selectedAddress - the account address on which the incomingDetectedTokens were detected.
+     * @param detectionDetails.chainId - the chainId on which the incomingDetectedTokens were detected.
+     */
+    addDetectedTokens(incomingDetectedTokens: Token[], detectionDetails?: {
+        selectedAddress: string;
+        chainId: Hex;
+    }): Promise<void>;
+    /**
+     * Adds isERC721 field to token object. This is called when a user attempts to add tokens that
+     * were previously added which do not yet had isERC721 field.
+     *
+     * @param tokenAddress - The contract address of the token requiring the isERC721 field added.
+     * @returns The new token object with the added isERC721 field.
+     */
+    updateTokenType(tokenAddress: string): Promise<Token>;
+    /**
+     * This is a function that updates the tokens name for the tokens name if it is not defined.
+     *
+     * @param tokenList - Represents the fetched token list from service API
+     * @param tokenAttribute - Represents the token attribute that we want to update on the token list
+     */
+    private updateTokensAttribute;
+    /**
+     * Detects whether or not a token is ERC-721 compatible.
+     *
+     * @param tokenAddress - The token contract address.
+     * @returns A boolean indicating whether the token address passed in supports the EIP-721
+     * interface.
+     */
+    _detectIsERC721(tokenAddress: string): Promise<any>;
+    _createEthersContract(tokenAddress: string, abi: string, ethersProvider: any): Contract;
+    _generateRandomId(): string;
+    /**
+     * Adds a new suggestedAsset to the list of watched assets.
+     * Parameters will be validated according to the asset type being watched.
+     *
+     * @param asset - The asset to be watched. For now only ERC20 tokens are accepted.
+     * @param type - The asset type.
+     * @param interactingAddress - The address of the account that is requesting to watch the asset.
+     * @returns Object containing a Promise resolving to the suggestedAsset address if accepted.
+     */
+    watchAsset(asset: Token, type: string, interactingAddress?: string): Promise<void>;
+    /**
+     * Takes a new tokens and ignoredTokens array for the current network/account combination
+     * and returns new allTokens and allIgnoredTokens state to update to.
+     *
+     * @param params - Object that holds token params.
+     * @param params.newTokens - The new tokens to set for the current network and selected account.
+     * @param params.newIgnoredTokens - The new ignored tokens to set for the current network and selected account.
+     * @param params.newDetectedTokens - The new detected tokens to set for the current network and selected account.
+     * @param params.interactingAddress - The account address to use to store the tokens.
+     * @param params.interactingChainId - The chainId to use to store the tokens.
+     * @returns The updated `allTokens` and `allIgnoredTokens` state.
+     */
+    _getNewAllTokensState(params: {
+        newTokens?: Token[];
+        newIgnoredTokens?: string[];
+        newDetectedTokens?: Token[];
+        interactingAddress?: string;
+        interactingChainId?: Hex;
+    }): {
+        newAllTokens: {
+            [chainId: `0x${string}`]: {
+                [key: string]: Token[];
+            };
+        };
+        newAllIgnoredTokens: {
+            [chainId: `0x${string}`]: {
+                [key: string]: string[];
+            };
+        };
+        newAllDetectedTokens: {
+            [chainId: `0x${string}`]: {
+                [key: string]: Token[];
+            };
+        };
+    };
+    /**
+     * Removes all tokens from the ignored list.
+     */
+    clearIgnoredTokens(): void;
+    _requestApproval(suggestedAssetMeta: SuggestedAssetMeta): Promise<unknown>;
+}
+export default TokensController;
+//# sourceMappingURL=TokensController.d.ts.map

package/dist/TokensController.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"TokensController.d.ts","sourceRoot":"","sources":["../src/TokensController.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,+BAA+B,CAAC;AACxE,OAAO,KAAK,EACV,UAAU,EACV,SAAS,EACT,6BAA6B,EAC9B,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AAU3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,8BAA8B,CAAC;AACjE,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACzE,OAAO,KAAK,EAAE,GAAG,EAAE,MAAM,iBAAiB,CAAC;AAG3C,OAAO,EAAE,YAAY,EAAE,MAAM,QAAQ,CAAC;AAGtC,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,4BAA4B,CAAC;AAU3E,OAAO,KAAK,EAEV,cAAc,EAEf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,wBAAwB,CAAC;AAEpD;;;;;GAKG;AACH,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,eAAe,EAAE,MAAM,CAAC;IACxB,OAAO,EAAE,GAAG,CAAC;IACb,QAAQ,EAAE,GAAG,CAAC;CACf;AAED;;;;;;;;;GASG;AACH,aAAK,kBAAkB,GAAG;IACxB,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,KAAK,CAAC;IACb,kBAAkB,EAAE,MAAM,CAAC;CAC5B,CAAC;AAEF;;;;;;;;;;GAUG;AACH,MAAM,WAAW,WAAY,SAAQ,SAAS;IAC5C,MAAM,EAAE,KAAK,EAAE,CAAC;IAChB,aAAa,EAAE,MAAM,EAAE,CAAC;IACxB,cAAc,EAAE,KAAK,EAAE,CAAC;IACxB,SAAS,EAAE;QAAE,CAAC,OAAO,EAAE,GAAG,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,CAAA;SAAE,CAAA;KAAE,CAAC;IAC1D,gBAAgB,EAAE;QAAE,CAAC,OAAO,EAAE,GAAG,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,EAAE,CAAA;SAAE,CAAA;KAAE,CAAC;IAClE,iBAAiB,EAAE;QAAE,CAAC,OAAO,EAAE,GAAG,GAAG;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,KAAK,EAAE,CAAA;SAAE,CAAA;KAAE,CAAC;CACnE;AAED;;GAEG;AACH,QAAA,MAAM,cAAc,qBAAqB,CAAC;AAE1C;;GAEG;AACH,aAAK,cAAc,GAAG,kBAAkB,CAAC;AAEzC;;GAEG;AACH,oBAAY,yBAAyB,GAAG,6BAA6B,CACnE,OAAO,cAAc,EACrB,cAAc,EACd,KAAK,EACL,cAAc,CAAC,MAAM,CAAC,EACtB,KAAK,CACN,CAAC;AAEF;;GAEG;AACH,qBAAa,gBAAiB,SAAQ,cAAc,CAClD,YAAY,EACZ,WAAW,CACZ;IACC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAe;IAErC,OAAO,CAAC,cAAc,CAAM;IAE5B,OAAO,CAAC,eAAe,CAAwB;IAE/C,OAAO,CAAC,QAAQ,CAAC,eAAe,CAA4B;IAE5D;;;;;OAKG;YACW,kBAAkB;IAqBhC;;OAEG;IACH,GAAG,eAAsB;IAEzB;;OAEG;IACM,IAAI,SAAsB;IAEnC,OAAO,CAAC,QAAQ,CAAC,iBAAiB,CAAgD;IAElF;;;;;;;;;;;;OAYG;gBACS,EACV,OAAO,EAAE,cAAc,EACvB,wBAAwB,EACxB,oBAAoB,EACpB,sBAAsB,EACtB,iBAAiB,EACjB,MAAM,EACN,KAAK,EACL,SAAS,GACV,EAAE;QACD,OAAO,EAAE,GAAG,CAAC;QACb,wBAAwB,EAAE,CACxB,QAAQ,EAAE,CAAC,gBAAgB,EAAE,gBAAgB,KAAK,IAAI,KACnD,IAAI,CAAC;QACV,oBAAoB,EAAE,CACpB,QAAQ,EAAE,CAAC,YAAY,EAAE,YAAY,KAAK,IAAI,KAC3C,IAAI,CAAC;QACV,sBAAsB,EAAE,CACtB,QAAQ,EAAE,CAAC,cAAc,EAAE,cAAc,KAAK,IAAI,KAC/C,IAAI,CAAC;QACV,iBAAiB,EAAE,wBAAwB,CAAC,mBAAmB,CAAC,CAAC;QACjE,MAAM,CAAC,EAAE,OAAO,CAAC,YAAY,CAAC,CAAC;QAC/B,KAAK,CAAC,EAAE,OAAO,CAAC,WAAW,CAAC,CAAC;QAC7B,SAAS,EAAE,yBAAyB,CAAC;KACtC;IA4DD,6BAA6B,IAAI,GAAG;IAIpC;;;;;;;;;;;OAWG;IACG,QAAQ,CACZ,OAAO,EAAE,MAAM,EACf,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,MAAM,EAChB,EACE,IAAI,EACJ,KAAK,EACL,kBAAkB,GACnB,GAAE;QAAE,IAAI,CAAC,EAAE,MAAM,CAAC;QAAC,KAAK,CAAC,EAAE,MAAM,CAAC;QAAC,kBAAkB,CAAC,EAAE,MAAM,CAAA;KAAO,GACrE,OAAO,CAAC,KAAK,EAAE,CAAC;IAsFnB;;;;OAIG;IACG,SAAS,CAAC,cAAc,EAAE,KAAK,EAAE;IAuDvC;;;;OAIG;IACH,YAAY,CAAC,sBAAsB,EAAE,MAAM,EAAE;IAmC7C;;;;;;;OAOG;IACG,iBAAiB,CACrB,sBAAsB,EAAE,KAAK,EAAE,EAC/B,gBAAgB,CAAC,EAAE;QAAE,eAAe,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,GAAG,CAAA;KAAE;IA0F9D;;;;;;OAMG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM;IAW1C;;;;;OAKG;IACH,OAAO,CAAC,qBAAqB;IAiB7B;;;;;;OAMG;IACG,eAAe,CAAC,YAAY,EAAE,MAAM;IA0B1C,qBAAqB,CACnB,YAAY,EAAE,MAAM,EACpB,GAAG,EAAE,MAAM,EACX,cAAc,EAAE,GAAG,GAClB,QAAQ;IAKX,iBAAiB,IAAI,MAAM;IAI3B;;;;;;;;OAQG;IACG,UAAU,CACd,KAAK,EAAE,KAAK,EACZ,IAAI,EAAE,MAAM,EACZ,kBAAkB,CAAC,EAAE,MAAM,GAC1B,OAAO,CAAC,IAAI,CAAC;IAiChB;;;;;;;;;;;OAWG;IACH,qBAAqB,CAAC,MAAM,EAAE;QAC5B,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC;QACpB,gBAAgB,CAAC,EAAE,MAAM,EAAE,CAAC;QAC5B,iBAAiB,CAAC,EAAE,KAAK,EAAE,CAAC;QAC5B,kBAAkB,CAAC,EAAE,MAAM,CAAC;QAC5B,kBAAkB,CAAC,EAAE,GAAG,CAAC;KAC1B;;;;;;;;;;;;;;;;;IAyED;;OAEG;IACH,kBAAkB;IAIZ,gBAAgB,CAAC,kBAAkB,EAAE,kBAAkB;CAqB9D;AAED,eAAe,gBAAgB,CAAC"}