@metamask/assets-controllers 1.0.0

package/dist/token-service.js

@@ -0,0 +1,134 @@
+"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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchTokenMetadata = exports.fetchTokenList = exports.TOKEN_METADATA_NO_SUPPORT_ERROR = exports.TOKEN_END_POINT_API = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const assetsUtil_1 = require("./assetsUtil");
+exports.TOKEN_END_POINT_API = 'https://token-api.metaswap.codefi.network';
+exports.TOKEN_METADATA_NO_SUPPORT_ERROR = 'TokenService Error: Network does not support fetchTokenMetadata';
+/**
+ * Get the tokens URL for a specific network.
+ *
+ * @param chainId - The chain ID of the network the tokens requested are on.
+ * @returns The tokens URL.
+ */
+function getTokensURL(chainId) {
+    return `${exports.TOKEN_END_POINT_API}/tokens/${chainId}`;
+}
+/**
+ * Get the token metadata URL for the given network and token.
+ *
+ * @param chainId - The chain ID of the network the token is on.
+ * @param tokenAddress - The token address.
+ * @returns The token metadata URL.
+ */
+function getTokenMetadataURL(chainId, tokenAddress) {
+    return `${exports.TOKEN_END_POINT_API}/token/${chainId}?address=${tokenAddress}`;
+}
+const tenSecondsInMilliseconds = 10000;
+// Token list averages 1.6 MB in size
+// timeoutFetch by default has a 500ms timeout, which will almost always timeout given the response size.
+const defaultTimeout = tenSecondsInMilliseconds;
+/**
+ * Fetch the list of token metadata for a given network. This request is cancellable using the
+ * abort signal passed in.
+ *
+ * @param chainId - The chain ID of the network the requested tokens are on.
+ * @param abortSignal - The abort signal used to cancel the request if necessary.
+ * @param options - Additional fetch options.
+ * @param options.timeout - The fetch timeout.
+ * @returns The token list, or `undefined` if the request was cancelled.
+ */
+function fetchTokenList(chainId, abortSignal, { timeout = defaultTimeout } = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const tokenURL = getTokensURL(chainId);
+        const response = yield queryApi(tokenURL, abortSignal, timeout);
+        if (response) {
+            return parseJsonResponse(response);
+        }
+        return undefined;
+    });
+}
+exports.fetchTokenList = fetchTokenList;
+/**
+ * Fetch metadata for the token address provided for a given network. This request is cancellable
+ * using the abort signal passed in.
+ *
+ * @param chainId - The chain ID of the network the token is on.
+ * @param tokenAddress - The address of the token to fetch metadata for.
+ * @param abortSignal - The abort signal used to cancel the request if necessary.
+ * @param options - Additional fetch options.
+ * @param options.timeout - The fetch timeout.
+ * @returns The token metadata, or `undefined` if the request was either aborted or failed.
+ */
+function fetchTokenMetadata(chainId, tokenAddress, abortSignal, { timeout = defaultTimeout } = {}) {
+    return __awaiter(this, void 0, void 0, function* () {
+        if (!(0, assetsUtil_1.isTokenListSupportedForNetwork)(chainId)) {
+            throw new Error(exports.TOKEN_METADATA_NO_SUPPORT_ERROR);
+        }
+        const tokenMetadataURL = getTokenMetadataURL(chainId, tokenAddress);
+        const response = yield queryApi(tokenMetadataURL, abortSignal, timeout);
+        if (response) {
+            return parseJsonResponse(response);
+        }
+        return undefined;
+    });
+}
+exports.fetchTokenMetadata = fetchTokenMetadata;
+/**
+ * Perform fetch request against the api.
+ *
+ * @param apiURL - The URL of the API to fetch.
+ * @param abortSignal - The abort signal used to cancel the request if necessary.
+ * @param timeout - The fetch timeout.
+ * @returns Promise resolving request response.
+ */
+function queryApi(apiURL, abortSignal, timeout) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const fetchOptions = {
+            referrer: apiURL,
+            referrerPolicy: 'no-referrer-when-downgrade',
+            method: 'GET',
+            mode: 'cors',
+            signal: abortSignal,
+            cache: 'default',
+        };
+        fetchOptions.headers = new window.Headers();
+        fetchOptions.headers.set('Content-Type', 'application/json');
+        try {
+            return yield (0, controller_utils_1.timeoutFetch)(apiURL, fetchOptions, timeout);
+        }
+        catch (error) {
+            if (error instanceof Error && error.name === 'AbortError') {
+                console.log('Request is aborted');
+            }
+        }
+        return undefined;
+    });
+}
+/**
+ * Parse an API response and return the response JSON data.
+ *
+ * @param apiResponse - The API response to parse.
+ * @returns The response JSON data.
+ * @throws Will throw if the response includes an error.
+ */
+function parseJsonResponse(apiResponse) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const responseObj = yield apiResponse.json();
+        // api may return errors as json without setting an error http status code
+        if (responseObj === null || responseObj === void 0 ? void 0 : responseObj.error) {
+            throw new Error(`TokenService Error: ${responseObj.error}`);
+        }
+        return responseObj;
+    });
+}
+//# sourceMappingURL=token-service.js.map

