@zama-fhe/relayer-sdk 0.2.0-2 → 0.2.0-4

package/lib/node.cjs

@@ -616,6 +616,7 @@ function checkDeadlineValidity(startTimestamp, durationDays) {
     }
 }
 const userDecryptRequest = (kmsSigners, gatewayChainId, chainId, verifyingContractAddress, aclContractAddress, relayerUrl, provider, options) => async (_handles, privateKey, publicKey, signature, contractAddresses, userAddress, startTimestamp, durationDays) => {
+    const extraData = '0x00';
     let pubKey;
     let privKey;
     try {
@@ -671,6 +672,7 @@ const userDecryptRequest = (kmsSigners, gatewayChainId, chainId, verifyingContra
         userAddress: getAddress$1(userAddress),
         signature: signatureSanitized,
         publicKey: publicKeySanitized,
+        extraData,
     };
     const json = await fetchRelayerJsonRpcPost('USER_DECRYPT', `${relayerUrl}/v1/user-decrypt`, payloadForRequest, options);
     // assume the KMS Signers have the correct order
@@ -1007,6 +1009,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
             return input.getBits();
         },
         encrypt: async (options) => {
+            const extraData = '0x00';
             const bits = input.getBits();
             const ciphertext = input.encrypt();
             const payload = {
@@ -1014,6 +1017,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                 userAddress: getAddress(userAddress),
                 ciphertextWithInputVerification: toHexString(ciphertext),
                 contractChainId: ('0x' + chainId.toString(16)),
+                extraData,
             };
             const json = await fetchRelayerJsonRpcPost('INPUT_PROOF', `${relayerUrl}/v1/input-proof`, payload, options);
             if (!isFhevmRelayerInputProofResponse(json)) {
@@ -1050,6 +1054,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                     { name: 'userAddress', type: 'address' },
                     { name: 'contractAddress', type: 'address' },
                     { name: 'contractChainId', type: 'uint256' },
+                    { name: 'extraData', type: 'bytes' },
                 ],
             };
             const recoveredAddresses = signatures.map((signature) => {
@@ -1059,6 +1064,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                     userAddress,
                     contractAddress,
                     contractChainId: chainId,
+                    extraData,
                 }, sig);
                 return recoveredAddress;
             });
@@ -1073,6 +1079,8 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
             const listHandlesStr = handles.map((i) => toHexString(i));
             listHandlesStr.map((handle) => (inputProof += handle));
             signatures.map((signature) => (inputProof += signature.slice(2))); // removes the '0x' prefix from the `signature` string
