docs(common): sync doc v10 (#1360)

0xalexbel · web-flow · commit de2e91ebc966 · 2025-11-18T18:46:47.000+01:00
* docs(common): update doc (#1341) * docs(common): update getting started * docs(common): move from EthereumConfig to ZamaEthereumConfig * docs(common): remove reference to ebytesxxx * docs(common): add new public decryption doc (#1356) * docs(common): add acl public decrypt text * docs(common): add acl practical use * docs(common): branch to a non confidential path * docs(common): new public decrypt doc * docs(common): improve public decryption doc * docs(common): improve text
diff --git a/docs/examples/SUMMARY.md b/docs/examples/SUMMARY.md
@@ -22,8 +22,3 @@
   - [Swap ERC7984 to ERC20](openzeppelin/swapERC7984ToERC20.md)
   - [Swap ERC7984 to ERC7984](openzeppelin/swapERC7984ToERC7984.md)
 - [Vesting Wallet](openzeppelin/vesting-wallet.md)
-
-## Advanced
-
-- [Sealed-bid auction](sealed-bid-auction.md)
-  - [Sealed-bid auction tutorial](sealed-bid-auction-tutorial.md)
diff --git a/docs/examples/fhe-counter.md b/docs/examples/fhe-counter.md
@@ -121,10 +121,10 @@ describe("Counter", function () {
 pragma solidity ^0.8.24;
 
 import { FHE, euint32, externalEuint32 } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
 /// @title A simple FHE counter contract
-contract FHECounter is EthereumConfig {
+contract FHECounter is ZamaEthereumConfig {
   euint32 private _count;
 
   /// @notice Returns the current count
diff --git a/docs/examples/fhe-encrypt-multiple-value.md b/docs/examples/fhe-encrypt-multiple-value.md
@@ -121,10 +121,10 @@ describe("Counter", function () {
 pragma solidity ^0.8.24;
 
 import { FHE, euint32, externalEuint32 } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
 /// @title A simple FHE counter contract
-contract FHECounter is EthereumConfig {
+contract FHECounter is ZamaEthereumConfig {
   euint32 private _count;
 
   /// @notice Returns the current count
diff --git a/docs/examples/fhe-encrypt-multiple-values.md b/docs/examples/fhe-encrypt-multiple-values.md
@@ -26,12 +26,12 @@ import {
   euint32,
   eaddress
 } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
 /**
  * This trivial example demonstrates the FHE encryption mechanism.
  */
-contract EncryptMultipleValues is EthereumConfig {
+contract EncryptMultipleValues is ZamaEthereumConfig {
   ebool private _encryptedEbool;
   euint32 private _encryptedEuint32;
   eaddress private _encryptedEaddress;
diff --git a/docs/examples/fhe-encrypt-single-value.md b/docs/examples/fhe-encrypt-single-value.md
@@ -18,12 +18,12 @@ This ensures Hardhat can compile and test your contracts as expected.
 pragma solidity ^0.8.24;
 
 import { FHE, externalEuint32, euint32 } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
 /**
  * This trivial example demonstrates the FHE encryption mechanism.
  */
-contract EncryptSingleValue is EthereumConfig {
+contract EncryptSingleValue is ZamaEthereumConfig {
   euint32 private _encryptedEuint32;
 
   // solhint-disable-next-line no-empty-blocks
diff --git a/docs/examples/fhe-user-decrypt-multiple-values.md b/docs/examples/fhe-user-decrypt-multiple-values.md
@@ -20,9 +20,9 @@ This ensures Hardhat can compile and test your contracts as expected.
 pragma solidity ^0.8.24;
 
 import { FHE, ebool, euint32, euint64 } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
-contract UserDecryptMultipleValues is EthereumConfig {
+contract UserDecryptMultipleValues is ZamaEthereumConfig {
   ebool private _encryptedBool; // = 0 (uninitizalized)
   euint32 private _encryptedUint32; // = 0 (uninitizalized)
   euint64 private _encryptedUint64; // = 0 (uninitizalized)
diff --git a/docs/examples/fhe-user-decrypt-single-value.md b/docs/examples/fhe-user-decrypt-single-value.md
@@ -20,13 +20,13 @@ This ensures Hardhat can compile and test your contracts as expected.
 pragma solidity ^0.8.24;
 
 import { FHE, euint32 } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
 /**
  * This trivial example demonstrates the FHE decryption mechanism
  * and highlights common pitfalls developers may encounter.
  */
-contract UserDecryptSingleValue is EthereumConfig {
+contract UserDecryptSingleValue is ZamaEthereumConfig {
   euint32 private _trivialEuint32;
 
   // solhint-disable-next-line no-empty-blocks
diff --git a/docs/examples/fheadd.md b/docs/examples/fheadd.md
@@ -18,9 +18,9 @@ This ensures Hardhat can compile and test your contracts as expected.
 pragma solidity ^0.8.24;
 
 import { FHE, euint8, externalEuint8 } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
-contract FHEAdd is EthereumConfig {
+contract FHEAdd is ZamaEthereumConfig {
   euint8 private _a;
   euint8 private _b;
   // solhint-disable-next-line var-name-mixedcase
diff --git a/docs/examples/fheifthenelse.md b/docs/examples/fheifthenelse.md
@@ -18,9 +18,9 @@ This ensures Hardhat can compile and test your contracts as expected.
 pragma solidity ^0.8.24;
 
 import { FHE, ebool, euint8, externalEuint8 } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
-contract FHEIfThenElse is EthereumConfig {
+contract FHEIfThenElse is ZamaEthereumConfig {
   euint8 private _a;
   euint8 private _b;
   euint8 private _max;
diff --git a/docs/examples/openzeppelin/ERC7984ERC20WrapperMock.md b/docs/examples/openzeppelin/ERC7984ERC20WrapperMock.md
@@ -16,11 +16,11 @@ This ensures Hardhat can compile and test your contracts as expected.
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 pragma solidity ^0.8.27;
 
-import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {ZamaEthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {IERC20} from "@openzeppelin/contracts/interfaces/IERC20.sol";
 import {ERC7984ERC20Wrapper, ERC7984} from "@openzeppelin/confidential-contracts/token/ERC7984/extensions/ERC7984ERC20Wrapper.sol";
 
-contract ERC7984ERC20WrapperExample is ERC7984ERC20Wrapper, EthereumConfig {
+contract ERC7984ERC20WrapperExample is ERC7984ERC20Wrapper, ZamaEthereumConfig {
     constructor(
         IERC20 token,
         string memory name,
diff --git a/docs/examples/openzeppelin/erc7984-tutorial.md b/docs/examples/openzeppelin/erc7984-tutorial.md
@@ -28,7 +28,7 @@ Our confidential token will inherit from several key contracts:
 
 1. **`ERC7984`** - OpenZeppelin's base for confidential tokens
 2. **`Ownable2Step`** - Access control for minting and administrative functions
-3. **`EthereumConfig`** - FHE configuration for the Ethereum mainnet or Ethereum Sepolia testnet networks
+3. **`ZamaEthereumConfig`** - FHE configuration for the Ethereum mainnet or Ethereum Sepolia testnet networks
 
 ## The base smart contract
 
@@ -52,10 +52,10 @@ pragma solidity ^0.8.24;
 
 import {Ownable2Step, Ownable} from "@openzeppelin/contracts/access/Ownable2Step.sol";
 import {FHE, externalEuint64, euint64} from "@fhevm/solidity/lib/FHE.sol";
-import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {ZamaEthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {ERC7984} from "@openzeppelin/confidential-contracts/token/ERC7984.sol";
 
-contract ERC7984Example is EthereumConfig, ERC7984, Ownable2Step {
+contract ERC7984Example is ZamaEthereumConfig, ERC7984, Ownable2Step {
     constructor(
         address owner,
         uint64 amount,
diff --git a/docs/examples/openzeppelin/erc7984.md b/docs/examples/openzeppelin/erc7984.md
@@ -19,10 +19,10 @@ pragma solidity ^0.8.24;
 
 import {Ownable2Step, Ownable} from "@openzeppelin/contracts/access/Ownable2Step.sol";
 import {FHE, externalEuint64, euint64} from "@fhevm/solidity/lib/FHE.sol";
-import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {ZamaEthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {ERC7984} from "@openzeppelin/confidential-contracts/token/ERC7984.sol";
 
-contract ERC7984Example is EthereumConfig, ERC7984, Ownable2Step {
+contract ERC7984Example is ZamaEthereumConfig, ERC7984, Ownable2Step {
     constructor(
         address owner,
         uint64 amount,
diff --git a/docs/examples/openzeppelin/vesting-wallet.md b/docs/examples/openzeppelin/vesting-wallet.md
@@ -21,7 +21,7 @@ pragma solidity ^0.8.24;
 import {FHE, ebool, euint64, euint128} from "@fhevm/solidity/lib/FHE.sol";
 import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
 import {ReentrancyGuardTransient} from "@openzeppelin/contracts/utils/ReentrancyGuardTransient.sol";
-import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {ZamaEthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {IERC7984} from "../interfaces/IERC7984.sol";
 
 /**
@@ -33,7 +33,7 @@ import {IERC7984} from "../interfaces/IERC7984.sol";
  * 
  * This is a non-upgradeable version for demonstration purposes.
  */
-contract VestingWalletExample is Ownable, ReentrancyGuardTransient, EthereumConfig {
+contract VestingWalletExample is Ownable, ReentrancyGuardTransient, ZamaEthereumConfig {
     mapping(address token => euint128) private _tokenReleased;
     uint64 private _start;
     uint64 private _duration;
diff --git a/docs/examples/sealed-bid-auction-tutorial.md b/docs/examples/sealed-bid-auction-tutorial.md
@@ -29,7 +29,7 @@ For help with these steps, refer to these tutorials:
 
 # Create the smart contracts
 
-Let’s now create a new contract called `BlindAuction.sol` in the `./contracts/` folder. To enable FHE operations in our contract, we will need to inherit our contract from `EthereumConfig`. This configuration provides the necessary parameters and network-specific settings required to interact with Zama’s FHEVM.
+Let’s now create a new contract called `BlindAuction.sol` in the `./contracts/` folder. To enable FHE operations in our contract, we will need to inherit our contract from `ZamaEthereumConfig`. This configuration provides the necessary parameters and network-specific settings required to interact with Zama’s FHEVM.
 
 Let’s also create some state variable that is going to be used in our auction.
 For the payment, we will rely on a `ConfidentialFungibleToken`. Indeed, we cannot use traditional ERC20, because even if the state in our auction is private, anyone can still monitor blockchain transactions and guess the bid value. By using a `ConfidentialFungibleToken` we ensure the amount stays hidden. This `ConfidentialFungibleToken` can be used with any ERC20, you will only need to wrap your token to hide future transfers.
@@ -41,11 +41,11 @@ Our contract will also include an `ERC721` token representing the NFT being auct
 pragma solidity ^0.8.24;
 
 import { FHE, externalEuint64, euint64, ebool } from "@fhevm/solidity/lib/FHE.sol";
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 import { ConfidentialFungibleToken } from "@openzeppelin/confidential-contracts/token/ConfidentialFungibleToken.sol";
 // ...
 
-contract BlindAuction is EthereumConfig {
+contract BlindAuction is ZamaEthereumConfig {
   /// @notice The recipient of the highest bid once the auction ends
   address public beneficiary;
 
diff --git a/docs/examples/sealed-bid-auction.md b/docs/examples/sealed-bid-auction.md
@@ -18,15 +18,15 @@ This ensures Hardhat can compile and test your contracts as expected.
 pragma solidity ^0.8.24;
 
 import {FHE, externalEuint64, euint64, eaddress, ebool} from "@fhevm/solidity/lib/FHE.sol";
-import {EthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
+import {ZamaEthereumConfig} from "@fhevm/solidity/config/ZamaConfig.sol";
 import {Ownable2Step, Ownable} from "@openzeppelin/contracts/access/Ownable2Step.sol";
 import {IERC20Errors} from "@openzeppelin/contracts/interfaces/draft-IERC6093.sol";
 import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
 import {ReentrancyGuard} from "@openzeppelin/contracts/utils/ReentrancyGuard.sol";
 
 import {ConfidentialFungibleToken} from "@openzeppelin/confidential-contracts/token/ConfidentialFungibleToken.sol";
 
-contract BlindAuction is EthereumConfig, ReentrancyGuard {
+contract BlindAuction is ZamaEthereumConfig, ReentrancyGuard {
     /// @notice The recipient of the highest bid once the auction ends
     address public beneficiary;
 
diff --git a/docs/solidity-guides/acl/README.md b/docs/solidity-guides/acl/README.md
@@ -52,19 +52,23 @@ Developers can use functions like `allow`, `allowThis`, and `allowTransient` to
 - **`allow`**: Grants permanent access to an address.
 - **`allowThis`**: Grants the current contract access to manipulate the ciphertext.
 - **`allowTransient`**: Grants temporary access to an address for the current transaction.
+- **`makePubliclyDecryptable`**: Grants permanent, global permission for any entity to decrypt the cleartext value associated with the given ciphertext (handle) off-chain.
 
 ### Verifying access
 
 To check if an entity has permission to access a ciphertext, use functions like `isAllowed` or `isSenderAllowed`:
 
 - **`isAllowed`**: Verifies if a specific address has permission.
 - **`isSenderAllowed`**: Simplifies checks for the current transaction sender.
+- **`isPubliclyDecryptable`**: Verifies whether any entity is permitted to retrieve the ciphertext's cleartext value off-chain.
+- **`checkSignatures`**: Verifies the authenticity of a cleartext value by checking cryptographic signatures. This ensures that the value submitted back to the chain originated from a legitimate public decryption operation on the associated ciphertext handle.
 
 ## Practical uses of the ACL
 
 - **Confidential parameters**: Pass encrypted values securely between contracts, ensuring only authorized entities can access them.
 - **Secure state management**: Store encrypted state variables while controlling who can modify or read them.
 - **Privacy-preserving computations**: Enable computations on encrypted data with confidence that permissions are enforced.
+- **Publicly Verifiable Result Reveal**: Enable the public reveal of a confidential operation's final result. For example, enabling the public to verify the final price in a sealed-bid confidential auction.
 
 ---
 
diff --git a/docs/solidity-guides/configure.md b/docs/solidity-guides/configure.md
@@ -22,19 +22,19 @@ The `ZamaConfig` library exposes functions to retrieve FHEVM configuration struc
 
 Under the hood, this library encapsulates the network-specific addresses of Zama's FHEVM infrastructure into a single struct (`FHEVMConfigStruct`).
 
-## EthereumConfig
+## ZamaEthereumConfig
 
-The `EthereumConfig` contract is designed to be inherited by a user contract. The constructor automatically sets up the FHEVM coprocessor and decryption oracle using the configuration provided by the library for the respective network. When a contract inherits from `EthereumConfig`, the constructor calls `FHE.setCoprocessor` with the appropriate addresses. This ensures that the inheriting contract is automatically wired to the correct FHEVM contracts and oracle for the target network, abstracting away manual address management and reducing the risk of misconfiguration.
+The `ZamaEthereumConfig` contract is designed to be inherited by a user contract. The constructor automatically sets up the FHEVM coprocessor and decryption oracle using the configuration provided by the library for the respective network. When a contract inherits from `ZamaEthereumConfig`, the constructor calls `FHE.setCoprocessor` with the appropriate addresses. This ensures that the inheriting contract is automatically wired to the correct FHEVM contracts and oracle for the target network, abstracting away manual address management and reducing the risk of misconfiguration.
 
 **Example**
 
 ```solidity
 // SPDX-License-Identifier: BSD-3-Clause-Clear
 pragma solidity ^0.8.24;
 
-import { EthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
+import { ZamaEthereumConfig } from "@fhevm/solidity/config/ZamaConfig.sol";
 
-contract MyERC20 is EthereumConfig {
+contract MyERC20 is ZamaEthereumConfig {
   constructor() {
     // Additional initialization logic if needed
   }
@@ -64,4 +64,4 @@ require(FHE.isInitialized(counter), "Counter not initialized!");
 
 ## Summary
 
-By leveraging prebuilt a configuration contract like `EthereumConfig` in `ZamaConfig.sol`, you can efficiently set up your smart contract for encrypted computations. These tools abstract the complexity of cryptographic initialization, allowing you to focus on building secure, confidential smart contracts.
+By leveraging prebuilt a configuration contract like `ZamaEthereumConfig` in `ZamaConfig.sol`, you can efficiently set up your smart contract for encrypted computations. These tools abstract the complexity of cryptographic initialization, allowing you to focus on building secure, confidential smart contracts.
diff --git a/docs/solidity-guides/debug_decrypt.md b/docs/solidity-guides/debug_decrypt.md
@@ -67,15 +67,6 @@ To utilize the debug functions, import the [utils.ts](https://github.com/zama-ai
 
 For a more complete example, refer to the [ConfidentialERC20 test file](https://github.com/zama-ai/fhevm-hardhat-template/blob/f9505a67db31c988f49b6f4210df47ca3ce97841/test/confidentialERC20/ConfidentialERC20.ts#L181-L205).
 
-### Example: decrypting byte arrays
-
-```typescript
-// Decrypt a 128-byte encrypted value
-const ebytes128Handle: bigint = ...; // Get handle for the encrypted bytes
-const decryptedBytes: string = await debug.decryptEbytes128(ebytes128Handle);
-console.log("Decrypted Bytes:", decryptedBytes);
-```
-
 ## **How it works**
 
 ### Verifying types
diff --git a/docs/solidity-guides/decryption/oracle.md b/docs/solidity-guides/decryption/oracle.md
diff --git a/docs/solidity-guides/getting-started/overview.md b/docs/solidity-guides/getting-started/overview.md
diff --git a/docs/solidity-guides/getting-started/quick-start-tutorial/turn_it_into_fhevm.md b/docs/solidity-guides/getting-started/quick-start-tutorial/turn_it_into_fhevm.md
diff --git a/docs/solidity-guides/logics/conditions.md b/docs/solidity-guides/logics/conditions.md
diff --git a/docs/solidity-guides/transform_smart_contract_with_fhevm.md b/docs/solidity-guides/transform_smart_contract_with_fhevm.md
