@metamask-previews/user-operation-controller 41.2.9-preview-4f4c98e → 41.2.9-preview-eb263b0ee

package/dist/types.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AA0DA;;GAEG;AACH,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,gDAAyB,CAAA;IACzB,4CAAqB,CAAA;IACrB,wCAAiB,CAAA;IACjB,8CAAuB,CAAA;IACvB,wCAAiB,CAAA;IACjB,8CAAuB,CAAA;AACzB,CAAC,EAPW,mBAAmB,mCAAnB,mBAAmB,QAO9B","sourcesContent":["import type {\n  TransactionParams,\n  TransactionType,\n  UserFeeLevel,\n} from '@metamask/transaction-controller';\nimport type { Hex } from '@metamask/utils';\n\n/**\n * A complete user operation to be submitted to a bundler.\n * Defined in EIP-4337.\n */\nexport type UserOperation = {\n  /** The data to pass to the sender during the main execution call. */\n  callData: string;\n\n  /** The amount of gas to allocate the main execution call. */\n  callGasLimit: string;\n\n  /**\n   * The initCode of the account.\n   * Needed if and only if the account is not yet on-chain and needs to be created.\n   */\n  initCode: string;\n\n  /**\n   * Maximum fee per gas.\n   * Similar to EIP-1559 max_fee_per_gas.\n   */\n  maxFeePerGas: string;\n\n  /**\n   * Maximum priority fee per gas.\n   * Similar to EIP-1559 max_priority_fee_per_gas.\n   */\n  maxPriorityFeePerGas: string;\n\n  /** Anti-replay parameter. */\n  nonce: string;\n\n  /**\n   * Address of paymaster sponsoring the transaction, followed by extra data to send to the paymaster.\n   * Empty for self-sponsored transactions.\n   */\n  paymasterAndData: string;\n\n  /** The amount of gas to pay to compensate the bundler for pre-verification execution, calldata and any gas overhead that cannot be tracked on-chain. */\n  preVerificationGas: string;\n\n  /** The account making the operation. */\n  sender: string;\n\n  /** Data passed into the account along with the nonce during the verification step. */\n  signature: string;\n\n  /** The amount of gas to allocate for the verification step. */\n  verificationGasLimit: string;\n};\n\n/**\n * The possible statuses of a single user operation.\n */\nexport enum UserOperationStatus {\n  Unapproved = 'unapproved',\n  Approved = 'approved',\n  Signed = 'signed',\n  Submitted = 'submitted',\n  Failed = 'failed',\n  Confirmed = 'confirmed',\n}\n\n/** Information concerning an error while creating a user operation. */\nexport type UserOperationError = {\n  /**\n   * A descriptive error name.\n   */\n  name: string;\n\n  /**\n   * A descriptive error message providing details about the encountered error.\n   */\n  message: string;\n\n  /**\n   * The stack trace associated with the error, if available.\n   */\n  stack: string | null;\n\n  /**\n   * An optional error code associated with the error.\n   */\n  code: string | null;\n\n  /**\n   * Additional information related to the error.\n   */\n  rpc: string | null;\n};\n\n/**\n * Metadata concerning a single user operation, stored in the client state.\n */\nexport type UserOperationMetadata = {\n  /** Confirmed total cost of the gas for the user operation. */\n  actualGasCost: string | null;\n\n  /** Confirmed total amount of gas used by the user operation. */\n  actualGasUsed: string | null;\n\n  /** Base fee of the transaction block as a hex value. */\n  baseFeePerGas: string | null;\n\n  /** URL of the bundler that the operation was submitted to. */\n  bundlerUrl: string | null;\n\n  /** Hexadecimal chain ID of the target network. */\n  chainId: string;\n\n  /** An error that occurred while creating the operation. */\n  error: UserOperationError | null;\n\n  /** Hash of the user operation, generated by the bundler. */\n  hash: string | null;\n\n  /** A unique ID used to identify a user operation in the client. */\n  id: string;\n\n  /** The origin of the user operation, such as the hostname of a dApp. */\n  origin: string;\n\n  /** Current status of the user operation. */\n  status: UserOperationStatus;\n\n  /** Metadata specific to swap transactions. */\n  swapsMetadata: SwapsMetadata | null;\n\n  /** Timestamp of when the user operation was created. */\n  time: number;\n\n  /** Hash of the transaction that submitted the user operation to the entrypoint. */\n  transactionHash: string | null;\n\n  /** The initial transaction parameters that the user operation was created from. */\n  transactionParams: Required<TransactionParams> | null;\n\n  /** The type of transaction that the user operation will create. */\n  transactionType: TransactionType | null;\n\n  /** The origin of the gas fee values. */\n  userFeeLevel: UserFeeLevel | null;\n\n  /** Resulting user operation object to be submitted to the bundler. */\n  userOperation: UserOperation;\n};\n\n/**\n * The data provided to the smart contract account when preparing a user operation.\n */\nexport type PrepareUserOperationRequest = {\n  /** The hexadecimal chain ID of the target network. */\n  chainId: string;\n\n  /** The data to include in the resulting transaction.  */\n  data?: string;\n\n  /** Address of the account requesting the user operation. */\n  from: string;\n\n  /** The destination address of the resulting transaction. */\n  to?: string;\n\n  /** The value to send in the resulting transaction. */\n  value?: string;\n};\n\n/**\n * The data provided to the smart contract account when updating a user operation.\n */\nexport type UpdateUserOperationRequest = {\n  /** The user operation to update including the dummy signature and dummy paymasterAndData values. */\n  userOperation: UserOperation;\n\n  /** The hexadecimal chain ID of the target network. */\n  chainId: string;\n};\n\n/**\n * The data provided to the smart contract account when signing a user operation.\n */\nexport type SignUserOperationRequest = {\n  /** The user operation to sign including the dummy signature and final paymasterAndData values. */\n  userOperation: UserOperation;\n\n  /** The hexadecimal chain ID of the target network. */\n  chainId: string;\n};\n\n/**\n * The data returned by the smart contract account when preparing a user operation.\n */\nexport type PrepareUserOperationResponse = {\n  /** The URL of the bundler to submit the user operation to. */\n  bundler: string;\n\n  /** The data to pass to the sender during the main execution call. */\n  callData: string;\n\n  /**\n   * A dummy paymasterAndData value required to estimate gas using the bundler.\n   * Only required if the smart contract account is not providing gas values.\n   */\n  dummyPaymasterAndData?: string;\n\n  /**\n   * A dummy signature value required to estimate gas using the bundler.\n   * Only required if the smart contract account is not providing gas values.\n   */\n  dummySignature?: string;\n\n  /**\n   * The estimated gas limits for the user operation.\n   * Gas is automatically estimated using the bundler if not provided.\n   */\n  gas?: {\n    /** The amount of gas to allocate to the main execution call. */\n    callGasLimit: string;\n\n    /** The amount of gas to pay to compensate the bundler for pre-verification execution, calldata and any gas overhead that cannot be tracked on-chain. */\n    preVerificationGas: string;\n\n    /** The amount of gas to allocate for the verification step. */\n    verificationGasLimit: string;\n  };\n\n  /**\n   * The initCode to include in the user operation.\n   * Required only if the smart contract is not yet deployed.\n   */\n  initCode?: string;\n\n  /**\n   * The nonce to include in the user operation, specific to the smart contract account.\n   */\n  nonce: string;\n\n  /**\n   * The address of the smart contract account creating the user operation.\n   */\n  sender: string;\n};\n\n/**\n * The data returned by the smart contract account when updating a user operation.\n */\nexport type UpdateUserOperationResponse = {\n  /**\n   * The final paymasterAndData to include in the user operation.\n   * Not required if a paymaster is not sponsoring the transaction.\n   */\n  paymasterAndData?: string;\n\n  /**\n   * The final gas limits for the user operation suggested by the smart contract account.\n   * The simulated gas limits may be different after the bundler estimates gas with the use\n   * of the paymaster.\n   */\n  callGasLimit?: string;\n  preVerificationGas?: string;\n  verificationGasLimit?: string;\n};\n\n/**\n * The data returned by the smart contract account when signing a user operation.\n */\nexport type SignUserOperationResponse = {\n  /** The final signature of the user operation. */\n  signature: string;\n};\n\n/**\n * An abstraction to provide smart contract and paymaster specific data when creating a user operation.\n * This will typically communicate with an account snap installed in the client.\n */\nexport type SmartContractAccount = {\n  /**\n   * Retrieve the initial values required to create a user operation.\n   *\n   * @param request - The data needed by the smart contract account to provide the initial user operation values.\n   * @returns The initial values required to create a user operation.\n   */\n  prepareUserOperation: (\n    request: PrepareUserOperationRequest,\n  ) => Promise<PrepareUserOperationResponse>;\n\n  /**\n   * Retrieve additional data required to create a user operation, such as the paymasterAndData value.\n   * If gas values were not provided in the prepare response, this will be called after estimating gas using the bundler.\n   *\n   * @param request - The data needed by the smart contract account to provide the additional user operation values.\n   * @returns The additional values required to create a user operation.\n   */\n  updateUserOperation: (\n    request: UpdateUserOperationRequest,\n  ) => Promise<UpdateUserOperationResponse>;\n\n  /**\n   * Sign the final user operation.\n   *\n   * @param request - The data needed by the smart contract account to generate the signature.\n   * @returns The final values required to sign a user operation.\n   */\n  signUserOperation: (\n    request: SignUserOperationRequest,\n  ) => Promise<SignUserOperationResponse>;\n};\n\n/**\n * Response from the `eth_getUserOperationReceipt` bundler method.\n * Includes the status of a completed user operation and the receipt of the transaction that submitted it.\n */\nexport type UserOperationReceipt = {\n  /** Confirmed total cost of the gas for the user operation. */\n  actualGasCost: Hex | number;\n\n  /** Confirmed total amount of gas used by the user operation. */\n  actualGasUsed: Hex | number;\n\n  /** True if the user operation was successfully confirmed on chain. */\n  success: boolean;\n\n  /** Receipt for the associated transaction. */\n  receipt: {\n    /** Hash of the block the transaction was added to. */\n    blockHash: string;\n\n    /** Hash of the confirmed transaction. */\n    transactionHash: string;\n  };\n};\n\n/** Information specific to user operations created from swap transactions. */\nexport type SwapsMetadata = {\n  /** ID of the associated approval transaction. */\n  approvalTxId: string | null;\n\n  /** Address of the destination token. */\n  destinationTokenAddress: string | null;\n\n  /** Number of decimals of the destination token. */\n  destinationTokenDecimals: number | null;\n\n  /** Symbol of the destination token. */\n  destinationTokenSymbol: string | null;\n\n  /** Amount of the destination token. */\n  destinationTokenAmount: string | null;\n\n  /** Estimated base fee of the swap. */\n  estimatedBaseFee: string | null;\n\n  /** Address of the source token. */\n  sourceTokenAddress: string | null;\n\n  /** Amount of the source token. */\n  sourceTokenAmount: string | null;\n\n  /** Number of decimals of the source token. */\n  sourceTokenDecimals: number | null;\n\n  /** Symbol of the source token. */\n  sourceTokenSymbol: string | null;\n\n  /** Recipient of the swap and send transaction. */\n  swapAndSendRecipient: string | null;\n\n  /** Untyped raw metadata values. */\n  swapMetaData: Record<string, never> | null;\n\n  /** Value of the token being swapped. */\n  swapTokenValue: string | null;\n};\n"]}

