Skip to content

1 - reading/writing more than 32 bytes into the TendConfig.extraData field #43

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
Sean329 merged 3 commits into from
Mar 20, 2025
Merged

1 - reading/writing more than 32 bytes into the TendConfig.extraData field #43

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
0791754
add logic for reading/writing more than 32 bytes into the `TendConfig…
mcclurejt Dec 19, 2024
b9d9ebb
Resolve @jalextowle 's comment
Sean329 Mar 20, 2025
bf77a01
Added tests to resolve the auditors' comments
Sean329 Mar 20, 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
51 changes: 48 additions & 3 deletions contracts/EverlongStrategy.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,11 +371,31 @@ contract EverlongStrategy is BaseStrategy {
uint256 positionClosureLimit = _config.positionClosureLimit;
bytes memory extraData = _config.extraData;
assembly {
tstore(tendEnabledSlot, 1)
tstore(tendEnabledSlot, 0x1)
tstore(minOutputSlot, minOutput)
tstore(minVaultSharePriceSlot, minVaultSharePrice)
tstore(positionClosureLimitSlot, positionClosureLimit)
tstore(extraDataSlot, extraData)

// Load the length of `extraData`.
let extraDataLength := mload(extraData)

// Pointer to the actual data.
let extraDataData := add(extraData, 0x20)

// Store the length in the `extraDataSlot`.
tstore(extraDataSlot, extraDataLength)

// Store the data in subsequent slots.
for {
let i := 0
} lt(i, extraDataLength) {
i := add(i, 0x20)
} {
tstore(
add(extraDataSlot, add(div(i, 0x20), 0x1)),
mload(add(extraDataData, i))
)
}
}
}

Expand Down Expand Up @@ -406,7 +426,32 @@ contract EverlongStrategy is BaseStrategy {
minOutput := tload(minOutputSlot)
minVaultSharePrice := tload(minVaultSharePriceSlot)
positionClosureLimit := tload(positionClosureLimitSlot)
extraData := tload(extraDataSlot)

// Load the length of `extraData`.
let extraDataLength := tload(extraDataSlot)

// Get free memory pointer.
let extraDataData := mload(0x40)

// Allocate memory.
mstore(0x40, add(extraDataData, add(extraDataLength, 0x20)))

// Store the length.
mstore(extraDataData, extraDataLength)

// Load the data from transient storage.
for {
let i := 0
} lt(i, extraDataLength) {
i := add(i, 0x20)
} {
mstore(
add(extraDataData, add(0x20, i)),
tload(add(extraDataSlot, add(div(i, 0x20), 0x1)))
)
}

extraData := extraDataData
}

// Return the TendConfig.
Expand Down
193 changes: 192 additions & 1 deletion test/everlong/units/Tend.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -295,4 +295,195 @@ contract TestTend is EverlongTest {
// Stop the prank.
vm.stopPrank();
}
}

/// @dev Tests that `TendConfig.extraData` is fully loaded even when the
/// content is greater than a single storage slot.
function test_extraData_large() external {
// Start a prank as the keeper address.
vm.startPrank(address(keeperContract));

// Prepare a large `bytes` array for `extraData`.
bytes memory largeExtraData = new bytes(1024);
for (uint256 i = 0; i < 1024; i++) {
largeExtraData[i] = bytes1(uint8(i % 256));
}

// Call `setTendConfig` with the large `extraData`.
IEverlongStrategy(address(strategy)).setTendConfig(
IEverlongStrategy.TendConfig({
minOutput: 1,
minVaultSharePrice: 2,
positionClosureLimit: 3,
extraData: largeExtraData
})
);

// Retrieve the TendConfig.
(, IEverlongStrategy.TendConfig memory tendConfig) = IEverlongStrategy(
address(strategy)
).getTendConfig();

// Assert that the retrieved `extraData` is the same as the input.
assertEq(tendConfig.minOutput, 1, "minOutput mismatch");
assertEq(tendConfig.minVaultSharePrice, 2, "minVaultSharePrice mismatch");
assertEq(tendConfig.positionClosureLimit, 3, "positionClosureLimit mismatch");

// Use bytes comparison for extraData
assertEq(tendConfig.extraData.length, largeExtraData.length, "extraData length mismatch");

for (uint256 i = 0; i < largeExtraData.length; i++) {
assertEq(uint8(tendConfig.extraData[i]), uint8(largeExtraData[i]), string(abi.encodePacked("extraData byte mismatch at index ", i)));
}

// Stop the prank.
vm.stopPrank();
}

/// @dev Tests that empty `extraData` is correctly handled.
function test_extraData_empty() external {
// Start a prank as the keeper address.
vm.startPrank(address(keeperContract));

// Empty extraData
bytes memory emptyData = new bytes(0);

// Set TendConfig with empty extraData
IEverlongStrategy(address(strategy)).setTendConfig(
IEverlongStrategy.TendConfig({
minOutput: 42,
minVaultSharePrice: 100,
positionClosureLimit: 5,
extraData: emptyData
})
);

// Retrieve the TendConfig
(, IEverlongStrategy.TendConfig memory tendConfig) = IEverlongStrategy(
address(strategy)
).getTendConfig();

// Assert all fields
assertEq(tendConfig.minOutput, 42, "minOutput mismatch");
assertEq(tendConfig.minVaultSharePrice, 100, "minVaultSharePrice mismatch");
assertEq(tendConfig.positionClosureLimit, 5, "positionClosureLimit mismatch");
assertEq(tendConfig.extraData.length, 0, "extraData should be empty");

// Stop the prank.
vm.stopPrank();
}

/// @dev Tests that `extraData` smaller than 32 bytes is correctly handled.
function test_extraData_small() external {
// Start a prank as the keeper address.
vm.startPrank(address(keeperContract));

// Small extraData (<32 bytes)
bytes memory smallData = bytes("small data");

// Set TendConfig with small extraData
IEverlongStrategy(address(strategy)).setTendConfig(
IEverlongStrategy.TendConfig({
minOutput: 123,
minVaultSharePrice: 456,
positionClosureLimit: 789,
extraData: smallData
})
);

// Retrieve the TendConfig
(, IEverlongStrategy.TendConfig memory tendConfig) = IEverlongStrategy(
address(strategy)
).getTendConfig();

// Assert all fields
assertEq(tendConfig.minOutput, 123, "minOutput mismatch");
assertEq(tendConfig.minVaultSharePrice, 456, "minVaultSharePrice mismatch");
assertEq(tendConfig.positionClosureLimit, 789, "positionClosureLimit mismatch");

// Check extraData
assertEq(tendConfig.extraData.length, smallData.length, "extraData length mismatch");
assertEq(keccak256(tendConfig.extraData), keccak256(smallData), "extraData content mismatch");

// Stop the prank.
vm.stopPrank();
}

/// @dev Tests that `extraData` exactly 32 bytes is correctly handled.
function test_extraData_exactly32Bytes() external {
// Start a prank as the keeper address.
vm.startPrank(address(keeperContract));

// Create exactly 32 bytes of data
bytes memory data32 = new bytes(32);
for (uint256 i = 0; i < 32; i++) {
data32[i] = bytes1(uint8(i + 1));
}

// Set TendConfig with 32-byte extraData
IEverlongStrategy(address(strategy)).setTendConfig(
IEverlongStrategy.TendConfig({
minOutput: 0xdead,
minVaultSharePrice: 0xbeef,
positionClosureLimit: 0xcafe,
extraData: data32
})
);

// Retrieve the TendConfig
(, IEverlongStrategy.TendConfig memory tendConfig) = IEverlongStrategy(
address(strategy)
).getTendConfig();

// Assert all fields
assertEq(tendConfig.minOutput, 0xdead, "minOutput mismatch");
assertEq(tendConfig.minVaultSharePrice, 0xbeef, "minVaultSharePrice mismatch");
assertEq(tendConfig.positionClosureLimit, 0xcafe, "positionClosureLimit mismatch");

// Check extraData
assertEq(tendConfig.extraData.length, data32.length, "extraData length mismatch");

for (uint256 i = 0; i < data32.length; i++) {
assertEq(uint8(tendConfig.extraData[i]), uint8(data32[i]), string(abi.encodePacked("extraData byte mismatch at index ", i)));
}

// Stop the prank.
vm.stopPrank();
}

/// @dev Tests that `extraData` with a single byte is correctly handled.
function test_extraData_singleByte() external {
// Start a prank as the keeper address.
vm.startPrank(address(keeperContract));

// Single byte extraData
bytes memory singleByteData = new bytes(1);
singleByteData[0] = 0x42;

// Set TendConfig with single byte extraData
IEverlongStrategy(address(strategy)).setTendConfig(
IEverlongStrategy.TendConfig({
minOutput: 999,
minVaultSharePrice: 888,
positionClosureLimit: 777,
extraData: singleByteData
})
);

// Retrieve the TendConfig
(, IEverlongStrategy.TendConfig memory tendConfig) = IEverlongStrategy(
address(strategy)
).getTendConfig();

// Assert all fields
assertEq(tendConfig.minOutput, 999, "minOutput mismatch");
assertEq(tendConfig.minVaultSharePrice, 888, "minVaultSharePrice mismatch");
assertEq(tendConfig.positionClosureLimit, 777, "positionClosureLimit mismatch");

// Check extraData
assertEq(tendConfig.extraData.length, 1, "extraData length should be 1");
assertEq(uint8(tendConfig.extraData[0]), 0x42, "extraData byte value mismatch");

// Stop the prank.
vm.stopPrank();
}
}
Loading