Skip to content

Move to foundry v1 and benchmark #14427

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

Merged
JosepBove merged 6 commits into from
Feb 24, 2025
Merged

Move to foundry v1 and benchmark #14427

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
38fbe38
bump to foundry v1
JosepBove Feb 19, 2025
4d2c7f7
library harness failing
JosepBove Feb 19, 2025
f5f31c4
rm return name
JosepBove Feb 19, 2025
a53b5fc
fix internal revert tests
JosepBove Feb 19, 2025
d847bb5
rerun CI
JosepBove Feb 19, 2025
796e379
move to v1 tag
JosepBove Feb 21, 2025
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: 3 additions & 3 deletions mise.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ just = "1.37.0"
# Foundry is a special case because it supplies multiple binaries at the same
# GitHub release, so we need to use the aliasing trick to get mise to not error
# The git ref here should be on the `stable` branch.
forge = "nightly-5d16800a64e5357fbb2493e4cae061756d145981"
cast = "nightly-5d16800a64e5357fbb2493e4cae061756d145981"
anvil = "nightly-5d16800a64e5357fbb2493e4cae061756d145981"
forge = "stable"
Comment thread
JosepBove marked this conversation as resolved.
Outdated
cast = "stable"
anvil = "stable"

# Other dependencies
codecov-uploader = "0.8.0"
Expand Down
20 changes: 17 additions & 3 deletions packages/contracts-bedrock/test/libraries/Bytes.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,15 @@ import { Test } from "forge-std/Test.sol";
// Target contract
import { Bytes } from "src/libraries/Bytes.sol";

contract Bytes_Harness {
function exposed_slice(bytes memory _input, uint256 _start, uint256 _length) public pure returns (bytes memory) {
return Bytes.slice(_input, _start, _length);
}
}