package/dist/{types.d.ts → types.d.cts}

@@ -1,5 +1,5 @@
-import type { TransactionParams, TransactionType, UserFeeLevel } from '@metamask/transaction-controller';
-import type { Hex } from '@metamask/utils';
+import type { TransactionParams, TransactionType, UserFeeLevel } from "@metamask/transaction-controller";
+import type { Hex } from "@metamask/utils";
 /**
  * A complete user operation to be submitted to a bundler.
  * Defined in EIP-4337.
@@ -291,4 +291,4 @@ export type SwapsMetadata = {
     /** Value of the token being swapped. */
     swapTokenValue: string | null;
 };
-//# sourceMappingURL=types.d.ts.map
+//# sourceMappingURL=types.d.cts.map

package/dist/types.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.cts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,YAAY,EACb,yCAAyC;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IAEjB,6DAA6D;IAC7D,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,wJAAwJ;IACxJ,kBAAkB,EAAE,MAAM,CAAC;IAE3B,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IAEf,sFAAsF;IACtF,SAAS,EAAE,MAAM,CAAC;IAElB,+DAA+D;IAC/D,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,SAAS,cAAc;CACxB;AAED,uEAAuE;AACvE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,8DAA8D;IAC9D,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,gEAAgE;IAChE,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,wDAAwD;IACxD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,8DAA8D;IAC9D,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAEhB,2DAA2D;IAC3D,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEjC,4DAA4D;IAC5D,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,mEAAmE;IACnE,EAAE,EAAE,MAAM,CAAC;IAEX,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAC;IAEf,4CAA4C;IAC5C,MAAM,EAAE,mBAAmB,CAAC;IAE5B,8CAA8C;IAC9C,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAEpC,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IAEb,mFAAmF;IACnF,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,mFAAmF;IACnF,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEtD,mEAAmE;IACnE,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IAExC,wCAAwC;IACxC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAElC,sEAAsE;IACtE,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAEhB,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IAEb,4DAA4D;IAC5D,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,oGAAoG;IACpG,aAAa,EAAE,aAAa,CAAC;IAE7B,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,kGAAkG;IAClG,aAAa,EAAE,aAAa,CAAC;IAE7B,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAEhB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,GAAG,CAAC,EAAE;QACJ,gEAAgE;QAChE,YAAY,EAAE,MAAM,CAAC;QAErB,wJAAwJ;QACxJ,kBAAkB,EAAE,MAAM,CAAC;QAE3B,+DAA+D;QAC/D,oBAAoB,EAAE,MAAM,CAAC;KAC9B,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;OAKG;IACH,oBAAoB,EAAE,CACpB,OAAO,EAAE,2BAA2B,KACjC,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,mBAAmB,EAAE,CACnB,OAAO,EAAE,0BAA0B,KAChC,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,iBAAiB,EAAE,CACjB,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,8DAA8D;IAC9D,aAAa,EAAE,GAAG,GAAG,MAAM,CAAC;IAE5B,gEAAgE;IAChE,aAAa,EAAE,GAAG,GAAG,MAAM,CAAC;IAE5B,sEAAsE;IACtE,OAAO,EAAE,OAAO,CAAC;IAEjB,8CAA8C;IAC9C,OAAO,EAAE;QACP,sDAAsD;QACtD,SAAS,EAAE,MAAM,CAAC;QAElB,yCAAyC;QACzC,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH,CAAC;AAEF,8EAA8E;AAC9E,MAAM,MAAM,aAAa,GAAG;IAC1B,iDAAiD;IACjD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,wCAAwC;IACxC,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC,mDAAmD;IACnD,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC,uCAAuC;IACvC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,uCAAuC;IACvC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,kCAAkC;IAClC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,8CAA8C;IAC9C,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,kCAAkC;IAClC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,kDAAkD;IAClD,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,mCAAmC;IACnC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC;IAE3C,wCAAwC;IACxC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC"}