+            // Append the extra data to the input proof
+            inputProof += extraData.slice(2);
             return {
                 handles,
                 inputProof: fromHexString(inputProof),
@@ -1134,6 +1142,7 @@ function deserializeDecryptedResult(handles, decryptedResult) {
     return results;
 }
 const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, verifyingContractAddress, aclContractAddress, relayerUrl, provider, options) => async (_handles) => {
+    const extraData = '0x00';
     const acl = new ethers.ethers.Contract(aclContractAddress, aclABI, provider);
     let handles;
     try {
@@ -1155,6 +1164,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
     checkEncryptedBits(handles);
     const payloadForRequest = {
         ciphertextHandles: handles,
+        extraData,
     };
     const json = await fetchRelayerJsonRpcPost('PUBLIC_DECRYPT', `${relayerUrl}/v1/public-decrypt`, payloadForRequest, options);
     // verify signatures on decryption:
@@ -1168,6 +1178,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
         PublicDecryptVerification: [
             { name: 'ctHandles', type: 'bytes32[]' },
             { name: 'decryptedResult', type: 'bytes' },
+            { name: 'extraData', type: 'bytes' },
         ],
     };
     const result = json.response[0];
@@ -1177,7 +1188,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
     const signatures = result.signatures;
     const recoveredAddresses = signatures.map((signature) => {
         const sig = signature.startsWith('0x') ? signature : `0x${signature}`;
-        const recoveredAddress = ethers.ethers.verifyTypedData(domain, types, { ctHandles: handles, decryptedResult }, sig);
+        const recoveredAddress = ethers.ethers.verifyTypedData(domain, types, { ctHandles: handles, decryptedResult, extraData }, sig);
         return recoveredAddress;
     });
     const thresholdReached = isThresholdReached(kmsSigners, recoveredAddresses, thresholdSigners);
@@ -1198,9 +1209,11 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
  * @param contractsChainId - The chain ID where the contracts are deployed
  * @param startTimestamp - The timestamp when the decryption permission becomes valid
  * @param durationDays - How many days the decryption permission remains valid
+ * @param delegatedAccount - Optional delegated account address
  * @returns EIP712 typed data structure for user decryption
  */
 const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contractAddresses, startTimestamp, durationDays, delegatedAccount) => {
+    const extraData = '0x00';
     if (delegatedAccount && !ethers.isAddress(delegatedAccount))
         throw new Error('Invalid delegated account.');
     if (!ethers.isAddress(verifyingContract)) {
@@ -1242,6 +1255,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                     { name: 'contractsChainId', type: 'uint256' },
                     { name: 'startTimestamp', type: 'uint256' },
                     { name: 'durationDays', type: 'uint256' },
+                    { name: 'extraData', type: 'bytes' },
                     {
                         name: 'delegatedAccount',
                         type: 'address',
@@ -1256,6 +1270,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                 contractsChainId,
                 startTimestamp: formattedStartTimestamp,
                 durationDays: formattedDurationDays,
+                extraData,
                 delegatedAccount: delegatedAccount,
             },
         };
@@ -1269,6 +1284,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                 { name: 'contractsChainId', type: 'uint256' },
                 { name: 'startTimestamp', type: 'uint256' },
                 { name: 'durationDays', type: 'uint256' },
+                { name: 'extraData', type: 'bytes' },
             ],
         },
         primaryType: 'UserDecryptRequestVerification',
@@ -1279,6 +1295,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
             contractsChainId,
             startTimestamp: formattedStartTimestamp,
             durationDays: formattedDurationDays,
+            extraData,
         },
     };
 };

package/lib/node.d.ts

@@ -13,6 +13,7 @@ import { TfheCompactPublicKey } from 'node-tfhe';
  * @param contractsChainId - The chain ID where the contracts are deployed
  * @param startTimestamp - The timestamp when the decryption permission becomes valid
  * @param durationDays - How many days the decryption permission remains valid
+ * @param delegatedAccount - Optional delegated account address
  * @returns EIP712 typed data structure for user decryption
  */
 export declare const createEIP712: (verifyingContract: string, contractsChainId: number) => (publicKey: string | Uint8Array, contractAddresses: string[], startTimestamp: string | number, durationDays: string | number, delegatedAccount?: string) => EIP712;

package/lib/node.js

@@ -595,6 +595,7 @@ function checkDeadlineValidity(startTimestamp, durationDays) {
     }
 }
 const userDecryptRequest = (kmsSigners, gatewayChainId, chainId, verifyingContractAddress, aclContractAddress, relayerUrl, provider, options) => async (_handles, privateKey, publicKey, signature, contractAddresses, userAddress, startTimestamp, durationDays) => {
+    const extraData = '0x00';
     let pubKey;
     let privKey;
     try {
@@ -650,6 +651,7 @@ const userDecryptRequest = (kmsSigners, gatewayChainId, chainId, verifyingContra
         userAddress: getAddress$1(userAddress),
         signature: signatureSanitized,
         publicKey: publicKeySanitized,
+        extraData,
     };
     const json = await fetchRelayerJsonRpcPost('USER_DECRYPT', `${relayerUrl}/v1/user-decrypt`, payloadForRequest, options);
     // assume the KMS Signers have the correct order
@@ -986,6 +988,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
             return input.getBits();
         },
         encrypt: async (options) => {
+            const extraData = '0x00';
             const bits = input.getBits();
             const ciphertext = input.encrypt();
             const payload = {
@@ -993,6 +996,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                 userAddress: getAddress(userAddress),
                 ciphertextWithInputVerification: toHexString(ciphertext),
                 contractChainId: ('0x' + chainId.toString(16)),
+                extraData,
             };
             const json = await fetchRelayerJsonRpcPost('INPUT_PROOF', `${relayerUrl}/v1/input-proof`, payload, options);
             if (!isFhevmRelayerInputProofResponse(json)) {
@@ -1029,6 +1033,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                     { name: 'userAddress', type: 'address' },
                     { name: 'contractAddress', type: 'address' },
                     { name: 'contractChainId', type: 'uint256' },
+                    { name: 'extraData', type: 'bytes' },
                 ],
             };
             const recoveredAddresses = signatures.map((signature) => {
@@ -1038,6 +1043,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                     userAddress,
                     contractAddress,
                     contractChainId: chainId,
+                    extraData,
                 }, sig);
                 return recoveredAddress;
             });
