@safe-global/relay-kit 3.4.1-alpha.0 → 3.4.1

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

@@ -0,0 +1,190 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSignatureBytes = exports.addDummySignature = exports.DUMMY_AUTHENTICATOR_DATA = exports.DUMMY_CLIENT_DATA_FIELDS = exports.userOperationToHexValues = exports.calculateSafeUserOperationHash = exports.encodeMultiSendCallData = exports.signSafeOp = exports.getEip4337BundlerProvider = void 0;
+const viem_1 = require("viem");
+const types_kit_1 = require("@safe-global/types-kit");
+const protocol_kit_1 = require("@safe-global/protocol-kit");
+const constants_1 = require("./constants");
+/**
+ * Gets the EIP-4337 bundler provider.
+ *
+ * @param {string} bundlerUrl The EIP-4337 bundler URL.
+ * @return {BundlerClient} The EIP-4337 bundler provider.
+ */
+function getEip4337BundlerProvider(bundlerUrl) {
+    const provider = (0, viem_1.createPublicClient)({
+        transport: (0, viem_1.http)(bundlerUrl),
+        rpcSchema: (0, viem_1.rpcSchema)()
+    });
+    return provider;
+}
+exports.getEip4337BundlerProvider = getEip4337BundlerProvider;
+/**
+ * Signs typed data.
+ *
+ * @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.
+ */
+async function signSafeOp(safeUserOperation, safeProvider, safe4337ModuleAddress) {
+    const signer = await safeProvider.getExternalSigner();
+    if (!signer) {
+        throw new Error('No signer found');
+    }
+    const chainId = await safeProvider.getChainId();
+    const signerAddress = signer.account.address;
+    const signature = await signer.signTypedData({
+        domain: {
+            chainId: Number(chainId),
+            verifyingContract: safe4337ModuleAddress
+        },
+        types: constants_1.EIP712_SAFE_OPERATION_TYPE,
+        message: {
+            ...safeUserOperation,
+            nonce: (0, viem_1.toHex)(safeUserOperation.nonce),
+            validAfter: (0, viem_1.toHex)(safeUserOperation.validAfter),
+            validUntil: (0, viem_1.toHex)(safeUserOperation.validUntil),
+            maxFeePerGas: (0, viem_1.toHex)(safeUserOperation.maxFeePerGas),
+            maxPriorityFeePerGas: (0, viem_1.toHex)(safeUserOperation.maxPriorityFeePerGas)
+        },
+        primaryType: 'SafeOp'
+    });
+    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 (0, viem_1.encodeFunctionData)({
+        abi: constants_1.ABI,
+        functionName: 'multiSend',
+        args: [
+            (0, protocol_kit_1.encodeMultiSendData)(transactions.map((tx) => ({ ...tx, operation: tx.operation ?? types_kit_1.OperationType.Call })))
+        ]
+    });
+}
+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 (0, viem_1.hashTypedData)({
+        domain: {
+            chainId: Number(chainId),
+            verifyingContract: safe4337ModuleAddress
+        },
+        types: constants_1.EIP712_SAFE_OPERATION_TYPE,
+        primaryType: 'SafeOp',
+        message: safeUserOperation
+    });
+}
+exports.calculateSafeUserOperationHash = calculateSafeUserOperationHash;
+/**
+ * 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: (0, viem_1.toHex)(userOperation.nonce),
+        callGasLimit: (0, viem_1.toHex)(userOperation.callGasLimit),
+        verificationGasLimit: (0, viem_1.toHex)(userOperation.verificationGasLimit),
+        preVerificationGas: (0, viem_1.toHex)(userOperation.preVerificationGas),
+        maxFeePerGas: (0, viem_1.toHex)(userOperation.maxFeePerGas),
+        maxPriorityFeePerGas: (0, viem_1.toHex)(userOperation.maxPriorityFeePerGas)
+    };
+    return userOperationWithHexValues;
+}
+exports.userOperationToHexValues = userOperationToHexValues;
+/**
+ * Passkey Dummy client data JSON fields. This can be used for gas estimations, as it pads the fields enough
+ * to account for variations in WebAuthn implementations.
+ */
+exports.DUMMY_CLIENT_DATA_FIELDS = [
+    `"origin":"https://safe.global"`,
+    `"padding":"This pads the clientDataJSON so that we can leave room for additional implementation specific fields for a more accurate 'preVerificationGas' estimate."`
+].join(',');
+/**
+ * Dummy authenticator data. This can be used for gas estimations, as it ensures that the correct
+ * authenticator flags are set.
+ */
+exports.DUMMY_AUTHENTICATOR_DATA = new Uint8Array(37);
+// Authenticator data is the concatenation of:
+// - 32 byte SHA-256 hash of the relying party ID
+// - 1 byte for the user verification flag
+// - 4 bytes for the signature count
+// We fill it all with `0xfe` and set the appropriate user verification flag.
+exports.DUMMY_AUTHENTICATOR_DATA.fill(0xfe);
+exports.DUMMY_AUTHENTICATOR_DATA[32] = 0x04;
+/**
+ * This method creates a dummy signature for the SafeOperation based on the Safe threshold. We assume that all owners are passkeys
+ * This is useful for gas estimations
+ * @param userOperation - The user operation
+ * @param signer - The signer
+ * @param threshold - The Safe threshold
+ * @returns The user operation with the dummy passkey signature
+ */
+function addDummySignature(userOperation, signer, threshold) {
+    const signatures = [];
+    for (let i = 0; i < threshold; i++) {
+        const isContractSignature = true;
+        const passkeySignature = getSignatureBytes({
+            authenticatorData: exports.DUMMY_AUTHENTICATOR_DATA,
+            clientDataFields: exports.DUMMY_CLIENT_DATA_FIELDS,
+            r: BigInt(`0x${'ec'.repeat(32)}`),
+            s: BigInt(`0x${'d5a'.repeat(21)}f`)
+        });
+        signatures.push(new protocol_kit_1.EthSafeSignature(signer, passkeySignature, isContractSignature));
+    }
+    return {
+        ...userOperation,
+        signature: (0, viem_1.encodePacked)(['uint48', 'uint48', 'bytes'], [0, 0, (0, protocol_kit_1.buildSignatureBytes)(signatures)])
+    };
+}
+exports.addDummySignature = addDummySignature;
+/**
+ * Encodes the given WebAuthn signature into a string. This computes the ABI-encoded signature parameters:
+ * ```solidity
+ * abi.encode(authenticatorData, clientDataFields, r, s);
+ * ```
+ *
+ * @param authenticatorData - The authenticator data as a Uint8Array.
+ * @param clientDataFields - The client data fields as a string.
+ * @param r - The value of r as a bigint.
+ * @param s - The value of s as a bigint.
+ * @returns The encoded string.
+ */
+function getSignatureBytes({ authenticatorData, clientDataFields, r, s }) {
+    // Helper functions
+    // Convert a number to a 64-byte hex string with padded upto Hex string with 32 bytes
+    const encodeUint256 = (x) => x.toString(16).padStart(64, '0');
+    // Calculate the byte size of the dynamic data along with the length parameter alligned to 32 bytes
+    const byteSize = (data) => 32 * (Math.ceil(data.length / 32) + 1); // +1 is for the length parameter
+    // Encode dynamic data padded with zeros if necessary in 32 bytes chunks
+    const encodeBytes = (data) => `${encodeUint256(data.length)}${(0, viem_1.toHex)(data).slice(2)}`.padEnd(byteSize(data) * 2, '0');
+    // authenticatorData starts after the first four words.
+    const authenticatorDataOffset = 32 * 4;
+    // clientDataFields starts immediately after the authenticator data.
+    const clientDataFieldsOffset = authenticatorDataOffset + byteSize(authenticatorData);
+    return ('0x' +
+        encodeUint256(authenticatorDataOffset) +
+        encodeUint256(clientDataFieldsOffset) +
+        encodeUint256(r) +
+        encodeUint256(s) +
+        encodeBytes(authenticatorData) +
+        encodeBytes(new TextEncoder().encode(clientDataFields)));
+}
+exports.getSignatureBytes = getSignatureBytes;
+//# 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,+BASa;AACb,sDAM+B;AAC/B,4DAKkC;AAClC,2CAA6D;AAG7D;;;;;GAKG;AACH,SAAgB,yBAAyB,CAAC,UAAkB;IAC1D,MAAM,QAAQ,GAAG,IAAA,yBAAkB,EAAC;QAClC,SAAS,EAAE,IAAA,WAAI,EAAC,UAAU,CAAC;QAC3B,SAAS,EAAE,IAAA,gBAAS,GAA+B;KACpD,CAAC,CAAA;IAEF,OAAO,QAAQ,CAAA;AACjB,CAAC;AAPD,8DAOC;AAED;;;;;;;GAOG;AACI,KAAK,UAAU,UAAU,CAC9B,iBAAoC,EACpC,YAA0B,EAC1B,qBAA6B;IAE7B,MAAM,MAAM,GAAG,MAAM,YAAY,CAAC,iBAAiB,EAAE,CAAA;IAErD,IAAI,CAAC,MAAM,EAAE,CAAC;QACZ,MAAM,IAAI,KAAK,CAAC,iBAAiB,CAAC,CAAA;IACpC,CAAC;IAED,MAAM,OAAO,GAAG,MAAM,YAAY,CAAC,UAAU,EAAE,CAAA;IAC/C,MAAM,aAAa,GAAG,MAAM,CAAC,OAAO,CAAC,OAAO,CAAA;IAC5C,MAAM,SAAS,GAAG,MAAM,MAAM,CAAC,aAAa,CAAC;QAC3C,MAAM,EAAE;YACN,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;YACxB,iBAAiB,EAAE,qBAAqB;SACzC;QACD,KAAK,EAAE,sCAA0B;QACjC,OAAO,EAAE;YACP,GAAG,iBAAiB;YACpB,KAAK,EAAE,IAAA,YAAK,EAAC,iBAAiB,CAAC,KAAK,CAAC;YACrC,UAAU,EAAE,IAAA,YAAK,EAAC,iBAAiB,CAAC,UAAU,CAAC;YAC/C,UAAU,EAAE,IAAA,YAAK,EAAC,iBAAiB,CAAC,UAAU,CAAC;YAC/C,YAAY,EAAE,IAAA,YAAK,EAAC,iBAAiB,CAAC,YAAY,CAAC;YACnD,oBAAoB,EAAE,IAAA,YAAK,EAAC,iBAAiB,CAAC,oBAAoB,CAAC;SACpE;QACD,WAAW,EAAE,QAAQ;KACtB,CAAC,CAAA;IAEF,OAAO,IAAI,+BAAgB,CAAC,aAAa,EAAE,SAAS,CAAC,CAAA;AACvD,CAAC;AA/BD,gCA+BC;AAED;;;;;GAKG;AACH,SAAgB,uBAAuB,CAAC,YAAmC;IACzE,OAAO,IAAA,yBAAkB,EAAC;QACxB,GAAG,EAAE,eAAG;QACR,YAAY,EAAE,WAAW;QACzB,IAAI,EAAE;YACJ,IAAA,kCAAmB,EACjB,YAAY,CAAC,GAAG,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,GAAG,EAAE,EAAE,SAAS,EAAE,EAAE,CAAC,SAAS,IAAI,yBAAa,CAAC,IAAI,EAAE,CAAC,CAAC,CAC9E;SACT;KACF,CAAC,CAAA;AACJ,CAAC;AAVD,0DAUC;AAED;;;;;;;GAOG;AACH,SAAgB,8BAA8B,CAC5C,iBAAoC,EACpC,OAAe,EACf,qBAA6B;IAE7B,OAAO,IAAA,oBAAa,EAAC;QACnB,MAAM,EAAE;YACN,OAAO,EAAE,MAAM,CAAC,OAAO,CAAC;YACxB,iBAAiB,EAAE,qBAAqB;SACzC;QACD,KAAK,EAAE,sCAA0B;QACjC,WAAW,EAAE,QAAQ;QACrB,OAAO,EAAE,iBAAiB;KAC3B,CAAC,CAAA;AACJ,CAAC;AAdD,wEAcC;AAED;;;;;GAKG;AACH,SAAgB,wBAAwB,CAAC,aAA4B;IACnE,MAAM,0BAA0B,GAAG;QACjC,GAAG,aAAa;QAChB,KAAK,EAAE,IAAA,YAAK,EAAC,aAAa,CAAC,KAAK,CAAC;QACjC,YAAY,EAAE,IAAA,YAAK,EAAC,aAAa,CAAC,YAAY,CAAC;QAC/C,oBAAoB,EAAE,IAAA,YAAK,EAAC,aAAa,CAAC,oBAAoB,CAAC;QAC/D,kBAAkB,EAAE,IAAA,YAAK,EAAC,aAAa,CAAC,kBAAkB,CAAC;QAC3D,YAAY,EAAE,IAAA,YAAK,EAAC,aAAa,CAAC,YAAY,CAAC;QAC/C,oBAAoB,EAAE,IAAA,YAAK,EAAC,aAAa,CAAC,oBAAoB,CAAC;KAChE,CAAA;IAED,OAAO,0BAA0B,CAAA;AACnC,CAAC;AAZD,4DAYC;AAED;;;GAGG;AACU,QAAA,wBAAwB,GAAG;IACtC,gCAAgC;IAChC,qKAAqK;CACtK,CAAC,IAAI,CAAC,GAAG,CAAC,CAAA;AAEX;;;GAGG;AACU,QAAA,wBAAwB,GAAG,IAAI,UAAU,CAAC,EAAE,CAAC,CAAA;AAC1D,8CAA8C;AAC9C,iDAAiD;AACjD,0CAA0C;AAC1C,oCAAoC;AACpC,6EAA6E;AAC7E,gCAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;AACnC,gCAAwB,CAAC,EAAE,CAAC,GAAG,IAAI,CAAA;AAEnC;;;;;;;GAOG;AACH,SAAgB,iBAAiB,CAC/B,aAA4B,EAC5B,MAAc,EACd,SAAiB;IAEjB,MAAM,UAAU,GAAG,EAAE,CAAA;IAErB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,SAAS,EAAE,CAAC,EAAE,EAAE,CAAC;QACnC,MAAM,mBAAmB,GAAG,IAAI,CAAA;QAChC,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;YACzC,iBAAiB,EAAE,gCAAwB;YAC3C,gBAAgB,EAAE,gCAAwB;YAC1C,CAAC,EAAE,MAAM,CAAC,KAAK,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC,EAAE,CAAC;YACjC,CAAC,EAAE,MAAM,CAAC,KAAK,KAAK,CAAC,MAAM,CAAC,EAAE,CAAC,GAAG,CAAC;SACpC,CAAC,CAAA;QAEF,UAAU,CAAC,IAAI,CAAC,IAAI,+BAAgB,CAAC,MAAM,EAAE,gBAAgB,EAAE,mBAAmB,CAAC,CAAC,CAAA;IACtF,CAAC;IAED,OAAO;QACL,GAAG,aAAa;QAChB,SAAS,EAAE,IAAA,mBAAY,EACrB,CAAC,QAAQ,EAAE,QAAQ,EAAE,OAAO,CAAC,EAC7B,CAAC,CAAC,EAAE,CAAC,EAAE,IAAA,kCAAmB,EAAC,UAAU,CAAQ,CAAC,CAC/C;KACF,CAAA;AACH,CAAC;AA1BD,8CA0BC;AAED;;;;;;;;;;;GAWG;AACH,SAAgB,iBAAiB,CAAC,EAChC,iBAAiB,EACjB,gBAAgB,EAChB,CAAC,EACD,CAAC,EAMF;IACC,mBAAmB;IACnB,qFAAqF;IACrF,MAAM,aAAa,GAAG,CAAC,CAAkB,EAAE,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,CAAC,CAAA;IAC9E,mGAAmG;IACnG,MAAM,QAAQ,GAAG,CAAC,IAAgB,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,CAAA,CAAC,iCAAiC;IAC/G,wEAAwE;IACxE,MAAM,WAAW,GAAG,CAAC,IAAgB,EAAE,EAAE,CACvC,GAAG,aAAa,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,IAAA,YAAK,EAAC,IAAI,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,GAAG,CAAC,CAAA;IAExF,uDAAuD;IACvD,MAAM,uBAAuB,GAAG,EAAE,GAAG,CAAC,CAAA;IACtC,oEAAoE;IACpE,MAAM,sBAAsB,GAAG,uBAAuB,GAAG,QAAQ,CAAC,iBAAiB,CAAC,CAAA;IAEpF,OAAO,CACL,IAAI;QACJ,aAAa,CAAC,uBAAuB,CAAC;QACtC,aAAa,CAAC,sBAAsB,CAAC;QACrC,aAAa,CAAC,CAAC,CAAC;QAChB,aAAa,CAAC,CAAC,CAAC;QAChB,WAAW,CAAC,iBAAiB,CAAC;QAC9B,WAAW,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CACxD,CAAA;AACH,CAAC;AAlCD,8CAkCC"}