-
Notifications
You must be signed in to change notification settings - Fork 50
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
test: create test suite for core functionality of
LSP17Extendable
- Loading branch information
Showing
8 changed files
with
257 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -64,6 +64,7 @@ jobs: | |
| "lsp9init", | ||
| "lsp11", | ||
| "lsp11init", | ||
| "lsp17", | ||
| "lsp20", | ||
| "lsp20init", | ||
| "lsp23", | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
31 changes: 31 additions & 0 deletions
31
contracts/Mocks/FallbackExtensions/RevertErrorsTestExtension.sol
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| pragma solidity ^0.8.0; | ||
|
|
||
| /** | ||
| * @dev This contract is used only for testing purposes | ||
| */ | ||
| contract RevertErrorsTestExtension { | ||
| error SomeCustomError(address someAddress); | ||
|
|
||
| function revertWithCustomError() public view { | ||
| revert SomeCustomError(msg.sender); | ||
| } | ||
|
|
||
| function revertWithErrorString() public pure { | ||
| revert("some error message"); | ||
| } | ||
|
|
||
| function revertWithPanicError() public pure { | ||
| uint256 number = 2; | ||
|
|
||
| // trigger an arithmetic underflow. | ||
| // this should trigger a error of type `Panic(uint256)` | ||
| // with error code 17 (0x11) --> Panic(0x11) | ||
| number -= 10; | ||
| } | ||
|
|
||
| function revertWithNoErrorData() public pure { | ||
| // solhint-disable reason-string | ||
| revert(); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,68 @@ | ||
| // SPDX-License-Identifier: Apache-2.0 | ||
| pragma solidity ^0.8.4; | ||
|
|
||
| import {LSP17Extendable} from "../LSP17ContractExtension/LSP17Extendable.sol"; | ||
|
|
||
| /** | ||
| * @dev This contract is used only for testing purposes | ||
| */ | ||
| contract LSP17ExtendableTester is LSP17Extendable { | ||
| mapping(bytes4 => address) internal _extensions; | ||
|
|
||
| string internal _someStorageData; | ||
| string internal _anotherStorageData; | ||
|
|
||
| // This `receive()` function is just put there to disable the following solc compiler warning: | ||
| // | ||
| // "This contract has a payable fallback function, but no receive ether function. | ||
| // Consider adding a receive ether function." | ||
| receive() external payable {} | ||
|
|
||
| // solhint-disable no-complex-fallback | ||
| fallback() external payable { | ||
| // CHECK we can update the contract's storage BEFORE calling an extension | ||
| setStorageData("updated BEFORE calling `_fallbackLSP17Extendable`"); | ||
|
|
||
| _fallbackLSP17Extendable(msg.data); | ||
|
|
||
| // CHECK we can update the contract's storage AFTER calling an extension | ||
| setAnotherStorageData( | ||
| "updated AFTER calling `_fallbackLSP17Extendable`" | ||
| ); | ||
| } | ||
|
|
||
| function getExtension( | ||
| bytes4 functionSelector | ||
| ) public view returns (address) { | ||
| return _getExtension(functionSelector); | ||
| } | ||
|
|
||
| function setExtension( | ||
| bytes4 functionSelector, | ||
| address extensionContract | ||
| ) public { | ||
| _extensions[functionSelector] = extensionContract; | ||
| } | ||
|
|
||
| function getStorageData() public view returns (string memory) { | ||
| return _someStorageData; | ||
| } | ||
|
|
||
| function setStorageData(string memory newData) public { | ||
| _someStorageData = newData; | ||
| } | ||
|
|
||
| function getAnotherStorageData() public view returns (string memory) { | ||
| return _anotherStorageData; | ||
| } | ||
|
|
||
| function setAnotherStorageData(string memory newData) public { | ||
| _anotherStorageData = newData; | ||
| } | ||
|
|
||
| function _getExtension( | ||
| bytes4 functionSelector | ||
| ) internal view override returns (address) { | ||
| return _extensions[functionSelector]; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| import { expect } from 'chai'; | ||
| import { ethers } from 'hardhat'; | ||
|
|
||
| import { | ||
| LSP17ExtendableTester, | ||
| LSP17ExtendableTester__factory, | ||
| EmitEventExtension, | ||
| EmitEventExtension__factory, | ||
| RevertErrorsTestExtension, | ||
| RevertErrorsTestExtension__factory, | ||
| } from '../../types'; | ||
|
|
||
| describe('LSP17Extendable - Basic Implementation', () => { | ||
| let accounts; | ||
|
|
||
| let lsp17Implementation: LSP17ExtendableTester; | ||
| let exampleExtension: EmitEventExtension; | ||
| let errorsExtension: RevertErrorsTestExtension; | ||
|
|
||
| const selectorWithExtension = | ||
| EmitEventExtension__factory.createInterface().getSighash('emitEvent'); | ||
| const selectorWithNoExtension = '0xdeadbeef'; | ||
|
|
||
| // selectors to test that errors are bubbled up to the contract | ||
| const revertErrorsExtensionInterface = RevertErrorsTestExtension__factory.createInterface(); | ||
|
|
||
| const selectorRevertCustomError = | ||
| revertErrorsExtensionInterface.getSighash('revertWithCustomError'); | ||
|
|
||
| const selectorRevertErrorString = | ||
| revertErrorsExtensionInterface.getSighash('revertWithErrorString'); | ||
|
|
||
| const selectorRevertPanicError = | ||
| revertErrorsExtensionInterface.getSighash('revertWithPanicError'); | ||
|
|
||
| const selectorRevertNoErrorData = | ||
| revertErrorsExtensionInterface.getSighash('revertWithNoErrorData'); | ||
|
|
||
| before('setup', async () => { | ||
| accounts = await ethers.getSigners(); | ||
|
|
||
| lsp17Implementation = await new LSP17ExtendableTester__factory(accounts[0]).deploy(); | ||
| exampleExtension = await new EmitEventExtension__factory(accounts[0]).deploy(); | ||
| errorsExtension = await new RevertErrorsTestExtension__factory(accounts[0]).deploy(); | ||
|
|
||
| await lsp17Implementation.setExtension(selectorWithExtension, exampleExtension.address); | ||
|
|
||
| await lsp17Implementation.setExtension(selectorRevertCustomError, errorsExtension.address); | ||
| await lsp17Implementation.setExtension(selectorRevertErrorString, errorsExtension.address); | ||
| await lsp17Implementation.setExtension(selectorRevertPanicError, errorsExtension.address); | ||
| await lsp17Implementation.setExtension(selectorRevertNoErrorData, errorsExtension.address); | ||
| }); | ||
|
|
||
| // make sure storage is cleared before running each test | ||
| afterEach(async () => { | ||
| await lsp17Implementation.setStorageData('0x'); | ||
| await lsp17Implementation.setAnotherStorageData('0x'); | ||
| }); | ||
|
|
||
| describe('when there is no extension set', () => { | ||
| it('should revert with error `NoExtensionFoundForFunctionSelector', async () => { | ||
| await expect( | ||
| accounts[0].sendTransaction({ | ||
| to: lsp17Implementation.address, | ||
| data: selectorWithNoExtension, | ||
| }), | ||
| ).to.be.revertedWithCustomError(lsp17Implementation, 'NoExtensionFoundForFunctionSelector'); | ||
| }); | ||
| }); | ||
|
|
||
| describe('when there is an extension set', () => { | ||
| describe('if the extension does not revert', () => { | ||
| it('should pass and not revert', async () => { | ||
| await expect( | ||
| accounts[0].sendTransaction({ | ||
| to: lsp17Implementation.address, | ||
| data: selectorWithExtension, | ||
| }), | ||
| ).to.emit(exampleExtension, 'EventEmittedInExtension'); | ||
| }); | ||
|
|
||
| describe('if there is any code logic that run after extension was called', () => { | ||
| it("should have updated the contract's storage after the fallback LSP17 function ran", async () => { | ||
| const storageBefore = await lsp17Implementation.getStorageData(); | ||
| expect(storageBefore).to.equal('0x'); | ||
|
|
||
| const anotherStorageBefore = await lsp17Implementation.getAnotherStorageData(); | ||
| expect(anotherStorageBefore).to.equal('0x'); | ||
|
|
||
| await accounts[0].sendTransaction({ | ||
| to: lsp17Implementation.address, | ||
| data: selectorWithExtension, | ||
| }); | ||
|
|
||
| const storageAfter = await lsp17Implementation.getStorageData(); | ||
| expect(storageAfter).to.equal('updated BEFORE calling `_fallbackLSP17Extendable`'); | ||
|
|
||
| const anotherStorageAfter = await lsp17Implementation.getAnotherStorageData(); | ||
| expect(anotherStorageAfter).to.equal('updated AFTER calling `_fallbackLSP17Extendable`'); | ||
| }); | ||
| }); | ||
| }); | ||
|
|
||
| describe('if the extension revert', () => { | ||
| it('should bubble up custom errors', async () => { | ||
| await expect( | ||
| accounts[0].sendTransaction({ | ||
| to: lsp17Implementation.address, | ||
| data: selectorRevertCustomError, | ||
| }), | ||
| ) | ||
| .to.be.revertedWithCustomError(errorsExtension, 'SomeCustomError') | ||
| .withArgs(lsp17Implementation.address); | ||
| }); | ||
|
|
||
| it('should bubble up revert errors string', async () => { | ||
| await expect( | ||
| accounts[0].sendTransaction({ | ||
| to: lsp17Implementation.address, | ||
| data: selectorRevertErrorString, | ||
| }), | ||
| ).to.be.revertedWith('some error message'); | ||
| }); | ||
|
|
||
| it('should bubble up Panic type errors with their code', async () => { | ||
| await expect( | ||
| accounts[0].sendTransaction({ | ||
| to: lsp17Implementation.address, | ||
| data: selectorRevertPanicError, | ||
| }), | ||
| ).to.be.revertedWithPanic('0x11' || 17); | ||
| }); | ||
|
|
||
| it('should not bubble up anything with empty error data (`revert()`)', async () => { | ||
| await expect( | ||
| accounts[0].sendTransaction({ | ||
| to: lsp17Implementation.address, | ||
| data: selectorRevertNoErrorData, | ||
| }), | ||
| ).to.be.reverted; | ||
| }); | ||
| }); | ||
| }); | ||
| }); |