@metamask/transaction-controller 41.1.0 → 42.1.0

package/dist/utils/etherscan.d.mts

@@ -1,74 +0,0 @@
-import type { Hex } from "@metamask/utils";
-export interface EtherscanTransactionMetaBase {
-    blockNumber: string;
-    blockHash: string;
-    confirmations: string;
-    contractAddress: string;
-    cumulativeGasUsed: string;
-    from: string;
-    gas: string;
-    gasPrice: string;
-    gasUsed: string;
-    hash: string;
-    nonce: string;
-    timeStamp: string;
-    to: string;
-    transactionIndex: string;
-    value: string;
-}
-export interface EtherscanTransactionMeta extends EtherscanTransactionMetaBase {
-    functionName: string;
-    input: string;
-    isError: string;
-    methodId: string;
-    txreceipt_status: string;
-}
-export interface EtherscanTokenTransactionMeta extends EtherscanTransactionMetaBase {
-    tokenDecimal: string;
-    tokenName: string;
-    tokenSymbol: string;
-}
-export interface EtherscanTransactionResponse<T extends EtherscanTransactionMetaBase> {
-    status: '0' | '1';
-    message?: string;
-    result: string | T[];
-}
-export interface EtherscanTransactionRequest {
-    address: string;
-    apiKey?: string;
-    chainId: Hex;
-    fromBlock?: number;
-    limit?: number;
-}
-/**
- * Retrieves transaction data from Etherscan.
- *
- * @param request - Configuration required to fetch transactions.
- * @param request.address - Address to retrieve transactions for.
- * @param request.apiKey - Etherscan API key to prevent rate limiting.
- * @param request.chainId - Current chain ID used to determine subdomain and domain.
- * @param request.fromBlock - Block number to start fetching transactions from.
- * @param request.limit - Number of transactions to retrieve.
- * @returns An Etherscan response object containing the request status and an array of token transaction data.
- */
-export declare function fetchEtherscanTransactions({ address, apiKey, chainId, fromBlock, limit, }: EtherscanTransactionRequest): Promise<EtherscanTransactionResponse<EtherscanTransactionMeta>>;
-/**
- * Retrieves token transaction data from Etherscan.
- *
- * @param request - Configuration required to fetch token transactions.
- * @param request.address - Address to retrieve token transactions for.
- * @param request.apiKey - Etherscan API key to prevent rate limiting.
- * @param request.chainId - Current chain ID used to determine subdomain and domain.
- * @param request.fromBlock - Block number to start fetching token transactions from.
- * @param request.limit - Number of token transactions to retrieve.
- * @returns An Etherscan response object containing the request status and an array of token transaction data.
- */
-export declare function fetchEtherscanTokenTransactions({ address, apiKey, chainId, fromBlock, limit, }: EtherscanTransactionRequest): Promise<EtherscanTransactionResponse<EtherscanTokenTransactionMeta>>;
-/**
- * Return the host url used to fetch data from Etherscan.
- *
- * @param chainId - Current chain ID used to determine subdomain and domain.
- * @returns host URL to access Etherscan data.
- */
-export declare function getEtherscanApiHost(chainId: Hex): string;
-//# sourceMappingURL=etherscan.d.mts.map

package/dist/utils/etherscan.d.mts.map

