@safe-global/relay-kit 2.0.3 → 2.1.0

package/dist/src/packs/safe-4337/types.d.ts

@@ -0,0 +1,158 @@
+import Safe, { EthersAdapter } from '@safe-global/protocol-kit';
+import { MetaTransactionData, SafeVersion } from '@safe-global/safe-core-sdk-types';
+import { ethers } from 'ethers';
+import SafeOperation from './SafeOperation';
+type ExistingSafeOptions = {
+    safeAddress: string;
+};
+type PredictedSafeOptions = {
+    owners: string[];
+    threshold: number;
+    safeVersion?: SafeVersion;
+    saltNonce?: string;
+};
+export type PaymasterOptions = {
+    paymasterUrl?: string;
+    isSponsored?: boolean;
+    sponsorshipPolicyId?: string;
+    paymasterAddress: string;
+    paymasterTokenAddress?: string;
+    amountToApprove?: bigint;
+};
+export type Safe4337InitOptions = {
+    ethersAdapter: EthersAdapter;
+    bundlerUrl: string;
+    rpcUrl: string;
+    safeModulesVersion?: string;
+    customContracts?: {
+        entryPointAddress?: string;
+        safe4337ModuleAddress?: string;
+        addModulesLibAddress?: string;
+    };
+    options: ExistingSafeOptions | PredictedSafeOptions;
+    paymasterOptions?: PaymasterOptions;
+};
+export type Safe4337Options = {
+    protocolKit: Safe;
+    bundlerUrl: string;
+    paymasterOptions?: PaymasterOptions;
+    bundlerClient: ethers.JsonRpcProvider;
+    publicClient: ethers.JsonRpcProvider;
+    entryPointAddress: string;
+    safe4337ModuleAddress: string;
+};
+export type Safe4337CreateTransactionProps = {
+    transactions: MetaTransactionData[];
+    options?: {
+        amountToApprove?: bigint;
+        validUntil?: number;
+        validAfter?: number;
+        feeEstimator?: IFeeEstimator;
+    };
+};
+export type Safe4337ExecutableProps = {
+    executable: SafeOperation;
+};
+export type SafeUserOperation = {
+    safe: string;
+    nonce: bigint;
+    initCode: string;
+    callData: string;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    paymasterAndData: string;
+    validAfter: number;
+    validUntil: number;
+    entryPoint: string;
+};
+export type UserOperation = {
+    sender: string;
+    nonce: string;
+    initCode: string;
+    callData: string;
+    callGasLimit: bigint;
+    verificationGasLimit: bigint;
+    preVerificationGas: bigint;
+    maxFeePerGas: bigint;
+    maxPriorityFeePerGas: bigint;
+    paymasterAndData: string;
+    signature: string;
+};
+export type EstimateGasData = {
+    maxFeePerGas?: bigint;
+    maxPriorityFeePerGas?: bigint;
+    preVerificationGas?: bigint;
+    verificationGasLimit?: bigint;
+    callGasLimit?: bigint;
+};
+export type EstimateSponsoredGasData = {
+    paymasterAndData: string;
+} & EstimateGasData;
+type Log = {
+    logIndex: string;
+    transactionIndex: string;
+    transactionHash: string;
+    blockHash: string;
+    blockNumber: string;
+    address: string;
+    data: string;
+    topics: string[];
+};
+type Receipt = {
+    transactionHash: string;
+    transactionIndex: string;
+    blockHash: string;
+    blockNumber: string;
+    from: string;
+    to: string;
+    cumulativeGasUsed: string;
+    gasUsed: string;
+    contractAddress: null;
+    logs: Log[];
+    logsBloom: string;
+    status: string;
+    effectiveGasPrice: string;
+};
+export type UserOperationReceipt = {
+    userOpHash: string;
+    sender: string;
+    nonce: string;
+    actualGasUsed: string;
+    actualGasCost: string;
+    success: boolean;
+    logs: Log[];
+    receipt: Receipt;
+};
+export type UserOperationWithPayload = {
+    userOperation: UserOperation;
+    entryPoint: string;
+    transactionHash: string;
+    blockHash: string;
+    blockNumber: string;
+};
+export type EstimateFeeFunctionProps = {
+    userOperation: UserOperation;
+    bundlerUrl: string;
+    entryPoint: string;
+};
+export type EstimateFeeFunction = ({ userOperation, bundlerUrl, entryPoint }: EstimateFeeFunctionProps) => Promise<EstimateGasData>;
+export type EstimateSponsoredFeeFunctionProps = {
+    userOperation: UserOperation;
+    paymasterUrl: string;
+    entryPoint: string;
+    sponsorshipPolicyId?: string;
+};
+export type EstimateSponsoredFeeFunction = ({ userOperation, paymasterUrl, entryPoint }: EstimateSponsoredFeeFunctionProps) => Promise<EstimateSponsoredGasData>;
+export interface IFeeEstimator {
+    setupEstimation?: EstimateFeeFunction;
+    adjustEstimation?: EstimateFeeFunction;
+    getPaymasterEstimation?: EstimateSponsoredFeeFunction;
+}
+export type EstimateFeeProps = {
+    safeOperation: SafeOperation;
+    feeEstimator?: IFeeEstimator;
+};
+export {};

package/dist/src/{types.js.map → packs/safe-4337/types.js.map}

@@ -1 +1 @@
-{"version":3,"file":"types.js","sourceRoot":"","sources":["../../src/types.ts"],"names":[],"mappings":""}
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../../src/packs/safe-4337/types.ts"],"names":[],"mappings":""}

package/dist/src/packs/safe-4337/utils.d.ts