package/dist/types.d.mts

@@ -0,0 +1,294 @@
+import type { TransactionParams, TransactionType, UserFeeLevel } from "@metamask/transaction-controller";
+import type { Hex } from "@metamask/utils";
+/**
+ * A complete user operation to be submitted to a bundler.
+ * Defined in EIP-4337.
+ */
+export type UserOperation = {
+    /** The data to pass to the sender during the main execution call. */
+    callData: string;
+    /** The amount of gas to allocate the main execution call. */
+    callGasLimit: string;
+    /**
+     * The initCode of the account.
+     * Needed if and only if the account is not yet on-chain and needs to be created.
+     */
+    initCode: string;
+    /**
+     * Maximum fee per gas.
+     * Similar to EIP-1559 max_fee_per_gas.
+     */
+    maxFeePerGas: string;
+    /**
+     * Maximum priority fee per gas.
+     * Similar to EIP-1559 max_priority_fee_per_gas.
+     */
+    maxPriorityFeePerGas: string;
+    /** Anti-replay parameter. */
+    nonce: string;
+    /**
+     * Address of paymaster sponsoring the transaction, followed by extra data to send to the paymaster.
+     * Empty for self-sponsored transactions.
+     */
+    paymasterAndData: string;
+    /** The amount of gas to pay to compensate the bundler for pre-verification execution, calldata and any gas overhead that cannot be tracked on-chain. */
+    preVerificationGas: string;
+    /** The account making the operation. */
+    sender: string;
+    /** Data passed into the account along with the nonce during the verification step. */
+    signature: string;
+    /** The amount of gas to allocate for the verification step. */
+    verificationGasLimit: string;
+};
+/**
+ * The possible statuses of a single user operation.
+ */
+export declare enum UserOperationStatus {
+    Unapproved = "unapproved",
+    Approved = "approved",
+    Signed = "signed",
+    Submitted = "submitted",
+    Failed = "failed",
+    Confirmed = "confirmed"
+}
+/** Information concerning an error while creating a user operation. */
+export type UserOperationError = {
+    /**
+     * A descriptive error name.
+     */
+    name: string;
+    /**
+     * A descriptive error message providing details about the encountered error.
+     */
+    message: string;
+    /**
+     * The stack trace associated with the error, if available.
+     */
+    stack: string | null;
+    /**
+     * An optional error code associated with the error.
+     */
+    code: string | null;
+    /**
+     * Additional information related to the error.
+     */
+    rpc: string | null;
+};
+/**
+ * Metadata concerning a single user operation, stored in the client state.
+ */
+export type UserOperationMetadata = {
+    /** Confirmed total cost of the gas for the user operation. */
+    actualGasCost: string | null;
+    /** Confirmed total amount of gas used by the user operation. */
+    actualGasUsed: string | null;
+    /** Base fee of the transaction block as a hex value. */
+    baseFeePerGas: string | null;
+    /** URL of the bundler that the operation was submitted to. */
+    bundlerUrl: string | null;
+    /** Hexadecimal chain ID of the target network. */
+    chainId: string;
+    /** An error that occurred while creating the operation. */
+    error: UserOperationError | null;
+    /** Hash of the user operation, generated by the bundler. */
+    hash: string | null;
+    /** A unique ID used to identify a user operation in the client. */
+    id: string;
+    /** The origin of the user operation, such as the hostname of a dApp. */
+    origin: string;
+    /** Current status of the user operation. */
+    status: UserOperationStatus;
+    /** Metadata specific to swap transactions. */
+    swapsMetadata: SwapsMetadata | null;
+    /** Timestamp of when the user operation was created. */
+    time: number;
+    /** Hash of the transaction that submitted the user operation to the entrypoint. */
+    transactionHash: string | null;
+    /** The initial transaction parameters that the user operation was created from. */
+    transactionParams: Required<TransactionParams> | null;
+    /** The type of transaction that the user operation will create. */
+    transactionType: TransactionType | null;
+    /** The origin of the gas fee values. */
+    userFeeLevel: UserFeeLevel | null;
+    /** Resulting user operation object to be submitted to the bundler. */
+    userOperation: UserOperation;
+};
+/**
+ * The data provided to the smart contract account when preparing a user operation.
+ */
+export type PrepareUserOperationRequest = {
+    /** The hexadecimal chain ID of the target network. */
+    chainId: string;
+    /** The data to include in the resulting transaction.  */
+    data?: string;
+    /** Address of the account requesting the user operation. */
+    from: string;
+    /** The destination address of the resulting transaction. */
+    to?: string;
+    /** The value to send in the resulting transaction. */
+    value?: string;
+};
+/**
+ * The data provided to the smart contract account when updating a user operation.
+ */
+export type UpdateUserOperationRequest = {
+    /** The user operation to update including the dummy signature and dummy paymasterAndData values. */
+    userOperation: UserOperation;
+    /** The hexadecimal chain ID of the target network. */
+    chainId: string;
+};
+/**
+ * The data provided to the smart contract account when signing a user operation.
+ */
+export type SignUserOperationRequest = {
+    /** The user operation to sign including the dummy signature and final paymasterAndData values. */
+    userOperation: UserOperation;
+    /** The hexadecimal chain ID of the target network. */
+    chainId: string;
+};
+/**
+ * The data returned by the smart contract account when preparing a user operation.
+ */
+export type PrepareUserOperationResponse = {
+    /** The URL of the bundler to submit the user operation to. */
+    bundler: string;
+    /** The data to pass to the sender during the main execution call. */
+    callData: string;
+    /**
+     * A dummy paymasterAndData value required to estimate gas using the bundler.
+     * Only required if the smart contract account is not providing gas values.
+     */
+    dummyPaymasterAndData?: string;
+    /**
+     * A dummy signature value required to estimate gas using the bundler.
+     * Only required if the smart contract account is not providing gas values.
+     */
+    dummySignature?: string;
+    /**
+     * The estimated gas limits for the user operation.
+     * Gas is automatically estimated using the bundler if not provided.
+     */
+    gas?: {
+        /** The amount of gas to allocate to the main execution call. */
+        callGasLimit: string;
+        /** The amount of gas to pay to compensate the bundler for pre-verification execution, calldata and any gas overhead that cannot be tracked on-chain. */
+        preVerificationGas: string;
+        /** The amount of gas to allocate for the verification step. */
+        verificationGasLimit: string;
+    };
+    /**
+     * The initCode to include in the user operation.
+     * Required only if the smart contract is not yet deployed.
+     */
+    initCode?: string;
+    /**
+     * The nonce to include in the user operation, specific to the smart contract account.
+     */
+    nonce: string;
+    /**
+     * The address of the smart contract account creating the user operation.
+     */
+    sender: string;
+};
+/**
+ * The data returned by the smart contract account when updating a user operation.
+ */
+export type UpdateUserOperationResponse = {
+    /**
+     * The final paymasterAndData to include in the user operation.
+     * Not required if a paymaster is not sponsoring the transaction.
+     */
+    paymasterAndData?: string;
+    /**
+     * The final gas limits for the user operation suggested by the smart contract account.
+     * The simulated gas limits may be different after the bundler estimates gas with the use
+     * of the paymaster.
+     */
+    callGasLimit?: string;
+    preVerificationGas?: string;
+    verificationGasLimit?: string;
+};
+/**
+ * The data returned by the smart contract account when signing a user operation.
+ */
+export type SignUserOperationResponse = {
+    /** The final signature of the user operation. */
+    signature: string;
+};
+/**
+ * An abstraction to provide smart contract and paymaster specific data when creating a user operation.
+ * This will typically communicate with an account snap installed in the client.
+ */
+export type SmartContractAccount = {
+    /**
+     * Retrieve the initial values required to create a user operation.
+     *
+     * @param request - The data needed by the smart contract account to provide the initial user operation values.
+     * @returns The initial values required to create a user operation.
+     */
+    prepareUserOperation: (request: PrepareUserOperationRequest) => Promise<PrepareUserOperationResponse>;
+    /**
+     * Retrieve additional data required to create a user operation, such as the paymasterAndData value.
+     * If gas values were not provided in the prepare response, this will be called after estimating gas using the bundler.
+     *
+     * @param request - The data needed by the smart contract account to provide the additional user operation values.
+     * @returns The additional values required to create a user operation.
+     */
+    updateUserOperation: (request: UpdateUserOperationRequest) => Promise<UpdateUserOperationResponse>;
+    /**
+     * Sign the final user operation.
+     *
+     * @param request - The data needed by the smart contract account to generate the signature.
+     * @returns The final values required to sign a user operation.
+     */
+    signUserOperation: (request: SignUserOperationRequest) => Promise<SignUserOperationResponse>;
+};
+/**
+ * Response from the `eth_getUserOperationReceipt` bundler method.
+ * Includes the status of a completed user operation and the receipt of the transaction that submitted it.
+ */
+export type UserOperationReceipt = {
+    /** Confirmed total cost of the gas for the user operation. */
+    actualGasCost: Hex | number;
+    /** Confirmed total amount of gas used by the user operation. */
+    actualGasUsed: Hex | number;
+    /** True if the user operation was successfully confirmed on chain. */
+    success: boolean;
+    /** Receipt for the associated transaction. */
+    receipt: {
+        /** Hash of the block the transaction was added to. */
+        blockHash: string;
+        /** Hash of the confirmed transaction. */
+        transactionHash: string;
+    };
+};
+/** Information specific to user operations created from swap transactions. */
+export type SwapsMetadata = {
+    /** ID of the associated approval transaction. */
+    approvalTxId: string | null;
+    /** Address of the destination token. */
+    destinationTokenAddress: string | null;
+    /** Number of decimals of the destination token. */
+    destinationTokenDecimals: number | null;
+    /** Symbol of the destination token. */
+    destinationTokenSymbol: string | null;
+    /** Amount of the destination token. */
+    destinationTokenAmount: string | null;
+    /** Estimated base fee of the swap. */
+    estimatedBaseFee: string | null;
+    /** Address of the source token. */
+    sourceTokenAddress: string | null;
+    /** Amount of the source token. */
+    sourceTokenAmount: string | null;
+    /** Number of decimals of the source token. */
+    sourceTokenDecimals: number | null;
+    /** Symbol of the source token. */
+    sourceTokenSymbol: string | null;
+    /** Recipient of the swap and send transaction. */
+    swapAndSendRecipient: string | null;
+    /** Untyped raw metadata values. */
+    swapMetaData: Record<string, never> | null;
+    /** Value of the token being swapped. */
+    swapTokenValue: string | null;
+};
+//# sourceMappingURL=types.d.mts.map