@@ -1052,6 +1058,8 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
             const listHandlesStr = handles.map((i) => toHexString(i));
             listHandlesStr.map((handle) => (inputProof += handle));
             signatures.map((signature) => (inputProof += signature.slice(2))); // removes the '0x' prefix from the `signature` string
+            // Append the extra data to the input proof
+            inputProof += extraData.slice(2);
             return {
                 handles,
                 inputProof: fromHexString(inputProof),
@@ -1113,6 +1121,7 @@ function deserializeDecryptedResult(handles, decryptedResult) {
     return results;
 }
 const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, verifyingContractAddress, aclContractAddress, relayerUrl, provider, options) => async (_handles) => {
+    const extraData = '0x00';
     const acl = new ethers.Contract(aclContractAddress, aclABI, provider);
     let handles;
     try {
@@ -1134,6 +1143,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
     checkEncryptedBits(handles);
     const payloadForRequest = {
         ciphertextHandles: handles,
+        extraData,
     };
     const json = await fetchRelayerJsonRpcPost('PUBLIC_DECRYPT', `${relayerUrl}/v1/public-decrypt`, payloadForRequest, options);
     // verify signatures on decryption:
@@ -1147,6 +1157,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
         PublicDecryptVerification: [
             { name: 'ctHandles', type: 'bytes32[]' },
             { name: 'decryptedResult', type: 'bytes' },
+            { name: 'extraData', type: 'bytes' },
         ],
     };
     const result = json.response[0];
@@ -1156,7 +1167,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
     const signatures = result.signatures;
     const recoveredAddresses = signatures.map((signature) => {
         const sig = signature.startsWith('0x') ? signature : `0x${signature}`;
-        const recoveredAddress = ethers.verifyTypedData(domain, types, { ctHandles: handles, decryptedResult }, sig);
+        const recoveredAddress = ethers.verifyTypedData(domain, types, { ctHandles: handles, decryptedResult, extraData }, sig);
         return recoveredAddress;
     });
     const thresholdReached = isThresholdReached(kmsSigners, recoveredAddresses, thresholdSigners);
@@ -1177,9 +1188,11 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
  * @param contractsChainId - The chain ID where the contracts are deployed
  * @param startTimestamp - The timestamp when the decryption permission becomes valid
  * @param durationDays - How many days the decryption permission remains valid
+ * @param delegatedAccount - Optional delegated account address
  * @returns EIP712 typed data structure for user decryption
  */
 const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contractAddresses, startTimestamp, durationDays, delegatedAccount) => {
+    const extraData = '0x00';
     if (delegatedAccount && !isAddress(delegatedAccount))
         throw new Error('Invalid delegated account.');
     if (!isAddress(verifyingContract)) {
@@ -1221,6 +1234,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                     { name: 'contractsChainId', type: 'uint256' },
                     { name: 'startTimestamp', type: 'uint256' },
                     { name: 'durationDays', type: 'uint256' },
+                    { name: 'extraData', type: 'bytes' },
                     {
                         name: 'delegatedAccount',
                         type: 'address',
@@ -1235,6 +1249,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                 contractsChainId,
                 startTimestamp: formattedStartTimestamp,
                 durationDays: formattedDurationDays,
+                extraData,
                 delegatedAccount: delegatedAccount,
             },
         };
@@ -1248,6 +1263,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                 { name: 'contractsChainId', type: 'uint256' },
                 { name: 'startTimestamp', type: 'uint256' },
                 { name: 'durationDays', type: 'uint256' },
+                { name: 'extraData', type: 'bytes' },
             ],
         },
         primaryType: 'UserDecryptRequestVerification',
