@metamask-previews/transaction-controller 56.1.0-preview-0c874fe4 → 56.1.0-preview-4ec8b2d

package/dist/api/simulation-api.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"simulation-api.cjs","sourceRoot":"","sources":["../../src/api/simulation-api.ts"],"names":[],"mappings":";;;AAAA,iEAAiE;AACjE,2CAA+D;AAE/D,0CAA8E;AAC9E,0CAA0C;AAE1C,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAa,EAAE,gBAAgB,CAAC,CAAC;AAEhE,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,QAAQ,GAAG,6CAA6C,CAAC;AAC/D,MAAM,iBAAiB,GAAG,UAAU,CAAC;AA2NrC,IAAI,gBAAgB,GAAG,CAAC,CAAC;AAEzB;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CACxC,OAAY,EACZ,OAA0B;IAE1B,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE5C,GAAG,CAAC,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAErC,MAAM,SAAS,GAAG,gBAAgB,CAAC;IACnC,gBAAgB,IAAI,CAAC,CAAC;IAEtB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC;YACrB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE3C,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;IAEvC,IAAI,YAAY,CAAC,KAAK,EAAE;QACtB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC;QAC7C,MAAM,IAAI,wBAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KAC1C;IAED,OAAO,YAAY,EAAE,MAAM,CAAC;AAC9B,CAAC;AA/BD,oDA+BC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,OAAY;IAC1C,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;IAC3C,MAAM,cAAc,GAAG,IAAA,sCAAmB,EAAC,OAAO,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE;QAC3B,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,yCAAgC,CAAC,OAAO,CAAC,CAAC;KACrD;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,cAAc;IAC3B,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,kBAAkB,CAAC,GAAG,iBAAiB,EAAE,CAAC;IAChE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAS,MAAM,CAAC,SAAiB;IAC/B,OAAO,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAC5C,CAAC","sourcesContent":["import { convertHexToDecimal } from '@metamask/controller-utils';\nimport { createModuleLogger, type Hex } from '@metamask/utils';\n\nimport { SimulationChainNotSupportedError, SimulationError } from '../errors';\nimport { projectLogger } from '../logger';\n\nconst log = createModuleLogger(projectLogger, 'simulation-api');\n\nconst RPC_METHOD = 'infura_simulateTransactions';\nconst BASE_URL = 'https://tx-sentinel-{0}.api.cx.metamask.io/';\nconst ENDPOINT_NETWORKS = 'networks';\n\n/** Single transaction to simulate in a simulation API request.  */\nexport type SimulationRequestTransaction = {\n  authorizationList?: {\n    /** Address of a smart contract that contains the code to be set. */\n    address: Hex;\n\n    /** Address of the account being upgraded. */\n    from: Hex;\n  }[];\n\n  /** Data to send with the transaction. */\n  data?: Hex;\n\n  /** Sender of the transaction. */\n  from: Hex;\n\n  /** Gas limit for the transaction. */\n  gas?: Hex;\n\n  /** Maximum fee per gas for the transaction. */\n  maxFeePerGas?: Hex;\n\n  /** Maximum priority fee per gas for the transaction. */\n  maxPriorityFeePerGas?: Hex;\n\n  /** Recipient of the transaction. */\n  to?: Hex;\n\n  /** Value to send with the transaction. */\n  value?: Hex;\n};\n\n/** Request to the simulation API to simulate transactions. */\nexport type SimulationRequest = {\n  /**\n   * Transactions to be sequentially simulated.\n   * State changes impact subsequent transactions in the list.\n   */\n  transactions: SimulationRequestTransaction[];\n\n  blockOverrides?: {\n    time?: Hex;\n  };\n\n  /**\n   * Overrides to the state of the blockchain, keyed by address.\n   */\n  overrides?: {\n    [address: Hex]: {\n      /** Override the code for an address. */\n      code?: Hex;\n\n      /** Overrides to the storage slots for an address. */\n      stateDiff?: {\n        [slot: Hex]: Hex;\n      };\n    };\n  };\n\n  /**\n   * Whether to include available token fees.\n   */\n  suggestFees?: {\n    /* Whether to estimate gas for the transaction being submitted via a delegation. */\n    with7702?: boolean;\n\n    /* Whether to include the gas fee of the token transfer. */\n    withFeeTransfer?: boolean;\n\n    /* Whether to include the native transfer if available. */\n    withTransfer?: boolean;\n  };\n\n  /**\n   * Whether to include call traces in the response.\n   * Defaults to false.\n   */\n  withCallTrace?: boolean;\n\n  /**\n   * Whether to include event logs in the response.\n   * Defaults to false.\n   */\n  withLogs?: boolean;\n};\n\n/** Raw event log emitted by a simulated transaction. */\nexport type SimulationResponseLog = {\n  /** Address of the account that created the event. */\n  address: Hex;\n\n  /** Raw data in the event that is not indexed. */\n  data: Hex;\n\n  /** Raw indexed data from the event. */\n  topics: Hex[];\n};\n\n/** Call trace of a single simulated transaction. */\nexport type SimulationResponseCallTrace = {\n  /** Nested calls. */\n  calls: SimulationResponseCallTrace[];\n\n  /** Raw event logs created by the call. */\n  logs: SimulationResponseLog[];\n};\n\n/**\n * Changes to the blockchain state.\n * Keyed by account address.\n */\nexport type SimulationResponseStateDiff = {\n  [address: Hex]: {\n    /** Native balance of the account. */\n    balance?: Hex;\n\n    /** Nonce of the account. */\n    nonce?: Hex;\n\n    /** Storage values per slot. */\n    storage?: {\n      [slot: Hex]: Hex;\n    };\n  };\n};\n\nexport type SimulationResponseTokenFee = {\n  /** Token data independent of current transaction. */\n  token: {\n    /** Address of the token contract. */\n    address: Hex;\n\n    /** Decimals of the token. */\n    decimals: number;\n\n    /** Symbol of the token. */\n    symbol: string;\n  };\n\n  /** Amount of tokens needed to pay for gas. */\n  balanceNeededToken: Hex;\n\n  /** Current token balance of sender. */\n  currentBalanceToken: Hex;\n\n  /** Account address that token should be transferred to. */\n  feeRecipient: Hex;\n\n  /** Conversation rate of 1 token to native WEI. */\n  rateWei: Hex;\n\n  /** Estimated gas limit required for fee transfer. */\n  transferEstimate: Hex;\n};\n\n/** Response from the simulation API for a single transaction. */\nexport type SimulationResponseTransaction = {\n  /** Hierarchy of call data including nested calls and logs. */\n  callTrace?: SimulationResponseCallTrace;\n\n  /** An error message indicating the transaction could not be simulated. */\n  error?: string;\n\n  /** Recommended gas fees for the transaction. */\n  fees?: {\n    /** Gas limit for the fee level. */\n    gas: Hex;\n\n    /** Maximum fee per gas for the fee level. */\n    maxFeePerGas: Hex;\n\n    /** Maximum priority fee per gas for the fee level. */\n    maxPriorityFeePerGas: Hex;\n\n    /** Token fee data for the fee level. */\n    tokenFees: SimulationResponseTokenFee[];\n  }[];\n\n  /** Required `gasLimit` for the transaction. */\n  gasLimit?: Hex;\n\n  /** Total gas used by the transaction. */\n  gasUsed?: Hex;\n\n  /** Return value of the transaction, such as the balance if calling balanceOf. */\n  return: Hex;\n\n  /** Changes to the blockchain state. */\n  stateDiff?: {\n    /** Initial blockchain state before the transaction. */\n    pre?: SimulationResponseStateDiff;\n\n    /** Updated blockchain state after the transaction. */\n    post?: SimulationResponseStateDiff;\n  };\n};\n\n/** Response from the simulation API. */\nexport type SimulationResponse = {\n  /** Simulation data for each transaction in the request. */\n  transactions: SimulationResponseTransaction[];\n};\n\n/** Data for a network supported by the Simulation API. */\ntype SimulationNetwork = {\n  /** Subdomain of the API for the network.  */\n  network: string;\n\n  /** Whether the network supports confirmation simulations. */\n  confirmations: boolean;\n};\n\n/** Response from the simulation API containing supported networks. */\ntype SimulationNetworkResponse = {\n  [chainIdDecimal: string]: SimulationNetwork;\n};\n\nlet requestIdCounter = 0;\n\n/**\n * Simulate transactions using the transaction simulation API.\n *\n * @param chainId - The chain ID to simulate transactions on.\n * @param request - The request to simulate transactions.\n * @returns The response from the simulation API.\n */\nexport async function simulateTransactions(\n  chainId: Hex,\n  request: SimulationRequest,\n): Promise<SimulationResponse> {\n  const url = await getSimulationUrl(chainId);\n\n  log('Sending request', url, request);\n\n  const requestId = requestIdCounter;\n  requestIdCounter += 1;\n\n  const response = await fetch(url, {\n    method: 'POST',\n    body: JSON.stringify({\n      id: String(requestId),\n      jsonrpc: '2.0',\n      method: RPC_METHOD,\n      params: [request],\n    }),\n  });\n\n  const responseJson = await response.json();\n\n  log('Received response', responseJson);\n\n  if (responseJson.error) {\n    const { code, message } = responseJson.error;\n    throw new SimulationError(message, code);\n  }\n\n  return responseJson?.result;\n}\n\n/**\n * Get the URL for the transaction simulation API.\n *\n * @param chainId - The chain ID to get the URL for.\n * @returns The URL for the transaction simulation API.\n */\nasync function getSimulationUrl(chainId: Hex): Promise<string> {\n  const networkData = await getNetworkData();\n  const chainIdDecimal = convertHexToDecimal(chainId);\n  const network = networkData[chainIdDecimal];\n\n  if (!network?.confirmations) {\n    log('Chain is not supported', chainId);\n    throw new SimulationChainNotSupportedError(chainId);\n  }\n\n  return getUrl(network.network);\n}\n\n/**\n * Retrieve the supported network data from the simulation API.\n *\n * @returns The network data response from the simulation API.\n */\nasync function getNetworkData(): Promise<SimulationNetworkResponse> {\n  const url = `${getUrl('ethereum-mainnet')}${ENDPOINT_NETWORKS}`;\n  const response = await fetch(url);\n  return response.json();\n}\n\n/**\n * Generate the URL for the specified subdomain in the simulation API.\n *\n * @param subdomain - The subdomain to generate the URL for.\n * @returns The URL for the transaction simulation API.\n */\nfunction getUrl(subdomain: string): string {\n  return BASE_URL.replace('{0}', subdomain);\n}\n"]}
+{"version":3,"file":"simulation-api.cjs","sourceRoot":"","sources":["../../src/api/simulation-api.ts"],"names":[],"mappings":";;;AAAA,iEAAiE;AACjE,2CAA+D;AAE/D,0CAA8E;AAC9E,0CAA0C;AAE1C,MAAM,GAAG,GAAG,IAAA,0BAAkB,EAAC,sBAAa,EAAE,gBAAgB,CAAC,CAAC;AAEhE,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,QAAQ,GAAG,6CAA6C,CAAC;AAC/D,MAAM,iBAAiB,GAAG,UAAU,CAAC;AAuOrC,IAAI,gBAAgB,GAAG,CAAC,CAAC;AAEzB;;;;;;GAMG;AACI,KAAK,UAAU,oBAAoB,CACxC,OAAY,EACZ,OAA0B;IAE1B,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE5C,GAAG,CAAC,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAErC,MAAM,SAAS,GAAG,gBAAgB,CAAC;IACnC,gBAAgB,IAAI,CAAC,CAAC;IAEtB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC;YACrB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE3C,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;IAEvC,IAAI,YAAY,CAAC,KAAK,EAAE;QACtB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC;QAC7C,MAAM,IAAI,wBAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KAC1C;IAED,OAAO,YAAY,EAAE,MAAM,CAAC;AAC9B,CAAC;AA/BD,oDA+BC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,OAAY;IAC1C,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;IAC3C,MAAM,cAAc,GAAG,IAAA,sCAAmB,EAAC,OAAO,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE;QAC3B,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,yCAAgC,CAAC,OAAO,CAAC,CAAC;KACrD;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,cAAc;IAC3B,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,kBAAkB,CAAC,GAAG,iBAAiB,EAAE,CAAC;IAChE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAS,MAAM,CAAC,SAAiB;IAC/B,OAAO,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAC5C,CAAC","sourcesContent":["import { convertHexToDecimal } from '@metamask/controller-utils';\nimport { createModuleLogger, type Hex } from '@metamask/utils';\n\nimport { SimulationChainNotSupportedError, SimulationError } from '../errors';\nimport { projectLogger } from '../logger';\n\nconst log = createModuleLogger(projectLogger, 'simulation-api');\n\nconst RPC_METHOD = 'infura_simulateTransactions';\nconst BASE_URL = 'https://tx-sentinel-{0}.api.cx.metamask.io/';\nconst ENDPOINT_NETWORKS = 'networks';\n\n/** Single transaction to simulate in a simulation API request.  */\nexport type SimulationRequestTransaction = {\n  authorizationList?: {\n    /** Address of a smart contract that contains the code to be set. */\n    address: Hex;\n\n    /** Address of the account being upgraded. */\n    from: Hex;\n  }[];\n\n  /** Data to send with the transaction. */\n  data?: Hex;\n\n  /** Sender of the transaction. */\n  from: Hex;\n\n  /** Gas limit for the transaction. */\n  gas?: Hex;\n\n  /** Maximum fee per gas for the transaction. */\n  maxFeePerGas?: Hex;\n\n  /** Maximum priority fee per gas for the transaction. */\n  maxPriorityFeePerGas?: Hex;\n\n  /** Recipient of the transaction. */\n  to?: Hex;\n\n  /** Value to send with the transaction. */\n  value?: Hex;\n};\n\n/** Request to the simulation API to simulate transactions. */\nexport type SimulationRequest = {\n  blockOverrides?: {\n    time?: Hex;\n  };\n\n  /**\n   * Overrides to the state of the blockchain, keyed by address.\n   */\n  overrides?: {\n    [address: Hex]: {\n      /** Override the code for an address. */\n      code?: Hex;\n\n      /** Overrides to the storage slots for an address. */\n      stateDiff?: {\n        [slot: Hex]: Hex;\n      };\n    };\n  };\n\n  /**\n   * Whether to include available token fees.\n   */\n  suggestFees?: {\n    /* Whether to estimate gas for the transaction being submitted via a delegation. */\n    with7702?: boolean;\n\n    /* Whether to include the gas fee of the token transfer. */\n    withFeeTransfer?: boolean;\n\n    /* Whether to include the native transfer if available. */\n    withTransfer?: boolean;\n  };\n\n  /**\n   * Transactions to be sequentially simulated.\n   * State changes impact subsequent transactions in the list.\n   */\n  transactions: SimulationRequestTransaction[];\n\n  /**\n   * Whether to include call traces in the response.\n   * Defaults to false.\n   */\n  withCallTrace?: boolean;\n\n  /**\n   * Whether to include the default block data in the simulation.\n   * Defaults to false.\n   */\n  withDefaultBlockOverrides?: boolean;\n\n  /**\n   * Whether to use the gas fees in the simulation.\n   * Defaults to false.\n   */\n  withGas?: boolean;\n\n  /**\n   * Whether to include event logs in the response.\n   * Defaults to false.\n   */\n  withLogs?: boolean;\n};\n\n/** Raw event log emitted by a simulated transaction. */\nexport type SimulationResponseLog = {\n  /** Address of the account that created the event. */\n  address: Hex;\n\n  /** Raw data in the event that is not indexed. */\n  data: Hex;\n\n  /** Raw indexed data from the event. */\n  topics: Hex[];\n};\n\n/** Call trace of a single simulated transaction. */\nexport type SimulationResponseCallTrace = {\n  /** Nested calls. */\n  calls: SimulationResponseCallTrace[];\n\n  /** Raw event logs created by the call. */\n  logs: SimulationResponseLog[];\n};\n\n/**\n * Changes to the blockchain state.\n * Keyed by account address.\n */\nexport type SimulationResponseStateDiff = {\n  [address: Hex]: {\n    /** Native balance of the account. */\n    balance?: Hex;\n\n    /** Nonce of the account. */\n    nonce?: Hex;\n\n    /** Storage values per slot. */\n    storage?: {\n      [slot: Hex]: Hex;\n    };\n  };\n};\n\nexport type SimulationResponseTokenFee = {\n  /** Token data independent of current transaction. */\n  token: {\n    /** Address of the token contract. */\n    address: Hex;\n\n    /** Decimals of the token. */\n    decimals: number;\n\n    /** Symbol of the token. */\n    symbol: string;\n  };\n\n  /** Amount of tokens needed to pay for gas. */\n  balanceNeededToken: Hex;\n\n  /** Current token balance of sender. */\n  currentBalanceToken: Hex;\n\n  /** Account address that token should be transferred to. */\n  feeRecipient: Hex;\n\n  /** Conversation rate of 1 token to native WEI. */\n  rateWei: Hex;\n\n  /** Estimated gas limit required for fee transfer. */\n  transferEstimate: Hex;\n};\n\n/** Response from the simulation API for a single transaction. */\nexport type SimulationResponseTransaction = {\n  /** Hierarchy of call data including nested calls and logs. */\n  callTrace?: SimulationResponseCallTrace;\n\n  /** An error message indicating the transaction could not be simulated. */\n  error?: string;\n\n  /** Recommended gas fees for the transaction. */\n  fees?: {\n    /** Gas limit for the fee level. */\n    gas: Hex;\n\n    /** Maximum fee per gas for the fee level. */\n    maxFeePerGas: Hex;\n\n    /** Maximum priority fee per gas for the fee level. */\n    maxPriorityFeePerGas: Hex;\n\n    /** Token fee data for the fee level. */\n    tokenFees: SimulationResponseTokenFee[];\n  }[];\n\n  /** Required `gasLimit` for the transaction. */\n  gasLimit?: Hex;\n\n  /** Total gas used by the transaction. */\n  gasUsed?: Hex;\n\n  /** Return value of the transaction, such as the balance if calling balanceOf. */\n  return: Hex;\n\n  /** Changes to the blockchain state. */\n  stateDiff?: {\n    /** Initial blockchain state before the transaction. */\n    pre?: SimulationResponseStateDiff;\n\n    /** Updated blockchain state after the transaction. */\n    post?: SimulationResponseStateDiff;\n  };\n};\n\n/** Response from the simulation API. */\nexport type SimulationResponse = {\n  /** Simulation data for each transaction in the request. */\n  transactions: SimulationResponseTransaction[];\n};\n\n/** Data for a network supported by the Simulation API. */\ntype SimulationNetwork = {\n  /** Subdomain of the API for the network.  */\n  network: string;\n\n  /** Whether the network supports confirmation simulations. */\n  confirmations: boolean;\n};\n\n/** Response from the simulation API containing supported networks. */\ntype SimulationNetworkResponse = {\n  [chainIdDecimal: string]: SimulationNetwork;\n};\n\nlet requestIdCounter = 0;\n\n/**\n * Simulate transactions using the transaction simulation API.\n *\n * @param chainId - The chain ID to simulate transactions on.\n * @param request - The request to simulate transactions.\n * @returns The response from the simulation API.\n */\nexport async function simulateTransactions(\n  chainId: Hex,\n  request: SimulationRequest,\n): Promise<SimulationResponse> {\n  const url = await getSimulationUrl(chainId);\n\n  log('Sending request', url, request);\n\n  const requestId = requestIdCounter;\n  requestIdCounter += 1;\n\n  const response = await fetch(url, {\n    method: 'POST',\n    body: JSON.stringify({\n      id: String(requestId),\n      jsonrpc: '2.0',\n      method: RPC_METHOD,\n      params: [request],\n    }),\n  });\n\n  const responseJson = await response.json();\n\n  log('Received response', responseJson);\n\n  if (responseJson.error) {\n    const { code, message } = responseJson.error;\n    throw new SimulationError(message, code);\n  }\n\n  return responseJson?.result;\n}\n\n/**\n * Get the URL for the transaction simulation API.\n *\n * @param chainId - The chain ID to get the URL for.\n * @returns The URL for the transaction simulation API.\n */\nasync function getSimulationUrl(chainId: Hex): Promise<string> {\n  const networkData = await getNetworkData();\n  const chainIdDecimal = convertHexToDecimal(chainId);\n  const network = networkData[chainIdDecimal];\n\n  if (!network?.confirmations) {\n    log('Chain is not supported', chainId);\n    throw new SimulationChainNotSupportedError(chainId);\n  }\n\n  return getUrl(network.network);\n}\n\n/**\n * Retrieve the supported network data from the simulation API.\n *\n * @returns The network data response from the simulation API.\n */\nasync function getNetworkData(): Promise<SimulationNetworkResponse> {\n  const url = `${getUrl('ethereum-mainnet')}${ENDPOINT_NETWORKS}`;\n  const response = await fetch(url);\n  return response.json();\n}\n\n/**\n * Generate the URL for the specified subdomain in the simulation API.\n *\n * @param subdomain - The subdomain to generate the URL for.\n * @returns The URL for the transaction simulation API.\n */\nfunction getUrl(subdomain: string): string {\n  return BASE_URL.replace('{0}', subdomain);\n}\n"]}

