@safe-global/relay-kit 3.0.0 → 3.0.2

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

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isEntryPointV6 = exports.entryPointToSafeModules = exports.sameString = exports.EQ_OR_GT_0_3_0 = void 0;
+const constants_1 = require("../constants");
+const EQ_0_2_0 = '0.2.0';
+exports.EQ_OR_GT_0_3_0 = '>=0.3.0';
+function sameString(str1, str2) {
+    return str1.toLowerCase() === str2.toLowerCase();
+}
+exports.sameString = sameString;
+function entryPointToSafeModules(entryPoint) {
+    const moduleVersionToEntryPoint = {
+        [constants_1.ENTRYPOINT_ADDRESS_V06]: EQ_0_2_0,
+        [constants_1.ENTRYPOINT_ADDRESS_V07]: exports.EQ_OR_GT_0_3_0
+    };
+    return moduleVersionToEntryPoint[entryPoint];
+}
+exports.entryPointToSafeModules = entryPointToSafeModules;
+function isEntryPointV6(address) {
+    return sameString(address, constants_1.ENTRYPOINT_ADDRESS_V06);
+}
+exports.isEntryPointV6 = isEntryPointV6;
+//# sourceMappingURL=entrypoint.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entrypoint.js","sourceRoot":"","sources":["../../../../../src/packs/safe-4337/utils/entrypoint.ts"],"names":[],"mappings":";;;AAAA,4CAA6E;AAE7E,MAAM,QAAQ,GAAG,OAAO,CAAA;AAEX,QAAA,cAAc,GAAG,SAAS,CAAA;AAEvC,SAAgB,UAAU,CAAC,IAAY,EAAE,IAAY;IACnD,OAAO,IAAI,CAAC,WAAW,EAAE,KAAK,IAAI,CAAC,WAAW,EAAE,CAAA;AAClD,CAAC;AAFD,gCAEC;AAED,SAAgB,uBAAuB,CAAC,UAAkB;IACxD,MAAM,yBAAyB,GAA2B;QACxD,CAAC,kCAAsB,CAAC,EAAE,QAAQ;QAClC,CAAC,kCAAsB,CAAC,EAAE,sBAAc;KACzC,CAAA;IAED,OAAO,yBAAyB,CAAC,UAAU,CAAC,CAAA;AAC9C,CAAC;AAPD,0DAOC;AAED,SAAgB,cAAc,CAAC,OAAe;IAC5C,OAAO,UAAU,CAAC,OAAO,EAAE,kCAAsB,CAAC,CAAA;AACpD,CAAC;AAFD,wCAEC"}

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

@@ -1,5 +1,6 @@
+import { SafeUserOperation, MetaTransactionData, SafeSignature, UserOperation } from '@safe-global/safe-core-sdk-types';
+import { SafeProvider } from '@safe-global/protocol-kit';
 import { ethers } from 'ethers';
-import { UserOperation } from '@safe-global/safe-core-sdk-types';
 /**
  * Gets the EIP-4337 bundler provider.
  *
@@ -8,12 +9,30 @@ import { UserOperation } from '@safe-global/safe-core-sdk-types';
  */
 export declare function getEip4337BundlerProvider(bundlerUrl: string): ethers.JsonRpcProvider;
 /**
- * Gets the EIP-1193 provider from the bundler url.
+ * Signs typed data.
  *
- * @param {string} rpcUrl The RPC URL.
- * @return {Provider} The EIP-1193 provider.
+ * @param {SafeUserOperation} safeUserOperation - Safe user operation to sign.
+ * @param {SafeProvider} safeProvider - Safe provider.
+ * @param {string} safe4337ModuleAddress - Safe 4337 module address.
+ * @return {Promise<SafeSignature>} The SafeSignature object containing the data and the signatures.
  */
-export declare function getEip1193Provider(rpcUrl: string): ethers.JsonRpcProvider;
+export declare function signSafeOp(safeUserOperation: SafeUserOperation, safeProvider: SafeProvider, safe4337ModuleAddress: string): Promise<SafeSignature>;
+/**
+ * Encodes multi-send data from transactions batch.
+ *
+ * @param {MetaTransactionData[]} transactions - an array of transaction to to be encoded.
+ * @return {string} The encoded data string.
+ */
+export declare function encodeMultiSendCallData(transactions: MetaTransactionData[]): string;
+/**
+ * Gets the safe user operation hash.
+ *
+ * @param {SafeUserOperation} safeUserOperation - The SafeUserOperation.
+ * @param {bigint} chainId - The chain id.
+ * @param {string} safe4337ModuleAddress - The Safe 4337 module address.
+ * @return {string} The hash of the safe operation.
+ */
+export declare function calculateSafeUserOperationHash(safeUserOperation: SafeUserOperation, chainId: bigint, safe4337ModuleAddress: string): string;
 /**
  * Converts various bigint values from a UserOperation to their hexadecimal representation.
  *
@@ -33,3 +52,11 @@ export declare function userOperationToHexValues(userOperation: UserOperation):
     paymasterAndData: string;
     signature: string;
 };
+/**
+ * This method creates a dummy signature for the SafeOperation based the owners.
+ * This is useful for gas estimations
+ * @param userOperation - The user operation
+ * @param safeOwners - The safe owner addresses
+ * @returns The user operation with the dummy signature
+ */
+export declare function addDummySignature(userOperation: UserOperation, safeOwners: string[]): UserOperation;

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