@@ -1258,6 +1274,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
             contractsChainId,
             startTimestamp: formattedStartTimestamp,
             durationDays: formattedDurationDays,
+            extraData,
         },
     };
 };

package/lib/web.d.ts

@@ -12,6 +12,7 @@ import { InitInput as TFHEInput } from 'tfhe';
  * @param contractsChainId - The chain ID where the contracts are deployed
  * @param startTimestamp - The timestamp when the decryption permission becomes valid
  * @param durationDays - How many days the decryption permission remains valid
+ * @param delegatedAccount - Optional delegated account address
  * @returns EIP712 typed data structure for user decryption
  */
 export declare const createEIP712: (verifyingContract: string, contractsChainId: number) => (publicKey: string | Uint8Array, contractAddresses: string[], startTimestamp: string | number, durationDays: string | number, delegatedAccount?: string) => EIP712;

package/lib/web.js

@@ -16704,6 +16704,7 @@ function checkDeadlineValidity(startTimestamp, durationDays) {
     }
 }
 const userDecryptRequest = (kmsSigners, gatewayChainId, chainId, verifyingContractAddress, aclContractAddress, relayerUrl, provider, options) => async (_handles, privateKey, publicKey, signature, contractAddresses, userAddress, startTimestamp, durationDays) => {
+    const extraData = '0x00';
     let pubKey;
     let privKey;
     try {
@@ -16759,6 +16760,7 @@ const userDecryptRequest = (kmsSigners, gatewayChainId, chainId, verifyingContra
         userAddress: getAddress$1(userAddress),
         signature: signatureSanitized,
         publicKey: publicKeySanitized,
+        extraData,
     };
     const json = await fetchRelayerJsonRpcPost('USER_DECRYPT', `${relayerUrl}/v1/user-decrypt`, payloadForRequest, options);
     // assume the KMS Signers have the correct order
@@ -17095,6 +17097,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
             return input.getBits();
         },
         encrypt: async (options) => {
+            const extraData = '0x00';
             const bits = input.getBits();
             const ciphertext = input.encrypt();
             const payload = {
@@ -17102,6 +17105,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                 userAddress: getAddress(userAddress),
                 ciphertextWithInputVerification: toHexString(ciphertext),
                 contractChainId: ('0x' + chainId.toString(16)),
+                extraData,
             };
             const json = await fetchRelayerJsonRpcPost('INPUT_PROOF', `${relayerUrl}/v1/input-proof`, payload, options);
             if (!isFhevmRelayerInputProofResponse(json)) {
@@ -17138,6 +17142,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                     { name: 'userAddress', type: 'address' },
                     { name: 'contractAddress', type: 'address' },
                     { name: 'contractChainId', type: 'uint256' },
+                    { name: 'extraData', type: 'bytes' },
                 ],
             };
             const recoveredAddresses = signatures.map((signature) => {
@@ -17147,6 +17152,7 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
                     userAddress,
                     contractAddress,
                     contractChainId: chainId,
+                    extraData,
                 }, sig);
                 return recoveredAddress;
             });
