Skip to content

Commit

Permalink
🔎 add PR:REVIEW tags
Browse files Browse the repository at this point in the history
  • Loading branch information
JaredBorders committed Jun 25, 2024
1 parent a33b596 commit 7487eff
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@
[![Foundry][foundry-badge]][foundry]
[![License: GPL-3.0][license-badge]][license]


/** @PR:REVIEW update following urls **/
[gha]: https://github.com/Kwenta/foundry-scaffold/actions
[gha-badge]: https://github.com/Kwenta/foundry-scaffold/actions/workflows/test.yml/badge.svg
[foundry]: https://getfoundry.sh/
Expand Down
7 changes: 7 additions & 0 deletions foundry.toml
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,13 @@ optimizer_runs = 1_000_000
[fmt]
line_length = 80
number_underscore = "thousands"
/** @PR:REVIEW recommend adding:
multiline_func_header = "all"
sort_imports = true
contract_new_lines = true
override_spacing = false
wrap_comments = true
**/

[rpc_endpoints]
mainnet = "${MAINNET_RPC_URL}"
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
"coverage:generate-lcov": "forge coverage --fork-url $(grep OPTIMISM_GOERLI_RPC_URL .env | cut -d '=' -f2) --report lcov",
"analysis:slither": "slither .",
"gas-snapshot": "forge snapshot --fork-url $(grep OPTIMISM_GOERLI_RPC_URL .env | cut -d '=' -f2)",
/** @PR:REVIEW synthetix not used **/
"decode-custom-error": "npx @usecannon/cli decode synthetix-perps-market"
},
"repository": {
Expand Down
6 changes: 6 additions & 0 deletions test/KSXVault.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ import {Test} from "forge-std/Test.sol";
import {KSXVault} from "../src/KSXVault.sol";
import {ERC20} from "@openzeppelin/contracts/token/ERC20/ERC20.sol";

/** @PR:REVIEW no tests for vault **/
/** @PR:REVIEW add pDAO test **/
/** @PR:REVIEW add share name **/
/** @PR:REVIEW add share symbol **/
/** @PR:REVIEW add use bootstrap everywhere instead of `Test` **/

contract KSXVaultTest is Test {
function setUp() public {}
}
Expand Down
6 changes: 6 additions & 0 deletions test/Upgrade.t.sol
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,13 @@ import {MockVaultUpgrade} from "test/utils/mocks/MockVaultUpgrade.sol";

contract UpgradeTest is Bootstrap {
function setUp() public {
/** @PR:REVIEW unless there is a specific reason, avoid using fork tests **/
initializeOptimism();
}
}

/** @PR:REVIEW not entirely sure why you split up UpgradeTest/MockUpgrade/UpgradeVault; if no specific reason combine. otherwise thats fine **/

contract MockUpgrade is UpgradeTest {
MockVaultUpgrade mockVaultUpgrade;

Expand All @@ -22,6 +25,9 @@ contract MockUpgrade is UpgradeTest {
}

function test_upgrade() public {

/** @PR:REVIEW might as well fuzz the messages; never know what might be caught **/

string memory message = "hi";

bool success;
Expand Down
1 change: 1 addition & 0 deletions test/utils/Bootstrap.sol
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
// SPDX-License-Identifier: GPL-3.0-or-later
pragma solidity 0.8.25;

/** @PR:REVIEW remove any unused imports (except console bc it is helpful) **/
import {console2} from "lib/forge-std/src/console2.sol";
import {
KSXVault
Expand Down

0 comments on commit 7487eff

Please sign in to comment.