chore(gateway-contracts): rename keygenThreshold to kmsGenThreshold

Author: melanciani

gateway-contracts/.env.example

@@ -29,8 +29,8 @@ MPC_THRESHOLD="1" # (uint256)
 PUBLIC_DECRYPTION_THRESHOLD="3" # (uint256)
 USER_DECRYPTION_THRESHOLD="3" # (uint256)
 
-# Key and CRS generation responses threshold
-KEYGEN_THRESHOLD="3" # (uint256)
+# KMS public material (FHE key, CRS) generation responses threshold
+KMS_GENERATION_THRESHOLD="3" # (uint256)
 
 # KMS Nodes
 # The number of KMS nodes must be lower or equal to the number of KMS nodes' metadata defined below

gateway-contracts/contracts/GatewayConfig.sol

@@ -114,8 +114,8 @@ contract GatewayConfig is IGatewayConfig, Ownable2StepUpgradeable, UUPSUpgradeab
         mapping(address custodianSignerAddress => bool isCustodianSigner) _isCustodianSigner;
         /// @notice The KMS nodes' metadata (V2)
         mapping(address kmsTxSenderAddress => KmsNodeV2 kmsNodeV2) kmsNodesV2;
-        /// @notice The threshold to consider for key and CRS generation consensus.
-        uint256 keygenThreshold;
+        /// @notice The threshold to consider for the KMS public material (FHE key, CRS) generation consensus.
+        uint256 kmsGenThreshold;
     }
 
     /// @dev Storage location has been computed using the following command:
@@ -146,7 +146,7 @@ contract GatewayConfig is IGatewayConfig, Ownable2StepUpgradeable, UUPSUpgradeab
         uint256 initialMpcThreshold,
         uint256 initialPublicDecryptionThreshold,
         uint256 initialUserDecryptionThreshold,
-        uint256 initialKeygenThreshold,
+        uint256 initialKmsGenThreshold,
         KmsNodeV2[] memory initialKmsNodes,
         Coprocessor[] memory initialCoprocessors,
         Custodian[] memory initialCustodians
@@ -190,7 +190,7 @@ contract GatewayConfig is IGatewayConfig, Ownable2StepUpgradeable, UUPSUpgradeab
         _setMpcThreshold(initialMpcThreshold);
         _setPublicDecryptionThreshold(initialPublicDecryptionThreshold);
         _setUserDecryptionThreshold(initialUserDecryptionThreshold);
-        _setKeygenThreshold(initialKeygenThreshold);
+        _setKmsGenThreshold(initialKmsGenThreshold);
 
         /// @dev Register the coprocessors
         for (uint256 i = 0; i < initialCoprocessors.length; i++) {
@@ -227,7 +227,7 @@ contract GatewayConfig is IGatewayConfig, Ownable2StepUpgradeable, UUPSUpgradeab
     /// @custom:oz-upgrades-validate-as-initializer
     function reinitializeV3(
         V3UpgradeInput[] memory v3UpgradeInputs,
-        uint256 keygenThreshold
+        uint256 kmsGenThreshold
     ) public virtual reinitializer(REINITIALIZER_VERSION) {
         GatewayConfigStorage storage $ = _getGatewayConfigStorage();
 
@@ -264,7 +264,7 @@ contract GatewayConfig is IGatewayConfig, Ownable2StepUpgradeable, UUPSUpgradeab
 
         /// @dev Setting the threshold should be done after the KMS nodes have been registered as the functions
         /// @dev reading the `kmsSignerAddresses` array.
-        _setKeygenThreshold(keygenThreshold);
+        _setKmsGenThreshold(kmsGenThreshold);
 
         emit ReinitializeGatewayConfigV3(kmsNodesV1, kmsNodesV2);
     }
@@ -297,10 +297,10 @@ contract GatewayConfig is IGatewayConfig, Ownable2StepUpgradeable, UUPSUpgradeab
         emit UpdateUserDecryptionThreshold(newUserDecryptionThreshold);
     }
 
