ERC721 extension for efficient batch minting (#3311)

Co-authored-by: Francisco <frangio.1@gmail.com>
This commit is contained in:
Hadrien Croubois
2022-09-05 23:09:30 +02:00
committed by GitHub
parent 005a35b02a
commit 171fa40bc8
17 changed files with 845 additions and 78 deletions

View File

@ -0,0 +1,191 @@
const { constants, expectEvent, expectRevert } = require('@openzeppelin/test-helpers');
const { expect } = require('chai');
const ERC721ConsecutiveMock = artifacts.require('ERC721ConsecutiveMock');
const ERC721ConsecutiveEnumerableMock = artifacts.require('ERC721ConsecutiveEnumerableMock');
const ERC721ConsecutiveNoConstructorMintMock = artifacts.require('ERC721ConsecutiveNoConstructorMintMock');
contract('ERC721Consecutive', function (accounts) {
const [ user1, user2, user3, receiver ] = accounts;
const name = 'Non Fungible Token';
const symbol = 'NFT';
const batches = [
{ receiver: user1, amount: 0 },
{ receiver: user1, amount: 3 },
{ receiver: user2, amount: 5 },
{ receiver: user3, amount: 0 },
{ receiver: user1, amount: 7 },
];
const delegates = [ user1, user3 ];
describe('with valid batches', function () {
beforeEach(async function () {
this.token = await ERC721ConsecutiveMock.new(
name,
symbol,
delegates,
batches.map(({ receiver }) => receiver),
batches.map(({ amount }) => amount),
);
});
describe('minting during construction', function () {
it('events are emitted at construction', async function () {
let first = 0;
for (const batch of batches) {
if (batch.amount > 0) {
await expectEvent.inConstruction(this.token, 'ConsecutiveTransfer', {
fromTokenId: web3.utils.toBN(first),
toTokenId: web3.utils.toBN(first + batch.amount - 1),
fromAddress: constants.ZERO_ADDRESS,
toAddress: batch.receiver,
});
} else {
// expectEvent.notEmitted.inConstruction only looks at event name, and doesn't check the parameters
}
first += batch.amount;
}
});
it('ownership is set', async function () {
const owners = batches.flatMap(({ receiver, amount }) => Array(amount).fill(receiver));
for (const tokenId in owners) {
expect(await this.token.ownerOf(tokenId))
.to.be.equal(owners[tokenId]);
}
});
it('balance & voting power are set', async function () {
for (const account of accounts) {
const balance = batches
.filter(({ receiver }) => receiver === account)
.map(({ amount }) => amount)
.reduce((a, b) => a + b, 0);
expect(await this.token.balanceOf(account))
.to.be.bignumber.equal(web3.utils.toBN(balance));
// If not delegated at construction, check before + do delegation
if (!delegates.includes(account)) {
expect(await this.token.getVotes(account))
.to.be.bignumber.equal(web3.utils.toBN(0));
await this.token.delegate(account, { from: account });
}
// At this point all accounts should have delegated
expect(await this.token.getVotes(account))
.to.be.bignumber.equal(web3.utils.toBN(balance));
}
});
});
describe('minting after construction', function () {
it('consecutive minting is not possible after construction', async function () {
await expectRevert(
this.token.mintConsecutive(user1, 10),
'ERC721Consecutive: batch minting restricted to constructor',
);
});
it('simple minting is possible after construction', async function () {
const tokenId = batches.reduce((acc, { amount }) => acc + amount, 0);
expect(await this.token.exists(tokenId)).to.be.equal(false);
expectEvent(
await this.token.mint(user1, tokenId),
'Transfer',
{ from: constants.ZERO_ADDRESS, to: user1, tokenId: tokenId.toString() },
);
});
it('cannot mint a token that has been batched minted', async function () {
const tokenId = batches.reduce((acc, { amount }) => acc + amount, 0) - 1;
expect(await this.token.exists(tokenId)).to.be.equal(true);
await expectRevert(
this.token.mint(user1, tokenId),
'ERC721: token already minted',
);
});
});
describe('ERC721 behavior', function () {
it('core takes over ownership on transfer', async function () {
await this.token.transferFrom(user1, receiver, 1, { from: user1 });
expect(await this.token.ownerOf(1)).to.be.equal(receiver);
});
it('tokens can be burned and re-minted', async function () {
expectEvent(
await this.token.burn(1, { from: user1 }),
'Transfer',
{ from: user1, to: constants.ZERO_ADDRESS, tokenId: '1' },
);
await expectRevert(this.token.ownerOf(1), 'ERC721: invalid token ID');
expectEvent(
await this.token.mint(user2, 1),
'Transfer',
{ from: constants.ZERO_ADDRESS, to: user2, tokenId: '1' },
);
expect(await this.token.ownerOf(1)).to.be.equal(user2);
});
});
});
describe('invalid use', function () {
it('cannot mint a batch larger than 5000', async function () {
await expectRevert(
ERC721ConsecutiveMock.new(
name,
symbol,
[],
[user1],
['5001'],
),
'ERC721Consecutive: batch too large',
);
});
it('cannot use single minting during construction', async function () {
await expectRevert(
ERC721ConsecutiveNoConstructorMintMock.new(
name,
symbol,
),
'ERC721Consecutive: can\'t mint during construction',
);
});
it('cannot use single minting during construction', async function () {
await expectRevert(
ERC721ConsecutiveNoConstructorMintMock.new(
name,
symbol,
),
'ERC721Consecutive: can\'t mint during construction',
);
});
it('consecutive mint not compatible with enumerability', async function () {
await expectRevert(
ERC721ConsecutiveEnumerableMock.new(
name,
symbol,
batches.map(({ receiver }) => receiver),
batches.map(({ amount }) => amount),
),
'ERC721Enumerable: consecutive transfers not supported',
);
});
});
});

View File

@ -18,6 +18,11 @@ contract('Checkpoints', function (accounts) {
describe('without checkpoints', function () {
it('returns zero as latest value', async function () {
expect(await this.checkpoint.latest()).to.be.bignumber.equal('0');
const ckpt = await this.checkpoint.latestCheckpoint();
expect(ckpt[0]).to.be.equal(false);
expect(ckpt[1]).to.be.bignumber.equal('0');
expect(ckpt[2]).to.be.bignumber.equal('0');
});
it('returns zero as past value', async function () {
@ -41,6 +46,11 @@ contract('Checkpoints', function (accounts) {
it('returns latest value', async function () {
expect(await this.checkpoint.latest()).to.be.bignumber.equal('3');
const ckpt = await this.checkpoint.latestCheckpoint();
expect(ckpt[0]).to.be.equal(true);
expect(ckpt[1]).to.be.bignumber.equal(web3.utils.toBN(this.tx3.receipt.blockNumber));
expect(ckpt[2]).to.be.bignumber.equal(web3.utils.toBN('3'));
});
for (const fn of [ 'getAtBlock(uint256)', 'getAtProbablyRecentBlock(uint256)' ]) {
@ -104,6 +114,11 @@ contract('Checkpoints', function (accounts) {
describe('without checkpoints', function () {
it('returns zero as latest value', async function () {
expect(await this.contract.latest()).to.be.bignumber.equal('0');
const ckpt = await this.contract.latestCheckpoint();
expect(ckpt[0]).to.be.equal(false);
expect(ckpt[1]).to.be.bignumber.equal('0');
expect(ckpt[2]).to.be.bignumber.equal('0');
});
it('lookup returns 0', async function () {
@ -115,11 +130,11 @@ contract('Checkpoints', function (accounts) {
describe('with checkpoints', function () {
beforeEach('pushing checkpoints', async function () {
this.checkpoints = [
{ key: 2, value: '17' },
{ key: 3, value: '42' },
{ key: 5, value: '101' },
{ key: 7, value: '23' },
{ key: 11, value: '99' },
{ key: '2', value: '17' },
{ key: '3', value: '42' },
{ key: '5', value: '101' },
{ key: '7', value: '23' },
{ key: '11', value: '99' },
];
for (const { key, value } of this.checkpoints) {
await this.contract.push(key, value);
@ -127,8 +142,12 @@ contract('Checkpoints', function (accounts) {
});
it('returns latest value', async function () {
expect(await this.contract.latest())
.to.be.bignumber.equal(last(this.checkpoints).value);
expect(await this.contract.latest()).to.be.bignumber.equal(last(this.checkpoints).value);
const ckpt = await this.contract.latestCheckpoint();
expect(ckpt[0]).to.be.equal(true);
expect(ckpt[1]).to.be.bignumber.equal(last(this.checkpoints).key);
expect(ckpt[2]).to.be.bignumber.equal(last(this.checkpoints).value);
});
it('cannot push values in the past', async function () {