@@ -1,7 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.userOperationToHexValues = exports.getEip1193Provider = exports.getEip4337BundlerProvider = void 0;
+exports.addDummySignature = exports.userOperationToHexValues = exports.calculateSafeUserOperationHash = exports.encodeMultiSendCallData = exports.signSafeOp = exports.getEip4337BundlerProvider = void 0;
+const safe_core_sdk_types_1 = require("@safe-global/safe-core-sdk-types");
+const protocol_kit_1 = require("@safe-global/protocol-kit");
 const ethers_1 = require("ethers");
+const constants_1 = require("./constants");
 /**
  * Gets the EIP-4337 bundler provider.
  *
@@ -16,18 +19,58 @@ function getEip4337BundlerProvider(bundlerUrl) {
 }
 exports.getEip4337BundlerProvider = getEip4337BundlerProvider;
 /**
- * Gets the EIP-1193 provider from the bundler url.
+ * Signs typed data.
  *
- * @param {string} rpcUrl The RPC URL.
- * @return {Provider} The EIP-1193 provider.
+ * @param {SafeUserOperation} safeUserOperation - Safe user operation to sign.
+ * @param {SafeProvider} safeProvider - Safe provider.
+ * @param {string} safe4337ModuleAddress - Safe 4337 module address.
+ * @return {Promise<SafeSignature>} The SafeSignature object containing the data and the signatures.
  */
