Add fuzz tests for the Checkpoints library (#4146)
Co-authored-by: Francisco <fg@frang.io>
This commit is contained in:
@ -13,16 +13,10 @@ function getVersion(path) {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
for (const [file, template] of Object.entries({
|
function generateFromTemplate(file, template, outputPrefix = '') {
|
||||||
'utils/math/SafeCast.sol': './templates/SafeCast.js',
|
|
||||||
'utils/structs/EnumerableSet.sol': './templates/EnumerableSet.js',
|
|
||||||
'utils/structs/EnumerableMap.sol': './templates/EnumerableMap.js',
|
|
||||||
'utils/Checkpoints.sol': './templates/Checkpoints.js',
|
|
||||||
'utils/StorageSlot.sol': './templates/StorageSlot.js',
|
|
||||||
})) {
|
|
||||||
const script = path.relative(path.join(__dirname, '../..'), __filename);
|
const script = path.relative(path.join(__dirname, '../..'), __filename);
|
||||||
const input = path.join(path.dirname(script), template);
|
const input = path.join(path.dirname(script), template);
|
||||||
const output = `./contracts/${file}`;
|
const output = path.join(outputPrefix, file);
|
||||||
const version = getVersion(output);
|
const version = getVersion(output);
|
||||||
const content = format(
|
const content = format(
|
||||||
'// SPDX-License-Identifier: MIT',
|
'// SPDX-License-Identifier: MIT',
|
||||||
@ -35,3 +29,21 @@ for (const [file, template] of Object.entries({
|
|||||||
fs.writeFileSync(output, content);
|
fs.writeFileSync(output, content);
|
||||||
cp.execFileSync('prettier', ['--write', output]);
|
cp.execFileSync('prettier', ['--write', output]);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// Contracts
|
||||||
|
for (const [file, template] of Object.entries({
|
||||||
|
'utils/math/SafeCast.sol': './templates/SafeCast.js',
|
||||||
|
'utils/structs/EnumerableSet.sol': './templates/EnumerableSet.js',
|
||||||
|
'utils/structs/EnumerableMap.sol': './templates/EnumerableMap.js',
|
||||||
|
'utils/Checkpoints.sol': './templates/Checkpoints.js',
|
||||||
|
'utils/StorageSlot.sol': './templates/StorageSlot.js',
|
||||||
|
})) {
|
||||||
|
generateFromTemplate(file, template, './contracts/');
|
||||||
|
}
|
||||||
|
|
||||||
|
// Tests
|
||||||
|
for (const [file, template] of Object.entries({
|
||||||
|
'utils/Checkpoints.t.sol': './templates/Checkpoints.t.js',
|
||||||
|
})) {
|
||||||
|
generateFromTemplate(file, template, './test/');
|
||||||
|
}
|
||||||
|
|||||||
@ -1,26 +1,5 @@
|
|||||||
const format = require('../format-lines');
|
const format = require('../format-lines');
|
||||||
|
const { OPTS, LEGACY_OPTS } = require('./Checkpoints.opts.js');
|
||||||
// OPTIONS
|
|
||||||
const defaultOpts = size => ({
|
|
||||||
historyTypeName: `Trace${size}`,
|
|
||||||
checkpointTypeName: `Checkpoint${size}`,
|
|
||||||
checkpointFieldName: '_checkpoints',
|
|
||||||
keyTypeName: `uint${256 - size}`,
|
|
||||||
keyFieldName: '_key',
|
|
||||||
valueTypeName: `uint${size}`,
|
|
||||||
valueFieldName: '_value',
|
|
||||||
});
|
|
||||||
|
|
||||||
const VALUE_SIZES = [224, 160];
|
|
||||||
|
|
||||||
const OPTS = VALUE_SIZES.map(size => defaultOpts(size));
|
|
||||||
|
|
||||||
const LEGACY_OPTS = {
|
|
||||||
...defaultOpts(224),
|
|
||||||
historyTypeName: 'History',
|
|
||||||
checkpointTypeName: 'Checkpoint',
|
|
||||||
keyFieldName: '_blockNumber',
|
|
||||||
};
|
|
||||||
|
|
||||||
// TEMPLATE
|
// TEMPLATE
|
||||||
const header = `\
|
const header = `\
|
||||||
|
|||||||
22
scripts/generate/templates/Checkpoints.opts.js
Normal file
22
scripts/generate/templates/Checkpoints.opts.js
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
// OPTIONS
|
||||||
|
const VALUE_SIZES = [224, 160];
|
||||||
|
|
||||||
|
const defaultOpts = size => ({
|
||||||
|
historyTypeName: `Trace${size}`,
|
||||||
|
checkpointTypeName: `Checkpoint${size}`,
|
||||||
|
checkpointFieldName: '_checkpoints',
|
||||||
|
keyTypeName: `uint${256 - size}`,
|
||||||
|
keyFieldName: '_key',
|
||||||
|
valueTypeName: `uint${size}`,
|
||||||
|
valueFieldName: '_value',
|
||||||
|
});
|
||||||
|
|
||||||
|
module.exports = {
|
||||||
|
OPTS: VALUE_SIZES.map(size => defaultOpts(size)),
|
||||||
|
LEGACY_OPTS: {
|
||||||
|
...defaultOpts(224),
|
||||||
|
historyTypeName: 'History',
|
||||||
|
checkpointTypeName: 'Checkpoint',
|
||||||
|
keyFieldName: '_blockNumber',
|
||||||
|
},
|
||||||
|
};
|
||||||
252
scripts/generate/templates/Checkpoints.t.js
Normal file
252
scripts/generate/templates/Checkpoints.t.js
Normal file
@ -0,0 +1,252 @@
|
|||||||
|
const format = require('../format-lines');
|
||||||
|
const { capitalize } = require('../../helpers');
|
||||||
|
const { OPTS, LEGACY_OPTS } = require('./Checkpoints.opts.js');
|
||||||
|
|
||||||
|
// TEMPLATE
|
||||||
|
const header = `\
|
||||||
|
pragma solidity ^0.8.0;
|
||||||
|
|
||||||
|
import "forge-std/Test.sol";
|
||||||
|
import "../../contracts/utils/Checkpoints.sol";
|
||||||
|
import "../../contracts/utils/math/SafeCast.sol";
|
||||||
|
`;
|
||||||
|
|
||||||
|
/* eslint-disable max-len */
|
||||||
|
const common = opts => `\
|
||||||
|
using Checkpoints for Checkpoints.${opts.historyTypeName};
|
||||||
|
|
||||||
|
// Maximum gap between keys used during the fuzzing tests: the \`_prepareKeys\` function with make sure that
|
||||||
|
// key#n+1 is in the [key#n, key#n + _KEY_MAX_GAP] range.
|
||||||
|
uint8 internal constant _KEY_MAX_GAP = 64;
|
||||||
|
|
||||||
|
Checkpoints.${opts.historyTypeName} internal _ckpts;
|
||||||
|
|
||||||
|
// helpers
|
||||||
|
function _bound${capitalize(opts.keyTypeName)}(
|
||||||
|
${opts.keyTypeName} x,
|
||||||
|
${opts.keyTypeName} min,
|
||||||
|
${opts.keyTypeName} max
|
||||||
|
) internal view returns (${opts.keyTypeName}) {
|
||||||
|
return SafeCast.to${capitalize(opts.keyTypeName)}(bound(uint256(x), uint256(min), uint256(max)));
|
||||||
|
}
|
||||||
|
|
||||||
|
function _prepareKeys(
|
||||||
|
${opts.keyTypeName}[] memory keys,
|
||||||
|
${opts.keyTypeName} maxSpread
|
||||||
|
) internal view {
|
||||||
|
${opts.keyTypeName} lastKey = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
${opts.keyTypeName} key = _bound${capitalize(opts.keyTypeName)}(keys[i], lastKey, lastKey + maxSpread);
|
||||||
|
keys[i] = key;
|
||||||
|
lastKey = key;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function _assertLatestCheckpoint(
|
||||||
|
bool exist,
|
||||||
|
${opts.keyTypeName} key,
|
||||||
|
${opts.valueTypeName} value
|
||||||
|
) internal {
|
||||||
|
(bool _exist, ${opts.keyTypeName} _key, ${opts.valueTypeName} _value) = _ckpts.latestCheckpoint();
|
||||||
|
assertEq(_exist, exist);
|
||||||
|
assertEq(_key, key);
|
||||||
|
assertEq(_value, value);
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
|
const testTrace = opts => `\
|
||||||
|
// tests
|
||||||
|
function testPush(
|
||||||
|
${opts.keyTypeName}[] memory keys,
|
||||||
|
${opts.valueTypeName}[] memory values,
|
||||||
|
${opts.keyTypeName} pastKey
|
||||||
|
) public {
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
// initial state
|
||||||
|
assertEq(_ckpts.length(), 0);
|
||||||
|
assertEq(_ckpts.latest(), 0);
|
||||||
|
_assertLatestCheckpoint(false, 0, 0);
|
||||||
|
|
||||||
|
uint256 duplicates = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
${opts.keyTypeName} key = keys[i];
|
||||||
|
${opts.valueTypeName} value = values[i % values.length];
|
||||||
|
if (i > 0 && key == keys[i-1]) ++duplicates;
|
||||||
|
|
||||||
|
// push
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
|
||||||
|
// check length & latest
|
||||||
|
assertEq(_ckpts.length(), i + 1 - duplicates);
|
||||||
|
assertEq(_ckpts.latest(), value);
|
||||||
|
_assertLatestCheckpoint(true, key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (keys.length > 0) {
|
||||||
|
${opts.keyTypeName} lastKey = keys[keys.length - 1];
|
||||||
|
pastKey = _bound${capitalize(opts.keyTypeName)}(pastKey, 0, lastKey - 1);
|
||||||
|
|
||||||
|
vm.expectRevert();
|
||||||
|
this.push(pastKey, values[keys.length % values.length]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function push(${opts.keyTypeName} key, ${opts.valueTypeName} value) external {
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function testLookup(
|
||||||
|
${opts.keyTypeName}[] memory keys,
|
||||||
|
${opts.valueTypeName}[] memory values,
|
||||||
|
${opts.keyTypeName} lookup
|
||||||
|
) public {
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
${opts.keyTypeName} lastKey = keys.length == 0 ? 0 : keys[keys.length - 1];
|
||||||
|
lookup = _bound${capitalize(opts.keyTypeName)}(lookup, 0, lastKey + _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
${opts.valueTypeName} upper = 0;
|
||||||
|
${opts.valueTypeName} lower = 0;
|
||||||
|
${opts.keyTypeName} lowerKey = type(${opts.keyTypeName}).max;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
${opts.keyTypeName} key = keys[i];
|
||||||
|
${opts.valueTypeName} value = values[i % values.length];
|
||||||
|
|
||||||
|
// push
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
|
||||||
|
// track expected result of lookups
|
||||||
|
if (key <= lookup) {
|
||||||
|
upper = value;
|
||||||
|
}
|
||||||
|
// find the first key that is not smaller than the lookup key
|
||||||
|
if (key >= lookup && (i == 0 || keys[i-1] < lookup)) {
|
||||||
|
lowerKey = key;
|
||||||
|
}
|
||||||
|
if (key == lowerKey) {
|
||||||
|
lower = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// check lookup
|
||||||
|
assertEq(_ckpts.lowerLookup(lookup), lower);
|
||||||
|
assertEq(_ckpts.upperLookup(lookup), upper);
|
||||||
|
assertEq(_ckpts.upperLookupRecent(lookup), upper);
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
|
||||||
|
const testHistory = opts => `\
|
||||||
|
// tests
|
||||||
|
function testPush(
|
||||||
|
${opts.keyTypeName}[] memory keys,
|
||||||
|
${opts.valueTypeName}[] memory values,
|
||||||
|
${opts.keyTypeName} pastKey
|
||||||
|
) public {
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
// initial state
|
||||||
|
assertEq(_ckpts.length(), 0);
|
||||||
|
assertEq(_ckpts.latest(), 0);
|
||||||
|
_assertLatestCheckpoint(false, 0, 0);
|
||||||
|
|
||||||
|
uint256 duplicates = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
${opts.keyTypeName} key = keys[i];
|
||||||
|
${opts.valueTypeName} value = values[i % values.length];
|
||||||
|
if (i > 0 && key == keys[i - 1]) ++duplicates;
|
||||||
|
|
||||||
|
// push
|
||||||
|
vm.roll(key);
|
||||||
|
_ckpts.push(value);
|
||||||
|
|
||||||
|
// check length & latest
|
||||||
|
assertEq(_ckpts.length(), i + 1 - duplicates);
|
||||||
|
assertEq(_ckpts.latest(), value);
|
||||||
|
_assertLatestCheckpoint(true, key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Can't push any key in the past
|
||||||
|
if (keys.length > 0) {
|
||||||
|
${opts.keyTypeName} lastKey = keys[keys.length - 1];
|
||||||
|
pastKey = _bound${capitalize(opts.keyTypeName)}(pastKey, 0, lastKey - 1);
|
||||||
|
|
||||||
|
vm.roll(pastKey);
|
||||||
|
vm.expectRevert();
|
||||||
|
this.push(values[keys.length % values.length]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function push(${opts.valueTypeName} value) external {
|
||||||
|
_ckpts.push(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function testLookup(
|
||||||
|
${opts.keyTypeName}[] memory keys,
|
||||||
|
${opts.valueTypeName}[] memory values,
|
||||||
|
${opts.keyTypeName} lookup
|
||||||
|
) public {
|
||||||
|
vm.assume(keys.length > 0);
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
${opts.keyTypeName} lastKey = keys[keys.length - 1];
|
||||||
|
vm.assume(lastKey > 0);
|
||||||
|
lookup = _bound${capitalize(opts.keyTypeName)}(lookup, 0, lastKey - 1);
|
||||||
|
|
||||||
|
${opts.valueTypeName} upper = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
${opts.keyTypeName} key = keys[i];
|
||||||
|
${opts.valueTypeName} value = values[i % values.length];
|
||||||
|
|
||||||
|
// push
|
||||||
|
vm.roll(key);
|
||||||
|
_ckpts.push(value);
|
||||||
|
|
||||||
|
// track expected result of lookups
|
||||||
|
if (key <= lookup) {
|
||||||
|
upper = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// check lookup
|
||||||
|
assertEq(_ckpts.getAtBlock(lookup), upper);
|
||||||
|
assertEq(_ckpts.getAtProbablyRecentBlock(lookup), upper);
|
||||||
|
|
||||||
|
vm.expectRevert(); this.getAtBlock(lastKey);
|
||||||
|
vm.expectRevert(); this.getAtBlock(lastKey + 1);
|
||||||
|
vm.expectRevert(); this.getAtProbablyRecentBlock(lastKey);
|
||||||
|
vm.expectRevert(); this.getAtProbablyRecentBlock(lastKey + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function getAtBlock(${opts.keyTypeName} key) external view {
|
||||||
|
_ckpts.getAtBlock(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function getAtProbablyRecentBlock(${opts.keyTypeName} key) external view {
|
||||||
|
_ckpts.getAtProbablyRecentBlock(key);
|
||||||
|
}
|
||||||
|
`;
|
||||||
|
/* eslint-enable max-len */
|
||||||
|
|
||||||
|
// GENERATE
|
||||||
|
module.exports = format(
|
||||||
|
header,
|
||||||
|
// HISTORY
|
||||||
|
`contract Checkpoints${LEGACY_OPTS.historyTypeName}Test is Test {`,
|
||||||
|
[common(LEGACY_OPTS), testHistory(LEGACY_OPTS)],
|
||||||
|
'}',
|
||||||
|
// TRACEXXX
|
||||||
|
...OPTS.flatMap(opts => [
|
||||||
|
`contract Checkpoints${opts.historyTypeName}Test is Test {`,
|
||||||
|
[common(opts), testTrace(opts)],
|
||||||
|
'}',
|
||||||
|
]),
|
||||||
|
);
|
||||||
341
test/utils/Checkpoints.t.sol
Normal file
341
test/utils/Checkpoints.t.sol
Normal file
@ -0,0 +1,341 @@
|
|||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
// This file was procedurally generated from scripts/generate/templates/Checkpoints.t.js.
|
||||||
|
|
||||||
|
pragma solidity ^0.8.0;
|
||||||
|
|
||||||
|
import "forge-std/Test.sol";
|
||||||
|
import "../../contracts/utils/Checkpoints.sol";
|
||||||
|
import "../../contracts/utils/math/SafeCast.sol";
|
||||||
|
|
||||||
|
contract CheckpointsHistoryTest is Test {
|
||||||
|
using Checkpoints for Checkpoints.History;
|
||||||
|
|
||||||
|
// Maximum gap between keys used during the fuzzing tests: the `_prepareKeys` function with make sure that
|
||||||
|
// key#n+1 is in the [key#n, key#n + _KEY_MAX_GAP] range.
|
||||||
|
uint8 internal constant _KEY_MAX_GAP = 64;
|
||||||
|
|
||||||
|
Checkpoints.History internal _ckpts;
|
||||||
|
|
||||||
|
// helpers
|
||||||
|
function _boundUint32(uint32 x, uint32 min, uint32 max) internal view returns (uint32) {
|
||||||
|
return SafeCast.toUint32(bound(uint256(x), uint256(min), uint256(max)));
|
||||||
|
}
|
||||||
|
|
||||||
|
function _prepareKeys(uint32[] memory keys, uint32 maxSpread) internal view {
|
||||||
|
uint32 lastKey = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint32 key = _boundUint32(keys[i], lastKey, lastKey + maxSpread);
|
||||||
|
keys[i] = key;
|
||||||
|
lastKey = key;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function _assertLatestCheckpoint(bool exist, uint32 key, uint224 value) internal {
|
||||||
|
(bool _exist, uint32 _key, uint224 _value) = _ckpts.latestCheckpoint();
|
||||||
|
assertEq(_exist, exist);
|
||||||
|
assertEq(_key, key);
|
||||||
|
assertEq(_value, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// tests
|
||||||
|
function testPush(uint32[] memory keys, uint224[] memory values, uint32 pastKey) public {
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
// initial state
|
||||||
|
assertEq(_ckpts.length(), 0);
|
||||||
|
assertEq(_ckpts.latest(), 0);
|
||||||
|
_assertLatestCheckpoint(false, 0, 0);
|
||||||
|
|
||||||
|
uint256 duplicates = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint32 key = keys[i];
|
||||||
|
uint224 value = values[i % values.length];
|
||||||
|
if (i > 0 && key == keys[i - 1]) ++duplicates;
|
||||||
|
|
||||||
|
// push
|
||||||
|
vm.roll(key);
|
||||||
|
_ckpts.push(value);
|
||||||
|
|
||||||
|
// check length & latest
|
||||||
|
assertEq(_ckpts.length(), i + 1 - duplicates);
|
||||||
|
assertEq(_ckpts.latest(), value);
|
||||||
|
_assertLatestCheckpoint(true, key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Can't push any key in the past
|
||||||
|
if (keys.length > 0) {
|
||||||
|
uint32 lastKey = keys[keys.length - 1];
|
||||||
|
pastKey = _boundUint32(pastKey, 0, lastKey - 1);
|
||||||
|
|
||||||
|
vm.roll(pastKey);
|
||||||
|
vm.expectRevert();
|
||||||
|
this.push(values[keys.length % values.length]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function push(uint224 value) external {
|
||||||
|
_ckpts.push(value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function testLookup(uint32[] memory keys, uint224[] memory values, uint32 lookup) public {
|
||||||
|
vm.assume(keys.length > 0);
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
uint32 lastKey = keys[keys.length - 1];
|
||||||
|
vm.assume(lastKey > 0);
|
||||||
|
lookup = _boundUint32(lookup, 0, lastKey - 1);
|
||||||
|
|
||||||
|
uint224 upper = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint32 key = keys[i];
|
||||||
|
uint224 value = values[i % values.length];
|
||||||
|
|
||||||
|
// push
|
||||||
|
vm.roll(key);
|
||||||
|
_ckpts.push(value);
|
||||||
|
|
||||||
|
// track expected result of lookups
|
||||||
|
if (key <= lookup) {
|
||||||
|
upper = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// check lookup
|
||||||
|
assertEq(_ckpts.getAtBlock(lookup), upper);
|
||||||
|
assertEq(_ckpts.getAtProbablyRecentBlock(lookup), upper);
|
||||||
|
|
||||||
|
vm.expectRevert();
|
||||||
|
this.getAtBlock(lastKey);
|
||||||
|
vm.expectRevert();
|
||||||
|
this.getAtBlock(lastKey + 1);
|
||||||
|
vm.expectRevert();
|
||||||
|
this.getAtProbablyRecentBlock(lastKey);
|
||||||
|
vm.expectRevert();
|
||||||
|
this.getAtProbablyRecentBlock(lastKey + 1);
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function getAtBlock(uint32 key) external view {
|
||||||
|
_ckpts.getAtBlock(key);
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function getAtProbablyRecentBlock(uint32 key) external view {
|
||||||
|
_ckpts.getAtProbablyRecentBlock(key);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
contract CheckpointsTrace224Test is Test {
|
||||||
|
using Checkpoints for Checkpoints.Trace224;
|
||||||
|
|
||||||
|
// Maximum gap between keys used during the fuzzing tests: the `_prepareKeys` function with make sure that
|
||||||
|
// key#n+1 is in the [key#n, key#n + _KEY_MAX_GAP] range.
|
||||||
|
uint8 internal constant _KEY_MAX_GAP = 64;
|
||||||
|
|
||||||
|
Checkpoints.Trace224 internal _ckpts;
|
||||||
|
|
||||||
|
// helpers
|
||||||
|
function _boundUint32(uint32 x, uint32 min, uint32 max) internal view returns (uint32) {
|
||||||
|
return SafeCast.toUint32(bound(uint256(x), uint256(min), uint256(max)));
|
||||||
|
}
|
||||||
|
|
||||||
|
function _prepareKeys(uint32[] memory keys, uint32 maxSpread) internal view {
|
||||||
|
uint32 lastKey = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint32 key = _boundUint32(keys[i], lastKey, lastKey + maxSpread);
|
||||||
|
keys[i] = key;
|
||||||
|
lastKey = key;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function _assertLatestCheckpoint(bool exist, uint32 key, uint224 value) internal {
|
||||||
|
(bool _exist, uint32 _key, uint224 _value) = _ckpts.latestCheckpoint();
|
||||||
|
assertEq(_exist, exist);
|
||||||
|
assertEq(_key, key);
|
||||||
|
assertEq(_value, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// tests
|
||||||
|
function testPush(uint32[] memory keys, uint224[] memory values, uint32 pastKey) public {
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
// initial state
|
||||||
|
assertEq(_ckpts.length(), 0);
|
||||||
|
assertEq(_ckpts.latest(), 0);
|
||||||
|
_assertLatestCheckpoint(false, 0, 0);
|
||||||
|
|
||||||
|
uint256 duplicates = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint32 key = keys[i];
|
||||||
|
uint224 value = values[i % values.length];
|
||||||
|
if (i > 0 && key == keys[i - 1]) ++duplicates;
|
||||||
|
|
||||||
|
// push
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
|
||||||
|
// check length & latest
|
||||||
|
assertEq(_ckpts.length(), i + 1 - duplicates);
|
||||||
|
assertEq(_ckpts.latest(), value);
|
||||||
|
_assertLatestCheckpoint(true, key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (keys.length > 0) {
|
||||||
|
uint32 lastKey = keys[keys.length - 1];
|
||||||
|
pastKey = _boundUint32(pastKey, 0, lastKey - 1);
|
||||||
|
|
||||||
|
vm.expectRevert();
|
||||||
|
this.push(pastKey, values[keys.length % values.length]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function push(uint32 key, uint224 value) external {
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function testLookup(uint32[] memory keys, uint224[] memory values, uint32 lookup) public {
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
uint32 lastKey = keys.length == 0 ? 0 : keys[keys.length - 1];
|
||||||
|
lookup = _boundUint32(lookup, 0, lastKey + _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
uint224 upper = 0;
|
||||||
|
uint224 lower = 0;
|
||||||
|
uint32 lowerKey = type(uint32).max;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint32 key = keys[i];
|
||||||
|
uint224 value = values[i % values.length];
|
||||||
|
|
||||||
|
// push
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
|
||||||
|
// track expected result of lookups
|
||||||
|
if (key <= lookup) {
|
||||||
|
upper = value;
|
||||||
|
}
|
||||||
|
// find the first key that is not smaller than the lookup key
|
||||||
|
if (key >= lookup && (i == 0 || keys[i - 1] < lookup)) {
|
||||||
|
lowerKey = key;
|
||||||
|
}
|
||||||
|
if (key == lowerKey) {
|
||||||
|
lower = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// check lookup
|
||||||
|
assertEq(_ckpts.lowerLookup(lookup), lower);
|
||||||
|
assertEq(_ckpts.upperLookup(lookup), upper);
|
||||||
|
assertEq(_ckpts.upperLookupRecent(lookup), upper);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
contract CheckpointsTrace160Test is Test {
|
||||||
|
using Checkpoints for Checkpoints.Trace160;
|
||||||
|
|
||||||
|
// Maximum gap between keys used during the fuzzing tests: the `_prepareKeys` function with make sure that
|
||||||
|
// key#n+1 is in the [key#n, key#n + _KEY_MAX_GAP] range.
|
||||||
|
uint8 internal constant _KEY_MAX_GAP = 64;
|
||||||
|
|
||||||
|
Checkpoints.Trace160 internal _ckpts;
|
||||||
|
|
||||||
|
// helpers
|
||||||
|
function _boundUint96(uint96 x, uint96 min, uint96 max) internal view returns (uint96) {
|
||||||
|
return SafeCast.toUint96(bound(uint256(x), uint256(min), uint256(max)));
|
||||||
|
}
|
||||||
|
|
||||||
|
function _prepareKeys(uint96[] memory keys, uint96 maxSpread) internal view {
|
||||||
|
uint96 lastKey = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint96 key = _boundUint96(keys[i], lastKey, lastKey + maxSpread);
|
||||||
|
keys[i] = key;
|
||||||
|
lastKey = key;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function _assertLatestCheckpoint(bool exist, uint96 key, uint160 value) internal {
|
||||||
|
(bool _exist, uint96 _key, uint160 _value) = _ckpts.latestCheckpoint();
|
||||||
|
assertEq(_exist, exist);
|
||||||
|
assertEq(_key, key);
|
||||||
|
assertEq(_value, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
// tests
|
||||||
|
function testPush(uint96[] memory keys, uint160[] memory values, uint96 pastKey) public {
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
// initial state
|
||||||
|
assertEq(_ckpts.length(), 0);
|
||||||
|
assertEq(_ckpts.latest(), 0);
|
||||||
|
_assertLatestCheckpoint(false, 0, 0);
|
||||||
|
|
||||||
|
uint256 duplicates = 0;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint96 key = keys[i];
|
||||||
|
uint160 value = values[i % values.length];
|
||||||
|
if (i > 0 && key == keys[i - 1]) ++duplicates;
|
||||||
|
|
||||||
|
// push
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
|
||||||
|
// check length & latest
|
||||||
|
assertEq(_ckpts.length(), i + 1 - duplicates);
|
||||||
|
assertEq(_ckpts.latest(), value);
|
||||||
|
_assertLatestCheckpoint(true, key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (keys.length > 0) {
|
||||||
|
uint96 lastKey = keys[keys.length - 1];
|
||||||
|
pastKey = _boundUint96(pastKey, 0, lastKey - 1);
|
||||||
|
|
||||||
|
vm.expectRevert();
|
||||||
|
this.push(pastKey, values[keys.length % values.length]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// used to test reverts
|
||||||
|
function push(uint96 key, uint160 value) external {
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
}
|
||||||
|
|
||||||
|
function testLookup(uint96[] memory keys, uint160[] memory values, uint96 lookup) public {
|
||||||
|
vm.assume(values.length > 0 && values.length <= keys.length);
|
||||||
|
_prepareKeys(keys, _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
uint96 lastKey = keys.length == 0 ? 0 : keys[keys.length - 1];
|
||||||
|
lookup = _boundUint96(lookup, 0, lastKey + _KEY_MAX_GAP);
|
||||||
|
|
||||||
|
uint160 upper = 0;
|
||||||
|
uint160 lower = 0;
|
||||||
|
uint96 lowerKey = type(uint96).max;
|
||||||
|
for (uint256 i = 0; i < keys.length; ++i) {
|
||||||
|
uint96 key = keys[i];
|
||||||
|
uint160 value = values[i % values.length];
|
||||||
|
|
||||||
|
// push
|
||||||
|
_ckpts.push(key, value);
|
||||||
|
|
||||||
|
// track expected result of lookups
|
||||||
|
if (key <= lookup) {
|
||||||
|
upper = value;
|
||||||
|
}
|
||||||
|
// find the first key that is not smaller than the lookup key
|
||||||
|
if (key >= lookup && (i == 0 || keys[i - 1] < lookup)) {
|
||||||
|
lowerKey = key;
|
||||||
|
}
|
||||||
|
if (key == lowerKey) {
|
||||||
|
lower = value;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// check lookup
|
||||||
|
assertEq(_ckpts.lowerLookup(lookup), lower);
|
||||||
|
assertEq(_ckpts.upperLookup(lookup), upper);
|
||||||
|
assertEq(_ckpts.upperLookupRecent(lookup), upper);
|
||||||
|
}
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user