feat(host-contracts): add support for msgValue in FHE.requestDecryption (#164)

* feat(host-contracts): add support for msgValue in FHE.requestDecryption

* feat(library-solidity): add support for msgValue in FHE.requestDecryption

* refactor(library-solidity): reduce duplicate logic

Author: PacificYield

host-contracts/codegen/main.ts

@@ -3,9 +3,9 @@ import path from 'path';
 
 import { validateFHETypes, validateOperators } from './common';
 import { generateOverloads } from './generateOverloads';
+import { generateSolidityHCULimit } from './hcuLimitGenerator';
 import { ALL_OPERATORS } from './operators';
 import operatorsPrices from './operatorsPrices.json';
-import { generateSolidityHCULimit } from './hcuLimitGenerator';
 import { generateSolidityFHELib, generateSolidityFheType, generateSolidityImplLib } from './templates';
 import {
   generateSolidityOverloadTestFiles,

host-contracts/codegen/templates.ts

@@ -490,7 +490,7 @@ function generateDecryptionOracleInterface(): string {
    * @notice This interface contains the only function required from DecryptionOracle. 
    */
   interface IDecryptionOracle {
-    function requestDecryption(uint256 requestID, bytes32[] calldata ctsHandles, bytes4 callbackSelector) external;
+    function requestDecryption(uint256 requestID, bytes32[] calldata ctsHandles, bytes4 callbackSelector) external payable;
   }
   `;
 }
@@ -1204,12 +1204,24 @@ function generateSolidityDecryptionOracleMethods(fheTypes: AdjustedFheType[]): s
     function requestDecryption(
         bytes32[] memory ctsHandles,
         bytes4 callbackSelector
+    ) internal returns (uint256 requestID) {
+      requestID = requestDecryption(ctsHandles, callbackSelector, 0);
+    }
+
+    /**
+     * @dev     Calls the DecryptionOracle contract to request the decryption of a list of handles, with a custom msgValue.
+     * @notice  Also does the needed call to ACL::allowForDecryption with requested handles.
+     */
+    function requestDecryption(
+        bytes32[] memory ctsHandles,
+        bytes4 callbackSelector,
+        uint256 msgValue
     ) internal returns (uint256 requestID) {
       DecryptionRequestsStruct storage $ = Impl.getDecryptionRequests();
       requestID = $.counterRequest;
       FHEVMConfigStruct storage $$ = Impl.getFHEVMConfig();
       IACL($$.ACLAddress).allowForDecryption(ctsHandles);
-      IDecryptionOracle($.DecryptionOracleAddress).requestDecryption(requestID, ctsHandles, callbackSelector);
+      IDecryptionOracle($.DecryptionOracleAddress).requestDecryption{value: msgValue}(requestID, ctsHandles, callbackSelector);
       saveRequestedHandles(requestID, ctsHandles);
       $.counterRequest++;
     }

host-contracts/lib/FHE.sol

@@ -44,7 +44,11 @@ interface IKMSVerifier {
  * @notice This interface contains the only function required from DecryptionOracle.
  */
 interface IDecryptionOracle {
-    function requestDecryption(uint256 requestID, bytes32[] calldata ctsHandles, bytes4 callbackSelector) external;
+    function requestDecryption(
+        uint256 requestID,
+        bytes32[] calldata ctsHandles,
+        bytes4 callbackSelector
+    ) external payable;
 }
 
 /**
@@ -9442,12 +9446,28 @@ library FHE {
     function requestDecryption(
         bytes32[] memory ctsHandles,
         bytes4 callbackSelector
+    ) internal returns (uint256 requestID) {
+        requestID = requestDecryption(ctsHandles, callbackSelector, 0);
+    }
+
+    /**
+     * @dev     Calls the DecryptionOracle contract to request the decryption of a list of handles, with a custom msgValue.
+     * @notice  Also does the needed call to ACL::allowForDecryption with requested handles.
+     */
+    function requestDecryption(
+        bytes32[] memory ctsHandles,
+        bytes4 callbackSelector,
+        uint256 msgValue
     ) internal returns (uint256 requestID) {
         DecryptionRequestsStruct storage $ = Impl.getDecryptionRequests();
         requestID = $.counterRequest;
         FHEVMConfigStruct storage $$ = Impl.getFHEVMConfig();
         IACL($$.ACLAddress).allowForDecryption(ctsHandles);
-        IDecryptionOracle($.DecryptionOracleAddress).requestDecryption(requestID, ctsHandles, callbackSelector);
+        IDecryptionOracle($.DecryptionOracleAddress).requestDecryption{value: msgValue}(
+            requestID,
+            ctsHandles,
+            callbackSelector
+        );
         saveRequestedHandles(requestID, ctsHandles);
         $.counterRequest++;
     }

library-solidity/codegen/templates.ts

@@ -490,7 +490,7 @@ function generateDecryptionOracleInterface(): string {
    * @notice This interface contains the only function required from DecryptionOracle. 
    */
   interface IDecryptionOracle {
-    function requestDecryption(uint256 requestID, bytes32[] calldata ctsHandles, bytes4 callbackSelector) external;
+    function requestDecryption(uint256 requestID, bytes32[] calldata ctsHandles, bytes4 callbackSelector) external payable;
   }
   `;
 }
@@ -1204,12 +1204,24 @@ function generateSolidityDecryptionOracleMethods(fheTypes: AdjustedFheType[]): s
     function requestDecryption(
         bytes32[] memory ctsHandles,
         bytes4 callbackSelector
+    ) internal returns (uint256 requestID) {
+      requestID = requestDecryption(ctsHandles, callbackSelector, 0);
+    }
+
+    /**
+     * @dev     Calls the DecryptionOracle contract to request the decryption of a list of handles, with a custom msgValue.
+     * @notice  Also does the needed call to ACL::allowForDecryption with requested handles.
+     */
+    function requestDecryption(
+        bytes32[] memory ctsHandles,
+        bytes4 callbackSelector,
+        uint256 msgValue
     ) internal returns (uint256 requestID) {
       DecryptionRequestsStruct storage $ = Impl.getDecryptionRequests();
       requestID = $.counterRequest;
       FHEVMConfigStruct storage $$ = Impl.getFHEVMConfig();
       IACL($$.ACLAddress).allowForDecryption(ctsHandles);
-      IDecryptionOracle($.DecryptionOracleAddress).requestDecryption(requestID, ctsHandles, callbackSelector);
+      IDecryptionOracle($.DecryptionOracleAddress).requestDecryption{value: msgValue}(requestID, ctsHandles, callbackSelector);
       saveRequestedHandles(requestID, ctsHandles);
       $.counterRequest++;
     }

library-solidity/lib/FHE.sol

@@ -44,7 +44,11 @@ interface IKMSVerifier {
  * @notice This interface contains the only function required from DecryptionOracle.
  */
 interface IDecryptionOracle {
-    function requestDecryption(uint256 requestID, bytes32[] calldata ctsHandles, bytes4 callbackSelector) external;
+    function requestDecryption(
+        uint256 requestID,
+        bytes32[] calldata ctsHandles,
+        bytes4 callbackSelector
+    ) external payable;
 }
 
 /**
@@ -9442,12 +9446,28 @@ library FHE {
     function requestDecryption(
         bytes32[] memory ctsHandles,
         bytes4 callbackSelector
+    ) internal returns (uint256 requestID) {
+        requestID = requestDecryption(ctsHandles, callbackSelector, 0);
+    }
+
+    /**
+     * @dev     Calls the DecryptionOracle contract to request the decryption of a list of handles, with a custom msgValue.
+     * @notice  Also does the needed call to ACL::allowForDecryption with requested handles.
+     */
+    function requestDecryption(
+        bytes32[] memory ctsHandles,
+        bytes4 callbackSelector,
+        uint256 msgValue
     ) internal returns (uint256 requestID) {
         DecryptionRequestsStruct storage $ = Impl.getDecryptionRequests();
         requestID = $.counterRequest;
         FHEVMConfigStruct storage $$ = Impl.getFHEVMConfig();
         IACL($$.ACLAddress).allowForDecryption(ctsHandles);
-        IDecryptionOracle($.DecryptionOracleAddress).requestDecryption(requestID, ctsHandles, callbackSelector);
+        IDecryptionOracle($.DecryptionOracleAddress).requestDecryption{value: msgValue}(
+            requestID,
+            ctsHandles,
+            callbackSelector
+        );
         saveRequestedHandles(requestID, ctsHandles);
         $.counterRequest++;
     }