You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs(user) — user-facing content: guides, tutorials, concept explanations, etc.
docs(api) — interfaces: contracts, SDKs, plugin APIs, etc.
docs(code) — code examples, templates, scripts, tests, etc.
docs(misc) — structure, navigation, styling, feedback, housekeeping, etc.
Context / Background
While reviewing the FHEVMExecutor contract, I noticed several areas where documentation could be improved to help developers better understand usage assumptions, constraints, and edge cases.
Many functions rely on implicit rules (such as scalarByte expectations, supported type bitmasks, and specific revert conditions) that are not clearly documented. This may lead to confusion for developers integrating with the executor or troubleshooting failed transactions.
Category
Context / Background
While reviewing the
FHEVMExecutorcontract, I noticed several areas where documentation could be improved to help developers better understand usage assumptions, constraints, and edge cases.Many functions rely on implicit rules (such as
scalarByteexpectations, supported type bitmasks, and specific revert conditions) that are not clearly documented. This may lead to confusion for developers integrating with the executor or troubleshooting failed transactions.Target Files/Pages
contracts/FHEVMExecutor.solTasks
scalarByteacross all binary operators.IsNotScalar,DivisionByZero, andIncompatibleTypes.supportedTypes) are constructed and validated.FheType.Boolregardless of input types.