Use hardhat-exposed to reduce the need for mocks (#3666)
Co-authored-by: Francisco <fg@frang.io>
This commit is contained in:
Hadrien Croubois
GitHub
@ -1,7 +1,7 @@
|
||||
const { balance, ether, expectRevert, send, expectEvent } = require('@openzeppelin/test-helpers');
|
||||
const { balance, constants, ether, expectRevert, send, expectEvent } = require('@openzeppelin/test-helpers');
|
||||
const { expect } = require('chai');
|
||||
|
||||
const AddressImpl = artifacts.require('AddressImpl');
|
||||
const Address = artifacts.require('$Address');
|
||||
const EtherReceiver = artifacts.require('EtherReceiverMock');
|
||||
const CallReceiverMock = artifacts.require('CallReceiverMock');
|
||||
|
||||
@ -9,17 +9,16 @@ contract('Address', function (accounts) {
|
||||
const [ recipient, other ] = accounts;
|
||||
|
||||
beforeEach(async function () {
|
||||
this.mock = await AddressImpl.new();
|
||||
this.mock = await Address.new();
|
||||
});
|
||||
|
||||
describe('isContract', function () {
|
||||
it('returns false for account address', async function () {
|
||||
expect(await this.mock.isContract(other)).to.equal(false);
|
||||
expect(await this.mock.$isContract(other)).to.equal(false);
|
||||
});
|
||||
|
||||
it('returns true for contract address', async function () {
|
||||
const contract = await AddressImpl.new();
|
||||
expect(await this.mock.isContract(contract.address)).to.equal(true);
|
||||
expect(await this.mock.$isContract(this.mock.address)).to.equal(true);
|
||||
});
|
||||
});
|
||||
|
||||
@ -30,13 +29,16 @@ contract('Address', function (accounts) {
|
||||
|
||||
context('when sender contract has no funds', function () {
|
||||
it('sends 0 wei', async function () {
|
||||
await this.mock.sendValue(other, 0);
|
||||
await this.mock.$sendValue(other, 0);
|
||||
|
||||
expect(await this.recipientTracker.delta()).to.be.bignumber.equal('0');
|
||||
});
|
||||
|
||||
it('reverts when sending non-zero amounts', async function () {
|
||||
await expectRevert(this.mock.sendValue(other, 1), 'Address: insufficient balance');
|
||||
await expectRevert(
|
||||
this.mock.$sendValue(other, 1),
|
||||
'Address: insufficient balance',
|
||||
);
|
||||
});
|
||||
});
|
||||
|
||||
@ -47,42 +49,46 @@ contract('Address', function (accounts) {
|
||||
});
|
||||
|
||||
it('sends 0 wei', async function () {
|
||||
await this.mock.sendValue(recipient, 0);
|
||||
await this.mock.$sendValue(recipient, 0);
|
||||
expect(await this.recipientTracker.delta()).to.be.bignumber.equal('0');
|
||||
});
|
||||
|
||||
it('sends non-zero amounts', async function () {
|
||||
await this.mock.sendValue(recipient, funds.subn(1));
|
||||
await this.mock.$sendValue(recipient, funds.subn(1));
|
||||
expect(await this.recipientTracker.delta()).to.be.bignumber.equal(funds.subn(1));
|
||||
});
|
||||
|
||||
it('sends the whole balance', async function () {
|
||||
await this.mock.sendValue(recipient, funds);
|
||||
await this.mock.$sendValue(recipient, funds);
|
||||
expect(await this.recipientTracker.delta()).to.be.bignumber.equal(funds);
|
||||
expect(await balance.current(this.mock.address)).to.be.bignumber.equal('0');
|
||||
});
|
||||
|
||||
it('reverts when sending more than the balance', async function () {
|
||||
await expectRevert(this.mock.sendValue(recipient, funds.addn(1)), 'Address: insufficient balance');
|
||||
await expectRevert(
|
||||
this.mock.$sendValue(recipient, funds.addn(1)),
|
||||
'Address: insufficient balance',
|
||||
);
|
||||
});
|
||||
|
||||
context('with contract recipient', function () {
|
||||
beforeEach(async function () {
|
||||
this.contractRecipient = await EtherReceiver.new();
|
||||
this.target = await EtherReceiver.new();
|
||||
});
|
||||
|
||||
it('sends funds', async function () {
|
||||
const tracker = await balance.tracker(this.contractRecipient.address);
|
||||
const tracker = await balance.tracker(this.target.address);
|
||||
|
||||
await this.target.setAcceptEther(true);
|
||||
await this.mock.$sendValue(this.target.address, funds);
|
||||
|
||||
await this.contractRecipient.setAcceptEther(true);
|
||||
await this.mock.sendValue(this.contractRecipient.address, funds);
|
||||
expect(await tracker.delta()).to.be.bignumber.equal(funds);
|
||||
});
|
||||
|
||||
it('reverts on recipient revert', async function () {
|
||||
await this.contractRecipient.setAcceptEther(false);
|
||||
await this.target.setAcceptEther(false);
|
||||
await expectRevert(
|
||||
this.mock.sendValue(this.contractRecipient.address, funds),
|
||||
this.mock.$sendValue(this.target.address, funds),
|
||||
'Address: unable to send value, recipient may have reverted',
|
||||
);
|
||||
});
|
||||
@ -92,71 +98,55 @@ contract('Address', function (accounts) {
|
||||
|
||||
describe('functionCall', function () {
|
||||
beforeEach(async function () {
|
||||
this.contractRecipient = await CallReceiverMock.new();
|
||||
this.target = await CallReceiverMock.new();
|
||||
});
|
||||
|
||||
context('with valid contract receiver', function () {
|
||||
it('calls the requested function', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
const receipt = await this.mock.functionCall(this.contractRecipient.address, abiEncodedCall);
|
||||
const receipt = await this.mock.$functionCall(this.target.address, abiEncodedCall);
|
||||
|
||||
expectEvent(receipt, 'CallReturnValue', { data: '0x1234' });
|
||||
expectEvent(
|
||||
receipt,
|
||||
'return$functionCall_address_bytes',
|
||||
{ ret0: web3.eth.abi.encodeParameters(['string'], [ '0x1234' ]) },
|
||||
);
|
||||
await expectEvent.inTransaction(receipt.tx, CallReceiverMock, 'MockFunctionCalled');
|
||||
});
|
||||
|
||||
it('reverts when the called function reverts with no reason', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunctionRevertsNoReason',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunctionRevertsNoReason().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionCall(this.contractRecipient.address, abiEncodedCall),
|
||||
this.mock.$functionCall(this.target.address, abiEncodedCall),
|
||||
'Address: low-level call failed',
|
||||
);
|
||||
});
|
||||
|
||||
it('reverts when the called function reverts, bubbling up the revert reason', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunctionRevertsReason',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunctionRevertsReason().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionCall(this.contractRecipient.address, abiEncodedCall),
|
||||
this.mock.$functionCall(this.target.address, abiEncodedCall),
|
||||
'CallReceiverMock: reverting',
|
||||
);
|
||||
});
|
||||
|
||||
it('reverts when the called function runs out of gas', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunctionOutOfGas',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunctionOutOfGas().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionCall(this.contractRecipient.address, abiEncodedCall, { gas: '120000' }),
|
||||
this.mock.$functionCall(this.target.address, abiEncodedCall, { gas: '120000' }),
|
||||
'Address: low-level call failed',
|
||||
);
|
||||
});
|
||||
|
||||
it('reverts when the called function throws', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunctionThrows',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunctionThrows().encodeABI();
|
||||
|
||||
await expectRevert.unspecified(
|
||||
this.mock.functionCall(this.contractRecipient.address, abiEncodedCall),
|
||||
this.mock.$functionCall(this.target.address, abiEncodedCall),
|
||||
);
|
||||
});
|
||||
|
||||
@ -168,7 +158,7 @@ contract('Address', function (accounts) {
|
||||
}, []);
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionCall(this.contractRecipient.address, abiEncodedCall),
|
||||
this.mock.$functionCall(this.target.address, abiEncodedCall),
|
||||
'Address: low-level call failed',
|
||||
);
|
||||
});
|
||||
@ -177,32 +167,31 @@ contract('Address', function (accounts) {
|
||||
context('with non-contract receiver', function () {
|
||||
it('reverts when address is not a contract', async function () {
|
||||
const [ recipient ] = accounts;
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
await expectRevert(this.mock.functionCall(recipient, abiEncodedCall), 'Address: call to non-contract');
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.$functionCall(recipient, abiEncodedCall),
|
||||
'Address: call to non-contract',
|
||||
);
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
describe('functionCallWithValue', function () {
|
||||
beforeEach(async function () {
|
||||
this.contractRecipient = await CallReceiverMock.new();
|
||||
this.target = await CallReceiverMock.new();
|
||||
});
|
||||
|
||||
context('with zero value', function () {
|
||||
it('calls the requested function', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
const receipt = await this.mock.functionCallWithValue(this.contractRecipient.address, abiEncodedCall, 0);
|
||||
|
||||
expectEvent(receipt, 'CallReturnValue', { data: '0x1234' });
|
||||
const receipt = await this.mock.$functionCallWithValue(this.target.address, abiEncodedCall, 0);
|
||||
expectEvent(
|
||||
receipt,
|
||||
'return$functionCallWithValue_address_bytes_uint256',
|
||||
{ ret0: web3.eth.abi.encodeParameters(['string'], [ '0x1234' ]) },
|
||||
);
|
||||
await expectEvent.inTransaction(receipt.tx, CallReceiverMock, 'MockFunctionCalled');
|
||||
});
|
||||
});
|
||||
@ -211,66 +200,61 @@ contract('Address', function (accounts) {
|
||||
const amount = ether('1.2');
|
||||
|
||||
it('reverts if insufficient sender balance', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionCallWithValue(this.contractRecipient.address, abiEncodedCall, amount),
|
||||
this.mock.$functionCallWithValue(this.target.address, abiEncodedCall, amount),
|
||||
'Address: insufficient balance for call',
|
||||
);
|
||||
});
|
||||
|
||||
it('calls the requested function with existing value', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
const tracker = await balance.tracker(this.contractRecipient.address);
|
||||
const tracker = await balance.tracker(this.target.address);
|
||||
|
||||
await send.ether(other, this.mock.address, amount);
|
||||
const receipt = await this.mock.functionCallWithValue(this.contractRecipient.address, abiEncodedCall, amount);
|
||||
|
||||
const receipt = await this.mock.$functionCallWithValue(this.target.address, abiEncodedCall, amount);
|
||||
expectEvent(
|
||||
receipt,
|
||||
'return$functionCallWithValue_address_bytes_uint256',
|
||||
{ ret0: web3.eth.abi.encodeParameters(['string'], [ '0x1234' ]) },
|
||||
);
|
||||
await expectEvent.inTransaction(receipt.tx, CallReceiverMock, 'MockFunctionCalled');
|
||||
|
||||
expect(await tracker.delta()).to.be.bignumber.equal(amount);
|
||||
|
||||
expectEvent(receipt, 'CallReturnValue', { data: '0x1234' });
|
||||
await expectEvent.inTransaction(receipt.tx, CallReceiverMock, 'MockFunctionCalled');
|
||||
});
|
||||
|
||||
it('calls the requested function with transaction funds', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
const tracker = await balance.tracker(this.contractRecipient.address);
|
||||
const tracker = await balance.tracker(this.target.address);
|
||||
|
||||
expect(await balance.current(this.mock.address)).to.be.bignumber.equal('0');
|
||||
const receipt = await this.mock.functionCallWithValue(
|
||||
this.contractRecipient.address, abiEncodedCall, amount, { from: other, value: amount },
|
||||
|
||||
const receipt = await this.mock.$functionCallWithValue(
|
||||
this.target.address,
|
||||
abiEncodedCall,
|
||||
amount,
|
||||
{ from: other, value: amount },
|
||||
);
|
||||
expectEvent(
|
||||
receipt,
|
||||
'return$functionCallWithValue_address_bytes_uint256',
|
||||
{ ret0: web3.eth.abi.encodeParameters(['string'], [ '0x1234' ]) },
|
||||
);
|
||||
await expectEvent.inTransaction(receipt.tx, CallReceiverMock, 'MockFunctionCalled');
|
||||
|
||||
expect(await tracker.delta()).to.be.bignumber.equal(amount);
|
||||
|
||||
expectEvent(receipt, 'CallReturnValue', { data: '0x1234' });
|
||||
await expectEvent.inTransaction(receipt.tx, CallReceiverMock, 'MockFunctionCalled');
|
||||
});
|
||||
|
||||
it('reverts when calling non-payable functions', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunctionNonPayable',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunctionNonPayable().encodeABI();
|
||||
|
||||
await send.ether(other, this.mock.address, amount);
|
||||
await expectRevert(
|
||||
this.mock.functionCallWithValue(this.contractRecipient.address, abiEncodedCall, amount),
|
||||
this.mock.$functionCallWithValue(this.target.address, abiEncodedCall, amount),
|
||||
'Address: low-level call with value failed',
|
||||
);
|
||||
});
|
||||
@ -279,56 +263,40 @@ contract('Address', function (accounts) {
|
||||
|
||||
describe('functionStaticCall', function () {
|
||||
beforeEach(async function () {
|
||||
this.contractRecipient = await CallReceiverMock.new();
|
||||
this.target = await CallReceiverMock.new();
|
||||
});
|
||||
|
||||
it('calls the requested function', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockStaticFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockStaticFunction().encodeABI();
|
||||
|
||||
const receipt = await this.mock.functionStaticCall(this.contractRecipient.address, abiEncodedCall);
|
||||
|
||||
expectEvent(receipt, 'CallReturnValue', { data: '0x1234' });
|
||||
expect(await this.mock.$functionStaticCall(this.target.address, abiEncodedCall))
|
||||
.to.be.equal(web3.eth.abi.encodeParameters(['string'], [ '0x1234' ]));
|
||||
});
|
||||
|
||||
it('reverts on a non-static function', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionStaticCall(this.contractRecipient.address, abiEncodedCall),
|
||||
this.mock.$functionStaticCall(this.target.address, abiEncodedCall),
|
||||
'Address: low-level static call failed',
|
||||
);
|
||||
});
|
||||
|
||||
it('bubbles up revert reason', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunctionRevertsReason',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunctionRevertsReason().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionStaticCall(this.contractRecipient.address, abiEncodedCall),
|
||||
this.mock.$functionStaticCall(this.target.address, abiEncodedCall),
|
||||
'CallReceiverMock: reverting',
|
||||
);
|
||||
});
|
||||
|
||||
it('reverts when address is not a contract', async function () {
|
||||
const [ recipient ] = accounts;
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionStaticCall(recipient, abiEncodedCall),
|
||||
this.mock.$functionStaticCall(recipient, abiEncodedCall),
|
||||
'Address: call to non-contract',
|
||||
);
|
||||
});
|
||||
@ -336,45 +304,42 @@ contract('Address', function (accounts) {
|
||||
|
||||
describe('functionDelegateCall', function () {
|
||||
beforeEach(async function () {
|
||||
this.contractRecipient = await CallReceiverMock.new();
|
||||
this.target = await CallReceiverMock.new();
|
||||
});
|
||||
|
||||
it('delegate calls the requested function', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunctionWritesStorage',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
// pseudorandom values
|
||||
const slot = '0x93e4c53af435ddf777c3de84bb9a953a777788500e229a468ea1036496ab66a0';
|
||||
const value = '0x6a465d1c49869f71fb65562bcbd7e08c8044074927f0297127203f2a9924ff5b';
|
||||
|
||||
const receipt = await this.mock.functionDelegateCall(this.contractRecipient.address, abiEncodedCall);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunctionWritesStorage(slot, value).encodeABI();
|
||||
|
||||
expectEvent(receipt, 'CallReturnValue', { data: '0x1234' });
|
||||
expect(await web3.eth.getStorageAt(this.mock.address, slot)).to.be.equal(constants.ZERO_BYTES32);
|
||||
|
||||
expect(await this.mock.sharedAnswer()).to.equal('42');
|
||||
expectEvent(
|
||||
await this.mock.$functionDelegateCall(this.target.address, abiEncodedCall),
|
||||
'return$functionDelegateCall_address_bytes',
|
||||
{ ret0: web3.eth.abi.encodeParameters(['string'], [ '0x1234' ]) },
|
||||
);
|
||||
|
||||
expect(await web3.eth.getStorageAt(this.mock.address, slot)).to.be.equal(value);
|
||||
});
|
||||
|
||||
it('bubbles up revert reason', async function () {
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunctionRevertsReason',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunctionRevertsReason().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionDelegateCall(this.contractRecipient.address, abiEncodedCall),
|
||||
this.mock.$functionDelegateCall(this.target.address, abiEncodedCall),
|
||||
'CallReceiverMock: reverting',
|
||||
);
|
||||
});
|
||||
|
||||
it('reverts when address is not a contract', async function () {
|
||||
const [ recipient ] = accounts;
|
||||
const abiEncodedCall = web3.eth.abi.encodeFunctionCall({
|
||||
name: 'mockFunction',
|
||||
type: 'function',
|
||||
inputs: [],
|
||||
}, []);
|
||||
const abiEncodedCall = this.target.contract.methods.mockFunction().encodeABI();
|
||||
|
||||
await expectRevert(
|
||||
this.mock.functionDelegateCall(recipient, abiEncodedCall),
|
||||
this.mock.$functionDelegateCall(recipient, abiEncodedCall),
|
||||
'Address: call to non-contract',
|
||||
);
|
||||
});
|
||||
|
||||
Reference in New Issue
Block a user