package/dist/types.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.mts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,iBAAiB,EACjB,eAAe,EACf,YAAY,EACb,yCAAyC;AAC1C,OAAO,KAAK,EAAE,GAAG,EAAE,wBAAwB;AAE3C;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG;IAC1B,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IAEjB,6DAA6D;IAC7D,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,oBAAoB,EAAE,MAAM,CAAC;IAE7B,6BAA6B;IAC7B,KAAK,EAAE,MAAM,CAAC;IAEd;;;OAGG;IACH,gBAAgB,EAAE,MAAM,CAAC;IAEzB,wJAAwJ;IACxJ,kBAAkB,EAAE,MAAM,CAAC;IAE3B,wCAAwC;IACxC,MAAM,EAAE,MAAM,CAAC;IAEf,sFAAsF;IACtF,SAAS,EAAE,MAAM,CAAC;IAElB,+DAA+D;IAC/D,oBAAoB,EAAE,MAAM,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,oBAAY,mBAAmB;IAC7B,UAAU,eAAe;IACzB,QAAQ,aAAa;IACrB,MAAM,WAAW;IACjB,SAAS,cAAc;IACvB,MAAM,WAAW;IACjB,SAAS,cAAc;CACxB;AAED,uEAAuE;AACvE,MAAM,MAAM,kBAAkB,GAAG;IAC/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB;;OAEG;IACH,GAAG,EAAE,MAAM,GAAG,IAAI,CAAC;CACpB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,qBAAqB,GAAG;IAClC,8DAA8D;IAC9D,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,gEAAgE;IAChE,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,wDAAwD;IACxD,aAAa,EAAE,MAAM,GAAG,IAAI,CAAC;IAE7B,8DAA8D;IAC9D,UAAU,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B,kDAAkD;IAClD,OAAO,EAAE,MAAM,CAAC;IAEhB,2DAA2D;IAC3D,KAAK,EAAE,kBAAkB,GAAG,IAAI,CAAC;IAEjC,4DAA4D;IAC5D,IAAI,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpB,mEAAmE;IACnE,EAAE,EAAE,MAAM,CAAC;IAEX,wEAAwE;IACxE,MAAM,EAAE,MAAM,CAAC;IAEf,4CAA4C;IAC5C,MAAM,EAAE,mBAAmB,CAAC;IAE5B,8CAA8C;IAC9C,aAAa,EAAE,aAAa,GAAG,IAAI,CAAC;IAEpC,wDAAwD;IACxD,IAAI,EAAE,MAAM,CAAC;IAEb,mFAAmF;IACnF,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B,mFAAmF;IACnF,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEtD,mEAAmE;IACnE,eAAe,EAAE,eAAe,GAAG,IAAI,CAAC;IAExC,wCAAwC;IACxC,YAAY,EAAE,YAAY,GAAG,IAAI,CAAC;IAElC,sEAAsE;IACtE,aAAa,EAAE,aAAa,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;IAEhB,yDAAyD;IACzD,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd,4DAA4D;IAC5D,IAAI,EAAE,MAAM,CAAC;IAEb,4DAA4D;IAC5D,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ,sDAAsD;IACtD,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,oGAAoG;IACpG,aAAa,EAAE,aAAa,CAAC;IAE7B,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC,kGAAkG;IAClG,aAAa,EAAE,aAAa,CAAC;IAE7B,sDAAsD;IACtD,OAAO,EAAE,MAAM,CAAC;CACjB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC,8DAA8D;IAC9D,OAAO,EAAE,MAAM,CAAC;IAEhB,qEAAqE;IACrE,QAAQ,EAAE,MAAM,CAAC;IAEjB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;;OAGG;IACH,cAAc,CAAC,EAAE,MAAM,CAAC;IAExB;;;OAGG;IACH,GAAG,CAAC,EAAE;QACJ,gEAAgE;QAChE,YAAY,EAAE,MAAM,CAAC;QAErB,wJAAwJ;QACxJ,kBAAkB,EAAE,MAAM,CAAC;QAE3B,+DAA+D;QAC/D,oBAAoB,EAAE,MAAM,CAAC;KAC9B,CAAC;IAEF;;;OAGG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,KAAK,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,MAAM,EAAE,MAAM,CAAC;CAChB,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,2BAA2B,GAAG;IACxC;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,oBAAoB,CAAC,EAAE,MAAM,CAAC;CAC/B,CAAC;AAEF;;GAEG;AACH,MAAM,MAAM,yBAAyB,GAAG;IACtC,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;CACnB,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC;;;;;OAKG;IACH,oBAAoB,EAAE,CACpB,OAAO,EAAE,2BAA2B,KACjC,OAAO,CAAC,4BAA4B,CAAC,CAAC;IAE3C;;;;;;OAMG;IACH,mBAAmB,EAAE,CACnB,OAAO,EAAE,0BAA0B,KAChC,OAAO,CAAC,2BAA2B,CAAC,CAAC;IAE1C;;;;;OAKG;IACH,iBAAiB,EAAE,CACjB,OAAO,EAAE,wBAAwB,KAC9B,OAAO,CAAC,yBAAyB,CAAC,CAAC;CACzC,CAAC;AAEF;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IACjC,8DAA8D;IAC9D,aAAa,EAAE,GAAG,GAAG,MAAM,CAAC;IAE5B,gEAAgE;IAChE,aAAa,EAAE,GAAG,GAAG,MAAM,CAAC;IAE5B,sEAAsE;IACtE,OAAO,EAAE,OAAO,CAAC;IAEjB,8CAA8C;IAC9C,OAAO,EAAE;QACP,sDAAsD;QACtD,SAAS,EAAE,MAAM,CAAC;QAElB,yCAAyC;QACzC,eAAe,EAAE,MAAM,CAAC;KACzB,CAAC;CACH,CAAC;AAEF,8EAA8E;AAC9E,MAAM,MAAM,aAAa,GAAG;IAC1B,iDAAiD;IACjD,YAAY,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B,wCAAwC;IACxC,uBAAuB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvC,mDAAmD;IACnD,wBAAwB,EAAE,MAAM,GAAG,IAAI,CAAC;IAExC,uCAAuC;IACvC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,uCAAuC;IACvC,sBAAsB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtC,sCAAsC;IACtC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEhC,mCAAmC;IACnC,kBAAkB,EAAE,MAAM,GAAG,IAAI,CAAC;IAElC,kCAAkC;IAClC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,8CAA8C;IAC9C,mBAAmB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC,kCAAkC;IAClC,iBAAiB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEjC,kDAAkD;IAClD,oBAAoB,EAAE,MAAM,GAAG,IAAI,CAAC;IAEpC,mCAAmC;IACnC,YAAY,EAAE,MAAM,CAAC,MAAM,EAAE,KAAK,CAAC,GAAG,IAAI,CAAC;IAE3C,wCAAwC;IACxC,cAAc,EAAE,MAAM,GAAG,IAAI,CAAC;CAC/B,CAAC"}

