Move ERC721 and ERC1155 receiver checks to dedicate libraries (#4845)

Co-authored-by: Ernesto García <ernestognw@gmail.com>
2024-01-30 19:58:35 +01:00
parent 61117c4db8
commit 7eba10dd1e
7 changed files with 540 additions and 101 deletions
--- a/test/token/ERC721/utils/ERC721Utils.test.js
+++ b/test/token/ERC721/utils/ERC721Utils.test.js
@ -0,0 +1,94 @@
+const { ethers } = require('hardhat');
+const { expect } = require('chai');
+const { loadFixture } = require('@nomicfoundation/hardhat-network-helpers');
+const { RevertType } = require('../../../helpers/enums');
+const { PANIC_CODES } = require('@nomicfoundation/hardhat-chai-matchers/panic');
+
+const tokenId = 1n;
+
+const RECEIVER_MAGIC_VALUE = '0x150b7a02';
+
+const deployReceiver = (revertType, returnValue = RECEIVER_MAGIC_VALUE) =>
+  ethers.deployContract('$ERC721ReceiverMock', [returnValue, revertType]);
+
+const fixture = async () => {
+  const [eoa, operator, owner] = await ethers.getSigners();
+  const utils = await ethers.deployContract('$ERC721Utils');
+
+  const receivers = {
+    correct: await deployReceiver(RevertType.None),
+    invalid: await deployReceiver(RevertType.None, '0xdeadbeef'),
+    message: await deployReceiver(RevertType.RevertWithMessage),
+    empty: await deployReceiver(RevertType.RevertWithoutMessage),
+    customError: await deployReceiver(RevertType.RevertWithCustomError),
+    panic: await deployReceiver(RevertType.Panic),
+    nonReceiver: await ethers.deployContract('CallReceiverMock'),
+    eoa,
+  };
+
+  return { operator, owner, utils, receivers };
+};
+
+describe('ERC721Utils', function () {
+  beforeEach(async function () {
+    Object.assign(this, await loadFixture(fixture));
+  });
+
+  describe('onERC721Received', function () {
+    it('succeeds when called by an EOA', async function () {
+      await expect(this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.eoa, tokenId, '0x')).to
+        .not.be.reverted;
+    });
+
+    it('succeeds when data is passed', async function () {
+      const data = '0x12345678';
+      await expect(this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.correct, tokenId, data))
+        .to.not.be.reverted;
+    });
+
+    it('succeeds when data is empty', async function () {
+      await expect(this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.correct, tokenId, '0x'))
+        .to.not.be.reverted;
+    });
+
+    it('reverts when receiver returns invalid value', async function () {
+      await expect(this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.invalid, tokenId, '0x'))
+        .to.be.revertedWithCustomError(this.utils, 'ERC721InvalidReceiver')
+        .withArgs(this.receivers.invalid);
+    });
+
+    it('reverts when receiver reverts with message', async function () {
+      await expect(
+        this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.message, tokenId, '0x'),
+      ).to.be.revertedWith('ERC721ReceiverMock: reverting');
+    });
+
+    it('reverts when receiver reverts without message', async function () {
+      await expect(this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.empty, tokenId, '0x'))
+        .to.be.revertedWithCustomError(this.utils, 'ERC721InvalidReceiver')
+        .withArgs(this.receivers.empty);
+    });
+
+    it('reverts when receiver reverts with custom error', async function () {
+      await expect(
+        this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.customError, tokenId, '0x'),
+      )
+        .to.be.revertedWithCustomError(this.receivers.customError, 'CustomError')
+        .withArgs(RECEIVER_MAGIC_VALUE);
+    });
+
+    it('reverts when receiver panics', async function () {
+      await expect(
+        this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.panic, tokenId, '0x'),
+      ).to.be.revertedWithPanic(PANIC_CODES.DIVISION_BY_ZERO);
+    });
+
+    it('reverts when receiver does not implement onERC721Received', async function () {
+      await expect(
+        this.utils.$checkOnERC721Received(this.operator, this.owner, this.receivers.nonReceiver, tokenId, '0x'),
+      )
+        .to.be.revertedWithCustomError(this.utils, 'ERC721InvalidReceiver')
+        .withArgs(this.receivers.nonReceiver);
+    });
+  });
+});