Skip to content

Commit

Permalink
docs: NatSpec
Browse files Browse the repository at this point in the history
  • Loading branch information
PacificYield committed Nov 26, 2024
1 parent 004d9fd commit 4fa88d5
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
6 changes: 6 additions & 0 deletions contracts/contracts/TFHEExecutor.sol
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,12 @@ interface IInputVerifier {
) external returns (uint256);
}

/**
* @title TFHEExecutor
* @notice This contract implements symbolic execution on the blockchain and one of its
* main responsibilities is to deterministically generate ciphertext handles.
* @dev This contract is deployed using an UUPS proxy.
*/
contract TFHEExecutor is UUPSUpgradeable, Ownable2StepUpgradeable {
/// @notice Handle version
uint8 public constant HANDLE_VERSION = 0;
Expand Down
6 changes: 6 additions & 0 deletions contracts/contracts/TFHEExecutorWithEvents.sol
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@ pragma solidity ^0.8.24;

import {TFHEExecutor} from "./TFHEExecutor.sol";

/**
* @title TFHEExecutorWithEvents
* @notice This contract inherits TFHEExecutor and overrides its functions to emit
* events for all TFHE operations.
* @dev This contract is deployed using an UUPS proxy.
*/
contract TFHEExecutorWithEvents is TFHEExecutor {
event FheAdd(uint256 lhs, uint256 rhs, bytes1 scalarByte, uint256 result);
event FheSub(uint256 lhs, uint256 rhs, bytes1 scalarByte, uint256 result);
Expand Down

0 comments on commit 4fa88d5

Please sign in to comment.