@@ -1 +0,0 @@
-{"version":3,"file":"etherscan.d.mts","sourceRoot":"","sources":["../../src/utils/etherscan.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAU3C,MAAM,WAAW,4BAA4B;IAC3C,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,MAAM,CAAC;IACxB,iBAAiB,EAAE,MAAM,CAAC;IAC1B,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,MAAM,CAAC;IACZ,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,EAAE,MAAM,CAAC;IACb,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,EAAE,EAAE,MAAM,CAAC;IACX,gBAAgB,EAAE,MAAM,CAAC;IACzB,KAAK,EAAE,MAAM,CAAC;CACf;AAKD,MAAM,WAAW,wBAAyB,SAAQ,4BAA4B;IAC5E,YAAY,EAAE,MAAM,CAAC;IACrB,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IAGjB,gBAAgB,EAAE,MAAM,CAAC;CAC1B;AAKD,MAAM,WAAW,6BACf,SAAQ,4BAA4B;IACpC,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,EAAE,MAAM,CAAC;CACrB;AAKD,MAAM,WAAW,4BAA4B,CAG3C,CAAC,SAAS,4BAA4B;IAEtC,MAAM,EAAE,GAAG,GAAG,GAAG,CAAC;IAClB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,MAAM,EAAE,MAAM,GAAG,CAAC,EAAE,CAAC;CACtB;AAKD,MAAM,WAAW,2BAA2B;IAC1C,OAAO,EAAE,MAAM,CAAC;IAChB,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,GAAG,CAAC;IACb,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,0BAA0B,CAAC,EAC/C,OAAO,EACP,MAAM,EACN,OAAO,EACP,SAAS,EACT,KAAK,GACN,EAAE,2BAA2B,GAAG,OAAO,CACtC,4BAA4B,CAAC,wBAAwB,CAAC,CACvD,CAQA;AAED;;;;;;;;;;GAUG;AACH,wBAAsB,+BAA+B,CAAC,EACpD,OAAO,EACP,MAAM,EACN,OAAO,EACP,SAAS,EACT,KAAK,GACN,EAAE,2BAA2B,GAAG,OAAO,CACtC,4BAA4B,CAAC,6BAA6B,CAAC,CAC5D,CAQA;AAoFD;;;;;GAKG;AACH,wBAAgB,mBAAmB,CAAC,OAAO,EAAE,GAAG,UAW/C"}

package/dist/utils/etherscan.mjs

@@ -1,110 +0,0 @@
-import { handleFetch } from "@metamask/controller-utils";
-import { ETHERSCAN_SUPPORTED_NETWORKS } from "../constants.mjs";
-import { createModuleLogger, projectLogger } from "../logger.mjs";
-const log = createModuleLogger(projectLogger, 'etherscan');
-/**
- * Retrieves transaction data from Etherscan.
- *
- * @param request - Configuration required to fetch transactions.
- * @param request.address - Address to retrieve transactions for.
- * @param request.apiKey - Etherscan API key to prevent rate limiting.
- * @param request.chainId - Current chain ID used to determine subdomain and domain.
- * @param request.fromBlock - Block number to start fetching transactions from.
- * @param request.limit - Number of transactions to retrieve.
- * @returns An Etherscan response object containing the request status and an array of token transaction data.
- */
-export async function fetchEtherscanTransactions({ address, apiKey, chainId, fromBlock, limit, }) {
-    return await fetchTransactions('txlist', {
-        address,
-        apiKey,
-        chainId,
-        fromBlock,
-        limit,
-    });
-}
-/**
- * Retrieves token transaction data from Etherscan.
- *
- * @param request - Configuration required to fetch token transactions.
- * @param request.address - Address to retrieve token transactions for.
- * @param request.apiKey - Etherscan API key to prevent rate limiting.
- * @param request.chainId - Current chain ID used to determine subdomain and domain.
- * @param request.fromBlock - Block number to start fetching token transactions from.
- * @param request.limit - Number of token transactions to retrieve.
- * @returns An Etherscan response object containing the request status and an array of token transaction data.
- */
-export async function fetchEtherscanTokenTransactions({ address, apiKey, chainId, fromBlock, limit, }) {
-    return await fetchTransactions('tokentx', {
-        address,
-        apiKey,
-        chainId,
-        fromBlock,
-        limit,
-    });
-}
-/**
- * Retrieves transaction data from Etherscan from a specific endpoint.
- *
- * @param action - The Etherscan endpoint to use.
- * @param options - Options bag.
- * @param options.address - Address to retrieve transactions for.
- * @param options.apiKey - Etherscan API key to prevent rate limiting.
- * @param options.chainId - Current chain ID used to determine subdomain and domain.
- * @param options.fromBlock - Block number to start fetching transactions from.
- * @param options.limit - Number of transactions to retrieve.
- * @returns An object containing the request status and an array of transaction data.
- */
-async function fetchTransactions(action, { address, apiKey, chainId, fromBlock, limit, }) {
-    const urlParams = {
-        module: 'account',
-        address,
-        startBlock: fromBlock?.toString(),
-        offset: limit?.toString(),
-        sort: 'desc',
-    };
-    const etherscanTxUrl = getEtherscanApiUrl(chainId, {
-        ...urlParams,
-        action,
-        apikey: apiKey,
-    });
-    log('Sending request', etherscanTxUrl);
-    const response = (await handleFetch(etherscanTxUrl));
-    return response;
-}
-/**
- * Return a URL that can be used to fetch data from Etherscan.
- *
- * @param chainId - Current chain ID used to determine subdomain and domain.
- * @param urlParams - The parameters used to construct the URL.
- * @returns URL to access Etherscan data.
- */
-function getEtherscanApiUrl(chainId, urlParams) {
-    const apiUrl = getEtherscanApiHost(chainId);
-    let url = `${apiUrl}/api?`;
-    for (const paramKey of Object.keys(urlParams)) {
-        const value = urlParams[paramKey];
-        if (!value) {
-            continue;
-        }
-        url += `${paramKey}=${value}&`;
-    }
-    url += 'tag=latest&page=1';
-    return url;
-}
-/**
- * Return the host url used to fetch data from Etherscan.
- *
- * @param chainId - Current chain ID used to determine subdomain and domain.
- * @returns host URL to access Etherscan data.
- */
-export function getEtherscanApiHost(chainId) {
-    // @ts-expect-error We account for `chainId` not being a property below
-    const networkInfo = ETHERSCAN_SUPPORTED_NETWORKS[chainId];
-    if (!networkInfo) {
-        throw new Error(`Etherscan does not support chain with ID: ${chainId}`);
-    }
-    // TODO: Either fix this lint violation or explain why it's necessary to ignore.
-    // eslint-disable-next-line @typescript-eslint/restrict-template-expressions
-    return `https://${networkInfo.subdomain}.${networkInfo.domain}`;
-}
-//# sourceMappingURL=etherscan.mjs.map

package/dist/utils/etherscan.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"etherscan.mjs","sourceRoot":"","sources":["../../src/utils/etherscan.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,mCAAmC;AAGzD,OAAO,EAAE,4BAA4B,EAAE,yBAAqB;AAC5D,OAAO,EAAE,kBAAkB,EAAE,aAAa,EAAE,sBAAkB;AAE9D,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;AAsE3D;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,0BAA0B,CAAC,EAC/C,OAAO,EACP,MAAM,EACN,OAAO,EACP,SAAS,EACT,KAAK,GACuB;IAG5B,OAAO,MAAM,iBAAiB,CAAC,QAAQ,EAAE;QACvC,OAAO;QACP,MAAM;QACN,OAAO;QACP,SAAS;QACT,KAAK;KACN,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,CAAC,KAAK,UAAU,+BAA+B,CAAC,EACpD,OAAO,EACP,MAAM,EACN,OAAO,EACP,SAAS,EACT,KAAK,GACuB;IAG5B,OAAO,MAAM,iBAAiB,CAAC,SAAS,EAAE;QACxC,OAAO;QACP,MAAM;QACN,OAAO;QACP,SAAS;QACT,KAAK;KACN,CAAC,CAAC;AACL,CAAC;AAED;;;;;;;;;;;GAWG;AACH,KAAK,UAAU,iBAAiB,CAG9B,MAAc,EACd,EACE,OAAO,EACP,MAAM,EACN,OAAO,EACP,SAAS,EACT,KAAK,GAON;IAED,MAAM,SAAS,GAAG;QAChB,MAAM,EAAE,SAAS;QACjB,OAAO;QACP,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE;QACjC,MAAM,EAAE,KAAK,EAAE,QAAQ,EAAE;QACzB,IAAI,EAAE,MAAM;KACb,CAAC;IAEF,MAAM,cAAc,GAAG,kBAAkB,CAAC,OAAO,EAAE;QACjD,GAAG,SAAS;QACZ,MAAM;QACN,MAAM,EAAE,MAAM;KACf,CAAC,CAAC;IAEH,GAAG,CAAC,iBAAiB,EAAE,cAAc,CAAC,CAAC;IAEvC,MAAM,QAAQ,GAAG,CAAC,MAAM,WAAW,CACjC,cAAc,CACf,CAA+C,CAAC;IAEjD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAED;;;;;;GAMG;AACH,SAAS,kBAAkB,CACzB,OAAY,EACZ,SAA6C;IAE7C,MAAM,MAAM,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAC5C,IAAI,GAAG,GAAG,GAAG,MAAM,OAAO,CAAC;IAE3B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE;QAC7C,MAAM,KAAK,GAAG,SAAS,CAAC,QAAQ,CAAC,CAAC;QAElC,IAAI,CAAC,KAAK,EAAE;YACV,SAAS;SACV;QAED,GAAG,IAAI,GAAG,QAAQ,IAAI,KAAK,GAAG,CAAC;KAChC;IAED,GAAG,IAAI,mBAAmB,CAAC;IAE3B,OAAO,GAAG,CAAC;AACb,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,mBAAmB,CAAC,OAAY;IAC9C,uEAAuE;IACvE,MAAM,WAAW,GAAG,4BAA4B,CAAC,OAAO,CAAC,CAAC;IAE1D,IAAI,CAAC,WAAW,EAAE;QAChB,MAAM,IAAI,KAAK,CAAC,6CAA6C,OAAO,EAAE,CAAC,CAAC;KACzE;IAED,gFAAgF;IAChF,4EAA4E;IAC5E,OAAO,WAAW,WAAW,CAAC,SAAS,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;AAClE,CAAC","sourcesContent":["import { handleFetch } from '@metamask/controller-utils';\nimport type { Hex } from '@metamask/utils';\n\nimport { ETHERSCAN_SUPPORTED_NETWORKS } from '../constants';\nimport { createModuleLogger, projectLogger } from '../logger';\n\nconst log = createModuleLogger(projectLogger, 'etherscan');\n\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface EtherscanTransactionMetaBase {\n  blockNumber: string;\n  blockHash: string;\n  confirmations: string;\n  contractAddress: string;\n  cumulativeGasUsed: string;\n  from: string;\n  gas: string;\n  gasPrice: string;\n  gasUsed: string;\n  hash: string;\n  nonce: string;\n  timeStamp: string;\n  to: string;\n  transactionIndex: string;\n  value: string;\n}\n\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface EtherscanTransactionMeta extends EtherscanTransactionMetaBase {\n  functionName: string;\n  input: string;\n  isError: string;\n  methodId: string;\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  txreceipt_status: string;\n}\n\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface EtherscanTokenTransactionMeta\n  extends EtherscanTransactionMetaBase {\n  tokenDecimal: string;\n  tokenName: string;\n  tokenSymbol: string;\n}\n\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface EtherscanTransactionResponse<\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/naming-convention\n  T extends EtherscanTransactionMetaBase,\n> {\n  status: '0' | '1';\n  message?: string;\n  result: string | T[];\n}\n\n// This interface was created before this ESLint rule was added.\n// Convert to a `type` in a future major version.\n// eslint-disable-next-line @typescript-eslint/consistent-type-definitions\nexport interface EtherscanTransactionRequest {\n  address: string;\n  apiKey?: string;\n  chainId: Hex;\n  fromBlock?: number;\n  limit?: number;\n}\n\n/**\n * Retrieves transaction data from Etherscan.\n *\n * @param request - Configuration required to fetch transactions.\n * @param request.address - Address to retrieve transactions for.\n * @param request.apiKey - Etherscan API key to prevent rate limiting.\n * @param request.chainId - Current chain ID used to determine subdomain and domain.\n * @param request.fromBlock - Block number to start fetching transactions from.\n * @param request.limit - Number of transactions to retrieve.\n * @returns An Etherscan response object containing the request status and an array of token transaction data.\n */\nexport async function fetchEtherscanTransactions({\n  address,\n  apiKey,\n  chainId,\n  fromBlock,\n  limit,\n}: EtherscanTransactionRequest): Promise<\n  EtherscanTransactionResponse<EtherscanTransactionMeta>\n> {\n  return await fetchTransactions('txlist', {\n    address,\n    apiKey,\n    chainId,\n    fromBlock,\n    limit,\n  });\n}\n\n/**\n * Retrieves token transaction data from Etherscan.\n *\n * @param request - Configuration required to fetch token transactions.\n * @param request.address - Address to retrieve token transactions for.\n * @param request.apiKey - Etherscan API key to prevent rate limiting.\n * @param request.chainId - Current chain ID used to determine subdomain and domain.\n * @param request.fromBlock - Block number to start fetching token transactions from.\n * @param request.limit - Number of token transactions to retrieve.\n * @returns An Etherscan response object containing the request status and an array of token transaction data.\n */\nexport async function fetchEtherscanTokenTransactions({\n  address,\n  apiKey,\n  chainId,\n  fromBlock,\n  limit,\n}: EtherscanTransactionRequest): Promise<\n  EtherscanTransactionResponse<EtherscanTokenTransactionMeta>\n> {\n  return await fetchTransactions('tokentx', {\n    address,\n    apiKey,\n    chainId,\n    fromBlock,\n    limit,\n  });\n}\n\n/**\n * Retrieves transaction data from Etherscan from a specific endpoint.\n *\n * @param action - The Etherscan endpoint to use.\n * @param options - Options bag.\n * @param options.address - Address to retrieve transactions for.\n * @param options.apiKey - Etherscan API key to prevent rate limiting.\n * @param options.chainId - Current chain ID used to determine subdomain and domain.\n * @param options.fromBlock - Block number to start fetching transactions from.\n * @param options.limit - Number of transactions to retrieve.\n * @returns An object containing the request status and an array of transaction data.\n */\nasync function fetchTransactions<\n  ResponseData extends EtherscanTransactionMetaBase,\n>(\n  action: string,\n  {\n    address,\n    apiKey,\n    chainId,\n    fromBlock,\n    limit,\n  }: {\n    address: string;\n    apiKey?: string;\n    chainId: Hex;\n    fromBlock?: number;\n    limit?: number;\n  },\n): Promise<EtherscanTransactionResponse<ResponseData>> {\n  const urlParams = {\n    module: 'account',\n    address,\n    startBlock: fromBlock?.toString(),\n    offset: limit?.toString(),\n    sort: 'desc',\n  };\n\n  const etherscanTxUrl = getEtherscanApiUrl(chainId, {\n    ...urlParams,\n    action,\n    apikey: apiKey,\n  });\n\n  log('Sending request', etherscanTxUrl);\n\n  const response = (await handleFetch(\n    etherscanTxUrl,\n  )) as EtherscanTransactionResponse<ResponseData>;\n\n  return response;\n}\n\n/**\n * Return a URL that can be used to fetch data from Etherscan.\n *\n * @param chainId - Current chain ID used to determine subdomain and domain.\n * @param urlParams - The parameters used to construct the URL.\n * @returns URL to access Etherscan data.\n */\nfunction getEtherscanApiUrl(\n  chainId: Hex,\n  urlParams: Record<string, string | undefined>,\n): string {\n  const apiUrl = getEtherscanApiHost(chainId);\n  let url = `${apiUrl}/api?`;\n\n  for (const paramKey of Object.keys(urlParams)) {\n    const value = urlParams[paramKey];\n\n    if (!value) {\n      continue;\n    }\n\n    url += `${paramKey}=${value}&`;\n  }\n\n  url += 'tag=latest&page=1';\n\n  return url;\n}\n\n/**\n * Return the host url used to fetch data from Etherscan.\n *\n * @param chainId - Current chain ID used to determine subdomain and domain.\n * @returns host URL to access Etherscan data.\n */\nexport function getEtherscanApiHost(chainId: Hex) {\n  // @ts-expect-error We account for `chainId` not being a property below\n  const networkInfo = ETHERSCAN_SUPPORTED_NETWORKS[chainId];\n\n  if (!networkInfo) {\n    throw new Error(`Etherscan does not support chain with ID: ${chainId}`);\n  }\n\n  // TODO: Either fix this lint violation or explain why it's necessary to ignore.\n  // eslint-disable-next-line @typescript-eslint/restrict-template-expressions\n  return `https://${networkInfo.subdomain}.${networkInfo.domain}`;\n}\n"]}