@@ -17161,6 +17167,8 @@ const createRelayerEncryptedInput = (aclContractAddress, verifyingContractAddres
             const listHandlesStr = handles.map((i) => toHexString(i));
             listHandlesStr.map((handle) => (inputProof += handle));
             signatures.map((signature) => (inputProof += signature.slice(2))); // removes the '0x' prefix from the `signature` string
+            // Append the extra data to the input proof
+            inputProof += extraData.slice(2);
             return {
                 handles,
                 inputProof: fromHexString(inputProof),
@@ -17222,6 +17230,7 @@ function deserializeDecryptedResult(handles, decryptedResult) {
     return results;
 }
 const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, verifyingContractAddress, aclContractAddress, relayerUrl, provider, options) => async (_handles) => {
+    const extraData = '0x00';
     const acl = new ethers.Contract(aclContractAddress, aclABI, provider);
     let handles;
     try {
@@ -17243,6 +17252,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
     checkEncryptedBits(handles);
     const payloadForRequest = {
         ciphertextHandles: handles,
+        extraData,
     };
     const json = await fetchRelayerJsonRpcPost('PUBLIC_DECRYPT', `${relayerUrl}/v1/public-decrypt`, payloadForRequest, options);
     // verify signatures on decryption:
@@ -17256,6 +17266,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
         PublicDecryptVerification: [
             { name: 'ctHandles', type: 'bytes32[]' },
             { name: 'decryptedResult', type: 'bytes' },
+            { name: 'extraData', type: 'bytes' },
         ],
     };
     const result = json.response[0];
@@ -17265,7 +17276,7 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
     const signatures = result.signatures;
     const recoveredAddresses = signatures.map((signature) => {
         const sig = signature.startsWith('0x') ? signature : `0x${signature}`;
-        const recoveredAddress = ethers.verifyTypedData(domain, types, { ctHandles: handles, decryptedResult }, sig);
+        const recoveredAddress = ethers.verifyTypedData(domain, types, { ctHandles: handles, decryptedResult, extraData }, sig);
         return recoveredAddress;
     });
     const thresholdReached = isThresholdReached(kmsSigners, recoveredAddresses, thresholdSigners);
@@ -17286,9 +17297,11 @@ const publicDecryptRequest = (kmsSigners, thresholdSigners, gatewayChainId, veri
  * @param contractsChainId - The chain ID where the contracts are deployed
  * @param startTimestamp - The timestamp when the decryption permission becomes valid
  * @param durationDays - How many days the decryption permission remains valid
+ * @param delegatedAccount - Optional delegated account address
  * @returns EIP712 typed data structure for user decryption
  */
 const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contractAddresses, startTimestamp, durationDays, delegatedAccount) => {
+    const extraData = '0x00';
     if (delegatedAccount && !isAddress(delegatedAccount))
         throw new Error('Invalid delegated account.');
     if (!isAddress(verifyingContract)) {
@@ -17330,6 +17343,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                     { name: 'contractsChainId', type: 'uint256' },
                     { name: 'startTimestamp', type: 'uint256' },
                     { name: 'durationDays', type: 'uint256' },
+                    { name: 'extraData', type: 'bytes' },
                     {
                         name: 'delegatedAccount',
                         type: 'address',
@@ -17344,6 +17358,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                 contractsChainId,
                 startTimestamp: formattedStartTimestamp,
                 durationDays: formattedDurationDays,
+                extraData,
                 delegatedAccount: delegatedAccount,
             },
         };
@@ -17357,6 +17372,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
                 { name: 'contractsChainId', type: 'uint256' },
                 { name: 'startTimestamp', type: 'uint256' },
                 { name: 'durationDays', type: 'uint256' },
+                { name: 'extraData', type: 'bytes' },
             ],
         },
         primaryType: 'UserDecryptRequestVerification',
@@ -17367,6 +17383,7 @@ const createEIP712 = (verifyingContract, contractsChainId) => (publicKey, contra
             contractsChainId,
             startTimestamp: formattedStartTimestamp,
             durationDays: formattedDurationDays,
+            extraData,
         },
     };
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zama-fhe/relayer-sdk",
-  "version": "0.2.0-2",
+  "version": "0.2.0-4",
   "description": "fhevm Relayer SDK",
   "main": "lib/node.js",
   "types": "lib/node.d.ts",
@@ -64,8 +64,8 @@
     "wasm-feature-detect": "^1.8.0",
     "node-tfhe": "1.3.0",
     "tfhe": "1.3.0",
-    "node-tkms": "0.11.0-23",
-    "tkms": "0.11.0-23"
+    "node-tkms": "0.11.0-24",
+    "tkms": "0.11.0-24"
   },
   "devDependencies": {
     "@fetch-mock/jest": "0.2.16",