package/dist/api/simulation-api.d.cts

@@ -24,11 +24,6 @@ export type SimulationRequestTransaction = {
 };
 /** Request to the simulation API to simulate transactions. */
 export type SimulationRequest = {
-    /**
-     * Transactions to be sequentially simulated.
-     * State changes impact subsequent transactions in the list.
-     */
-    transactions: SimulationRequestTransaction[];
     blockOverrides?: {
         time?: Hex;
     };
@@ -53,11 +48,26 @@ export type SimulationRequest = {
         withFeeTransfer?: boolean;
         withTransfer?: boolean;
     };
+    /**
+     * Transactions to be sequentially simulated.
+     * State changes impact subsequent transactions in the list.
+     */
+    transactions: SimulationRequestTransaction[];
     /**
      * Whether to include call traces in the response.
      * Defaults to false.
      */
     withCallTrace?: boolean;
+    /**
+     * Whether to include the default block data in the simulation.
+     * Defaults to false.
+     */
+    withDefaultBlockOverrides?: boolean;
+    /**
+     * Whether to use the gas fees in the simulation.
+     * Defaults to false.
+     */
+    withGas?: boolean;
     /**
      * Whether to include event logs in the response.
      * Defaults to false.

package/dist/api/simulation-api.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"simulation-api.d.cts","sourceRoot":"","sources":["../../src/api/simulation-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,GAAG,EAAE,wBAAwB;AAW/D,mEAAmE;AACnE,MAAM,MAAM,4BAA4B,GAAG;IACzC,iBAAiB,CAAC,EAAE;QAClB,oEAAoE;QACpE,OAAO,EAAE,GAAG,CAAC;QAEb,6CAA6C;QAC7C,IAAI,EAAE,GAAG,CAAC;KACX,EAAE,CAAC;IAEJ,yCAAyC;IACzC,IAAI,CAAC,EAAE,GAAG,CAAC;IAEX,iCAAiC;IACjC,IAAI,EAAE,GAAG,CAAC;IAEV,qCAAqC;IACrC,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,+CAA+C;IAC/C,YAAY,CAAC,EAAE,GAAG,CAAC;IAEnB,wDAAwD;IACxD,oBAAoB,CAAC,EAAE,GAAG,CAAC;IAE3B,oCAAoC;IACpC,EAAE,CAAC,EAAE,GAAG,CAAC;IAET,0CAA0C;IAC1C,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,YAAY,EAAE,4BAA4B,EAAE,CAAC;IAE7C,cAAc,CAAC,EAAE;QACf,IAAI,CAAC,EAAE,GAAG,CAAC;KACZ,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,wCAAwC;YACxC,IAAI,CAAC,EAAE,GAAG,CAAC;YAEX,qDAAqD;YACrD,SAAS,CAAC,EAAE;gBACV,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;aAClB,CAAC;SACH,CAAC;KACH,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QAEZ,QAAQ,CAAC,EAAE,OAAO,CAAC;QAGnB,eAAe,CAAC,EAAE,OAAO,CAAC;QAG1B,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,qBAAqB,GAAG;IAClC,qDAAqD;IACrD,OAAO,EAAE,GAAG,CAAC;IAEb,iDAAiD;IACjD,IAAI,EAAE,GAAG,CAAC;IAEV,uCAAuC;IACvC,MAAM,EAAE,GAAG,EAAE,CAAC;CACf,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,2BAA2B,GAAG;IACxC,oBAAoB;IACpB,KAAK,EAAE,2BAA2B,EAAE,CAAC;IAErC,0CAA0C;IAC1C,IAAI,EAAE,qBAAqB,EAAE,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,CAAC,OAAO,EAAE,GAAG,GAAG;QACd,qCAAqC;QACrC,OAAO,CAAC,EAAE,GAAG,CAAC;QAEd,4BAA4B;QAC5B,KAAK,CAAC,EAAE,GAAG,CAAC;QAEZ,+BAA+B;QAC/B,OAAO,CAAC,EAAE;YACR,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;SAClB,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,qDAAqD;IACrD,KAAK,EAAE;QACL,qCAAqC;QACrC,OAAO,EAAE,GAAG,CAAC;QAEb,6BAA6B;QAC7B,QAAQ,EAAE,MAAM,CAAC;QAEjB,2BAA2B;QAC3B,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,8CAA8C;IAC9C,kBAAkB,EAAE,GAAG,CAAC;IAExB,uCAAuC;IACvC,mBAAmB,EAAE,GAAG,CAAC;IAEzB,2DAA2D;IAC3D,YAAY,EAAE,GAAG,CAAC;IAElB,kDAAkD;IAClD,OAAO,EAAE,GAAG,CAAC;IAEb,qDAAqD;IACrD,gBAAgB,EAAE,GAAG,CAAC;CACvB,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,6BAA6B,GAAG;IAC1C,8DAA8D;IAC9D,SAAS,CAAC,EAAE,2BAA2B,CAAC;IAExC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,gDAAgD;IAChD,IAAI,CAAC,EAAE;QACL,mCAAmC;QACnC,GAAG,EAAE,GAAG,CAAC;QAET,6CAA6C;QAC7C,YAAY,EAAE,GAAG,CAAC;QAElB,sDAAsD;QACtD,oBAAoB,EAAE,GAAG,CAAC;QAE1B,wCAAwC;QACxC,SAAS,EAAE,0BAA0B,EAAE,CAAC;KACzC,EAAE,CAAC;IAEJ,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,GAAG,CAAC;IAEf,yCAAyC;IACzC,OAAO,CAAC,EAAE,GAAG,CAAC;IAEd,iFAAiF;IACjF,MAAM,EAAE,GAAG,CAAC;IAEZ,uCAAuC;IACvC,SAAS,CAAC,EAAE;QACV,uDAAuD;QACvD,GAAG,CAAC,EAAE,2BAA2B,CAAC;QAElC,sDAAsD;QACtD,IAAI,CAAC,EAAE,2BAA2B,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,wCAAwC;AACxC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,2DAA2D;IAC3D,YAAY,EAAE,6BAA6B,EAAE,CAAC;CAC/C,CAAC;AAkBF;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CA4B7B"}
+{"version":3,"file":"simulation-api.d.cts","sourceRoot":"","sources":["../../src/api/simulation-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,GAAG,EAAE,wBAAwB;AAW/D,mEAAmE;AACnE,MAAM,MAAM,4BAA4B,GAAG;IACzC,iBAAiB,CAAC,EAAE;QAClB,oEAAoE;QACpE,OAAO,EAAE,GAAG,CAAC;QAEb,6CAA6C;QAC7C,IAAI,EAAE,GAAG,CAAC;KACX,EAAE,CAAC;IAEJ,yCAAyC;IACzC,IAAI,CAAC,EAAE,GAAG,CAAC;IAEX,iCAAiC;IACjC,IAAI,EAAE,GAAG,CAAC;IAEV,qCAAqC;IACrC,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,+CAA+C;IAC/C,YAAY,CAAC,EAAE,GAAG,CAAC;IAEnB,wDAAwD;IACxD,oBAAoB,CAAC,EAAE,GAAG,CAAC;IAE3B,oCAAoC;IACpC,EAAE,CAAC,EAAE,GAAG,CAAC;IAET,0CAA0C;IAC1C,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,CAAC,EAAE;QACf,IAAI,CAAC,EAAE,GAAG,CAAC;KACZ,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,wCAAwC;YACxC,IAAI,CAAC,EAAE,GAAG,CAAC;YAEX,qDAAqD;YACrD,SAAS,CAAC,EAAE;gBACV,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;aAClB,CAAC;SACH,CAAC;KACH,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QAEZ,QAAQ,CAAC,EAAE,OAAO,CAAC;QAGnB,eAAe,CAAC,EAAE,OAAO,CAAC;QAG1B,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,YAAY,EAAE,4BAA4B,EAAE,CAAC;IAE7C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,qBAAqB,GAAG;IAClC,qDAAqD;IACrD,OAAO,EAAE,GAAG,CAAC;IAEb,iDAAiD;IACjD,IAAI,EAAE,GAAG,CAAC;IAEV,uCAAuC;IACvC,MAAM,EAAE,GAAG,EAAE,CAAC;CACf,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,2BAA2B,GAAG;IACxC,oBAAoB;IACpB,KAAK,EAAE,2BAA2B,EAAE,CAAC;IAErC,0CAA0C;IAC1C,IAAI,EAAE,qBAAqB,EAAE,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,CAAC,OAAO,EAAE,GAAG,GAAG;QACd,qCAAqC;QACrC,OAAO,CAAC,EAAE,GAAG,CAAC;QAEd,4BAA4B;QAC5B,KAAK,CAAC,EAAE,GAAG,CAAC;QAEZ,+BAA+B;QAC/B,OAAO,CAAC,EAAE;YACR,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;SAClB,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,qDAAqD;IACrD,KAAK,EAAE;QACL,qCAAqC;QACrC,OAAO,EAAE,GAAG,CAAC;QAEb,6BAA6B;QAC7B,QAAQ,EAAE,MAAM,CAAC;QAEjB,2BAA2B;QAC3B,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,8CAA8C;IAC9C,kBAAkB,EAAE,GAAG,CAAC;IAExB,uCAAuC;IACvC,mBAAmB,EAAE,GAAG,CAAC;IAEzB,2DAA2D;IAC3D,YAAY,EAAE,GAAG,CAAC;IAElB,kDAAkD;IAClD,OAAO,EAAE,GAAG,CAAC;IAEb,qDAAqD;IACrD,gBAAgB,EAAE,GAAG,CAAC;CACvB,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,6BAA6B,GAAG;IAC1C,8DAA8D;IAC9D,SAAS,CAAC,EAAE,2BAA2B,CAAC;IAExC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,gDAAgD;IAChD,IAAI,CAAC,EAAE;QACL,mCAAmC;QACnC,GAAG,EAAE,GAAG,CAAC;QAET,6CAA6C;QAC7C,YAAY,EAAE,GAAG,CAAC;QAElB,sDAAsD;QACtD,oBAAoB,EAAE,GAAG,CAAC;QAE1B,wCAAwC;QACxC,SAAS,EAAE,0BAA0B,EAAE,CAAC;KACzC,EAAE,CAAC;IAEJ,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,GAAG,CAAC;IAEf,yCAAyC;IACzC,OAAO,CAAC,EAAE,GAAG,CAAC;IAEd,iFAAiF;IACjF,MAAM,EAAE,GAAG,CAAC;IAEZ,uCAAuC;IACvC,SAAS,CAAC,EAAE;QACV,uDAAuD;QACvD,GAAG,CAAC,EAAE,2BAA2B,CAAC;QAElC,sDAAsD;QACtD,IAAI,CAAC,EAAE,2BAA2B,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,wCAAwC;AACxC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,2DAA2D;IAC3D,YAAY,EAAE,6BAA6B,EAAE,CAAC;CAC/C,CAAC;AAkBF;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CA4B7B"}

package/dist/api/simulation-api.d.mts

@@ -24,11 +24,6 @@ export type SimulationRequestTransaction = {
 };
 /** Request to the simulation API to simulate transactions. */
 export type SimulationRequest = {
-    /**
-     * Transactions to be sequentially simulated.
-     * State changes impact subsequent transactions in the list.
-     */
-    transactions: SimulationRequestTransaction[];
     blockOverrides?: {
         time?: Hex;
     };
@@ -53,11 +48,26 @@ export type SimulationRequest = {
         withFeeTransfer?: boolean;
         withTransfer?: boolean;
     };
+    /**
+     * Transactions to be sequentially simulated.
+     * State changes impact subsequent transactions in the list.
+     */
+    transactions: SimulationRequestTransaction[];
     /**
      * Whether to include call traces in the response.
      * Defaults to false.
      */
     withCallTrace?: boolean;
+    /**
+     * Whether to include the default block data in the simulation.
+     * Defaults to false.
+     */
+    withDefaultBlockOverrides?: boolean;
+    /**
+     * Whether to use the gas fees in the simulation.
+     * Defaults to false.
+     */
+    withGas?: boolean;
     /**
      * Whether to include event logs in the response.
      * Defaults to false.

package/dist/api/simulation-api.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"simulation-api.d.mts","sourceRoot":"","sources":["../../src/api/simulation-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,GAAG,EAAE,wBAAwB;AAW/D,mEAAmE;AACnE,MAAM,MAAM,4BAA4B,GAAG;IACzC,iBAAiB,CAAC,EAAE;QAClB,oEAAoE;QACpE,OAAO,EAAE,GAAG,CAAC;QAEb,6CAA6C;QAC7C,IAAI,EAAE,GAAG,CAAC;KACX,EAAE,CAAC;IAEJ,yCAAyC;IACzC,IAAI,CAAC,EAAE,GAAG,CAAC;IAEX,iCAAiC;IACjC,IAAI,EAAE,GAAG,CAAC;IAEV,qCAAqC;IACrC,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,+CAA+C;IAC/C,YAAY,CAAC,EAAE,GAAG,CAAC;IAEnB,wDAAwD;IACxD,oBAAoB,CAAC,EAAE,GAAG,CAAC;IAE3B,oCAAoC;IACpC,EAAE,CAAC,EAAE,GAAG,CAAC;IAET,0CAA0C;IAC1C,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,YAAY,EAAE,4BAA4B,EAAE,CAAC;IAE7C,cAAc,CAAC,EAAE;QACf,IAAI,CAAC,EAAE,GAAG,CAAC;KACZ,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,wCAAwC;YACxC,IAAI,CAAC,EAAE,GAAG,CAAC;YAEX,qDAAqD;YACrD,SAAS,CAAC,EAAE;gBACV,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;aAClB,CAAC;SACH,CAAC;KACH,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QAEZ,QAAQ,CAAC,EAAE,OAAO,CAAC;QAGnB,eAAe,CAAC,EAAE,OAAO,CAAC;QAG1B,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,qBAAqB,GAAG;IAClC,qDAAqD;IACrD,OAAO,EAAE,GAAG,CAAC;IAEb,iDAAiD;IACjD,IAAI,EAAE,GAAG,CAAC;IAEV,uCAAuC;IACvC,MAAM,EAAE,GAAG,EAAE,CAAC;CACf,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,2BAA2B,GAAG;IACxC,oBAAoB;IACpB,KAAK,EAAE,2BAA2B,EAAE,CAAC;IAErC,0CAA0C;IAC1C,IAAI,EAAE,qBAAqB,EAAE,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,CAAC,OAAO,EAAE,GAAG,GAAG;QACd,qCAAqC;QACrC,OAAO,CAAC,EAAE,GAAG,CAAC;QAEd,4BAA4B;QAC5B,KAAK,CAAC,EAAE,GAAG,CAAC;QAEZ,+BAA+B;QAC/B,OAAO,CAAC,EAAE;YACR,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;SAClB,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,qDAAqD;IACrD,KAAK,EAAE;QACL,qCAAqC;QACrC,OAAO,EAAE,GAAG,CAAC;QAEb,6BAA6B;QAC7B,QAAQ,EAAE,MAAM,CAAC;QAEjB,2BAA2B;QAC3B,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,8CAA8C;IAC9C,kBAAkB,EAAE,GAAG,CAAC;IAExB,uCAAuC;IACvC,mBAAmB,EAAE,GAAG,CAAC;IAEzB,2DAA2D;IAC3D,YAAY,EAAE,GAAG,CAAC;IAElB,kDAAkD;IAClD,OAAO,EAAE,GAAG,CAAC;IAEb,qDAAqD;IACrD,gBAAgB,EAAE,GAAG,CAAC;CACvB,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,6BAA6B,GAAG;IAC1C,8DAA8D;IAC9D,SAAS,CAAC,EAAE,2BAA2B,CAAC;IAExC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,gDAAgD;IAChD,IAAI,CAAC,EAAE;QACL,mCAAmC;QACnC,GAAG,EAAE,GAAG,CAAC;QAET,6CAA6C;QAC7C,YAAY,EAAE,GAAG,CAAC;QAElB,sDAAsD;QACtD,oBAAoB,EAAE,GAAG,CAAC;QAE1B,wCAAwC;QACxC,SAAS,EAAE,0BAA0B,EAAE,CAAC;KACzC,EAAE,CAAC;IAEJ,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,GAAG,CAAC;IAEf,yCAAyC;IACzC,OAAO,CAAC,EAAE,GAAG,CAAC;IAEd,iFAAiF;IACjF,MAAM,EAAE,GAAG,CAAC;IAEZ,uCAAuC;IACvC,SAAS,CAAC,EAAE;QACV,uDAAuD;QACvD,GAAG,CAAC,EAAE,2BAA2B,CAAC;QAElC,sDAAsD;QACtD,IAAI,CAAC,EAAE,2BAA2B,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,wCAAwC;AACxC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,2DAA2D;IAC3D,YAAY,EAAE,6BAA6B,EAAE,CAAC;CAC/C,CAAC;AAkBF;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CA4B7B"}
+{"version":3,"file":"simulation-api.d.mts","sourceRoot":"","sources":["../../src/api/simulation-api.ts"],"names":[],"mappings":"AACA,OAAO,EAAsB,KAAK,GAAG,EAAE,wBAAwB;AAW/D,mEAAmE;AACnE,MAAM,MAAM,4BAA4B,GAAG;IACzC,iBAAiB,CAAC,EAAE;QAClB,oEAAoE;QACpE,OAAO,EAAE,GAAG,CAAC;QAEb,6CAA6C;QAC7C,IAAI,EAAE,GAAG,CAAC;KACX,EAAE,CAAC;IAEJ,yCAAyC;IACzC,IAAI,CAAC,EAAE,GAAG,CAAC;IAEX,iCAAiC;IACjC,IAAI,EAAE,GAAG,CAAC;IAEV,qCAAqC;IACrC,GAAG,CAAC,EAAE,GAAG,CAAC;IAEV,+CAA+C;IAC/C,YAAY,CAAC,EAAE,GAAG,CAAC;IAEnB,wDAAwD;IACxD,oBAAoB,CAAC,EAAE,GAAG,CAAC;IAE3B,oCAAoC;IACpC,EAAE,CAAC,EAAE,GAAG,CAAC;IAET,0CAA0C;IAC1C,KAAK,CAAC,EAAE,GAAG,CAAC;CACb,CAAC;AAEF,8DAA8D;AAC9D,MAAM,MAAM,iBAAiB,GAAG;IAC9B,cAAc,CAAC,EAAE;QACf,IAAI,CAAC,EAAE,GAAG,CAAC;KACZ,CAAC;IAEF;;OAEG;IACH,SAAS,CAAC,EAAE;QACV,CAAC,OAAO,EAAE,GAAG,GAAG;YACd,wCAAwC;YACxC,IAAI,CAAC,EAAE,GAAG,CAAC;YAEX,qDAAqD;YACrD,SAAS,CAAC,EAAE;gBACV,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;aAClB,CAAC;SACH,CAAC;KACH,CAAC;IAEF;;OAEG;IACH,WAAW,CAAC,EAAE;QAEZ,QAAQ,CAAC,EAAE,OAAO,CAAC;QAGnB,eAAe,CAAC,EAAE,OAAO,CAAC;QAG1B,YAAY,CAAC,EAAE,OAAO,CAAC;KACxB,CAAC;IAEF;;;OAGG;IACH,YAAY,EAAE,4BAA4B,EAAE,CAAC;IAE7C;;;OAGG;IACH,aAAa,CAAC,EAAE,OAAO,CAAC;IAExB;;;OAGG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAC;IAEpC;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;;OAGG;IACH,QAAQ,CAAC,EAAE,OAAO,CAAC;CACpB,CAAC;AAEF,wDAAwD;AACxD,MAAM,MAAM,qBAAqB,GAAG;IAClC,qDAAqD;IACrD,OAAO,EAAE,GAAG,CAAC;IAEb,iDAAiD;IACjD,IAAI,EAAE,GAAG,CAAC;IAEV,uCAAuC;IACvC,MAAM,EAAE,GAAG,EAAE,CAAC;CACf,CAAC;AAEF,oDAAoD;AACpD,MAAM,MAAM,2BAA2B,GAAG;IACxC,oBAAoB;IACpB,KAAK,EAAE,2BAA2B,EAAE,CAAC;IAErC,0CAA0C;IAC1C,IAAI,EAAE,qBAAqB,EAAE,CAAC;CAC/B,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,CAAC,OAAO,EAAE,GAAG,GAAG;QACd,qCAAqC;QACrC,OAAO,CAAC,EAAE,GAAG,CAAC;QAEd,4BAA4B;QAC5B,KAAK,CAAC,EAAE,GAAG,CAAC;QAEZ,+BAA+B;QAC/B,OAAO,CAAC,EAAE;YACR,CAAC,IAAI,EAAE,GAAG,GAAG,GAAG,CAAC;SAClB,CAAC;KACH,CAAC;CACH,CAAC;AAEF,MAAM,MAAM,0BAA0B,GAAG;IACvC,qDAAqD;IACrD,KAAK,EAAE;QACL,qCAAqC;QACrC,OAAO,EAAE,GAAG,CAAC;QAEb,6BAA6B;QAC7B,QAAQ,EAAE,MAAM,CAAC;QAEjB,2BAA2B;QAC3B,MAAM,EAAE,MAAM,CAAC;KAChB,CAAC;IAEF,8CAA8C;IAC9C,kBAAkB,EAAE,GAAG,CAAC;IAExB,uCAAuC;IACvC,mBAAmB,EAAE,GAAG,CAAC;IAEzB,2DAA2D;IAC3D,YAAY,EAAE,GAAG,CAAC;IAElB,kDAAkD;IAClD,OAAO,EAAE,GAAG,CAAC;IAEb,qDAAqD;IACrD,gBAAgB,EAAE,GAAG,CAAC;CACvB,CAAC;AAEF,iEAAiE;AACjE,MAAM,MAAM,6BAA6B,GAAG;IAC1C,8DAA8D;IAC9D,SAAS,CAAC,EAAE,2BAA2B,CAAC;IAExC,0EAA0E;IAC1E,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,gDAAgD;IAChD,IAAI,CAAC,EAAE;QACL,mCAAmC;QACnC,GAAG,EAAE,GAAG,CAAC;QAET,6CAA6C;QAC7C,YAAY,EAAE,GAAG,CAAC;QAElB,sDAAsD;QACtD,oBAAoB,EAAE,GAAG,CAAC;QAE1B,wCAAwC;QACxC,SAAS,EAAE,0BAA0B,EAAE,CAAC;KACzC,EAAE,CAAC;IAEJ,+CAA+C;IAC/C,QAAQ,CAAC,EAAE,GAAG,CAAC;IAEf,yCAAyC;IACzC,OAAO,CAAC,EAAE,GAAG,CAAC;IAEd,iFAAiF;IACjF,MAAM,EAAE,GAAG,CAAC;IAEZ,uCAAuC;IACvC,SAAS,CAAC,EAAE;QACV,uDAAuD;QACvD,GAAG,CAAC,EAAE,2BAA2B,CAAC;QAElC,sDAAsD;QACtD,IAAI,CAAC,EAAE,2BAA2B,CAAC;KACpC,CAAC;CACH,CAAC;AAEF,wCAAwC;AACxC,MAAM,MAAM,kBAAkB,GAAG;IAC/B,2DAA2D;IAC3D,YAAY,EAAE,6BAA6B,EAAE,CAAC;CAC/C,CAAC;AAkBF;;;;;;GAMG;AACH,wBAAsB,oBAAoB,CACxC,OAAO,EAAE,GAAG,EACZ,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,kBAAkB,CAAC,CA4B7B"}

package/dist/api/simulation-api.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"simulation-api.mjs","sourceRoot":"","sources":["../../src/api/simulation-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,mCAAmC;AACjE,OAAO,EAAE,kBAAkB,EAAY,wBAAwB;AAE/D,OAAO,EAAE,gCAAgC,EAAE,eAAe,EAAE,sBAAkB;AAC9E,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAE1C,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;AAEhE,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,QAAQ,GAAG,6CAA6C,CAAC;AAC/D,MAAM,iBAAiB,GAAG,UAAU,CAAC;AA2NrC,IAAI,gBAAgB,GAAG,CAAC,CAAC;AAEzB;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAY,EACZ,OAA0B;IAE1B,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE5C,GAAG,CAAC,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAErC,MAAM,SAAS,GAAG,gBAAgB,CAAC;IACnC,gBAAgB,IAAI,CAAC,CAAC;IAEtB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC;YACrB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE3C,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;IAEvC,IAAI,YAAY,CAAC,KAAK,EAAE;QACtB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC;QAC7C,MAAM,IAAI,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KAC1C;IAED,OAAO,YAAY,EAAE,MAAM,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,OAAY;IAC1C,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;IAC3C,MAAM,cAAc,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE;QAC3B,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,gCAAgC,CAAC,OAAO,CAAC,CAAC;KACrD;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,cAAc;IAC3B,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,kBAAkB,CAAC,GAAG,iBAAiB,EAAE,CAAC;IAChE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAS,MAAM,CAAC,SAAiB;IAC/B,OAAO,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAC5C,CAAC","sourcesContent":["import { convertHexToDecimal } from '@metamask/controller-utils';\nimport { createModuleLogger, type Hex } from '@metamask/utils';\n\nimport { SimulationChainNotSupportedError, SimulationError } from '../errors';\nimport { projectLogger } from '../logger';\n\nconst log = createModuleLogger(projectLogger, 'simulation-api');\n\nconst RPC_METHOD = 'infura_simulateTransactions';\nconst BASE_URL = 'https://tx-sentinel-{0}.api.cx.metamask.io/';\nconst ENDPOINT_NETWORKS = 'networks';\n\n/** Single transaction to simulate in a simulation API request.  */\nexport type SimulationRequestTransaction = {\n  authorizationList?: {\n    /** Address of a smart contract that contains the code to be set. */\n    address: Hex;\n\n    /** Address of the account being upgraded. */\n    from: Hex;\n  }[];\n\n  /** Data to send with the transaction. */\n  data?: Hex;\n\n  /** Sender of the transaction. */\n  from: Hex;\n\n  /** Gas limit for the transaction. */\n  gas?: Hex;\n\n  /** Maximum fee per gas for the transaction. */\n  maxFeePerGas?: Hex;\n\n  /** Maximum priority fee per gas for the transaction. */\n  maxPriorityFeePerGas?: Hex;\n\n  /** Recipient of the transaction. */\n  to?: Hex;\n\n  /** Value to send with the transaction. */\n  value?: Hex;\n};\n\n/** Request to the simulation API to simulate transactions. */\nexport type SimulationRequest = {\n  /**\n   * Transactions to be sequentially simulated.\n   * State changes impact subsequent transactions in the list.\n   */\n  transactions: SimulationRequestTransaction[];\n\n  blockOverrides?: {\n    time?: Hex;\n  };\n\n  /**\n   * Overrides to the state of the blockchain, keyed by address.\n   */\n  overrides?: {\n    [address: Hex]: {\n      /** Override the code for an address. */\n      code?: Hex;\n\n      /** Overrides to the storage slots for an address. */\n      stateDiff?: {\n        [slot: Hex]: Hex;\n      };\n    };\n  };\n\n  /**\n   * Whether to include available token fees.\n   */\n  suggestFees?: {\n    /* Whether to estimate gas for the transaction being submitted via a delegation. */\n    with7702?: boolean;\n\n    /* Whether to include the gas fee of the token transfer. */\n    withFeeTransfer?: boolean;\n\n    /* Whether to include the native transfer if available. */\n    withTransfer?: boolean;\n  };\n\n  /**\n   * Whether to include call traces in the response.\n   * Defaults to false.\n   */\n  withCallTrace?: boolean;\n\n  /**\n   * Whether to include event logs in the response.\n   * Defaults to false.\n   */\n  withLogs?: boolean;\n};\n\n/** Raw event log emitted by a simulated transaction. */\nexport type SimulationResponseLog = {\n  /** Address of the account that created the event. */\n  address: Hex;\n\n  /** Raw data in the event that is not indexed. */\n  data: Hex;\n\n  /** Raw indexed data from the event. */\n  topics: Hex[];\n};\n\n/** Call trace of a single simulated transaction. */\nexport type SimulationResponseCallTrace = {\n  /** Nested calls. */\n  calls: SimulationResponseCallTrace[];\n\n  /** Raw event logs created by the call. */\n  logs: SimulationResponseLog[];\n};\n\n/**\n * Changes to the blockchain state.\n * Keyed by account address.\n */\nexport type SimulationResponseStateDiff = {\n  [address: Hex]: {\n    /** Native balance of the account. */\n    balance?: Hex;\n\n    /** Nonce of the account. */\n    nonce?: Hex;\n\n    /** Storage values per slot. */\n    storage?: {\n      [slot: Hex]: Hex;\n    };\n  };\n};\n\nexport type SimulationResponseTokenFee = {\n  /** Token data independent of current transaction. */\n  token: {\n    /** Address of the token contract. */\n    address: Hex;\n\n    /** Decimals of the token. */\n    decimals: number;\n\n    /** Symbol of the token. */\n    symbol: string;\n  };\n\n  /** Amount of tokens needed to pay for gas. */\n  balanceNeededToken: Hex;\n\n  /** Current token balance of sender. */\n  currentBalanceToken: Hex;\n\n  /** Account address that token should be transferred to. */\n  feeRecipient: Hex;\n\n  /** Conversation rate of 1 token to native WEI. */\n  rateWei: Hex;\n\n  /** Estimated gas limit required for fee transfer. */\n  transferEstimate: Hex;\n};\n\n/** Response from the simulation API for a single transaction. */\nexport type SimulationResponseTransaction = {\n  /** Hierarchy of call data including nested calls and logs. */\n  callTrace?: SimulationResponseCallTrace;\n\n  /** An error message indicating the transaction could not be simulated. */\n  error?: string;\n\n  /** Recommended gas fees for the transaction. */\n  fees?: {\n    /** Gas limit for the fee level. */\n    gas: Hex;\n\n    /** Maximum fee per gas for the fee level. */\n    maxFeePerGas: Hex;\n\n    /** Maximum priority fee per gas for the fee level. */\n    maxPriorityFeePerGas: Hex;\n\n    /** Token fee data for the fee level. */\n    tokenFees: SimulationResponseTokenFee[];\n  }[];\n\n  /** Required `gasLimit` for the transaction. */\n  gasLimit?: Hex;\n\n  /** Total gas used by the transaction. */\n  gasUsed?: Hex;\n\n  /** Return value of the transaction, such as the balance if calling balanceOf. */\n  return: Hex;\n\n  /** Changes to the blockchain state. */\n  stateDiff?: {\n    /** Initial blockchain state before the transaction. */\n    pre?: SimulationResponseStateDiff;\n\n    /** Updated blockchain state after the transaction. */\n    post?: SimulationResponseStateDiff;\n  };\n};\n\n/** Response from the simulation API. */\nexport type SimulationResponse = {\n  /** Simulation data for each transaction in the request. */\n  transactions: SimulationResponseTransaction[];\n};\n\n/** Data for a network supported by the Simulation API. */\ntype SimulationNetwork = {\n  /** Subdomain of the API for the network.  */\n  network: string;\n\n  /** Whether the network supports confirmation simulations. */\n  confirmations: boolean;\n};\n\n/** Response from the simulation API containing supported networks. */\ntype SimulationNetworkResponse = {\n  [chainIdDecimal: string]: SimulationNetwork;\n};\n\nlet requestIdCounter = 0;\n\n/**\n * Simulate transactions using the transaction simulation API.\n *\n * @param chainId - The chain ID to simulate transactions on.\n * @param request - The request to simulate transactions.\n * @returns The response from the simulation API.\n */\nexport async function simulateTransactions(\n  chainId: Hex,\n  request: SimulationRequest,\n): Promise<SimulationResponse> {\n  const url = await getSimulationUrl(chainId);\n\n  log('Sending request', url, request);\n\n  const requestId = requestIdCounter;\n  requestIdCounter += 1;\n\n  const response = await fetch(url, {\n    method: 'POST',\n    body: JSON.stringify({\n      id: String(requestId),\n      jsonrpc: '2.0',\n      method: RPC_METHOD,\n      params: [request],\n    }),\n  });\n\n  const responseJson = await response.json();\n\n  log('Received response', responseJson);\n\n  if (responseJson.error) {\n    const { code, message } = responseJson.error;\n    throw new SimulationError(message, code);\n  }\n\n  return responseJson?.result;\n}\n\n/**\n * Get the URL for the transaction simulation API.\n *\n * @param chainId - The chain ID to get the URL for.\n * @returns The URL for the transaction simulation API.\n */\nasync function getSimulationUrl(chainId: Hex): Promise<string> {\n  const networkData = await getNetworkData();\n  const chainIdDecimal = convertHexToDecimal(chainId);\n  const network = networkData[chainIdDecimal];\n\n  if (!network?.confirmations) {\n    log('Chain is not supported', chainId);\n    throw new SimulationChainNotSupportedError(chainId);\n  }\n\n  return getUrl(network.network);\n}\n\n/**\n * Retrieve the supported network data from the simulation API.\n *\n * @returns The network data response from the simulation API.\n */\nasync function getNetworkData(): Promise<SimulationNetworkResponse> {\n  const url = `${getUrl('ethereum-mainnet')}${ENDPOINT_NETWORKS}`;\n  const response = await fetch(url);\n  return response.json();\n}\n\n/**\n * Generate the URL for the specified subdomain in the simulation API.\n *\n * @param subdomain - The subdomain to generate the URL for.\n * @returns The URL for the transaction simulation API.\n */\nfunction getUrl(subdomain: string): string {\n  return BASE_URL.replace('{0}', subdomain);\n}\n"]}
+{"version":3,"file":"simulation-api.mjs","sourceRoot":"","sources":["../../src/api/simulation-api.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,mCAAmC;AACjE,OAAO,EAAE,kBAAkB,EAAY,wBAAwB;AAE/D,OAAO,EAAE,gCAAgC,EAAE,eAAe,EAAE,sBAAkB;AAC9E,OAAO,EAAE,aAAa,EAAE,sBAAkB;AAE1C,MAAM,GAAG,GAAG,kBAAkB,CAAC,aAAa,EAAE,gBAAgB,CAAC,CAAC;AAEhE,MAAM,UAAU,GAAG,6BAA6B,CAAC;AACjD,MAAM,QAAQ,GAAG,6CAA6C,CAAC;AAC/D,MAAM,iBAAiB,GAAG,UAAU,CAAC;AAuOrC,IAAI,gBAAgB,GAAG,CAAC,CAAC;AAEzB;;;;;;GAMG;AACH,MAAM,CAAC,KAAK,UAAU,oBAAoB,CACxC,OAAY,EACZ,OAA0B;IAE1B,MAAM,GAAG,GAAG,MAAM,gBAAgB,CAAC,OAAO,CAAC,CAAC;IAE5C,GAAG,CAAC,iBAAiB,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;IAErC,MAAM,SAAS,GAAG,gBAAgB,CAAC;IACnC,gBAAgB,IAAI,CAAC,CAAC;IAEtB,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,EAAE;QAChC,MAAM,EAAE,MAAM;QACd,IAAI,EAAE,IAAI,CAAC,SAAS,CAAC;YACnB,EAAE,EAAE,MAAM,CAAC,SAAS,CAAC;YACrB,OAAO,EAAE,KAAK;YACd,MAAM,EAAE,UAAU;YAClB,MAAM,EAAE,CAAC,OAAO,CAAC;SAClB,CAAC;KACH,CAAC,CAAC;IAEH,MAAM,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IAE3C,GAAG,CAAC,mBAAmB,EAAE,YAAY,CAAC,CAAC;IAEvC,IAAI,YAAY,CAAC,KAAK,EAAE;QACtB,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,YAAY,CAAC,KAAK,CAAC;QAC7C,MAAM,IAAI,eAAe,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;KAC1C;IAED,OAAO,YAAY,EAAE,MAAM,CAAC;AAC9B,CAAC;AAED;;;;;GAKG;AACH,KAAK,UAAU,gBAAgB,CAAC,OAAY;IAC1C,MAAM,WAAW,GAAG,MAAM,cAAc,EAAE,CAAC;IAC3C,MAAM,cAAc,GAAG,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACpD,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,CAAC,CAAC;IAE5C,IAAI,CAAC,OAAO,EAAE,aAAa,EAAE;QAC3B,GAAG,CAAC,wBAAwB,EAAE,OAAO,CAAC,CAAC;QACvC,MAAM,IAAI,gCAAgC,CAAC,OAAO,CAAC,CAAC;KACrD;IAED,OAAO,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC;AACjC,CAAC;AAED;;;;GAIG;AACH,KAAK,UAAU,cAAc;IAC3B,MAAM,GAAG,GAAG,GAAG,MAAM,CAAC,kBAAkB,CAAC,GAAG,iBAAiB,EAAE,CAAC;IAChE,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,CAAC;IAClC,OAAO,QAAQ,CAAC,IAAI,EAAE,CAAC;AACzB,CAAC;AAED;;;;;GAKG;AACH,SAAS,MAAM,CAAC,SAAiB;IAC/B,OAAO,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;AAC5C,CAAC","sourcesContent":["import { convertHexToDecimal } from '@metamask/controller-utils';\nimport { createModuleLogger, type Hex } from '@metamask/utils';\n\nimport { SimulationChainNotSupportedError, SimulationError } from '../errors';\nimport { projectLogger } from '../logger';\n\nconst log = createModuleLogger(projectLogger, 'simulation-api');\n\nconst RPC_METHOD = 'infura_simulateTransactions';\nconst BASE_URL = 'https://tx-sentinel-{0}.api.cx.metamask.io/';\nconst ENDPOINT_NETWORKS = 'networks';\n\n/** Single transaction to simulate in a simulation API request.  */\nexport type SimulationRequestTransaction = {\n  authorizationList?: {\n    /** Address of a smart contract that contains the code to be set. */\n    address: Hex;\n\n    /** Address of the account being upgraded. */\n    from: Hex;\n  }[];\n\n  /** Data to send with the transaction. */\n  data?: Hex;\n\n  /** Sender of the transaction. */\n  from: Hex;\n\n  /** Gas limit for the transaction. */\n  gas?: Hex;\n\n  /** Maximum fee per gas for the transaction. */\n  maxFeePerGas?: Hex;\n\n  /** Maximum priority fee per gas for the transaction. */\n  maxPriorityFeePerGas?: Hex;\n\n  /** Recipient of the transaction. */\n  to?: Hex;\n\n  /** Value to send with the transaction. */\n  value?: Hex;\n};\n\n/** Request to the simulation API to simulate transactions. */\nexport type SimulationRequest = {\n  blockOverrides?: {\n    time?: Hex;\n  };\n\n  /**\n   * Overrides to the state of the blockchain, keyed by address.\n   */\n  overrides?: {\n    [address: Hex]: {\n      /** Override the code for an address. */\n      code?: Hex;\n\n      /** Overrides to the storage slots for an address. */\n      stateDiff?: {\n        [slot: Hex]: Hex;\n      };\n    };\n  };\n\n  /**\n   * Whether to include available token fees.\n   */\n  suggestFees?: {\n    /* Whether to estimate gas for the transaction being submitted via a delegation. */\n    with7702?: boolean;\n\n    /* Whether to include the gas fee of the token transfer. */\n    withFeeTransfer?: boolean;\n\n    /* Whether to include the native transfer if available. */\n    withTransfer?: boolean;\n  };\n\n  /**\n   * Transactions to be sequentially simulated.\n   * State changes impact subsequent transactions in the list.\n   */\n  transactions: SimulationRequestTransaction[];\n\n  /**\n   * Whether to include call traces in the response.\n   * Defaults to false.\n   */\n  withCallTrace?: boolean;\n\n  /**\n   * Whether to include the default block data in the simulation.\n   * Defaults to false.\n   */\n  withDefaultBlockOverrides?: boolean;\n\n  /**\n   * Whether to use the gas fees in the simulation.\n   * Defaults to false.\n   */\n  withGas?: boolean;\n\n  /**\n   * Whether to include event logs in the response.\n   * Defaults to false.\n   */\n  withLogs?: boolean;\n};\n\n/** Raw event log emitted by a simulated transaction. */\nexport type SimulationResponseLog = {\n  /** Address of the account that created the event. */\n  address: Hex;\n\n  /** Raw data in the event that is not indexed. */\n  data: Hex;\n\n  /** Raw indexed data from the event. */\n  topics: Hex[];\n};\n\n/** Call trace of a single simulated transaction. */\nexport type SimulationResponseCallTrace = {\n  /** Nested calls. */\n  calls: SimulationResponseCallTrace[];\n\n  /** Raw event logs created by the call. */\n  logs: SimulationResponseLog[];\n};\n\n/**\n * Changes to the blockchain state.\n * Keyed by account address.\n */\nexport type SimulationResponseStateDiff = {\n  [address: Hex]: {\n    /** Native balance of the account. */\n    balance?: Hex;\n\n    /** Nonce of the account. */\n    nonce?: Hex;\n\n    /** Storage values per slot. */\n    storage?: {\n      [slot: Hex]: Hex;\n    };\n  };\n};\n\nexport type SimulationResponseTokenFee = {\n  /** Token data independent of current transaction. */\n  token: {\n    /** Address of the token contract. */\n    address: Hex;\n\n    /** Decimals of the token. */\n    decimals: number;\n\n    /** Symbol of the token. */\n    symbol: string;\n  };\n\n  /** Amount of tokens needed to pay for gas. */\n  balanceNeededToken: Hex;\n\n  /** Current token balance of sender. */\n  currentBalanceToken: Hex;\n\n  /** Account address that token should be transferred to. */\n  feeRecipient: Hex;\n\n  /** Conversation rate of 1 token to native WEI. */\n  rateWei: Hex;\n\n  /** Estimated gas limit required for fee transfer. */\n  transferEstimate: Hex;\n};\n\n/** Response from the simulation API for a single transaction. */\nexport type SimulationResponseTransaction = {\n  /** Hierarchy of call data including nested calls and logs. */\n  callTrace?: SimulationResponseCallTrace;\n\n  /** An error message indicating the transaction could not be simulated. */\n  error?: string;\n\n  /** Recommended gas fees for the transaction. */\n  fees?: {\n    /** Gas limit for the fee level. */\n    gas: Hex;\n\n    /** Maximum fee per gas for the fee level. */\n    maxFeePerGas: Hex;\n\n    /** Maximum priority fee per gas for the fee level. */\n    maxPriorityFeePerGas: Hex;\n\n    /** Token fee data for the fee level. */\n    tokenFees: SimulationResponseTokenFee[];\n  }[];\n\n  /** Required `gasLimit` for the transaction. */\n  gasLimit?: Hex;\n\n  /** Total gas used by the transaction. */\n  gasUsed?: Hex;\n\n  /** Return value of the transaction, such as the balance if calling balanceOf. */\n  return: Hex;\n\n  /** Changes to the blockchain state. */\n  stateDiff?: {\n    /** Initial blockchain state before the transaction. */\n    pre?: SimulationResponseStateDiff;\n\n    /** Updated blockchain state after the transaction. */\n    post?: SimulationResponseStateDiff;\n  };\n};\n\n/** Response from the simulation API. */\nexport type SimulationResponse = {\n  /** Simulation data for each transaction in the request. */\n  transactions: SimulationResponseTransaction[];\n};\n\n/** Data for a network supported by the Simulation API. */\ntype SimulationNetwork = {\n  /** Subdomain of the API for the network.  */\n  network: string;\n\n  /** Whether the network supports confirmation simulations. */\n  confirmations: boolean;\n};\n\n/** Response from the simulation API containing supported networks. */\ntype SimulationNetworkResponse = {\n  [chainIdDecimal: string]: SimulationNetwork;\n};\n\nlet requestIdCounter = 0;\n\n/**\n * Simulate transactions using the transaction simulation API.\n *\n * @param chainId - The chain ID to simulate transactions on.\n * @param request - The request to simulate transactions.\n * @returns The response from the simulation API.\n */\nexport async function simulateTransactions(\n  chainId: Hex,\n  request: SimulationRequest,\n): Promise<SimulationResponse> {\n  const url = await getSimulationUrl(chainId);\n\n  log('Sending request', url, request);\n\n  const requestId = requestIdCounter;\n  requestIdCounter += 1;\n\n  const response = await fetch(url, {\n    method: 'POST',\n    body: JSON.stringify({\n      id: String(requestId),\n      jsonrpc: '2.0',\n      method: RPC_METHOD,\n      params: [request],\n    }),\n  });\n\n  const responseJson = await response.json();\n\n  log('Received response', responseJson);\n\n  if (responseJson.error) {\n    const { code, message } = responseJson.error;\n    throw new SimulationError(message, code);\n  }\n\n  return responseJson?.result;\n}\n\n/**\n * Get the URL for the transaction simulation API.\n *\n * @param chainId - The chain ID to get the URL for.\n * @returns The URL for the transaction simulation API.\n */\nasync function getSimulationUrl(chainId: Hex): Promise<string> {\n  const networkData = await getNetworkData();\n  const chainIdDecimal = convertHexToDecimal(chainId);\n  const network = networkData[chainIdDecimal];\n\n  if (!network?.confirmations) {\n    log('Chain is not supported', chainId);\n    throw new SimulationChainNotSupportedError(chainId);\n  }\n\n  return getUrl(network.network);\n}\n\n/**\n * Retrieve the supported network data from the simulation API.\n *\n * @returns The network data response from the simulation API.\n */\nasync function getNetworkData(): Promise<SimulationNetworkResponse> {\n  const url = `${getUrl('ethereum-mainnet')}${ENDPOINT_NETWORKS}`;\n  const response = await fetch(url);\n  return response.json();\n}\n\n/**\n * Generate the URL for the specified subdomain in the simulation API.\n *\n * @param subdomain - The subdomain to generate the URL for.\n * @returns The URL for the transaction simulation API.\n */\nfunction getUrl(subdomain: string): string {\n  return BASE_URL.replace('{0}', subdomain);\n}\n"]}

package/dist/utils/{simulation.cjs → balance-changes.cjs}

@@ -1,10 +1,14 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getEvents = exports.getSimulationData = exports.SupportedToken = void 0;
+exports.getBalanceChanges = exports.SupportedToken = void 0;
 const abi_1 = require("@ethersproject/abi");
 const controller_utils_1 = require("@metamask/controller-utils");
 const metamask_eth_abis_1 = require("@metamask/metamask-eth-abis");
 const utils_1 = require("@metamask/utils");
+const bn_js_1 = __importDefault(require("bn.js"));
 const simulation_api_1 = require("../api/simulation-api.cjs");
 const constants_1 = require("../constants.cjs");
 const errors_1 = require("../errors.cjs");
@@ -18,7 +22,7 @@ var SupportedToken;
     SupportedToken["ERC20_WRAPPED"] = "erc20Wrapped";
     SupportedToken["ERC721_LEGACY"] = "erc721Legacy";
 })(SupportedToken || (exports.SupportedToken = SupportedToken = {}));
-const log = (0, utils_1.createModuleLogger)(logger_1.projectLogger, 'simulation');
+const log = (0, utils_1.createModuleLogger)(logger_1.projectLogger, 'balance-changes');
 const SUPPORTED_EVENTS = [
     'Transfer',
     'TransferSingle',
@@ -58,95 +62,64 @@ const REVERTED_ERRORS = ['execution reverted', 'insufficient funds for gas'];
  * @param request.to - The recipient of the transaction.
  * @param request.value - The value of the transaction.
  * @param request.data - The data of the transaction.
- * @param options - Additional options.
- * @param options.blockTime - An optional block time to simulate the transaction at.
  * @returns The simulation data.
  */
-async function getSimulationData(request, options = {}) {
-    const { authorizationList, chainId, from, to, value, data } = request;
-    const { use7702Fees } = options;
-    log('Getting simulation data', { request, options });
+async function getBalanceChanges(request) {
+    log('Request', request);
     try {
         const response = await baseRequest({
-            chainId,
-            from,
-            options,
+            request,
             params: {
-                suggestFees: {
-                    withFeeTransfer: true,
-                    withTransfer: true,
-                    ...(use7702Fees ? { with7702: true } : {}),
-                },
                 withCallTrace: true,
                 withLogs: true,
             },
-            transactions: [
-                {
-                    authorizationList,
-                    data,
-                    from,
-                    to,
-                    value,
-                },
-            ],
         });
         const transactionError = response.transactions?.[0]?.error;
         if (transactionError) {
             throw new errors_1.SimulationError(transactionError);
         }
-        const nativeBalanceChange = getNativeBalanceChange(request.from, response);
+        const nativeBalanceChange = getNativeBalanceChange(request, response);
         const events = getEvents(response);
         log('Parsed events', events);
-        const tokenBalanceChanges = await getTokenBalanceChanges(request, events, options);
+        const tokenBalanceChanges = await getTokenBalanceChanges(request, events);
         const simulationData = {
             nativeBalanceChange,
             tokenBalanceChanges,
         };
-        let gasFeeTokens = [];
-        try {
-            gasFeeTokens = getGasFeeTokens(response);
-        }
-        catch (error) {
-            log('Failed to parse gas fee tokens', error, response);
-        }
-        return {
-            gasFeeTokens,
-            simulationData,
-        };
+        return simulationData;
     }
     catch (error) {
-        log('Failed to get simulation data', error, request);
+        log('Failed to get balance changes', error, request);
         let simulationError = error;
         if (REVERTED_ERRORS.some((revertErrorMessage) => simulationError.message?.includes(revertErrorMessage))) {
             simulationError = new errors_1.SimulationRevertedError();
         }
         const { code, message } = simulationError;
         return {
-            gasFeeTokens: [],
-            simulationData: {
-                tokenBalanceChanges: [],
-                error: {
-                    code,
-                    message,
-                },
+            tokenBalanceChanges: [],
+            error: {
+                code,
+                message,
             },
         };
     }
 }
-exports.getSimulationData = getSimulationData;
+exports.getBalanceChanges = getBalanceChanges;
 /**
  * Extract the native balance change from a simulation response.
  *
- * @param userAddress - The user's account address.
- * @param response - The simulation response.
- * @returns The native balance change or undefined if unchanged.
+ * @param request - Simulation request.
+ * @param response - Simulation response.
+ * @returns Native balance change or undefined if unchanged.
  */
-function getNativeBalanceChange(userAddress, response) {
+function getNativeBalanceChange(request, response) {
     const transactionResponse = response.transactions[0];
     /* istanbul ignore next */
     if (!transactionResponse) {
         return undefined;
     }
+    const { txParams } = request;
+    const userAddress = txParams.from;
     const { stateDiff } = transactionResponse;
     const previousBalance = stateDiff?.pre?.[userAddress]?.balance;
     const newBalance = stateDiff?.post?.[userAddress]?.balance;
@@ -196,7 +169,6 @@ function getEvents(response) {
     })
         .filter((e) => e !== undefined);
 }
-exports.getEvents = getEvents;
 /**
  * Normalize event arguments using ABI input definitions.
  *
@@ -233,30 +205,24 @@ function normalizeEventArgValue(value) {
  *
  * @param request - The transaction that was simulated.
  * @param events - The parsed events.
- * @param options - Additional options.
- * @param options.blockTime - An optional block time to simulate the transaction at.
  * @returns An array of token balance changes.
  */
-async function getTokenBalanceChanges(request, events, options) {
-    const { chainId, from } = request;
+async function getTokenBalanceChanges(request, events) {
+    const { txParams } = request;
+    const from = txParams.from;
     const balanceTxs = getTokenBalanceTransactions(request, events);
     log('Generated balance transactions', [...balanceTxs.after.values()]);
-    const transactions = [
-        ...balanceTxs.before.values(),
-        request,
-        ...balanceTxs.after.values(),
-    ];
-    if (transactions.length === 1) {
+    const transactionCount = balanceTxs.before.size + balanceTxs.after.size + 1;
+    if (transactionCount === 1) {
         return [];
     }
     const response = await baseRequest({
-        chainId,
-        from,
-        options,
-        transactions,
+        request,
+        before: [...balanceTxs.before.values()],
+        after: [...balanceTxs.after.values()],
     });
     log('Balance simulation response', response);
-    if (response.transactions.length !== transactions.length) {
+    if (response.transactions.length !== transactionCount) {
         throw new errors_1.SimulationInvalidResponseError();
     }
     let prevBalanceTxIndex = 0;
@@ -265,10 +231,10 @@ async function getTokenBalanceChanges(request, events, options) {
         const previousBalanceCheckSkipped = !balanceTxs.before.get(token);
         const previousBalance = previousBalanceCheckSkipped
             ? '0x0'
-            : getAmountFromBalanceTransactionResult(request.from, token, 
+            : getAmountFromBalanceTransactionResult(from, token, 
             // eslint-disable-next-line no-plusplus
             response.transactions[prevBalanceTxIndex++]);
-        const newBalance = getAmountFromBalanceTransactionResult(request.from, token, response.transactions[index + balanceTxs.before.size + 1]);
+        const newBalance = getAmountFromBalanceTransactionResult(from, token, response.transactions[index + balanceTxs.before.size + 1]);
         const balanceChange = getSimulationBalanceChange(previousBalance, newBalance);
         if (!balanceChange) {
             return undefined;
@@ -291,7 +257,8 @@ function getTokenBalanceTransactions(request, events) {
     const tokenKeys = new Set();
     const before = new Map();
     const after = new Map();
-    const userEvents = events.filter((event) => [event.args.from, event.args.to].includes(request.from));
+    const from = request.txParams.from;
+    const userEvents = events.filter((event) => [event.args.from, event.args.to].includes(from));
     log('Filtered user events', userEvents);
     for (const event of userEvents) {
         const tokenIds = getEventTokenIds(event);
@@ -308,9 +275,9 @@ function getTokenBalanceTransactions(request, events) {
                 continue;
             }
             tokenKeys.add(tokenKey);
-            const data = getBalanceTransactionData(event.tokenStandard, request.from, tokenId);
+            const data = getBalanceTransactionData(event.tokenStandard, from, tokenId);
             const transaction = {
-                from: request.from,
+                from,
                 to: event.contractAddress,
                 data,
             };
@@ -496,61 +463,82 @@ function getContractInterfaces() {
         return [tokenType, contractInterface];
     }));
 }
-/**
- * Extract gas fee tokens from a simulation response.
- *
- * @param response - The simulation response.
- * @returns An array of gas fee tokens.
- */
-function getGasFeeTokens(response) {
-    const feeLevel = response.transactions?.[0]
-        ?.fees?.[0];
-    const tokenFees = feeLevel?.tokenFees ?? [];
-    return tokenFees.map((tokenFee) => ({
-        amount: tokenFee.balanceNeededToken,
-        balance: tokenFee.currentBalanceToken,
-        decimals: tokenFee.token.decimals,
-        gas: feeLevel.gas,
-        gasTransfer: tokenFee.transferEstimate,
-        maxFeePerGas: feeLevel.maxFeePerGas,
-        maxPriorityFeePerGas: feeLevel.maxPriorityFeePerGas,
-        rateWei: tokenFee.rateWei,
-        recipient: tokenFee.feeRecipient,
-        symbol: tokenFee.token.symbol,
-        tokenAddress: tokenFee.token.address,
-    }));
-}
 /**
  * Base request to simulation API.
  *
- * @param request - The request object.
- * @param request.chainId - Chain ID of the transaction.
- * @param request.from - Address of the sender.
- * @param request.options - Options for the simulation.
- * @param request.params - Additional parameters for the request.
- * @param request.transactions - Transactions to simulate.
+ * @param options - Options bag.
+ * @param options.after - Transactions to simulate after user's transaction.
+ * @param options.before - Transactions to simulate before user's transaction.
+ * @param options.params - Additional parameters for the request.
+ * @param options.request - Original request object.
  * @returns The simulation response.
  */
-async function baseRequest({ chainId, from, options, params, transactions, }) {
-    const { blockTime, senderCode } = options;
+async function baseRequest({ request, params, before = [], after = [], }) {
+    const { blockTime, chainId, ethQuery, txParams } = request;
+    const { authorizationList } = txParams;
+    const from = txParams.from;
+    const authorizationListFinal = authorizationList?.map((authorization) => ({
+        address: authorization.address,
+        from,
+    }));
+    const userTransaction = {
+        authorizationList: authorizationListFinal,
+        data: txParams.data,
+        from: txParams.from,
+        gas: txParams.gas,
+        maxFeePerGas: (txParams.maxFeePerGas ?? txParams.gasPrice),
+        maxPriorityFeePerGas: (txParams.maxPriorityFeePerGas ??
+            txParams.gasPrice),
+        to: txParams.to,
+        value: txParams.value,
+    };
+    const transactions = [...before, userTransaction, ...after];
+    const requiredBalanceBN = getRequiredBalance(request);
+    const requiredBalanceHex = (0, controller_utils_1.toHex)(requiredBalanceBN);
+    log('Required balance', requiredBalanceHex);
+    const currentBalanceHex = (await (0, controller_utils_1.query)(ethQuery, 'getBalance', [
+        from,
+        'latest',
+    ]));
+    const currentBalanceBN = (0, controller_utils_1.hexToBN)(currentBalanceHex);
+    log('Current balance', currentBalanceHex);
+    const isInsufficientBalance = currentBalanceBN.lt(requiredBalanceBN);
     return await (0, simulation_api_1.simulateTransactions)(chainId, {
-        transactions,
         ...params,
+        transactions,
+        withGas: true,
+        withDefaultBlockOverrides: true,
         ...(blockTime && {
             blockOverrides: {
                 ...params?.blockOverrides,
                 time: (0, controller_utils_1.toHex)(blockTime),
             },
         }),
-        ...(senderCode && {
+        ...(isInsufficientBalance && {
             overrides: {
                 ...params?.overrides,
                 [from]: {
                     ...params?.overrides?.[from],
-                    code: senderCode,
+                    balance: requiredBalanceHex,
                 },
             },
         }),
     });
 }
-//# sourceMappingURL=simulation.cjs.map
+/**
+ * Calculate the required minimum balance for a transaction.
+ *
+ * @param request - The transaction request.
+ * @returns The minimal balance as a BN.
+ */
+function getRequiredBalance(request) {
+    const { txParams } = request;
+    const gasLimit = (0, controller_utils_1.hexToBN)(txParams.gas ?? '0x0');
+    const gasPrice = (0, controller_utils_1.hexToBN)(txParams.maxFeePerGas ?? txParams.gasPrice ?? '0x0');
+    const value = (0, controller_utils_1.hexToBN)(txParams.value ?? '0x0');
+    const nestedValue = (request.nestedTransactions ?? [])
+        .map((tx) => (0, controller_utils_1.hexToBN)(tx.value ?? '0x0'))
+        .reduce((acc, val) => acc.add(val), new bn_js_1.default(0));
+    return gasLimit.mul(gasPrice).add(value).add(nestedValue);
+}
+//# sourceMappingURL=balance-changes.cjs.map