permissionless 0.0.30 → 0.0.32

package/errors/gas.ts

@@ -0,0 +1,120 @@
+import { BaseError } from "viem"
+
+export type VerificationGasLimitTooLowErrorType =
+    VerificationGasLimitTooLowError & {
+        name: "VerificationGasLimitTooLowError"
+    }
+export class VerificationGasLimitTooLowError extends BaseError {
+    static message = /aa4[01]/
+    override name = "VerificationGasLimitTooLowError"
+    constructor({
+        cause,
+        verificationGasLimit,
+        docsPath
+    }: {
+        cause?: BaseError
+        verificationGasLimit?: bigint
+        docsPath?: string
+    }) {
+        super(
+            [
+                `The smart account and paymaster verification exceeded the verificationGasLimit ${verificationGasLimit} set for the user operation.`,
+                "",
+                "Possible solutions:",
+                "• Verify that the verificationGasLimit set for the user operation is high enough to cover the gas used during smart account and paymaster verification.",
+                "• If you are using the eth_estimateUserOperationGas or pm_sponsorUserOperation method from bundler provider to set user operation gas limits and the EntryPoint throws this error during submission, reach out to them.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type ActualGasCostTooHighErrorType = ActualGasCostTooHighError & {
+    name: "ActualGasCostTooHighError"
+}
+export class ActualGasCostTooHighError extends BaseError {
+    static message = /aa51/
+    override name = "ActualGasCostTooHighError"
+    constructor({
+        cause,
+        docsPath
+    }: {
+        cause?: BaseError
+        docsPath?: string
+    }) {
+        super(
+            [
+                "The actual gas cost of the user operation ended up being higher than the funds paid by the smart account or the paymaster.",
+                "",
+                "Possible solutions:",
+                "• If you encounter this error, try increasing the verificationGasLimit set for the user operation.",
+                "• If you are using the eth_estimateUserOperationGas or pm_sponsorUserOperation method from bundler provider to set user operation gas limits and the EntryPoint throws this error during submission, reach out to them.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type GasValuesOverflowErrorType = GasValuesOverflowError & {
+    name: "GasValuesOverflowError"
+}
+export class GasValuesOverflowError extends BaseError {
+    static message = /aa94/
+    override name = "GasValuesOverflowError"
+    constructor({
+        cause,
+        docsPath
+    }: {
+        cause?: BaseError
+        docsPath?: string
+    }) {
+        super(
+            [
+                "The gas limit values of the user operation overflowed, they must fit in uint160.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type BundlerOutOfGasErrorType = BundlerOutOfGasError & {
+    name: "BundlerOutOfGasError"
+}
+export class BundlerOutOfGasError extends BaseError {
+    static message = /aa95/
+    override name = "BundlerOutOfGasError"
+    constructor({
+        cause,
+        docsPath
+    }: {
+        cause?: BaseError
+        docsPath?: string
+    }) {
+        super(
+            [
+                "The bundler tried to bundle the user operation with the gas limit set too low.",
+                "",
+                "Possible solutions:",
+                "• If you are using your own bundler, configure it send gas limits properly.",
+                "• If you are using a bundler provider, reach out to them.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}

package/errors/index.ts

@@ -0,0 +1,118 @@
+import {
+    InitCodeDidNotDeploySenderError,
+    type InitCodeDidNotDeploySenderErrorType,
+    InitCodeRevertedError,
+    type InitCodeRevertedErrorType,
+    InvalidSmartAccountNonceError,
+    type InvalidSmartAccountNonceErrorType,
+    InvalidSmartAccountSignatureError,
+    type InvalidSmartAccountSignatureErrorType,
+    SenderAddressMismatchError,
+    type SenderAddressMismatchErrorType,
+    SenderAlreadyDeployedError,
+    type SenderAlreadyDeployedErrorType,
+    SenderNotDeployedError,
+    type SenderNotDeployedErrorType,
+    SmartAccountInsufficientFundsError,
+    type SmartAccountInsufficientFundsErrorType,
+    SmartAccountSignatureValidityPeriodError,
+    type SmartAccountSignatureValidityPeriodErrorType,
+    SmartAccountValidationRevertedError,
+    type SmartAccountValidationRevertedErrorType
+} from "./account.js"
+import {
+    EstimateUserOperationGasError,
+    type EstimateUserOperationGasErrorType
+} from "./estimateUserOperationGas.js"
+import {
+    SendUserOperationError,
+    type SendUserOperationErrorType
+} from "./sendUserOperation.js"
+
+import {
+    InvalidPaymasterAndDataError,
+    type InvalidPaymasterAndDataErrorType,
+    PaymasterDataRejectedError,
+    type PaymasterDataRejectedErrorType,
+    PaymasterDepositTooLowError,
+    type PaymasterDepositTooLowErrorType,
+    PaymasterNotDeployedError,
+    type PaymasterNotDeployedErrorType,
+    PaymasterPostOpRevertedError,
+    type PaymasterPostOpRevertedErrorType,
+    PaymasterValidationRevertedError,
+    type PaymasterValidationRevertedErrorType,
+    PaymasterValidityPeriodError,
+    type PaymasterValidityPeriodErrorType
+} from "./paymaster.js"
+
+import {
+    InvalidAggregatorError,
+    type InvalidAggregatorErrorType,
+    InvalidBeneficiaryAddressError,
+    type InvalidBeneficiaryAddressErrorType
+} from "./bundler.js"
+
+import {
+    ActualGasCostTooHighError,
+    type ActualGasCostTooHighErrorType,
+    BundlerOutOfGasError,
+    type BundlerOutOfGasErrorType,
+    GasValuesOverflowError,
+    type GasValuesOverflowErrorType,
+    VerificationGasLimitTooLowError,
+    type VerificationGasLimitTooLowErrorType
+} from "./gas.js"
+
+export {
+    type InitCodeDidNotDeploySenderErrorType,
+    type InitCodeRevertedErrorType,
+    type InvalidSmartAccountNonceErrorType,
+    type InvalidSmartAccountSignatureErrorType,
+    type SenderAddressMismatchErrorType,
+    type SenderAlreadyDeployedErrorType,
+    type SenderNotDeployedErrorType,
+    type SmartAccountInsufficientFundsErrorType,
+    type SmartAccountSignatureValidityPeriodErrorType,
+    type SmartAccountValidationRevertedErrorType,
+    type InvalidPaymasterAndDataErrorType,
+    type PaymasterDataRejectedErrorType,
+    type PaymasterDepositTooLowErrorType,
+    type PaymasterNotDeployedErrorType,
+    type PaymasterPostOpRevertedErrorType,
+    type PaymasterValidationRevertedErrorType,
+    type PaymasterValidityPeriodErrorType,
+    type InvalidAggregatorErrorType,
+    type InvalidBeneficiaryAddressErrorType,
+    type ActualGasCostTooHighErrorType,
+    type BundlerOutOfGasErrorType,
+    type GasValuesOverflowErrorType,
+    type VerificationGasLimitTooLowErrorType,
+    SenderAlreadyDeployedError,
+    EstimateUserOperationGasError,
+    InitCodeRevertedError,
+    SenderAddressMismatchError,
+    InitCodeDidNotDeploySenderError,
+    SenderNotDeployedError,
+    SmartAccountInsufficientFundsError,
+    SmartAccountSignatureValidityPeriodError,
+    SmartAccountValidationRevertedError,
+    InvalidSmartAccountNonceError,
+    PaymasterNotDeployedError,
+    PaymasterDepositTooLowError,
+    InvalidSmartAccountSignatureError,
+    InvalidBeneficiaryAddressError,
+    InvalidAggregatorError,
+    InvalidPaymasterAndDataError,
+    PaymasterDataRejectedError,
+    PaymasterValidityPeriodError,
+    PaymasterValidationRevertedError,
+    VerificationGasLimitTooLowError,
+    ActualGasCostTooHighError,
+    GasValuesOverflowError,
+    BundlerOutOfGasError,
+    PaymasterPostOpRevertedError,
+    SendUserOperationError,
+    type EstimateUserOperationGasErrorType,
+    type SendUserOperationErrorType
+}

package/errors/paymaster.ts

@@ -0,0 +1,257 @@
+import { BaseError, type Hex } from "viem"
+import { getAddressFromInitCodeOrPaymasterAndData } from "../utils/index.js"
+
+export type PaymasterNotDeployedErrorType = PaymasterNotDeployedError & {
+    name: "PaymasterNotDeployedError"
+}
+export class PaymasterNotDeployedError extends BaseError {
+    static message = /aa30/
+    override name = "PaymasterNotDeployedError"
+    constructor({
+        cause,
+        paymasterAndData,
+        docsPath
+    }: {
+        cause?: BaseError
+        paymasterAndData?: Hex
+        docsPath?: string
+    } = {}) {
+        const paymaster = paymasterAndData
+            ? getAddressFromInitCodeOrPaymasterAndData(paymasterAndData)
+            : "0x"
+
+        super(
+            [
+                `Paymaster ${paymaster} is not deployed.`,
+                "",
+                "Possible solutions:",
+                "• Verify that the paymasterAndData field is correct, and that the first 20 bytes are the address of the paymaster contract you intend to use.",
+                "• Verify that the paymaster contract is deployed on the network you are using.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type PaymasterDepositTooLowErrorType = PaymasterDepositTooLowError & {
+    name: "PaymasterDepositTooLowError"
+}
+export class PaymasterDepositTooLowError extends BaseError {
+    static message = /aa31/
+    override name = "PaymasterDepositTooLowError"
+    constructor({
+        cause,
+        paymasterAndData,
+        docsPath
+    }: {
+        cause?: BaseError
+        paymasterAndData?: Hex
+        docsPath?: string
+    } = {}) {
+        const paymaster = paymasterAndData
+            ? getAddressFromInitCodeOrPaymasterAndData(paymasterAndData)
+            : "0x"
+
+        super(
+            [
+                `Paymaster ${paymaster} contract does not have enough funds deposited into the EntryPoint contract to cover the required funds for the user operation.`,
+                "",
+                "Possible solutions:",
+                "• If you are using your own paymaster contract, deposit more funds into the EntryPoint contract through the deposit() function of the paymaster contract.",
+                "• Verify that the paymasterAndData field is correct, and that the first 20 bytes are the address of the paymaster contract you intend to useVerify that the paymasterAndData field is correct, and that the first 20 bytes are the address of the paymaster contract you intend to use.",
+                "• If you are using a paymaster service, reach out to them.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type PaymasterValidityPeriodErrorType = PaymasterValidityPeriodError & {
+    name: "PaymasterValidityPeriodError"
+}
+export class PaymasterValidityPeriodError extends BaseError {
+    static message = /aa32/
+    override name = "PaymasterValidityPeriodError"
+    constructor({
+        cause,
+        paymasterAndData,
+        docsPath
+    }: {
+        cause?: BaseError
+        paymasterAndData?: Hex
+        docsPath?: string
+    }) {
+        const paymaster = paymasterAndData
+            ? getAddressFromInitCodeOrPaymasterAndData(paymasterAndData)
+            : "0x"
+
+        super(
+            [
+                `Paymaster ${paymaster}'s data used in the paymasterAndData field of the user operation is not valid, because it is outside of the time range it specified.`,
+                "",
+                "Possible reasons:",
+                "• This error occurs when the block.timestamp falls after the validUntil timestamp, or before the validAfter timestamp.",
+                "",
+                "Possible solutions:",
+                "• If you are using your own paymaster contract and using time-based signatures, verify that the validAfter and validUntil fields are set correctly and that the user operation is sent within the specified range.",
+                "• If you are using your own paymaster contract and not looking to use time-based signatures, verify that the validAfter and validUntil fields are set to 0.",
+                "• If you are using a service, contact your service provider for their paymaster's validity.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type PaymasterValidationRevertedErrorType =
+    PaymasterValidationRevertedError & {
+        name: "PaymasterValidationRevertedError"
+    }
+export class PaymasterValidationRevertedError extends BaseError {
+    static message = /aa33/
+    override name = "PaymasterValidationRevertedError"
+    constructor({
+        cause,
+        paymasterAndData,
+        docsPath
+    }: {
+        cause?: BaseError
+        paymasterAndData?: Hex
+        docsPath?: string
+    }) {
+        const paymaster = paymasterAndData
+            ? getAddressFromInitCodeOrPaymasterAndData(paymasterAndData)
+            : "0x"
+
+        super(
+            [
+                `The validatePaymasterUserOp function of the paymaster ${paymaster} either reverted or ran out of gas.`,
+                "",
+                "Possible solutions:",
+                "• Verify that the verificationGasLimit is high enough to cover the validatePaymasterUserOp function's gas costs.",
+                "• If you are using your own paymaster contract, verify that the validatePaymasterUserOp function is implemented with the correct logic, and that the user operation is supposed to be valid.",
+                "• If you are using a paymaster service, and the user operation is well formed with a high enough verificationGasLimit, reach out to them.",
+                "• If you are not looking to use a paymaster to cover the gas fees, verify that the paymasterAndData field is not set.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type PaymasterDataRejectedErrorType = PaymasterDataRejectedError & {
+    name: "PaymasterDataRejectedError"
+}
+export class PaymasterDataRejectedError extends BaseError {
+    static message = /aa34/
+    override name = "PaymasterDataRejectedError"
+    constructor({
+        cause,
+        paymasterAndData,
+        docsPath
+    }: {
+        cause?: BaseError
+        paymasterAndData?: Hex
+        docsPath?: string
+    }) {
+        const paymaster = paymasterAndData
+            ? getAddressFromInitCodeOrPaymasterAndData(paymasterAndData)
+            : "0x"
+
+        super(
+            [
+                `The validatePaymasterUserOp function of the paymaster ${paymaster} rejected paymasterAndData.`,
+                "",
+                "Possible solutions:",
+                "• If you are using your own paymaster contract, verify that the user operation was correctly signed according to your implementation, and that the paymaster signature was correctly encoded in the paymasterAndData field of the user operation.",
+                "• If you are using a paymaster service, make sure you do not modify any of the fields of the user operation after the paymaster signs over it (except the signature field).",
+                "• If you are using a paymaster service and you have not modified any of the fields except the signature but you are still getting this error, reach out to them.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type PaymasterPostOpRevertedErrorType = PaymasterPostOpRevertedError & {
+    name: "PaymasterPostOpRevertedError"
+}
+export class PaymasterPostOpRevertedError extends BaseError {
+    static message = /aa50/
+    override name = "PaymasterPostOpRevertedError"
+    constructor({
+        cause,
+        paymasterAndData,
+        docsPath
+    }: {
+        cause?: BaseError
+        paymasterAndData?: Hex
+        docsPath?: string
+    }) {
+        const paymaster = paymasterAndData
+            ? getAddressFromInitCodeOrPaymasterAndData(paymasterAndData)
+            : "0x"
+
+        super(
+            [
+                `The postOp function of the paymaster ${paymaster} reverted.`,
+                "",
+                "Possible solutions:",
+                "• If you are using your own paymaster contract, verify that that you have correctly implemented the postOp function (if you are using one). If you do not intent to make use of the postOp function, make sure you do not set the context parameter in the paymaster's validatePaymasterUserOp function.",
+                "• If you are using a paymaster service and you see this error, reach out to them.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}
+
+export type InvalidPaymasterAndDataErrorType = InvalidPaymasterAndDataError & {
+    name: "InvalidPaymasterAndDataError"
+}
+export class InvalidPaymasterAndDataError extends BaseError {
+    static message = /aa93/
+    override name = "InvalidPaymasterAndDataError"
+    constructor({
+        cause,
+        docsPath
+    }: {
+        cause?: BaseError
+        docsPath?: string
+    }) {
+        super(
+            [
+                "The paymasterAndData field of the user operation is invalid.",
+                "",
+                "Possible solutions:",
+                "• Make sure you have either not set a value for the paymasterAndData, or that it is at least 20 bytes long.",
+                "• If you are using a paymaster service, reach out to them.",
+                "",
+                docsPath ? `Docs: ${docsPath}` : ""
+            ].join("\n"),
+            {
+                cause
+            }
+        )
+    }
+}

package/errors/sendUserOperation.ts

@@ -0,0 +1,49 @@
+import { BaseError } from "viem"
+import { type SendUserOperationParameters } from "../actions/bundler/sendUserOperation.js"
+import { prettyPrint } from "./utils.js"
+
+export type SendUserOperationErrorType = SendUserOperationError & {
+    name: "SendUserOperationError"
+}
+export class SendUserOperationError extends BaseError {
+    override cause: BaseError
+
+    override name = "SendUserOperationError"
+
+    constructor(
+        cause: BaseError,
+        {
+            userOperation,
+            entryPoint,
+            docsPath
+        }: SendUserOperationParameters & {
+            docsPath?: string
+        }
+    ) {
+        const prettyArgs = prettyPrint({
+            sender: userOperation.sender,
+            nonce: userOperation.nonce,
+            initCode: userOperation.initCode,
+            callData: userOperation.callData,
+            callGasLimit: userOperation.callGasLimit,
+            verificationGasLimit: userOperation.verificationGasLimit,
+            preVerificationGas: userOperation.preVerificationGas,
+            maxFeePerGas: userOperation.maxFeePerGas,
+            maxPriorityFeePerGas: userOperation.maxPriorityFeePerGas,
+            paymasterAndData: userOperation.paymasterAndData,
+            signature: userOperation.signature,
+            entryPoint
+        })
+
+        super(cause.shortMessage, {
+            cause,
+            docsPath,
+            metaMessages: [
+                ...(cause.metaMessages ? [...cause.metaMessages, " "] : []),
+                "sendUserOperation Arguments:",
+                prettyArgs
+            ].filter(Boolean) as string[]
+        })
+        this.cause = cause
+    }
+}

package/errors/utils.ts

@@ -0,0 +1,19 @@
+export type ErrorType<name extends string = "Error"> = Error & { name: name }
+
+export function prettyPrint(
+    args: Record<string, bigint | number | string | undefined | false | unknown>
+) {
+    const entries = Object.entries(args)
+        .map(([key, value]) => {
+            if (value === undefined || value === false) return null
+            return [key, value]
+        })
+        .filter(Boolean) as [string, string][]
+    const maxLength = entries.reduce(
+        (acc, [key]) => Math.max(acc, key.length),
+        0
+    )
+    return entries
+        .map(([key, value]) => `  ${`${key}:`.padEnd(maxLength + 1)}  ${value}`)
+        .join("\n")
+}

package/index.ts

@@ -85,3 +85,4 @@ import { getUserOperationHash } from "./utils/getUserOperationHash.js"
 
 export { getUserOperationHash, type GetUserOperationHashParams }
 export * from "./utils/index.js"
+export * from "./errors/index.js"

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "permissionless",
-    "version": "0.0.30",
+    "version": "0.0.32",
     "author": "Pimlico",
     "homepage": "https://docs.pimlico.io/permissionless",
     "repository": "github:pimlicolabs/permissionless.js",
@@ -69,6 +69,11 @@
             "types": "./_types/utils/index.d.ts",
             "import": "./_esm/utils/index.js",
             "default": "./_cjs/utils/index.js"
+        },
+        "./errors": {
+            "types": "./_types/errors/index.d.ts",
+            "import": "./_esm/errors/index.js",
+            "default": "./_cjs/errors/index.js"
         }
     },
     "peerDependencies": {