Skip to content
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

Jump to bottom

Add and check contract code formatting using forge fmt #48

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Add and check contract code formatting using forge fmt #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f371281
Nit: Add formatting for contracts
Philogy Apr 30, 2024
5b150c8
Style: clean up imports & simplify `ERC20Mock`
Philogy Apr 30, 2024
80a3e5c
Fix: Make token backwards compatible
Philogy Apr 30, 2024
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
4 changes: 4 additions & 0 deletions .github/workflows/contracts-tests.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,7 @@ jobs:
- name: Run tests
run: forge test -vvv
working-directory: ./contracts

- name: Enforce Formatting
run: forge fmt --check
working-directory: ./contracts
276 changes: 77 additions & 199 deletions contracts/script/IncredibleSquaringDeployer.s.sol
View file
Open in desktop

Large diffs are not rendered by default.

70 changes: 18 additions & 52 deletions contracts/script/utils/Utils.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,9 @@ import "forge-std/StdJson.sol";

contract Utils is Script {
// Note that this fct will only work for the ERC20Mock that has a public mint function
function _mintTokens(
address strategyAddress,
address[] memory tos,
uint256[] memory amounts
) internal {
function _mintTokens(address strategyAddress, address[] memory tos, uint256[] memory amounts) internal {
for (uint256 i = 0; i < tos.length; i++) {
ERC20Mock underlyingToken = ERC20Mock(
address(StrategyBase(strategyAddress).underlyingToken())
);
ERC20Mock underlyingToken = ERC20Mock(address(StrategyBase(strategyAddress).underlyingToken()));
underlyingToken.mint(tos[i], amounts[i]);
}
}
Expand All @@ -32,77 +26,49 @@ contract Utils is Script {
}
}

function convertBoolToString(
bool input
) public pure returns (string memory) {
function convertBoolToString(bool input) public pure returns (string memory) {
if (input) {
return "true";
} else {
return "false";
}
}

function convertOperatorStatusToString(
IRegistryCoordinator.OperatorStatus operatorStatus
) public pure returns (string memory) {
if (
operatorStatus ==
IRegistryCoordinator.OperatorStatus.NEVER_REGISTERED
) {
function convertOperatorStatusToString(IRegistryCoordinator.OperatorStatus operatorStatus)
public
pure
returns (string memory)
{
if (operatorStatus == IRegistryCoordinator.OperatorStatus.NEVER_REGISTERED) {
return "NEVER_REGISTERED";
} else if (
operatorStatus == IRegistryCoordinator.OperatorStatus.REGISTERED
) {
} else if (operatorStatus == IRegistryCoordinator.OperatorStatus.REGISTERED) {
return "REGISTERED";
} else if (
operatorStatus == IRegistryCoordinator.OperatorStatus.DEREGISTERED
) {
} else if (operatorStatus == IRegistryCoordinator.OperatorStatus.DEREGISTERED) {
return "DEREGISTERED";
} else {
return "UNKNOWN";
}
}

// Forge scripts best practice: https://book.getfoundry.sh/tutorials/best-practices#scripts
function readInput(
string memory inputFileName
) internal view returns (string memory) {
string memory inputDir = string.concat(
vm.projectRoot(),
"/script/input/"
);
function readInput(string memory inputFileName) internal view returns (string memory) {
string memory inputDir = string.concat(vm.projectRoot(), "/script/input/");
string memory chainDir = string.concat(vm.toString(block.chainid), "/");
string memory file = string.concat(inputFileName, ".json");
return vm.readFile(string.concat(inputDir, chainDir, file));
}

function readOutput(
string memory outputFileName
) internal view returns (string memory) {
string memory inputDir = string.concat(
vm.projectRoot(),
"/script/output/"
);
function readOutput(string memory outputFileName) internal view returns (string memory) {
string memory inputDir = string.concat(vm.projectRoot(), "/script/output/");
string memory chainDir = string.concat(vm.toString(block.chainid), "/");
string memory file = string.concat(outputFileName, ".json");
return vm.readFile(string.concat(inputDir, chainDir, file));
}

function writeOutput(
string memory outputJson,
string memory outputFileName
) internal {
string memory outputDir = string.concat(
vm.projectRoot(),
"/script/output/"
);
function writeOutput(string memory outputJson, string memory outputFileName) internal {
string memory outputDir = string.concat(vm.projectRoot(), "/script/output/");
string memory chainDir = string.concat(vm.toString(block.chainid), "/");
string memory outputFilePath = string.concat(
outputDir,
chainDir,
outputFileName,
".json"
);
string memory outputFilePath = string.concat(outputDir, chainDir, outputFileName, ".json");
vm.writeJson(outputJson, outputFilePath);
}
}
Loading