@@ -0,0 +1,35 @@
+import { ethers } from 'ethers';
+import { UserOperation } from './types';
+/**
+ * Gets the EIP-4337 bundler provider.
+ *
+ * @param {string} bundlerUrl The EIP-4337 bundler URL.
+ * @return {Provider} The EIP-4337 bundler provider.
+ */
+export declare function getEip4337BundlerProvider(bundlerUrl: string): ethers.JsonRpcProvider;
+/**
+ * Gets the EIP-1193 provider from the bundler url.
+ *
+ * @param {string} rpcUrl The RPC URL.
+ * @return {Provider} The EIP-1193 provider.
+ */
+export declare function getEip1193Provider(rpcUrl: string): ethers.JsonRpcProvider;
+/**
+ * Converts various bigint values from a UserOperation to their hexadecimal representation.
+ *
+ * @param {UserOperation} userOperation - The UserOperation object whose values are to be converted.
+ * @returns {UserOperation} A new UserOperation object with the values converted to hexadecimal.
+ */
+export declare function userOperationToHexValues(userOperation: UserOperation): {
+    nonce: string;
+    callGasLimit: string;
+    verificationGasLimit: string;
+    preVerificationGas: string;
+    maxFeePerGas: string;
+    maxPriorityFeePerGas: string;
+    sender: string;
+    initCode: string;
+    callData: string;
+    paymasterAndData: string;
+    signature: string;
+};

package/dist/src/packs/safe-4337/utils.js

@@ -0,0 +1,50 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.userOperationToHexValues = exports.getEip1193Provider = exports.getEip4337BundlerProvider = void 0;
+const ethers_1 = require("ethers");
+/**
+ * Gets the EIP-4337 bundler provider.
+ *
+ * @param {string} bundlerUrl The EIP-4337 bundler URL.
+ * @return {Provider} The EIP-4337 bundler provider.
+ */
+function getEip4337BundlerProvider(bundlerUrl) {
+    const provider = new ethers_1.ethers.JsonRpcProvider(bundlerUrl, undefined, {
+        batchMaxCount: 1
+    });
+    return provider;
+}
+exports.getEip4337BundlerProvider = getEip4337BundlerProvider;
+/**
+ * Gets the EIP-1193 provider from the bundler url.
+ *
+ * @param {string} rpcUrl The RPC URL.
+ * @return {Provider} The EIP-1193 provider.
+ */
+function getEip1193Provider(rpcUrl) {
+    const provider = new ethers_1.ethers.JsonRpcProvider(rpcUrl, undefined, {
+        batchMaxCount: 1
+    });
+    return provider;
+}
+exports.getEip1193Provider = getEip1193Provider;
+/**
+ * Converts various bigint values from a UserOperation to their hexadecimal representation.
+ *
+ * @param {UserOperation} userOperation - The UserOperation object whose values are to be converted.
+ * @returns {UserOperation} A new UserOperation object with the values converted to hexadecimal.
+ */
+function userOperationToHexValues(userOperation) {
+    const userOperationWithHexValues = {
+        ...userOperation,
+        nonce: ethers_1.ethers.toBeHex(userOperation.nonce),
+        callGasLimit: ethers_1.ethers.toBeHex(userOperation.callGasLimit),
+        verificationGasLimit: ethers_1.ethers.toBeHex(userOperation.verificationGasLimit),
+        preVerificationGas: ethers_1.ethers.toBeHex(userOperation.preVerificationGas),
+        maxFeePerGas: ethers_1.ethers.toBeHex(userOperation.maxFeePerGas),
+        maxPriorityFeePerGas: ethers_1.ethers.toBeHex(userOperation.maxPriorityFeePerGas)
+    };
+    return userOperationWithHexValues;
+}
+exports.userOperationToHexValues = userOperationToHexValues;
+//# sourceMappingURL=utils.js.map

package/dist/src/packs/safe-4337/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/packs/safe-4337/utils.ts"],"names":[],"mappings":";;;AAAA,mCAA+B;AAG/B;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,UAAkB;IAC1D,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,eAAe,CAAC,UAAU,EAAE,SAAS,EAAE;QACjE,aAAa,EAAE,CAAC;KACjB,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAA;AACjB,CAAC;AAND,8DAMC;AAED;;;;;GAKG;AACH,SAAgB,kBAAkB,CAAC,MAAc;IAC/C,MAAM,QAAQ,GAAG,IAAI,eAAM,CAAC,eAAe,CAAC,MAAM,EAAE,SAAS,EAAE;QAC7D,aAAa,EAAE,CAAC;KACjB,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAA;AACjB,CAAC;AAND,gDAMC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,aAA4B;IACnE,MAAM,0BAA0B,GAAG;QACjC,GAAG,aAAa;QAChB,KAAK,EAAE,eAAM,CAAC,OAAO,CAAC,aAAa,CAAC,KAAK,CAAC;QAC1C,YAAY,EAAE,eAAM,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC;QACxD,oBAAoB,EAAE,eAAM,CAAC,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC;QACxE,kBAAkB,EAAE,eAAM,CAAC,OAAO,CAAC,aAAa,CAAC,kBAAkB,CAAC;QACpE,YAAY,EAAE,eAAM,CAAC,OAAO,CAAC,aAAa,CAAC,YAAY,CAAC;QACxD,oBAAoB,EAAE,eAAM,CAAC,OAAO,CAAC,aAAa,CAAC,oBAAoB,CAAC;KACzE,CAAA;IAED,OAAO,0BAA0B,CAAA;AACnC,CAAC;AAZD,4DAYC"}