ContextQMD
Back to Fhevm

Api

docs/solidity-guides/foundry/api.md

0.13.0-34.2 KB
Original Source

This page is a quick reference for the FhevmTest base contract from forge-fhevm. For the full reference and additional helpers, see the forge-fhevm docs.

Import

solidity
import {FhevmTest} from "forge-fhevm/FhevmTest.sol";

State variables (set by setUp())

VariableTypeRole
_executorFHEVMExecutorProcesses FHE operations and emits the events that drive plaintext tracking
_aclACLPer-handle access control (transient and persistent)
_inputVerifierInputVerifierVerifies EIP-712 input proofs (1 mock signer)
_kmsVerifierKMSVerifierVerifies EIP-712 decryption proofs (1 mock signer)
MOCK_INPUT_SIGNERaddressAddress of the mock input signer
MOCK_KMS_SIGNERaddressAddress of the mock KMS signer

Encryption helpers

Each helper has a two-argument overload (address(this) is the implicit user) and a three-argument overload (explicit user).

solidity
function encryptBool(bool value, address target) returns (externalEbool, bytes memory);
function encryptBool(bool value, address user, address target) returns (externalEbool, bytes memory);

function encryptUint8(uint8 value, address target) returns (externalEuint8, bytes memory);
function encryptUint8(uint8 value, address user, address target) returns (externalEuint8, bytes memory);

// Same shape for: encryptUint16, encryptUint32, encryptUint64,
//                  encryptUint128, encryptUint256, encryptAddress

Decryption helpers

solidity
// Low-level: no ACL checks, raw uint256
function decrypt(bytes32 handle) returns (uint256);

// Typed overloads — return the matching Solidity primitive
function decrypt(ebool value)    returns (bool);
function decrypt(euint8 value)   returns (uint8);
function decrypt(euint16 value)  returns (uint16);
function decrypt(euint32 value)  returns (uint32);
function decrypt(euint64 value)  returns (uint64);
function decrypt(euint128 value) returns (uint128);
function decrypt(euint256 value) returns (uint256);
function decrypt(eaddress value) returns (address);

// Public decrypt — KMS-signed proof verifiable via FHE.checkSignatures
function publicDecrypt(bytes32[] memory handles)
    returns (uint256[] memory cleartexts, bytes memory proof);

// User decrypt — full ACL + EIP-712 flow
function userDecrypt(
    bytes32 handle,
    address userAddress,
    address contractAddress,
    bytes memory userSignature
) returns (uint256);

Proof helpers

solidity
// KMS-signed decryption proof (no ACL check) — for callback-style flows
function buildDecryptionProof(bytes32[] memory handles, bytes memory abiEncodedCleartexts)
    view returns (bytes memory proof);
function buildDecryptionProof(bytes32 handle, bytes memory abiEncodedCleartext)
    view returns (bytes memory proof);

// EIP-712 user-decrypt signature
function signUserDecrypt(uint256 userPk, address contractAddress)
    view returns (bytes memory signature);
function signUserDecrypt(
    uint256 userPk,
    address[] memory contractAddresses,
    uint256 startTimestamp,
    uint256 durationDays
) view returns (bytes memory signature);

Constants

ConstantValuePurpose
MOCK_INPUT_SIGNER_PKHardcoded mock key — see FhevmTest.solSigns input proofs (deterministic, mock signer)
MOCK_KMS_SIGNER_PKHardcoded mock key — see FhevmTest.solSigns KMS decryption proofs (deterministic, mock signer)
EMPTY_EXTRA_DATAhex"00"Default extra data appended to EIP-712 proofs
DEFAULT_USER_DECRYPT_DURATION_DAYS1Default validity for user-decrypt sigs

{% hint style="info" %} The mock signer keys are Zama-specific values committed inside forge-fhevm/src/FhevmTest.sol — they are not Foundry's standard test private keys. They exist only so EIP-712 proofs are deterministic in tests. {% endhint %}