-    /// @dev See {IGatewayConfig-updateKeygenThreshold}.
-    function updateKeygenThreshold(uint256 newKeygenThreshold) external virtual onlyOwner {
-        _setKeygenThreshold(newKeygenThreshold);
-        emit UpdateKeygenThreshold(newKeygenThreshold);
+    /// @dev See {IGatewayConfig-updateKmsGenThreshold}.
+    function updateKmsGenThreshold(uint256 newKmsGenThreshold) external virtual onlyOwner {
+        _setKmsGenThreshold(newKmsGenThreshold);
+        emit UpdateKmsGenThreshold(newKmsGenThreshold);
     }
 
     /// @dev See {IGatewayConfig-addHostChain}.
@@ -429,10 +429,10 @@ contract GatewayConfig is IGatewayConfig, Ownable2StepUpgradeable, UUPSUpgradeab
         return $.userDecryptionThreshold;
     }
 
-    /// @dev See {IGatewayConfig-getKeygenThreshold}.
-    function getKeygenThreshold() external view virtual returns (uint256) {
+    /// @dev See {IGatewayConfig-getKmsGenThreshold}.
+    function getKmsGenThreshold() external view virtual returns (uint256) {
         GatewayConfigStorage storage $ = _getGatewayConfigStorage();
-        return $.keygenThreshold;
+        return $.kmsGenThreshold;
     }
 
     /// @dev See {IGatewayConfig-getCoprocessorMajorityThreshold}.
@@ -585,23 +585,23 @@ contract GatewayConfig is IGatewayConfig, Ownable2StepUpgradeable, UUPSUpgradeab
 
     /**
      * @dev Sets the key and CRS generation threshold.
-     * @param newKeygenThreshold The new key and CRS generation threshold.
+     * @param newKmsGenThreshold The new key and CRS generation threshold.
      */
-    function _setKeygenThreshold(uint256 newKeygenThreshold) internal virtual {
+    function _setKmsGenThreshold(uint256 newKmsGenThreshold) internal virtual {
         GatewayConfigStorage storage $ = _getGatewayConfigStorage();
         uint256 nKmsNodes = $.kmsSignerAddresses.length;
 
         /// @dev Check that the key and CRS generation threshold `t` is valid. It must verify:
         /// @dev - `t >= 1` : the key and CRS generation consensus should require at least one vote
         /// @dev - `t <= n` : it should be less than the number of registered KMS nodes
-        if (newKeygenThreshold == 0) {
-            revert InvalidNullKeygenThreshold();
+        if (newKmsGenThreshold == 0) {
+            revert InvalidNullKmsGenThreshold();
         }
-        if (newKeygenThreshold > nKmsNodes) {
-            revert InvalidHighKeygenThreshold(newKeygenThreshold, nKmsNodes);
+        if (newKmsGenThreshold > nKmsNodes) {
+            revert InvalidHighKmsGenThreshold(newKmsGenThreshold, nKmsNodes);
         }
 
-        $.keygenThreshold = newKeygenThreshold;
+        $.kmsGenThreshold = newKmsGenThreshold;
     }
 
     /**

gateway-contracts/contracts/KMSManagement.sol

@@ -561,7 +561,7 @@ contract KMSManagement is
      * @return Whether the consensus is reached
      */
     function _isKmsConsensusReached(uint256 kmsCounter) internal view virtual returns (bool) {
-        uint256 consensusThreshold = GATEWAY_CONFIG.getKeygenThreshold();
+        uint256 consensusThreshold = GATEWAY_CONFIG.getKmsGenThreshold();
         return kmsCounter >= consensusThreshold;
     }
 

gateway-contracts/contracts/examples/GatewayConfigV3Example.sol

@@ -47,7 +47,7 @@ contract GatewayConfigV3Example is Ownable2StepUpgradeable, UUPSUpgradeable, Pau
         mapping(address custodianTxSenderAddress => bool isCustodianTxSender) _isCustodianTxSender;
         mapping(address custodianSignerAddress => bool isCustodianSigner) _isCustodianSigner;
         mapping(address kmsTxSenderAddress => KmsNodeV2 kmsNodeV2) kmsNodesV2;
-        uint256 keygenThreshold;
+        uint256 kmsGenThreshold;
         // New state variables added in the upgraded version
         ProtocolMetadataV2 protocolMetadataV2;
     }

gateway-contracts/contracts/interfaces/IGatewayConfig.sol

@@ -70,9 +70,9 @@ interface IGatewayConfig {
 
     /**
      * @notice Emitted when the key and CRS generation threshold has been updated.
-     * @param newKeygenThreshold The new key and CRS generation threshold.
+     * @param newKmsGenThreshold The new key and CRS generation threshold.
      */
-    event UpdateKeygenThreshold(uint256 newKeygenThreshold);
+    event UpdateKmsGenThreshold(uint256 newKmsGenThreshold);
 
     /**
      * @notice Emitted when a new host chain has been registered.
@@ -116,10 +116,10 @@ interface IGatewayConfig {
     error InvalidHighUserDecryptionThreshold(uint256 userDecryptionThreshold, uint256 nKmsNodes);
 
     /// @notice Error emitted when the key and CRS generation threshold is null.
-    error InvalidNullKeygenThreshold();
+    error InvalidNullKmsGenThreshold();
 
     /// @notice Error emitted when the key and CRS generation threshold is strictly greater than the number of KMS nodes.
-    error InvalidHighKeygenThreshold(uint256 keygenThreshold, uint256 nKmsNodes);
+    error InvalidHighKmsGenThreshold(uint256 kmsGenThreshold, uint256 nKmsNodes);
 
     /**
      * @notice Emitted when all the pausable gateway contracts are paused.
@@ -234,9 +234,9 @@ interface IGatewayConfig {
     /**
      * @notice Update the key and CRS generation threshold.
      * @dev The new threshold must verify `1 <= t <= n`, with `n` the number of KMS nodes currently registered.
-     * @param newKeygenThreshold The new key and CRS generation threshold.
+     * @param newKmsGenThreshold The new key and CRS generation threshold.
      */
-    function updateKeygenThreshold(uint256 newKeygenThreshold) external;
+    function updateKmsGenThreshold(uint256 newKmsGenThreshold) external;
 
     /**
      * @notice Pause all pausable gateway contracts.
@@ -324,7 +324,7 @@ interface IGatewayConfig {
      * @notice Get the key and CRS generation threshold
      * @return The key and CRS generation threshold.
      */
-    function getKeygenThreshold() external view returns (uint256);
+    function getKmsGenThreshold() external view returns (uint256);
 
     /**
      * @notice Get the coprocessor majority threshold

gateway-contracts/contracts/mocks/GatewayConfigMock.sol

@@ -27,7 +27,7 @@ contract GatewayConfigMock {
 
     event UpdateUserDecryptionThreshold(uint256 newUserDecryptionThreshold);
 
-    event UpdateKeygenThreshold(uint256 newKeygenThreshold);
+    event UpdateKmsGenThreshold(uint256 newKmsGenThreshold);
 
     event AddHostChain(HostChain hostChain);
 
@@ -41,7 +41,7 @@ contract GatewayConfigMock {
         uint256 initialMpcThreshold,
         uint256 initialPublicDecryptionThreshold,
         uint256 initialUserDecryptionThreshold,
-        uint256 initialKeygenThreshold,
+        uint256 initialKmsGenThreshold,
         KmsNodeV2[] memory initialKmsNodes,
         Coprocessor[] memory initialCoprocessors,
         Custodian[] memory initialCustodians
@@ -56,7 +56,7 @@ contract GatewayConfigMock {
         emit InitializeGatewayConfig(pauser, metadata, mpcThreshold, kmsNodes, coprocessors, custodians);
     }
 
-    function reinitializeV3(V3UpgradeInput[] memory v3UpgradeInputs, uint256 keygenThreshold) public {
+    function reinitializeV3(V3UpgradeInput[] memory v3UpgradeInputs, uint256 kmsGenThreshold) public {
         KmsNodeV1[] memory kmsNodesV1 = new KmsNodeV1[](1);
         KmsNodeV2[] memory kmsNodesV2 = new KmsNodeV2[](1);
 
@@ -79,8 +79,8 @@ contract GatewayConfigMock {
         emit UpdateUserDecryptionThreshold(newUserDecryptionThreshold);
     }
 
-    function updateKeygenThreshold(uint256 newKeygenThreshold) external {
-        emit UpdateKeygenThreshold(newKeygenThreshold);
+    function updateKmsGenThreshold(uint256 newKmsGenThreshold) external {
+        emit UpdateKmsGenThreshold(newKmsGenThreshold);
     }
 
     function addHostChain(HostChain calldata hostChain) external {

gateway-contracts/docs/getting-started/contracts/gateway_config.md

@@ -70,6 +70,17 @@ Both thresholds should be :
 
 These thresholds are set at deployment and can be updated by the owner later on, as long as the above conditions are met.
 
+#### KMS generation threshold
+
+The KMS generation threshold `kmsGenThreshold` is used to determine the minimum number of valid responses from KMS nodes required to validate a KMS public material generation (FHE key, CRS).
+
+This threshold should be :
+
+- non-null: it should require at least one vote
+- less or equal to the number of registered KMS nodes: it should not require more than the number of registered KMS nodes
+
+This threshold is set at deployment and can be updated by the owner later on, as long as the above conditions are met.
+
 ### Coprocessor
 
 A coprocessor is also part of a set of multiple coprocessors. They are used to :

gateway-contracts/docs/getting-started/deployment/env_variables.md

@@ -28,6 +28,7 @@ Here's the complete list of environment variables used for deploying the FHEVM g
 | `MPC_THRESHOLD`                     | MPC threshold (cryptographic parameter) | uint256       | -                                                                                                   | Must be strictly less than the number of KMS nodes registered                 |
 | `PUBLIC_DECRYPTION_THRESHOLD`       | Public decryption threshold             | uint256       | -                                                                                                   | Must be non-null and less than or equal to the number of KMS nodes registered |
 | `USER_DECRYPTION_THRESHOLD`         | User decryption threshold               | uint256       | -                                                                                                   | Must be non-null and less than or equal to the number of KMS nodes registered |
+| `KMS_GENERATION_THRESHOLD`          | KMS generation (FHE key, CRS) threshold | uint256       | -                                                                                                   | Must be non-null and less than or equal to the number of KMS nodes registered |
 | `NUM_KMS_NODES`                     | Number of KMS nodes to register         | -             | -                                                                                                   | Must be at least the number of KMS nodes registered below                     |
 | `KMS_TX_SENDER_ADDRESS_{i}`         | Address of the KMS node `i`             | address       | -                                                                                                   | If `i` >= `NUM_KMS_NODES`, the variable is ignored                            |
 | `KMS_SIGNER_ADDRESS_{i}`            | Signer address of the KMS node `i`      | address       | -                                                                                                   | If `i` >= `NUM_KMS_NODES`, the variable is ignored                            |
@@ -88,7 +89,7 @@ USER_DECRYPTION_THRESHOLD="3" # (uint256)
 
 `PUBLIC_DECRYPTION_THRESHOLD` and `USER_DECRYPTION_THRESHOLD` must be non-null and less or equal to the number of KMS nodes registered below.
 
-In practice in the FHEVM protocol, they are set to values using the following formulas:
+In practice in the FHEVM protocol, these thresholds are set using the following formulas:
 
 - public decryption threshold: `floor(n/2) + 1`
 - user decryption threshold: `2*t + 1`
@@ -97,6 +98,16 @@ With `n` the number of KMS nodes registered below and `t` the MPC threshold.
 
 These values might change in the future.
 
+```bash
+KMS_GENERATION_THRESHOLD="3" # (uint256)
+```
+
+`KMS_GENERATION_THRESHOLD` must be non-null and less or equal to the number of KMS nodes registered below.
+
+In practice in the FHEVM protocol, this threshold is set to `floor(2n/3) + 1` with `n` the number of KMS nodes registered below.
+
+These values might change in the future.
+
 - KMS Nodes:
 
 ```bash