Skip to content

docs: add NatSpec to Script and Test base contracts #880

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
daixihegu wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −4
Open

docs: add NatSpec to Script and Test base contracts #880

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions src/Script.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,10 @@ import {VmSafe} from "./Vm.sol";
// 📦 BOILERPLATE
import {ScriptBase} from "./Base.sol";

// ⭐️ SCRIPT
/// @notice Default base contract for Forge scripts.
/// @dev Includes safe cheatcodes, chain helpers, utility helpers, and console modules.
abstract contract Script is ScriptBase, StdChains, StdCheatsSafe, StdUtils {
// Note: IS_SCRIPT() must return true.
/// @notice Marker used by Forge to identify script contracts.
/// @dev The generated `IS_SCRIPT()` getter must return true.
bool public IS_SCRIPT = true;
}
6 changes: 4 additions & 2 deletions src/Test.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,10 @@ import {Vm} from "./Vm.sol";
// 📦 BOILERPLATE
import {TestBase} from "./Base.sol";

// ⭐️ TEST
/// @notice Default base contract for Forge tests.
/// @dev Includes assertions, cheatcodes, invariant helpers, chain helpers, utility helpers, and console modules.
abstract contract Test is TestBase, StdAssertions, StdChains, StdCheats, StdInvariant, StdUtils {
// Note: IS_TEST() must return true.
/// @notice Marker used by Forge to identify test contracts.
/// @dev The generated `IS_TEST()` getter must return true.
bool public IS_TEST = true;
}