package/dist/{types.js → types.mjs}

@@ -10,4 +10,4 @@ export var UserOperationStatus;
     UserOperationStatus["Failed"] = "failed";
     UserOperationStatus["Confirmed"] = "confirmed";
 })(UserOperationStatus || (UserOperationStatus = {}));
-//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.mjs.map

package/dist/types.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.mjs","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AA0DA;;GAEG;AACH,MAAM,CAAN,IAAY,mBAOX;AAPD,WAAY,mBAAmB;IAC7B,gDAAyB,CAAA;IACzB,4CAAqB,CAAA;IACrB,wCAAiB,CAAA;IACjB,8CAAuB,CAAA;IACvB,wCAAiB,CAAA;IACjB,8CAAuB,CAAA;AACzB,CAAC,EAPW,mBAAmB,KAAnB,mBAAmB,QAO9B","sourcesContent":["import type {\n  TransactionParams,\n  TransactionType,\n  UserFeeLevel,\n} from '@metamask/transaction-controller';\nimport type { Hex } from '@metamask/utils';\n\n/**\n * A complete user operation to be submitted to a bundler.\n * Defined in EIP-4337.\n */\nexport type UserOperation = {\n  /** The data to pass to the sender during the main execution call. */\n  callData: string;\n\n  /** The amount of gas to allocate the main execution call. */\n  callGasLimit: string;\n\n  /**\n   * The initCode of the account.\n   * Needed if and only if the account is not yet on-chain and needs to be created.\n   */\n  initCode: string;\n\n  /**\n   * Maximum fee per gas.\n   * Similar to EIP-1559 max_fee_per_gas.\n   */\n  maxFeePerGas: string;\n\n  /**\n   * Maximum priority fee per gas.\n   * Similar to EIP-1559 max_priority_fee_per_gas.\n   */\n  maxPriorityFeePerGas: string;\n\n  /** Anti-replay parameter. */\n  nonce: string;\n\n  /**\n   * Address of paymaster sponsoring the transaction, followed by extra data to send to the paymaster.\n   * Empty for self-sponsored transactions.\n   */\n  paymasterAndData: string;\n\n  /** The amount of gas to pay to compensate the bundler for pre-verification execution, calldata and any gas overhead that cannot be tracked on-chain. */\n  preVerificationGas: string;\n\n  /** The account making the operation. */\n  sender: string;\n\n  /** Data passed into the account along with the nonce during the verification step. */\n  signature: string;\n\n  /** The amount of gas to allocate for the verification step. */\n  verificationGasLimit: string;\n};\n\n/**\n * The possible statuses of a single user operation.\n */\nexport enum UserOperationStatus {\n  Unapproved = 'unapproved',\n  Approved = 'approved',\n  Signed = 'signed',\n  Submitted = 'submitted',\n  Failed = 'failed',\n  Confirmed = 'confirmed',\n}\n\n/** Information concerning an error while creating a user operation. */\nexport type UserOperationError = {\n  /**\n   * A descriptive error name.\n   */\n  name: string;\n\n  /**\n   * A descriptive error message providing details about the encountered error.\n   */\n  message: string;\n\n  /**\n   * The stack trace associated with the error, if available.\n   */\n  stack: string | null;\n\n  /**\n   * An optional error code associated with the error.\n   */\n  code: string | null;\n\n  /**\n   * Additional information related to the error.\n   */\n  rpc: string | null;\n};\n\n/**\n * Metadata concerning a single user operation, stored in the client state.\n */\nexport type UserOperationMetadata = {\n  /** Confirmed total cost of the gas for the user operation. */\n  actualGasCost: string | null;\n\n  /** Confirmed total amount of gas used by the user operation. */\n  actualGasUsed: string | null;\n\n  /** Base fee of the transaction block as a hex value. */\n  baseFeePerGas: string | null;\n\n  /** URL of the bundler that the operation was submitted to. */\n  bundlerUrl: string | null;\n\n  /** Hexadecimal chain ID of the target network. */\n  chainId: string;\n\n  /** An error that occurred while creating the operation. */\n  error: UserOperationError | null;\n\n  /** Hash of the user operation, generated by the bundler. */\n  hash: string | null;\n\n  /** A unique ID used to identify a user operation in the client. */\n  id: string;\n\n  /** The origin of the user operation, such as the hostname of a dApp. */\n  origin: string;\n\n  /** Current status of the user operation. */\n  status: UserOperationStatus;\n\n  /** Metadata specific to swap transactions. */\n  swapsMetadata: SwapsMetadata | null;\n\n  /** Timestamp of when the user operation was created. */\n  time: number;\n\n  /** Hash of the transaction that submitted the user operation to the entrypoint. */\n  transactionHash: string | null;\n\n  /** The initial transaction parameters that the user operation was created from. */\n  transactionParams: Required<TransactionParams> | null;\n\n  /** The type of transaction that the user operation will create. */\n  transactionType: TransactionType | null;\n\n  /** The origin of the gas fee values. */\n  userFeeLevel: UserFeeLevel | null;\n\n  /** Resulting user operation object to be submitted to the bundler. */\n  userOperation: UserOperation;\n};\n\n/**\n * The data provided to the smart contract account when preparing a user operation.\n */\nexport type PrepareUserOperationRequest = {\n  /** The hexadecimal chain ID of the target network. */\n  chainId: string;\n\n  /** The data to include in the resulting transaction.  */\n  data?: string;\n\n  /** Address of the account requesting the user operation. */\n  from: string;\n\n  /** The destination address of the resulting transaction. */\n  to?: string;\n\n  /** The value to send in the resulting transaction. */\n  value?: string;\n};\n\n/**\n * The data provided to the smart contract account when updating a user operation.\n */\nexport type UpdateUserOperationRequest = {\n  /** The user operation to update including the dummy signature and dummy paymasterAndData values. */\n  userOperation: UserOperation;\n\n  /** The hexadecimal chain ID of the target network. */\n  chainId: string;\n};\n\n/**\n * The data provided to the smart contract account when signing a user operation.\n */\nexport type SignUserOperationRequest = {\n  /** The user operation to sign including the dummy signature and final paymasterAndData values. */\n  userOperation: UserOperation;\n\n  /** The hexadecimal chain ID of the target network. */\n  chainId: string;\n};\n\n/**\n * The data returned by the smart contract account when preparing a user operation.\n */\nexport type PrepareUserOperationResponse = {\n  /** The URL of the bundler to submit the user operation to. */\n  bundler: string;\n\n  /** The data to pass to the sender during the main execution call. */\n  callData: string;\n\n  /**\n   * A dummy paymasterAndData value required to estimate gas using the bundler.\n   * Only required if the smart contract account is not providing gas values.\n   */\n  dummyPaymasterAndData?: string;\n\n  /**\n   * A dummy signature value required to estimate gas using the bundler.\n   * Only required if the smart contract account is not providing gas values.\n   */\n  dummySignature?: string;\n\n  /**\n   * The estimated gas limits for the user operation.\n   * Gas is automatically estimated using the bundler if not provided.\n   */\n  gas?: {\n    /** The amount of gas to allocate to the main execution call. */\n    callGasLimit: string;\n\n    /** The amount of gas to pay to compensate the bundler for pre-verification execution, calldata and any gas overhead that cannot be tracked on-chain. */\n    preVerificationGas: string;\n\n    /** The amount of gas to allocate for the verification step. */\n    verificationGasLimit: string;\n  };\n\n  /**\n   * The initCode to include in the user operation.\n   * Required only if the smart contract is not yet deployed.\n   */\n  initCode?: string;\n\n  /**\n   * The nonce to include in the user operation, specific to the smart contract account.\n   */\n  nonce: string;\n\n  /**\n   * The address of the smart contract account creating the user operation.\n   */\n  sender: string;\n};\n\n/**\n * The data returned by the smart contract account when updating a user operation.\n */\nexport type UpdateUserOperationResponse = {\n  /**\n   * The final paymasterAndData to include in the user operation.\n   * Not required if a paymaster is not sponsoring the transaction.\n   */\n  paymasterAndData?: string;\n\n  /**\n   * The final gas limits for the user operation suggested by the smart contract account.\n   * The simulated gas limits may be different after the bundler estimates gas with the use\n   * of the paymaster.\n   */\n  callGasLimit?: string;\n  preVerificationGas?: string;\n  verificationGasLimit?: string;\n};\n\n/**\n * The data returned by the smart contract account when signing a user operation.\n */\nexport type SignUserOperationResponse = {\n  /** The final signature of the user operation. */\n  signature: string;\n};\n\n/**\n * An abstraction to provide smart contract and paymaster specific data when creating a user operation.\n * This will typically communicate with an account snap installed in the client.\n */\nexport type SmartContractAccount = {\n  /**\n   * Retrieve the initial values required to create a user operation.\n   *\n   * @param request - The data needed by the smart contract account to provide the initial user operation values.\n   * @returns The initial values required to create a user operation.\n   */\n  prepareUserOperation: (\n    request: PrepareUserOperationRequest,\n  ) => Promise<PrepareUserOperationResponse>;\n\n  /**\n   * Retrieve additional data required to create a user operation, such as the paymasterAndData value.\n   * If gas values were not provided in the prepare response, this will be called after estimating gas using the bundler.\n   *\n   * @param request - The data needed by the smart contract account to provide the additional user operation values.\n   * @returns The additional values required to create a user operation.\n   */\n  updateUserOperation: (\n    request: UpdateUserOperationRequest,\n  ) => Promise<UpdateUserOperationResponse>;\n\n  /**\n   * Sign the final user operation.\n   *\n   * @param request - The data needed by the smart contract account to generate the signature.\n   * @returns The final values required to sign a user operation.\n   */\n  signUserOperation: (\n    request: SignUserOperationRequest,\n  ) => Promise<SignUserOperationResponse>;\n};\n\n/**\n * Response from the `eth_getUserOperationReceipt` bundler method.\n * Includes the status of a completed user operation and the receipt of the transaction that submitted it.\n */\nexport type UserOperationReceipt = {\n  /** Confirmed total cost of the gas for the user operation. */\n  actualGasCost: Hex | number;\n\n  /** Confirmed total amount of gas used by the user operation. */\n  actualGasUsed: Hex | number;\n\n  /** True if the user operation was successfully confirmed on chain. */\n  success: boolean;\n\n  /** Receipt for the associated transaction. */\n  receipt: {\n    /** Hash of the block the transaction was added to. */\n    blockHash: string;\n\n    /** Hash of the confirmed transaction. */\n    transactionHash: string;\n  };\n};\n\n/** Information specific to user operations created from swap transactions. */\nexport type SwapsMetadata = {\n  /** ID of the associated approval transaction. */\n  approvalTxId: string | null;\n\n  /** Address of the destination token. */\n  destinationTokenAddress: string | null;\n\n  /** Number of decimals of the destination token. */\n  destinationTokenDecimals: number | null;\n\n  /** Symbol of the destination token. */\n  destinationTokenSymbol: string | null;\n\n  /** Amount of the destination token. */\n  destinationTokenAmount: string | null;\n\n  /** Estimated base fee of the swap. */\n  estimatedBaseFee: string | null;\n\n  /** Address of the source token. */\n  sourceTokenAddress: string | null;\n\n  /** Amount of the source token. */\n  sourceTokenAmount: string | null;\n\n  /** Number of decimals of the source token. */\n  sourceTokenDecimals: number | null;\n\n  /** Symbol of the source token. */\n  sourceTokenSymbol: string | null;\n\n  /** Recipient of the swap and send transaction. */\n  swapAndSendRecipient: string | null;\n\n  /** Untyped raw metadata values. */\n  swapMetaData: Record<string, never> | null;\n\n  /** Value of the token being swapped. */\n  swapTokenValue: string | null;\n};\n"]}

package/dist/utils/chain-id.cjs

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.toEip155ChainId = void 0;
+/**
+ * Converts a chain ID string to a compliant CAIP-2 chain ID reference for EIP-155 chains.
+ *
+ * @param chainId - Chain ID string
+ * @returns An CAIP-2 chain ID reference for EIP-155 chains.
+ */
+function toEip155ChainId(chainId) {
+    const chainIdNumber = Number(chainId);
+    // If for some reason the chainId isn't convertible to a decimal integer representation, we fallback
+    // to the initial `chainId`.
+    return Number.isInteger(chainIdNumber) ? chainIdNumber.toString() : chainId;
+}
+exports.toEip155ChainId = toEip155ChainId;
+//# sourceMappingURL=chain-id.cjs.map

package/dist/utils/chain-id.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain-id.cjs","sourceRoot":"","sources":["../../src/utils/chain-id.ts"],"names":[],"mappings":";;;AAAA;;;;;GAKG;AACH,SAAgB,eAAe,CAAC,OAAe;IAC7C,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAEtC,oGAAoG;IACpG,4BAA4B;IAC5B,OAAO,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AAC9E,CAAC;AAND,0CAMC","sourcesContent":["/**\n * Converts a chain ID string to a compliant CAIP-2 chain ID reference for EIP-155 chains.\n *\n * @param chainId - Chain ID string\n * @returns An CAIP-2 chain ID reference for EIP-155 chains.\n */\nexport function toEip155ChainId(chainId: string): string {\n  const chainIdNumber = Number(chainId);\n\n  // If for some reason the chainId isn't convertible to a decimal integer representation, we fallback\n  // to the initial `chainId`.\n  return Number.isInteger(chainIdNumber) ? chainIdNumber.toString() : chainId;\n}\n"]}

package/dist/utils/{chain-id.d.ts → chain-id.d.cts}

@@ -5,4 +5,4 @@
  * @returns An CAIP-2 chain ID reference for EIP-155 chains.
  */
 export declare function toEip155ChainId(chainId: string): string;
-//# sourceMappingURL=chain-id.d.ts.map
+//# sourceMappingURL=chain-id.d.cts.map

package/dist/utils/chain-id.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain-id.d.cts","sourceRoot":"","sources":["../../src/utils/chain-id.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAMvD"}

package/dist/utils/chain-id.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Converts a chain ID string to a compliant CAIP-2 chain ID reference for EIP-155 chains.
+ *
+ * @param chainId - Chain ID string
+ * @returns An CAIP-2 chain ID reference for EIP-155 chains.
+ */
+export declare function toEip155ChainId(chainId: string): string;
+//# sourceMappingURL=chain-id.d.mts.map

package/dist/utils/chain-id.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain-id.d.mts","sourceRoot":"","sources":["../../src/utils/chain-id.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAMvD"}

package/dist/utils/{chain-id.js → chain-id.mjs}

@@ -10,4 +10,4 @@ export function toEip155ChainId(chainId) {
     // to the initial `chainId`.
     return Number.isInteger(chainIdNumber) ? chainIdNumber.toString() : chainId;
 }
-//# sourceMappingURL=chain-id.js.map
+//# sourceMappingURL=chain-id.mjs.map

package/dist/utils/chain-id.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"chain-id.mjs","sourceRoot":"","sources":["../../src/utils/chain-id.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,UAAU,eAAe,CAAC,OAAe;IAC7C,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,CAAC;IAEtC,oGAAoG;IACpG,4BAA4B;IAC5B,OAAO,MAAM,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,QAAQ,EAAE,CAAC,CAAC,CAAC,OAAO,CAAC;AAC9E,CAAC","sourcesContent":["/**\n * Converts a chain ID string to a compliant CAIP-2 chain ID reference for EIP-155 chains.\n *\n * @param chainId - Chain ID string\n * @returns An CAIP-2 chain ID reference for EIP-155 chains.\n */\nexport function toEip155ChainId(chainId: string): string {\n  const chainIdNumber = Number(chainId);\n\n  // If for some reason the chainId isn't convertible to a decimal integer representation, we fallback\n  // to the initial `chainId`.\n  return Number.isInteger(chainIdNumber) ? chainIdNumber.toString() : chainId;\n}\n"]}

package/dist/utils/gas-fees.cjs

@@ -0,0 +1,194 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.updateGasFees = void 0;
+const controller_utils_1 = require("@metamask/controller-utils");
+const eth_query_1 = __importDefault(require("@metamask/eth-query"));
+const gas_fee_controller_1 = require("@metamask/gas-fee-controller");
+const transaction_controller_1 = require("@metamask/transaction-controller");
+const utils_1 = require("@metamask/utils");
+const constants_js_1 = require("../constants.cjs");
+const logger_js_1 = require("../logger.cjs");
+const log = (0, logger_js_1.createModuleLogger)(logger_js_1.projectLogger, 'gas-fees');
+/**
+ * Populates the gas fee properties for a user operation.
+ *
+ * @param request - The request to update the gas fees.
+ * @param request.getGasFeeEstimates - A callback to get gas fee estimates.
+ * @param request.metadata - The metadata for the user operation.
+ * @param request.originalRequest - The original request to add the user operation.
+ * @param request.provider - A provider to query the network.
+ * @param request.transaction - The transaction that created the user operation.
+ */
+async function updateGasFees(request) {
+    const { metadata, originalRequest, transaction } = request;
+    const { userOperation } = metadata;
+    let suggestedGasFees;
+    const getGasFeeEstimates = async () => {
+        if (!suggestedGasFees) {
+            suggestedGasFees = await getSuggestedGasFees(request);
+        }
+        return suggestedGasFees;
+    };
+    userOperation.maxFeePerGas = await getMaxFeePerGas(originalRequest, getGasFeeEstimates, transaction);
+    userOperation.maxPriorityFeePerGas = await getMaxPriorityFeePerGas(originalRequest, getGasFeeEstimates, userOperation, transaction);
+    metadata.userFeeLevel = getUserFeeLevel(metadata, originalRequest, suggestedGasFees, transaction);
+}
+exports.updateGasFees = updateGasFees;
+/**
+ * Gets the maxFeePerGas for a user operation.
+ *
+ * @param originalRequest - The original request to add the user operation.
+ * @param getGetFasEstimates - A callback to get gas fee estimates.
+ * @param transaction - The transaction that created the user operation.
+ * @returns The maxFeePerGas for the user operation.
+ */
+async function getMaxFeePerGas(originalRequest, getGetFasEstimates, transaction) {
+    const { maxFeePerGas, maxPriorityFeePerGas } = originalRequest;
+    const { gasPrice } = transaction ?? {};
+    if (!isGasFeeEmpty(maxFeePerGas)) {
+        log('Using maxFeePerGas from request', maxFeePerGas);
+        return maxFeePerGas;
+    }
+    if (isGasFeeEmpty(maxPriorityFeePerGas) && gasPrice) {
+        log('Setting maxFeePerGas to transaction gasPrice', gasPrice);
+        return gasPrice;
+    }
+    const { maxFeePerGas: suggestedMaxFeePerGas } = await getGetFasEstimates();
+    if (!suggestedMaxFeePerGas) {
+        throw new Error('Failed to get gas fee estimate for maxFeePerGas');
+    }
+    log('Using maxFeePerGas from estimate', suggestedMaxFeePerGas);
+    return suggestedMaxFeePerGas;
+}
+/**
+ * Gets the maxPriorityFeePerGas for a user operation.
+ *
+ * @param originalRequest - The original request to add the user operation.
+ * @param getGetFasEstimates - A callback to get gas fee estimates.
+ * @param userOperation - The user operation being updated.
+ * @param transaction - The transaction that created the user operation.
+ * @returns The maxPriorityFeePerGas for the user operation.
+ */
+async function getMaxPriorityFeePerGas(originalRequest, getGetFasEstimates, userOperation, transaction) {
+    const { maxFeePerGas, maxPriorityFeePerGas } = originalRequest;
+    const { gasPrice } = transaction ?? {};
+    const { maxFeePerGas: updatedMaxFeePerGas } = userOperation;
+    if (!isGasFeeEmpty(maxPriorityFeePerGas)) {
+        log('Using maxPriorityFeePerGas from request', maxPriorityFeePerGas);
+        return maxPriorityFeePerGas;
+    }
+    if (isGasFeeEmpty(maxFeePerGas) && gasPrice) {
+        log('Setting maxPriorityFeePerGas to transaction gasPrice', gasPrice);
+        return gasPrice;
+    }
+    const { maxPriorityFeePerGas: suggestedMaxPriorityFeePerGas } = await getGetFasEstimates();
+    if (suggestedMaxPriorityFeePerGas) {
+        log('Using maxPriorityFeePerGas from estimate', suggestedMaxPriorityFeePerGas);
+        return suggestedMaxPriorityFeePerGas;
+    }
+    log('Setting maxPriorityFeePerGas to maxFeePerGas', updatedMaxFeePerGas);
+    return updatedMaxFeePerGas;
+}
+/**
+ * Gets the userFeeLevel for a user operation.
+ *
+ * @param metadata - The metadata for the user operation.
+ * @param originalRequest - The original request to add the user operation.
+ * @param suggestedGasFees - The suggested gas fees, if any.
+ * @param transaction - The transaction that created the user operation.
+ * @returns The userFeeLevel for the user operation.
+ */
+function getUserFeeLevel(metadata, originalRequest, suggestedGasFees, transaction) {
+    const { origin } = metadata;
+    const { maxFeePerGas, maxPriorityFeePerGas } = originalRequest;
+    const { maxFeePerGas: suggestedMaxFeePerGas, maxPriorityFeePerGas: suggestedMaxPriorityFeePerGas, } = suggestedGasFees || {};
+    if (isGasFeeEmpty(maxFeePerGas) &&
+        isGasFeeEmpty(maxPriorityFeePerGas) &&
+        transaction?.gasPrice) {
+        return origin === controller_utils_1.ORIGIN_METAMASK
+            ? transaction_controller_1.UserFeeLevel.CUSTOM
+            : transaction_controller_1.UserFeeLevel.DAPP_SUGGESTED;
+    }
+    if (isGasFeeEmpty(maxFeePerGas) &&
+        isGasFeeEmpty(maxPriorityFeePerGas) &&
+        suggestedMaxFeePerGas &&
+        suggestedMaxPriorityFeePerGas) {
+        return transaction_controller_1.UserFeeLevel.MEDIUM;
+    }
+    if (origin === controller_utils_1.ORIGIN_METAMASK) {
+        return transaction_controller_1.UserFeeLevel.CUSTOM;
+    }
+    return transaction_controller_1.UserFeeLevel.DAPP_SUGGESTED;
+}
+/**
+ * Gets suggested gas fees.
+ *
+ * @param request - The request to update the gas fees.
+ * @param request.getGasFeeEstimates - A callback to get gas fee estimates.
+ * @param request.provider - A provider to query the network.
+ * @returns The suggested gas fees.
+ */
+async function getSuggestedGasFees(request) {
+    const { getGasFeeEstimates, provider } = request;
+    try {
+        const { gasFeeEstimates, gasEstimateType } = await getGasFeeEstimates();
+        if (gasEstimateType === gas_fee_controller_1.GAS_ESTIMATE_TYPES.FEE_MARKET) {
+            /* istanbul ignore next */
+            const { medium: { suggestedMaxPriorityFeePerGas, suggestedMaxFeePerGas } = {}, } = gasFeeEstimates;
+            if (suggestedMaxPriorityFeePerGas && suggestedMaxFeePerGas) {
+                const values = {
+                    maxFeePerGas: gweiDecimalToWeiHex(suggestedMaxFeePerGas),
+                    maxPriorityFeePerGas: gweiDecimalToWeiHex(suggestedMaxPriorityFeePerGas),
+                };
+                log('Using medium values from fee market estimate', values);
+                return values;
+            }
+        }
+        if (gasEstimateType === gas_fee_controller_1.GAS_ESTIMATE_TYPES.LEGACY) {
+            const maxFeePerGas = gweiDecimalToWeiHex(gasFeeEstimates.medium);
+            log('Using medium value from legacy estimate', maxFeePerGas);
+            return {
+                maxFeePerGas,
+            };
+        }
+        if (gasEstimateType === gas_fee_controller_1.GAS_ESTIMATE_TYPES.ETH_GASPRICE) {
+            const maxFeePerGas = gweiDecimalToWeiHex(gasFeeEstimates.gasPrice);
+            log('Using gasPrice from estimate', maxFeePerGas);
+            return {
+                maxFeePerGas,
+            };
+        }
+    }
+    catch (error) {
+        log('Failed to get estimate', error);
+    }
+    const gasPriceDecimal = (await (0, controller_utils_1.query)(new eth_query_1.default(provider), 'gasPrice'));
+    if (!gasPriceDecimal) {
+        return {};
+    }
+    const maxFeePerGas = (0, utils_1.add0x)(gasPriceDecimal.toString(16));
+    log('Using gasPrice from network as fallback', maxFeePerGas);
+    return { maxFeePerGas };
+}
+/**
+ * Converts a GWEI decimal string to a WEI hexadecimal string.
+ *
+ * @param value - The GWEI decimal string to convert.
+ * @returns The WEI hexadecimal string.
+ */
+function gweiDecimalToWeiHex(value) {
+    return (0, controller_utils_1.toHex)((0, controller_utils_1.gweiDecToWEIBN)(value));
+}
+/**
+ * Checks if a gas fee property is empty.
+ *
+ * @param value - The gas fee value to check.
+ * @returns Whether the gas fee property is empty.
+ */
+function isGasFeeEmpty(value) {
+    return !value || value === constants_js_1.EMPTY_BYTES;
+}
+//# sourceMappingURL=gas-fees.cjs.map