Implement recommendations from 5.0 audit Phase 1A (#4398)

Co-authored-by: Francisco Giordano <fg@frang.io>
Co-authored-by: Hadrien Croubois <hadrien.croubois@gmail.com>
This commit is contained in:
Ernesto García
2023-07-03 12:02:06 -06:00
committed by GitHub
parent 06861dce54
commit bb64458928
38 changed files with 779 additions and 666 deletions

View File

@ -6,42 +6,42 @@ const { expectRevertCustomError } = require('../../../helpers/customError');
function shouldBehaveLikeERC20Burnable(owner, initialBalance, [burner]) {
describe('burn', function () {
describe('when the given amount is not greater than balance of the sender', function () {
context('for a zero amount', function () {
describe('when the given value is not greater than balance of the sender', function () {
context('for a zero value', function () {
shouldBurn(new BN(0));
});
context('for a non-zero amount', function () {
context('for a non-zero value', function () {
shouldBurn(new BN(100));
});
function shouldBurn(amount) {
function shouldBurn(value) {
beforeEach(async function () {
this.receipt = await this.token.burn(amount, { from: owner });
this.receipt = await this.token.burn(value, { from: owner });
});
it('burns the requested amount', async function () {
expect(await this.token.balanceOf(owner)).to.be.bignumber.equal(initialBalance.sub(amount));
it('burns the requested value', async function () {
expect(await this.token.balanceOf(owner)).to.be.bignumber.equal(initialBalance.sub(value));
});
it('emits a transfer event', async function () {
expectEvent(this.receipt, 'Transfer', {
from: owner,
to: ZERO_ADDRESS,
value: amount,
value: value,
});
});
}
});
describe('when the given amount is greater than the balance of the sender', function () {
const amount = initialBalance.addn(1);
describe('when the given value is greater than the balance of the sender', function () {
const value = initialBalance.addn(1);
it('reverts', async function () {
await expectRevertCustomError(this.token.burn(amount, { from: owner }), 'ERC20InsufficientBalance', [
await expectRevertCustomError(this.token.burn(value, { from: owner }), 'ERC20InsufficientBalance', [
owner,
initialBalance,
amount,
value,
]);
});
});
@ -49,54 +49,54 @@ function shouldBehaveLikeERC20Burnable(owner, initialBalance, [burner]) {
describe('burnFrom', function () {
describe('on success', function () {
context('for a zero amount', function () {
context('for a zero value', function () {
shouldBurnFrom(new BN(0));
});
context('for a non-zero amount', function () {
context('for a non-zero value', function () {
shouldBurnFrom(new BN(100));
});
function shouldBurnFrom(amount) {
const originalAllowance = amount.muln(3);
function shouldBurnFrom(value) {
const originalAllowance = value.muln(3);
beforeEach(async function () {
await this.token.approve(burner, originalAllowance, { from: owner });
this.receipt = await this.token.burnFrom(owner, amount, { from: burner });
this.receipt = await this.token.burnFrom(owner, value, { from: burner });
});
it('burns the requested amount', async function () {
expect(await this.token.balanceOf(owner)).to.be.bignumber.equal(initialBalance.sub(amount));
it('burns the requested value', async function () {
expect(await this.token.balanceOf(owner)).to.be.bignumber.equal(initialBalance.sub(value));
});
it('decrements allowance', async function () {
expect(await this.token.allowance(owner, burner)).to.be.bignumber.equal(originalAllowance.sub(amount));
expect(await this.token.allowance(owner, burner)).to.be.bignumber.equal(originalAllowance.sub(value));
});
it('emits a transfer event', async function () {
expectEvent(this.receipt, 'Transfer', {
from: owner,
to: ZERO_ADDRESS,
value: amount,
value: value,
});
});
}
});
describe('when the given amount is greater than the balance of the sender', function () {
const amount = initialBalance.addn(1);
describe('when the given value is greater than the balance of the sender', function () {
const value = initialBalance.addn(1);
it('reverts', async function () {
await this.token.approve(burner, amount, { from: owner });
await expectRevertCustomError(
this.token.burnFrom(owner, amount, { from: burner }),
'ERC20InsufficientBalance',
[owner, initialBalance, amount],
);
await this.token.approve(burner, value, { from: owner });
await expectRevertCustomError(this.token.burnFrom(owner, value, { from: burner }), 'ERC20InsufficientBalance', [
owner,
initialBalance,
value,
]);
});
});
describe('when the given amount is greater than the allowance', function () {
describe('when the given value is greater than the allowance', function () {
const allowance = new BN(100);
it('reverts', async function () {