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

Use hardhat-exposed to reduce the need for mocks (#3666)

Browse Source 
Co-authored-by: Francisco <fg@frang.io>
This commit is contained in:
Hadrien Croubois
2023-01-03 15:38:13 +01:00
committed by GitHub
parent a81b0d0b21
commit c1d9da4052
190 changed files with 2297 additions and 4311 deletions
Download Patch File Download Diff File Expand all files Collapse all files

131
test/utils/Checkpoints.test.js
View File

@ -4,22 +4,35 @@ const { expect } = require('chai');
const { batchInBlock } = require('../helpers/txpool');
const CheckpointsMock = artifacts.require('CheckpointsMock');
const $Checkpoints = artifacts.require('$Checkpoints');
const first = (array) => array.length ? array[0] : undefined;
const last = (array) => array.length ? array[array.length - 1] : undefined;
contract('Checkpoints', function () {
beforeEach(async function () {
this.mock = await $Checkpoints.new();
});
describe('History checkpoints', function () {
beforeEach(async function () {
this.checkpoint = await CheckpointsMock.new();
});
const latest = (self, ...args) =>
self.methods['$latest_Checkpoints_History(uint256)'](0, ...args);
const latestCheckpoint = (self, ...args) =>
self.methods['$latestCheckpoint_Checkpoints_History(uint256)'](0, ...args);
const push = (self, ...args) =>
self.methods['$push(uint256,uint256)'](0, ...args);
const getAtBlock = (self, ...args) =>
self.methods['$getAtBlock(uint256,uint256)'](0, ...args);
const getAtRecentBlock = (self, ...args) =>
self.methods['$getAtProbablyRecentBlock(uint256,uint256)'](0, ...args);
const getLength = (self, ...args) =>
self.methods['$length_Checkpoints_History(uint256)'](0, ...args);
describe('without checkpoints', function () {
it('returns zero as latest value', async function () {
expect(await this.checkpoint.latest()).to.be.bignumber.equal('0');
expect(await latest(this.mock)).to.be.bignumber.equal('0');
const ckpt = await this.checkpoint.latestCheckpoint();
const ckpt = await latestCheckpoint(this.mock);
expect(ckpt[0]).to.be.equal(false);
expect(ckpt[1]).to.be.bignumber.equal('0');
expect(ckpt[2]).to.be.bignumber.equal('0');
@ -27,51 +40,49 @@ contract('Checkpoints', function () {
it('returns zero as past value', async function () {
await time.advanceBlock();
expect(await this.checkpoint.getAtBlock(await web3.eth.getBlockNumber() - 1))
.to.be.bignumber.equal('0');
expect(await this.checkpoint.getAtProbablyRecentBlock(await web3.eth.getBlockNumber() - 1))
.to.be.bignumber.equal('0');
expect(await getAtBlock(this.mock, await web3.eth.getBlockNumber() - 1)).to.be.bignumber.equal('0');
expect(await getAtRecentBlock(this.mock, await web3.eth.getBlockNumber() - 1)).to.be.bignumber.equal('0');
});
});
describe('with checkpoints', function () {
beforeEach('pushing checkpoints', async function () {
this.tx1 = await this.checkpoint.push(1);
this.tx2 = await this.checkpoint.push(2);
this.tx1 = await push(this.mock, 1);
this.tx2 = await push(this.mock, 2);
await time.advanceBlock();
this.tx3 = await this.checkpoint.push(3);
this.tx3 = await push(this.mock, 3);
await time.advanceBlock();
await time.advanceBlock();
});
it('returns latest value', async function () {
expect(await this.checkpoint.latest()).to.be.bignumber.equal('3');
expect(await latest(this.mock)).to.be.bignumber.equal('3');
const ckpt = await this.checkpoint.latestCheckpoint();
const ckpt = await latestCheckpoint(this.mock);
expect(ckpt[0]).to.be.equal(true);
expect(ckpt[1]).to.be.bignumber.equal(web3.utils.toBN(this.tx3.receipt.blockNumber));
expect(ckpt[2]).to.be.bignumber.equal(web3.utils.toBN('3'));
});
for (const fn of [ 'getAtBlock(uint256)', 'getAtProbablyRecentBlock(uint256)' ]) {
describe(`lookup: ${fn}`, function () {
for (const getAtBlockVariant of [ getAtBlock, getAtRecentBlock ]) {
describe(`lookup: ${getAtBlockVariant}`, function () {
it('returns past values', async function () {
expect(await this.checkpoint.methods[fn](this.tx1.receipt.blockNumber - 1)).to.be.bignumber.equal('0');
expect(await this.checkpoint.methods[fn](this.tx1.receipt.blockNumber)).to.be.bignumber.equal('1');
expect(await this.checkpoint.methods[fn](this.tx2.receipt.blockNumber)).to.be.bignumber.equal('2');
expect(await getAtBlockVariant(this.mock, this.tx1.receipt.blockNumber - 1)).to.be.bignumber.equal('0');
expect(await getAtBlockVariant(this.mock, this.tx1.receipt.blockNumber)).to.be.bignumber.equal('1');
expect(await getAtBlockVariant(this.mock, this.tx2.receipt.blockNumber)).to.be.bignumber.equal('2');
// Block with no new checkpoints
expect(await this.checkpoint.methods[fn](this.tx2.receipt.blockNumber + 1)).to.be.bignumber.equal('2');
expect(await this.checkpoint.methods[fn](this.tx3.receipt.blockNumber)).to.be.bignumber.equal('3');
expect(await this.checkpoint.methods[fn](this.tx3.receipt.blockNumber + 1)).to.be.bignumber.equal('3');
expect(await getAtBlockVariant(this.mock, this.tx2.receipt.blockNumber + 1)).to.be.bignumber.equal('2');
expect(await getAtBlockVariant(this.mock, this.tx3.receipt.blockNumber)).to.be.bignumber.equal('3');
expect(await getAtBlockVariant(this.mock, this.tx3.receipt.blockNumber + 1)).to.be.bignumber.equal('3');
});
it('reverts if block number >= current block', async function () {
await expectRevert(
this.checkpoint.methods[fn](await web3.eth.getBlockNumber()),
getAtBlockVariant(this.mock, await web3.eth.getBlockNumber()),
'Checkpoints: block not yet mined',
);
await expectRevert(
this.checkpoint.methods[fn](await web3.eth.getBlockNumber() + 1),
getAtBlockVariant(this.mock, await web3.eth.getBlockNumber() + 1),
'Checkpoints: block not yet mined',
);
});
@ -79,51 +90,60 @@ contract('Checkpoints', function () {
}
it('multiple checkpoints in the same block', async function () {
const lengthBefore = await this.checkpoint.length();
const lengthBefore = await getLength(this.mock);
await batchInBlock([
() => this.checkpoint.push(8, { gas: 100000 }),
() => this.checkpoint.push(9, { gas: 100000 }),
() => this.checkpoint.push(10, { gas: 100000 }),
() => push(this.mock, 8, { gas: 100000 }),
() => push(this.mock, 9, { gas: 100000 }),
() => push(this.mock, 10, { gas: 100000 }),
]);
expect(await this.checkpoint.length()).to.be.bignumber.equal(lengthBefore.addn(1));
expect(await this.checkpoint.latest()).to.be.bignumber.equal('10');
expect(await getLength(this.mock)).to.be.bignumber.equal(lengthBefore.addn(1));
expect(await latest(this.mock)).to.be.bignumber.equal('10');
});
it('more than 5 checkpoints', async function () {
for (let i = 4; i <= 6; i++) {
await this.checkpoint.push(i);
await push(this.mock, i);
}
expect(await this.checkpoint.length()).to.be.bignumber.equal('6');
expect(await getLength(this.mock)).to.be.bignumber.equal('6');
const block = await web3.eth.getBlockNumber();
// recent
expect(await this.checkpoint.getAtProbablyRecentBlock(block - 1)).to.be.bignumber.equal('5');
expect(await getAtRecentBlock(this.mock, block - 1)).to.be.bignumber.equal('5');
// non-recent
expect(await this.checkpoint.getAtProbablyRecentBlock(block - 9)).to.be.bignumber.equal('0');
expect(await getAtRecentBlock(this.mock, block - 9)).to.be.bignumber.equal('0');
});
});
});
for (const length of [160, 224]) {
describe(`Trace${length}`, function () {
beforeEach(async function () {
this.contract = await artifacts.require(`Checkpoints${length}Mock`).new();
});
const latest = (self, ...args) =>
self.methods[`$latest_Checkpoints_Trace${length}(uint256)`](0, ...args);
const latestCheckpoint = (self, ...args) =>
self.methods[`$latestCheckpoint_Checkpoints_Trace${length}(uint256)`](0, ...args);
const push = (self, ...args) =>
self.methods[`$push(uint256,uint${256 - length},uint${length})`](0, ...args);
const upperLookup = (self, ...args) =>
self.methods[`$upperLookup(uint256,uint${256 - length})`](0, ...args);
const lowerLookup = (self, ...args) =>
self.methods[`$lowerLookup(uint256,uint${256 - length})`](0, ...args);
const getLength = (self, ...args) =>
self.methods[`$length_Checkpoints_Trace${length}(uint256)`](0, ...args);
describe('without checkpoints', function () {
it('returns zero as latest value', async function () {
expect(await this.contract.latest()).to.be.bignumber.equal('0');
expect(await latest(this.mock)).to.be.bignumber.equal('0');
const ckpt = await this.contract.latestCheckpoint();
const ckpt = await latestCheckpoint(this.mock);
expect(ckpt[0]).to.be.equal(false);
expect(ckpt[1]).to.be.bignumber.equal('0');
expect(ckpt[2]).to.be.bignumber.equal('0');
});
it('lookup returns 0', async function () {
expect(await this.contract.lowerLookup(0)).to.be.bignumber.equal('0');
expect(await this.contract.upperLookup(0)).to.be.bignumber.equal('0');
expect(await lowerLookup(this.mock, 0)).to.be.bignumber.equal('0');
expect(await upperLookup(this.mock, 0)).to.be.bignumber.equal('0');
});
});
@ -137,42 +157,47 @@ contract('Checkpoints', function () {
{ key: '11', value: '99' },
];
for (const { key, value } of this.checkpoints) {
await this.contract.push(key, value);
await push(this.mock, key, value);
}
});
it('returns latest value', async function () {
expect(await this.contract.latest()).to.be.bignumber.equal(last(this.checkpoints).value);
it('length', async function () {
expect(await getLength(this.mock))
.to.be.bignumber.equal(this.checkpoints.length.toString());
});
const ckpt = await this.contract.latestCheckpoint();
it('returns latest value', async function () {
expect(await latest(this.mock)).to.be.bignumber.equal(last(this.checkpoints).value);
const ckpt = await latestCheckpoint(this.mock);
expect(ckpt[0]).to.be.equal(true);
expect(ckpt[1]).to.be.bignumber.equal(last(this.checkpoints).key);
expect(ckpt[2]).to.be.bignumber.equal(last(this.checkpoints).value);
});
it('cannot push values in the past', async function () {
await expectRevert(this.contract.push(last(this.checkpoints).key - 1, '0'), 'Checkpoint: decreasing keys');
await expectRevert(push(this.mock, last(this.checkpoints).key - 1, '0'), 'Checkpoint: decreasing keys');
});
it('can update last value', async function () {
const newValue = '42';
// check length before the update
expect(await this.contract.length()).to.be.bignumber.equal(this.checkpoints.length.toString());
expect(await getLength(this.mock)).to.be.bignumber.equal(this.checkpoints.length.toString());
// update last key
await this.contract.push(last(this.checkpoints).key, newValue);
expect(await this.contract.latest()).to.be.bignumber.equal(newValue);
await push(this.mock, last(this.checkpoints).key, newValue);
expect(await latest(this.mock)).to.be.bignumber.equal(newValue);
// check that length did not change
expect(await this.contract.length()).to.be.bignumber.equal(this.checkpoints.length.toString());
expect(await getLength(this.mock)).to.be.bignumber.equal(this.checkpoints.length.toString());
});
it('lower lookup', async function () {
for (let i = 0; i < 14; ++i) {
const value = first(this.checkpoints.filter(x => i <= x.key))?.value || '0';
expect(await this.contract.lowerLookup(i)).to.be.bignumber.equal(value);
expect(await lowerLookup(this.mock, i)).to.be.bignumber.equal(value);
}
});
@ -180,7 +205,7 @@ contract('Checkpoints', function () {
for (let i = 0; i < 14; ++i) {
const value = last(this.checkpoints.filter(x => i >= x.key))?.value || '0';
expect(await this.contract.upperLookup(i)).to.be.bignumber.equal(value);
expect(await upperLookup(this.mock, i)).to.be.bignumber.equal(value);
}
});
});