Skip to content

Conversation

@RonTuretzky
Copy link
Collaborator

Adds detailed NatSpec documentation to all Solidity contracts in the project.

Summary

  • Added @title, @notice, @dev, @param, and @return tags to all interfaces, implementations, examples, tests, and scripts
  • Improved clarity on data structures, error conditions, and contract interactions
  • Documented all public functions with their behavior and parameters

Files Updated

  • Core contracts: IOpacitySDK.sol, OpacitySDK.sol
  • Example consumers: SimpleVerificationConsumer.sol, StorageQueryConsumer.sol
  • Tests: OpacitySDK.t.sol, ExampleConsumers.t.sol
  • Deployment script: Deploy.s.sol

All tests pass successfully (17 passed).

Adds detailed NatSpec documentation including @title, @notice, @dev, @param, and @return tags to all Solidity files in the project (interfaces, implementation, examples, tests, and scripts). Improves code clarity and developer experience for consuming the OpacitySDK.
Collapse multi-line struct initializations to single lines per forge fmt standards.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants