NoBey/openzeppelin-contracts
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Remove redundant memory usage in Checkpoints (#4540)

Browse Source 
Co-authored-by: Ernesto García <ernestognw@gmail.com>
This commit is contained in:
Vladislav Volosnikov
2024-01-17 10:51:36 +01:00
committed by GitHub
parent 692dbc560f
commit d2ba1f6251
3 changed files with 33 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
.changeset/brown-cooks-dress.md Normal file
View File

@ -0,0 +1,5 @@
---
'openzeppelin-solidity': patch
---
`Checkpoints`: Optimized checkpoint access by removing redundant memory usage.

39
contracts/utils/structs/Checkpoints.sol
View File

@ -104,7 +104,7 @@ library Checkpoints {
if (pos == 0) { if (pos == 0) {
return (false, 0, 0); return (false, 0, 0);
} else { } else {
Checkpoint224 memory ckpt = _unsafeAccess(self._checkpoints, pos - 1); Checkpoint224 storage ckpt = _unsafeAccess(self._checkpoints, pos - 1);
return (true, ckpt._key, ckpt._value); return (true, ckpt._key, ckpt._value);
} }
} }
@ -131,21 +131,22 @@ library Checkpoints {
uint256 pos = self.length; uint256 pos = self.length;
if (pos > 0) { if (pos > 0) {
// Copying to memory is important here. Checkpoint224 storage last = _unsafeAccess(self, pos - 1);
Checkpoint224 memory last = _unsafeAccess(self, pos - 1); uint32 lastKey = last._key;
uint224 lastValue = last._value;
// Checkpoint keys must be non-decreasing. // Checkpoint keys must be non-decreasing.
if (last._key > key) { if (lastKey > key) {
revert CheckpointUnorderedInsertion(); revert CheckpointUnorderedInsertion();
} }
// Update or push new checkpoint // Update or push new checkpoint
if (last._key == key) { if (lastKey == key) {
_unsafeAccess(self, pos - 1)._value = value; _unsafeAccess(self, pos - 1)._value = value;
} else { } else {
self.push(Checkpoint224({_key: key, _value: value})); self.push(Checkpoint224({_key: key, _value: value}));
} }
return (last._value, value); return (lastValue, value);
} else { } else {
self.push(Checkpoint224({_key: key, _value: value})); self.push(Checkpoint224({_key: key, _value: value}));
return (0, value); return (0, value);
@ -298,7 +299,7 @@ library Checkpoints {
if (pos == 0) { if (pos == 0) {
return (false, 0, 0); return (false, 0, 0);
} else { } else {
Checkpoint208 memory ckpt = _unsafeAccess(self._checkpoints, pos - 1); Checkpoint208 storage ckpt = _unsafeAccess(self._checkpoints, pos - 1);
return (true, ckpt._key, ckpt._value); return (true, ckpt._key, ckpt._value);
} }
} }
@ -325,21 +326,22 @@ library Checkpoints {
uint256 pos = self.length; uint256 pos = self.length;
if (pos > 0) { if (pos > 0) {
// Copying to memory is important here. Checkpoint208 storage last = _unsafeAccess(self, pos - 1);
Checkpoint208 memory last = _unsafeAccess(self, pos - 1); uint48 lastKey = last._key;
uint208 lastValue = last._value;
// Checkpoint keys must be non-decreasing. // Checkpoint keys must be non-decreasing.
if (last._key > key) { if (lastKey > key) {
revert CheckpointUnorderedInsertion(); revert CheckpointUnorderedInsertion();
} }
// Update or push new checkpoint // Update or push new checkpoint
if (last._key == key) { if (lastKey == key) {
_unsafeAccess(self, pos - 1)._value = value; _unsafeAccess(self, pos - 1)._value = value;
} else { } else {
self.push(Checkpoint208({_key: key, _value: value})); self.push(Checkpoint208({_key: key, _value: value}));
} }
return (last._value, value); return (lastValue, value);
} else { } else {
self.push(Checkpoint208({_key: key, _value: value})); self.push(Checkpoint208({_key: key, _value: value}));
return (0, value); return (0, value);
@ -492,7 +494,7 @@ library Checkpoints {
if (pos == 0) { if (pos == 0) {
return (false, 0, 0); return (false, 0, 0);
} else { } else {
Checkpoint160 memory ckpt = _unsafeAccess(self._checkpoints, pos - 1); Checkpoint160 storage ckpt = _unsafeAccess(self._checkpoints, pos - 1);
return (true, ckpt._key, ckpt._value); return (true, ckpt._key, ckpt._value);
} }
} }
@ -519,21 +521,22 @@ library Checkpoints {
uint256 pos = self.length; uint256 pos = self.length;
if (pos > 0) { if (pos > 0) {
// Copying to memory is important here. Checkpoint160 storage last = _unsafeAccess(self, pos - 1);
Checkpoint160 memory last = _unsafeAccess(self, pos - 1); uint96 lastKey = last._key;
uint160 lastValue = last._value;
// Checkpoint keys must be non-decreasing. // Checkpoint keys must be non-decreasing.
if (last._key > key) { if (lastKey > key) {
revert CheckpointUnorderedInsertion(); revert CheckpointUnorderedInsertion();
} }
// Update or push new checkpoint // Update or push new checkpoint
if (last._key == key) { if (lastKey == key) {
_unsafeAccess(self, pos - 1)._value = value; _unsafeAccess(self, pos - 1)._value = value;
} else { } else {
self.push(Checkpoint160({_key: key, _value: value})); self.push(Checkpoint160({_key: key, _value: value}));
} }
return (last._value, value); return (lastValue, value);
} else { } else {
self.push(Checkpoint160({_key: key, _value: value})); self.push(Checkpoint160({_key: key, _value: value}));
return (0, value); return (0, value);

13
scripts/generate/templates/Checkpoints.js
View File

@ -121,7 +121,7 @@ function latestCheckpoint(${opts.historyTypeName} storage self)
if (pos == 0) { if (pos == 0) {
return (false, 0, 0); return (false, 0, 0);
} else { } else {
${opts.checkpointTypeName} memory ckpt = _unsafeAccess(self.${opts.checkpointFieldName}, pos - 1); ${opts.checkpointTypeName} storage ckpt = _unsafeAccess(self.${opts.checkpointFieldName}, pos - 1);
return (true, ckpt.${opts.keyFieldName}, ckpt.${opts.valueFieldName}); return (true, ckpt.${opts.keyFieldName}, ckpt.${opts.valueFieldName});
} }
} }
@ -152,21 +152,22 @@ function _insert(
uint256 pos = self.length; uint256 pos = self.length;
if (pos > 0) { if (pos > 0) {
// Copying to memory is important here. ${opts.checkpointTypeName} storage last = _unsafeAccess(self, pos - 1);
${opts.checkpointTypeName} memory last = _unsafeAccess(self, pos - 1); ${opts.keyTypeName} lastKey = last.${opts.keyFieldName};
${opts.valueTypeName} lastValue = last.${opts.valueFieldName};
// Checkpoint keys must be non-decreasing. // Checkpoint keys must be non-decreasing.
if(last.${opts.keyFieldName} > key) { if (lastKey > key) {
revert CheckpointUnorderedInsertion(); revert CheckpointUnorderedInsertion();
} }
// Update or push new checkpoint // Update or push new checkpoint
if (last.${opts.keyFieldName} == key) { if (lastKey == key) {
_unsafeAccess(self, pos - 1).${opts.valueFieldName} = value; _unsafeAccess(self, pos - 1).${opts.valueFieldName} = value;
} else { } else {
self.push(${opts.checkpointTypeName}({${opts.keyFieldName}: key, ${opts.valueFieldName}: value})); self.push(${opts.checkpointTypeName}({${opts.keyFieldName}: key, ${opts.valueFieldName}: value}));
} }
return (last.${opts.valueFieldName}, value); return (lastValue, value);
} else { } else {
self.push(${opts.checkpointTypeName}({${opts.keyFieldName}: key, ${opts.valueFieldName}: value})); self.push(${opts.checkpointTypeName}({${opts.keyFieldName}: key, ${opts.valueFieldName}: value}));
return (0, value); return (0, value);