-function getEip1193Provider(rpcUrl) {
-    const provider = new ethers_1.ethers.JsonRpcProvider(rpcUrl, undefined, {
-        batchMaxCount: 1
+async function signSafeOp(safeUserOperation, safeProvider, safe4337ModuleAddress) {
+    const signer = (await safeProvider.getExternalSigner());
+    const chainId = await safeProvider.getChainId();
+    const signerAddress = await signer.getAddress();
+    const signature = await signer.signTypedData({
+        chainId,
+        verifyingContract: safe4337ModuleAddress
+    }, constants_1.EIP712_SAFE_OPERATION_TYPE, {
+        ...safeUserOperation,
+        nonce: ethers_1.ethers.toBeHex(safeUserOperation.nonce),
+        validAfter: ethers_1.ethers.toBeHex(safeUserOperation.validAfter),
+        validUntil: ethers_1.ethers.toBeHex(safeUserOperation.validUntil),
+        maxFeePerGas: ethers_1.ethers.toBeHex(safeUserOperation.maxFeePerGas),
+        maxPriorityFeePerGas: ethers_1.ethers.toBeHex(safeUserOperation.maxPriorityFeePerGas)
     });
-    return provider;
+    return new protocol_kit_1.EthSafeSignature(signerAddress, signature);
+}
+exports.signSafeOp = signSafeOp;
+/**
+ * Encodes multi-send data from transactions batch.
+ *
+ * @param {MetaTransactionData[]} transactions - an array of transaction to to be encoded.
+ * @return {string} The encoded data string.
+ */
+function encodeMultiSendCallData(transactions) {
+    return constants_1.INTERFACES.encodeFunctionData('multiSend', [
+        (0, protocol_kit_1.encodeMultiSendData)(transactions.map((tx) => ({ ...tx, operation: tx.operation ?? safe_core_sdk_types_1.OperationType.Call })))
+    ]);
 }
-exports.getEip1193Provider = getEip1193Provider;
+exports.encodeMultiSendCallData = encodeMultiSendCallData;
+/**
+ * Gets the safe user operation hash.
+ *
+ * @param {SafeUserOperation} safeUserOperation - The SafeUserOperation.
+ * @param {bigint} chainId - The chain id.
+ * @param {string} safe4337ModuleAddress - The Safe 4337 module address.
+ * @return {string} The hash of the safe operation.
+ */
+function calculateSafeUserOperationHash(safeUserOperation, chainId, safe4337ModuleAddress) {
+    return ethers_1.ethers.TypedDataEncoder.hash({
+        chainId,
+        verifyingContract: safe4337ModuleAddress
+    }, constants_1.EIP712_SAFE_OPERATION_TYPE, safeUserOperation);
+}
+exports.calculateSafeUserOperationHash = calculateSafeUserOperationHash;
 /**
  * Converts various bigint values from a UserOperation to their hexadecimal representation.
  *
@@ -47,4 +90,23 @@ function userOperationToHexValues(userOperation) {
     return userOperationWithHexValues;
 }
 exports.userOperationToHexValues = userOperationToHexValues;
+/**
+ * This method creates a dummy signature for the SafeOperation based the owners.
+ * This is useful for gas estimations
+ * @param userOperation - The user operation
+ * @param safeOwners - The safe owner addresses
+ * @returns The user operation with the dummy signature
+ */
+function addDummySignature(userOperation, safeOwners) {
+    const signatures = [];
+    for (const owner of safeOwners) {
+        const dummySignature = `0x000000000000000000000000${owner.slice(2)}000000000000000000000000000000000000000000000000000000000000000001`;
+        signatures.push(new protocol_kit_1.EthSafeSignature(owner, dummySignature));
+    }
+    return {
+        ...userOperation,
+        signature: ethers_1.ethers.solidityPacked(['uint48', 'uint48', 'bytes'], [0, 0, (0, protocol_kit_1.buildSignatureBytes)(signatures)])
+    };
+}
+exports.addDummySignature = addDummySignature;
 //# sourceMappingURL=utils.js.map

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

@@ -1 +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"}
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../../src/packs/safe-4337/utils.ts"],"names":[],"mappings":";;;AAAA,0EAMyC;AACzC,4DAKkC;AAClC,mCAA+B;AAC/B,2CAAoE;AAEpE;;;;;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;;;;;;;GAOG;AACI,KAAK,UAAU,UAAU,CAC9B,iBAAoC,EACpC,YAA0B,EAC1B,qBAA6B;IAE7B,MAAM,MAAM,GAAG,CAAC,MAAM,YAAY,CAAC,iBAAiB,EAAE,CAAkB,CAAA;IACxE,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,CAAA;IAC/C,MAAM,aAAa,GAAG,MAAM,MAAM,CAAC,UAAU,EAAE,CAAA;IAC/C,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,aAAa,CAC1C;QACE,OAAO;QACP,iBAAiB,EAAE,qBAAqB;KACzC,EACD,sCAA0B,EAC1B;QACE,GAAG,iBAAiB;QACpB,KAAK,EAAE,eAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,KAAK,CAAC;QAC9C,UAAU,EAAE,eAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC;QACxD,UAAU,EAAE,eAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,UAAU,CAAC;QACxD,YAAY,EAAE,eAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,YAAY,CAAC;QAC5D,oBAAoB,EAAE,eAAM,CAAC,OAAO,CAAC,iBAAiB,CAAC,oBAAoB,CAAC;KAC7E,CACF,CAAA;IAED,OAAO,IAAI,+BAAgB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;AACvD,CAAC;AAzBD,gCAyBC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,YAAmC;IACzE,OAAO,sBAAU,CAAC,kBAAkB,CAAC,WAAW,EAAE;QAChD,IAAA,kCAAmB,EACjB,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,IAAI,mCAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CACrF;KACF,CAAC,CAAA;AACJ,CAAC;AAND,0DAMC;AAED;;;;;;;GAOG;AACH,SAAgB,8BAA8B,CAC5C,iBAAoC,EACpC,OAAe,EACf,qBAA6B;IAE7B,OAAO,eAAM,CAAC,gBAAgB,CAAC,IAAI,CACjC;QACE,OAAO;QACP,iBAAiB,EAAE,qBAAqB;KACzC,EACD,sCAA0B,EAC1B,iBAAiB,CAClB,CAAA;AACH,CAAC;AAbD,wEAaC;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;AAED;;;;;;GAMG;AACH,SAAgB,iBAAiB,CAC/B,aAA4B,EAC5B,UAAoB;IAEpB,MAAM,UAAU,GAAG,EAAE,CAAA;IAErB,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;QAC/B,MAAM,cAAc,GAAG,6BAA6B,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,oEAAoE,CAAA;QACtI,UAAU,CAAC,IAAI,CAAC,IAAI,+BAAgB,CAAC,KAAK,EAAE,cAAc,CAAC,CAAC,CAAA;IAC9D,CAAC;IAED,OAAO;QACL,GAAG,aAAa;QAChB,SAAS,EAAE,eAAM,CAAC,cAAc,CAC9B,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,IAAA,kCAAmB,EAAC,UAAU,CAAC,CAAC,CACxC;KACF,CAAA;AACH,CAAC;AAlBD,8CAkBC"}