package/dist/token-service.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"token-service.js","sourceRoot":"","sources":["../src/token-service.ts"],"names":[],"mappings":";;;;;;;;;;;;AAAA,iEAA0D;AAC1D,6CAA8D;AAEjD,QAAA,mBAAmB,GAAG,2CAA2C,CAAC;AAClE,QAAA,+BAA+B,GAC1C,iEAAiE,CAAC;AAEpE;;;;;GAKG;AACH,SAAS,YAAY,CAAC,OAAe;IACnC,OAAO,GAAG,2BAAmB,WAAW,OAAO,EAAE,CAAC;AACpD,CAAC;AAED;;;;;;GAMG;AACH,SAAS,mBAAmB,CAAC,OAAe,EAAE,YAAoB;IAChE,OAAO,GAAG,2BAAmB,UAAU,OAAO,YAAY,YAAY,EAAE,CAAC;AAC3E,CAAC;AAED,MAAM,wBAAwB,GAAG,KAAM,CAAC;AAExC,qCAAqC;AACrC,yGAAyG;AACzG,MAAM,cAAc,GAAG,wBAAwB,CAAC;AAEhD;;;;;;;;;GASG;AACH,SAAsB,cAAc,CAClC,OAAe,EACf,WAAwB,EACxB,EAAE,OAAO,GAAG,cAAc,EAAE,GAAG,EAAE;;QAEjC,MAAM,QAAQ,GAAG,YAAY,CAAC,OAAO,CAAC,CAAC;QACvC,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,QAAQ,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QAChE,IAAI,QAAQ,EAAE;YACZ,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;SACpC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CAAA;AAXD,wCAWC;AAED;;;;;;;;;;GAUG;AACH,SAAsB,kBAAkB,CACtC,OAAe,EACf,YAAoB,EACpB,WAAwB,EACxB,EAAE,OAAO,GAAG,cAAc,EAAE,GAAG,EAAE;;QAEjC,IAAI,CAAC,IAAA,2CAA8B,EAAC,OAAO,CAAC,EAAE;YAC5C,MAAM,IAAI,KAAK,CAAC,uCAA+B,CAAC,CAAC;SAClD;QACD,MAAM,gBAAgB,GAAG,mBAAmB,CAAC,OAAO,EAAE,YAAY,CAAC,CAAC;QACpE,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAAC,gBAAgB,EAAE,WAAW,EAAE,OAAO,CAAC,CAAC;QACxE,IAAI,QAAQ,EAAE;YACZ,OAAO,iBAAiB,CAAC,QAAQ,CAAe,CAAC;SAClD;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CAAA;AAfD,gDAeC;AAED;;;;;;;GAOG;AACH,SAAe,QAAQ,CACrB,MAAc,EACd,WAAwB,EACxB,OAAe;;QAEf,MAAM,YAAY,GAAgB;YAChC,QAAQ,EAAE,MAAM;YAChB,cAAc,EAAE,4BAA4B;YAC5C,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,MAAM;YACZ,MAAM,EAAE,WAAW;YACnB,KAAK,EAAE,SAAS;SACjB,CAAC;QACF,YAAY,CAAC,OAAO,GAAG,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;QAC5C,YAAY,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;QAC7D,IAAI;YACF,OAAO,MAAM,IAAA,+BAAY,EAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,CAAC;SAC1D;QAAC,OAAO,KAAK,EAAE;YACd,IAAI,KAAK,YAAY,KAAK,IAAI,KAAK,CAAC,IAAI,KAAK,YAAY,EAAE;gBACzD,OAAO,CAAC,GAAG,CAAC,oBAAoB,CAAC,CAAC;aACnC;SACF;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;CAAA;AAED;;;;;;GAMG;AACH,SAAe,iBAAiB,CAAC,WAAqB;;QACpD,MAAM,WAAW,GAAG,MAAM,WAAW,CAAC,IAAI,EAAE,CAAC;QAC7C,0EAA0E;QAC1E,IAAI,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,KAAK,EAAE;YACtB,MAAM,IAAI,KAAK,CAAC,uBAAuB,WAAW,CAAC,KAAK,EAAE,CAAC,CAAC;SAC7D;QACD,OAAO,WAAW,CAAC;IACrB,CAAC;CAAA","sourcesContent":["import { timeoutFetch } from '@metamask/controller-utils';\nimport { isTokenListSupportedForNetwork } from './assetsUtil';\n\nexport const TOKEN_END_POINT_API = 'https://token-api.metaswap.codefi.network';\nexport const TOKEN_METADATA_NO_SUPPORT_ERROR =\n  'TokenService Error: Network does not support fetchTokenMetadata';\n\n/**\n * Get the tokens URL for a specific network.\n *\n * @param chainId - The chain ID of the network the tokens requested are on.\n * @returns The tokens URL.\n */\nfunction getTokensURL(chainId: string) {\n  return `${TOKEN_END_POINT_API}/tokens/${chainId}`;\n}\n\n/**\n * Get the token metadata URL for the given network and token.\n *\n * @param chainId - The chain ID of the network the token is on.\n * @param tokenAddress - The token address.\n * @returns The token metadata URL.\n */\nfunction getTokenMetadataURL(chainId: string, tokenAddress: string) {\n  return `${TOKEN_END_POINT_API}/token/${chainId}?address=${tokenAddress}`;\n}\n\nconst tenSecondsInMilliseconds = 10_000;\n\n// Token list averages 1.6 MB in size\n// timeoutFetch by default has a 500ms timeout, which will almost always timeout given the response size.\nconst defaultTimeout = tenSecondsInMilliseconds;\n\n/**\n * Fetch the list of token metadata for a given network. This request is cancellable using the\n * abort signal passed in.\n *\n * @param chainId - The chain ID of the network the requested tokens are on.\n * @param abortSignal - The abort signal used to cancel the request if necessary.\n * @param options - Additional fetch options.\n * @param options.timeout - The fetch timeout.\n * @returns The token list, or `undefined` if the request was cancelled.\n */\nexport async function fetchTokenList(\n  chainId: string,\n  abortSignal: AbortSignal,\n  { timeout = defaultTimeout } = {},\n): Promise<unknown> {\n  const tokenURL = getTokensURL(chainId);\n  const response = await queryApi(tokenURL, abortSignal, timeout);\n  if (response) {\n    return parseJsonResponse(response);\n  }\n  return undefined;\n}\n\n/**\n * Fetch metadata for the token address provided for a given network. This request is cancellable\n * using the abort signal passed in.\n *\n * @param chainId - The chain ID of the network the token is on.\n * @param tokenAddress - The address of the token to fetch metadata for.\n * @param abortSignal - The abort signal used to cancel the request if necessary.\n * @param options - Additional fetch options.\n * @param options.timeout - The fetch timeout.\n * @returns The token metadata, or `undefined` if the request was either aborted or failed.\n */\nexport async function fetchTokenMetadata<T>(\n  chainId: string,\n  tokenAddress: string,\n  abortSignal: AbortSignal,\n  { timeout = defaultTimeout } = {},\n): Promise<T | undefined> {\n  if (!isTokenListSupportedForNetwork(chainId)) {\n    throw new Error(TOKEN_METADATA_NO_SUPPORT_ERROR);\n  }\n  const tokenMetadataURL = getTokenMetadataURL(chainId, tokenAddress);\n  const response = await queryApi(tokenMetadataURL, abortSignal, timeout);\n  if (response) {\n    return parseJsonResponse(response) as Promise<T>;\n  }\n  return undefined;\n}\n\n/**\n * Perform fetch request against the api.\n *\n * @param apiURL - The URL of the API to fetch.\n * @param abortSignal - The abort signal used to cancel the request if necessary.\n * @param timeout - The fetch timeout.\n * @returns Promise resolving request response.\n */\nasync function queryApi(\n  apiURL: string,\n  abortSignal: AbortSignal,\n  timeout: number,\n): Promise<Response | undefined> {\n  const fetchOptions: RequestInit = {\n    referrer: apiURL,\n    referrerPolicy: 'no-referrer-when-downgrade',\n    method: 'GET',\n    mode: 'cors',\n    signal: abortSignal,\n    cache: 'default',\n  };\n  fetchOptions.headers = new window.Headers();\n  fetchOptions.headers.set('Content-Type', 'application/json');\n  try {\n    return await timeoutFetch(apiURL, fetchOptions, timeout);\n  } catch (error) {\n    if (error instanceof Error && error.name === 'AbortError') {\n      console.log('Request is aborted');\n    }\n  }\n  return undefined;\n}\n\n/**\n * Parse an API response and return the response JSON data.\n *\n * @param apiResponse - The API response to parse.\n * @returns The response JSON data.\n * @throws Will throw if the response includes an error.\n */\nasync function parseJsonResponse(apiResponse: Response): Promise<unknown> {\n  const responseObj = await apiResponse.json();\n  // api may return errors as json without setting an error http status code\n  if (responseObj?.error) {\n    throw new Error(`TokenService Error: ${responseObj.error}`);\n  }\n  return responseObj;\n}\n"]}

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "@metamask/assets-controllers",
+  "version": "1.0.0",
+  "description": "Controllers which manage interactions involving ERC-20, ERC-721, and ERC-1155 tokens (including NFTs)",
+  "keywords": [
+    "MetaMask",
+    "Ethereum"
+  ],
+  "homepage": "https://github.com/MetaMask/controllers/tree/main/packages/assets-controllers#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/controllers/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/controllers.git"
+  },
+  "license": "MIT",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist/"
+  ],
+  "scripts": {
+    "build:docs": "typedoc",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/assets-controllers",
+    "prepare-manifest:preview": "../../scripts/prepare-preview-manifest.sh",
+    "publish:preview": "yarn npm publish --tag preview",
+    "test": "jest",
+    "test:watch": "jest --watch"
+  },
+  "dependencies": {
+    "@ethersproject/abi": "^5.7.0",
+    "@ethersproject/bignumber": "^5.7.0",
+    "@ethersproject/contracts": "^5.7.0",
+    "@ethersproject/providers": "^5.7.0",
+    "@metamask/base-controller": "~1.0.0",
+    "@metamask/contract-metadata": "^1.35.0",
+    "@metamask/controller-utils": "~1.0.0",
+    "@metamask/metamask-eth-abis": "3.0.0",
+    "@metamask/network-controller": "~1.0.0",
+    "@metamask/preferences-controller": "~1.0.0",
+    "@types/uuid": "^8.3.0",
+    "abort-controller": "^3.0.0",
+    "async-mutex": "^0.2.6",
+    "babel-runtime": "^6.26.0",
+    "eth-query": "^2.1.2",
+    "eth-rpc-errors": "^4.0.0",
+    "ethereumjs-util": "^7.0.10",
+    "immer": "^9.0.6",
+    "multiformats": "^9.5.2",
+    "single-call-balance-checker-abi": "^1.0.0",
+    "uuid": "^8.3.2"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.1.0",
+    "@types/jest": "^26.0.22",
+    "@types/node": "^14.14.31",
+    "deepmerge": "^4.2.2",
+    "ethjs-provider-http": "^0.1.6",
+    "jest": "^26.4.2",
+    "nock": "^13.0.7",
+    "sinon": "^9.2.4",
+    "ts-jest": "^26.5.2",
+    "typedoc": "^0.22.15",
+    "typedoc-plugin-missing-exports": "^0.22.6",
+    "typescript": "~4.6.3"
+  },
+  "engines": {
+    "node": ">=14.0.0"
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}