const { ethers } = require('hardhat'); const { expect } = require('chai'); const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers'); const { PANIC_CODES } = require('@nomicfoundation/hardhat-chai-matchers/panic'); const coder = ethers.AbiCoder.defaultAbiCoder(); async function fixture() { const [recipient, other] = await ethers.getSigners(); const mock = await ethers.deployContract('$Address'); const target = await ethers.deployContract('CallReceiverMock'); const targetEther = await ethers.deployContract('EtherReceiverMock'); return { recipient, other, mock, target, targetEther }; } describe('Address', function () { beforeEach(async function () { Object.assign(this, await loadFixture(fixture)); }); describe('sendValue', function () { describe('when sender contract has no funds', function () { it('sends 0 wei', async function () { await expect(this.mock.$sendValue(this.other, 0)).to.changeEtherBalance(this.recipient, 0); }); it('reverts when sending non-zero amounts', async function () { await expect(this.mock.$sendValue(this.other, 1)) .to.be.revertedWithCustomError(this.mock, 'AddressInsufficientBalance') .withArgs(this.mock.target); }); }); describe('when sender contract has funds', function () { const funds = ethers.parseEther('1'); beforeEach(async function () { await this.other.sendTransaction({ to: this.mock, value: funds }); }); describe('with EOA recipient', function () { it('sends 0 wei', async function () { await expect(this.mock.$sendValue(this.recipient, 0)).to.changeEtherBalance(this.recipient.address, 0); }); it('sends non-zero amounts', async function () { await expect(this.mock.$sendValue(this.recipient, funds - 1n)).to.changeEtherBalance( this.recipient, funds - 1n, ); }); it('sends the whole balance', async function () { await expect(this.mock.$sendValue(this.recipient, funds)).to.changeEtherBalance(this.recipient, funds); expect(await ethers.provider.getBalance(this.mock)).to.equal(0n); }); it('reverts when sending more than the balance', async function () { await expect(this.mock.$sendValue(this.recipient, funds + 1n)) .to.be.revertedWithCustomError(this.mock, 'AddressInsufficientBalance') .withArgs(this.mock.target); }); }); describe('with contract recipient', function () { it('sends funds', async function () { await this.targetEther.setAcceptEther(true); await expect(this.mock.$sendValue(this.targetEther, funds)).to.changeEtherBalance(this.targetEther, funds); }); it('reverts on recipient revert', async function () { await this.targetEther.setAcceptEther(false); await expect(this.mock.$sendValue(this.targetEther, funds)).to.be.revertedWithCustomError( this.mock, 'FailedInnerCall', ); }); }); }); }); describe('functionCall', function () { describe('with valid contract receiver', function () { it('calls the requested function', async function () { const call = this.target.interface.encodeFunctionData('mockFunction'); await expect(this.mock.$functionCall(this.target, call)) .to.emit(this.target, 'MockFunctionCalled') .to.emit(this.mock, 'return$functionCall') .withArgs(coder.encode(['string'], ['0x1234'])); }); it('calls the requested empty return function', async function () { const call = this.target.interface.encodeFunctionData('mockFunctionEmptyReturn'); await expect(this.mock.$functionCall(this.target, call)).to.emit(this.target, 'MockFunctionCalled'); }); it('reverts when the called function reverts with no reason', async function () { const call = this.target.interface.encodeFunctionData('mockFunctionRevertsNoReason'); await expect(this.mock.$functionCall(this.target, call)).to.be.revertedWithCustomError( this.mock, 'FailedInnerCall', ); }); it('reverts when the called function reverts, bubbling up the revert reason', async function () { const call = this.target.interface.encodeFunctionData('mockFunctionRevertsReason'); await expect(this.mock.$functionCall(this.target, call)).to.be.revertedWith('CallReceiverMock: reverting'); }); it('reverts when the called function runs out of gas', async function () { const call = this.target.interface.encodeFunctionData('mockFunctionOutOfGas'); await expect(this.mock.$functionCall(this.target, call, { gasLimit: 120_000n })).to.be.revertedWithCustomError( this.mock, 'FailedInnerCall', ); }); it('reverts when the called function throws', async function () { const call = this.target.interface.encodeFunctionData('mockFunctionThrows'); await expect(this.mock.$functionCall(this.target, call)).to.be.revertedWithPanic(PANIC_CODES.ASSERTION_ERROR); }); it('reverts when function does not exist', async function () { const interface = new ethers.Interface(['function mockFunctionDoesNotExist()']); const call = interface.encodeFunctionData('mockFunctionDoesNotExist'); await expect(this.mock.$functionCall(this.target, call)).to.be.revertedWithCustomError( this.mock, 'FailedInnerCall', ); }); }); describe('with non-contract receiver', function () { it('reverts when address is not a contract', async function () { const call = this.target.interface.encodeFunctionData('mockFunction'); await expect(this.mock.$functionCall(this.recipient, call)) .to.be.revertedWithCustomError(this.mock, 'AddressEmptyCode') .withArgs(this.recipient.address); }); }); }); describe('functionCallWithValue', function () { describe('with zero value', function () { it('calls the requested function', async function () { const call = this.target.interface.encodeFunctionData('mockFunction'); await expect(this.mock.$functionCallWithValue(this.target, call, 0)) .to.emit(this.target, 'MockFunctionCalled') .to.emit(this.mock, 'return$functionCallWithValue') .withArgs(coder.encode(['string'], ['0x1234'])); }); }); describe('with non-zero value', function () { const value = ethers.parseEther('1.2'); it('reverts if insufficient sender balance', async function () { const call = this.target.interface.encodeFunctionData('mockFunction'); await expect(this.mock.$functionCallWithValue(this.target, call, value)) .to.be.revertedWithCustomError(this.mock, 'AddressInsufficientBalance') .withArgs(this.mock.target); }); it('calls the requested function with existing value', async function () { await this.other.sendTransaction({ to: this.mock, value }); const call = this.target.interface.encodeFunctionData('mockFunction'); const tx = await this.mock.$functionCallWithValue(this.target, call, value); await expect(tx).to.changeEtherBalance(this.target, value); await expect(tx) .to.emit(this.target, 'MockFunctionCalled') .to.emit(this.mock, 'return$functionCallWithValue') .withArgs(coder.encode(['string'], ['0x1234'])); }); it('calls the requested function with transaction funds', async function () { expect(await ethers.provider.getBalance(this.mock)).to.equal(0n); const call = this.target.interface.encodeFunctionData('mockFunction'); const tx = await this.mock.connect(this.other).$functionCallWithValue(this.target, call, value, { value }); await expect(tx).to.changeEtherBalance(this.target, value); await expect(tx) .to.emit(this.target, 'MockFunctionCalled') .to.emit(this.mock, 'return$functionCallWithValue') .withArgs(coder.encode(['string'], ['0x1234'])); }); it('reverts when calling non-payable functions', async function () { await this.other.sendTransaction({ to: this.mock, value }); const call = this.target.interface.encodeFunctionData('mockFunctionNonPayable'); await expect(this.mock.$functionCallWithValue(this.target, call, value)).to.be.revertedWithCustomError( this.mock, 'FailedInnerCall', ); }); }); }); describe('functionStaticCall', function () { it('calls the requested function', async function () { const call = this.target.interface.encodeFunctionData('mockStaticFunction'); expect(await this.mock.$functionStaticCall(this.target, call)).to.equal(coder.encode(['string'], ['0x1234'])); }); it('reverts on a non-static function', async function () { const call = this.target.interface.encodeFunctionData('mockFunction'); await expect(this.mock.$functionStaticCall(this.target, call)).to.be.revertedWithCustomError( this.mock, 'FailedInnerCall', ); }); it('bubbles up revert reason', async function () { const call = this.target.interface.encodeFunctionData('mockFunctionRevertsReason'); await expect(this.mock.$functionStaticCall(this.target, call)).to.be.revertedWith('CallReceiverMock: reverting'); }); it('reverts when address is not a contract', async function () { const call = this.target.interface.encodeFunctionData('mockFunction'); await expect(this.mock.$functionStaticCall(this.recipient, call)) .to.be.revertedWithCustomError(this.mock, 'AddressEmptyCode') .withArgs(this.recipient.address); }); }); describe('functionDelegateCall', function () { it('delegate calls the requested function', async function () { const slot = ethers.hexlify(ethers.randomBytes(32)); const value = ethers.hexlify(ethers.randomBytes(32)); const call = this.target.interface.encodeFunctionData('mockFunctionWritesStorage', [slot, value]); expect(await ethers.provider.getStorage(this.mock, slot)).to.equal(ethers.ZeroHash); await expect(await this.mock.$functionDelegateCall(this.target, call)) .to.emit(this.mock, 'return$functionDelegateCall') .withArgs(coder.encode(['string'], ['0x1234'])); expect(await ethers.provider.getStorage(this.mock, slot)).to.equal(value); }); it('bubbles up revert reason', async function () { const call = this.target.interface.encodeFunctionData('mockFunctionRevertsReason'); await expect(this.mock.$functionDelegateCall(this.target, call)).to.be.revertedWith( 'CallReceiverMock: reverting', ); }); it('reverts when address is not a contract', async function () { const call = this.target.interface.encodeFunctionData('mockFunction'); await expect(this.mock.$functionDelegateCall(this.recipient, call)) .to.be.revertedWithCustomError(this.mock, 'AddressEmptyCode') .withArgs(this.recipient.address); }); }); describe('verifyCallResult', function () { it('returns returndata on success', async function () { const returndata = '0x123abc'; expect(await this.mock.$verifyCallResult(true, returndata)).to.equal(returndata); }); }); });