contract Bytes_slice_Test is Test {
Bytes_Harness harness;

/// @notice Tests that the `slice` function works as expected when starting from index 0.
function test_slice_fromZeroIdx_works() public pure {
bytes memory input = hex"11223344556677889900";
Expand Down Expand Up @@ -124,6 +132,12 @@ contract Bytes_slice_Test is Test {
}

contract Bytes_slice_TestFail is Test {
Bytes_Harness harness;

function setUp() public {
harness = new Bytes_Harness();
}

/// @notice Tests that, when given an input bytes array of length `n`, the `slice` function will
/// always revert if `_start + _length > n`.
function testFuzz_slice_outOfBounds_reverts(bytes memory _input, uint256 _start, uint256 _length) public {
Expand All @@ -142,7 +156,7 @@ contract Bytes_slice_TestFail is Test {
}

vm.expectRevert("slice_outOfBounds");
Bytes.slice(_input, _start, _length);
harness.exposed_slice(_input, _start, _length);
}

/// @notice Tests that, when given a length `n` that is greater than `type(uint256).max - 31`,
Expand All @@ -152,7 +166,7 @@ contract Bytes_slice_TestFail is Test {
_length = uint256(bound(_length, type(uint256).max - 30, type(uint256).max));

vm.expectRevert("slice_overflow");
Bytes.slice(_input, _start, _length);
harness.exposed_slice(_input, _start, _length);
}

/// @notice Tests that, when given a start index `n` that is greater than
Expand All @@ -169,7 +183,7 @@ contract Bytes_slice_TestFail is Test {
vm.assume(_start > type(uint256).max - _length);

vm.expectRevert("slice_overflow");
Bytes.slice(_input, _start, _length);
harness.exposed_slice(_input, _start, _length);
}
}

Expand Down
14 changes: 13 additions & 1 deletion packages/contracts-bedrock/test/libraries/GasPayingToken.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,21 @@ import { Constants } from "src/libraries/Constants.sol";
import { Test } from "forge-std/Test.sol";
import { LibString } from "@solady/utils/LibString.sol";

contract GasPayingToken_Harness {
function exposed_sanitize(string memory _str) public pure returns (bytes32) {
return GasPayingToken.sanitize(_str);
}
}

/// @title GasPayingToken_Roundtrip_Test
/// @notice Tests the roundtrip of setting and getting the gas paying token.
contract GasPayingToken_Roundtrip_Test is Test {
GasPayingToken_Harness harness;

function setUp() public {
harness = new GasPayingToken_Harness();
}

/// @dev Test that the gas paying token correctly sets values in storage.
function testFuzz_set_succeeds(address _token, uint8 _decimals, bytes32 _name, bytes32 _symbol) external {
GasPayingToken.set(_token, _decimals, _name, _symbol);
Expand Down Expand Up @@ -104,7 +116,7 @@ contract GasPayingToken_Roundtrip_Test is Test {

vm.expectRevert("GasPayingToken: string cannot be greater than 32 bytes");

GasPayingToken.sanitize(_str);
harness.exposed_sanitize(_str);
}

/// @dev Test that `sanitize` works as expected when the input string is empty.
Expand Down
26 changes: 26 additions & 0 deletions packages/contracts-bedrock/test/libraries/rlp/RLPReader.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import { Test } from "forge-std/Test.sol";
import { RLPReader } from "src/libraries/rlp/RLPReader.sol";
import "src/libraries/rlp/RLPErrors.sol";

/// @notice Here we allow internal reverts as readRawBytes uses memory allocations and can only be tested internally
contract RLPReader_readBytes_Test is Test {
function test_readBytes_bytestring00_succeeds() external pure {
assertEq(RLPReader.readBytes(hex"00"), hex"00");
Expand All @@ -19,26 +20,31 @@ contract RLPReader_readBytes_Test is Test {
assertEq(RLPReader.readBytes(hex"7f"), hex"7f");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readBytes_revertListItem_reverts() external {
vm.expectRevert(UnexpectedList.selector);
RLPReader.readBytes(hex"c7c0c1c0c3c0c1c0");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readBytes_invalidStringLength_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readBytes(hex"b9");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readBytes_invalidListLength_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readBytes(hex"ff");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readBytes_invalidRemainder_reverts() external {
vm.expectRevert(InvalidDataRemainder.selector);
RLPReader.readBytes(hex"800a");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readBytes_invalidPrefix_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readBytes(hex"810a");
Expand Down Expand Up @@ -102,6 +108,7 @@ contract RLPReader_readList_Test is Test {
}
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_listLongerThan32Elements_reverts() external {
vm.expectRevert(stdError.indexOOBError);
RLPReader.readList(hex"e1454545454545454545454545454545454545454545454545454545454545454545");
Expand Down Expand Up @@ -135,100 +142,119 @@ contract RLPReader_readList_Test is Test {
assertEq(RLPReader.readRawBytes(list[3]), hex"ca846b6579348476616c34");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_invalidShortList_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"efdebd");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_longStringLength_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"efb83600");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_notLongEnough_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"efdebdaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_int32Overflow_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"bf0f000000000000021111");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_int32Overflow2_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"ff0f000000000000021111");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_incorrectLengthInArray_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readList(hex"b9002100dc2b275d0f74e8a53e6f4ec61b27f24278820be3f82ea2110e582081b0565df0");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_leadingZerosInLongLengthArray1_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readList(
hex"b90040000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f202122232425262728292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f"
);
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_leadingZerosInLongLengthArray2_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readList(hex"b800");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_leadingZerosInLongLengthList1_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readList(
hex"fb00000040000102030405060708090a0b0c0d0e0f101112131415161718191a1b1c1d1e1f202122232425262728292a2b2c2d2e2f303132333435363738393a3b3c3d3e3f"
);
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_nonOptimalLongLengthArray1_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readList(hex"b81000112233445566778899aabbccddeeff");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_nonOptimalLongLengthArray2_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readList(hex"b801ff");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_invalidValue_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"91");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_invalidRemainder_reverts() external {
vm.expectRevert(InvalidDataRemainder.selector);
RLPReader.readList(hex"c000");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_notEnoughContentForString1_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"ba010000aabbccddeeff");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_notEnoughContentForString2_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"b840ffeeddccbbaa99887766554433221100");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_notEnoughContentForList1_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"f90180");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_notEnoughContentForList2_reverts() external {
vm.expectRevert(ContentLengthMismatch.selector);
RLPReader.readList(hex"ffffffffffffffffff0001020304050607");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_longStringLessThan56Bytes_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readList(hex"b80100");
}

/// forge-config: default.allow_internal_expect_revert = true
function test_readList_longListLessThan56Bytes_reverts() external {
vm.expectRevert(InvalidHeader.selector);
RLPReader.readList(hex"f80100");
Expand Down
Loading