Skip to content

Ability to set starting token id for ERC721Consecutive #4097

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ernestognw merged 20 commits into from
May 26, 2023
+238 −143
Merged

Ability to set starting token id for ERC721Consecutive #4097

Changes from 1 commit
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
b693f7f
first consecutive id
kfishnchips Mar 10, 2023
bf8c076
linting and changeset
kfishnchips Mar 10, 2023
31a565b
using bound instead of assume and small test refactor
kfishnchips Mar 10, 2023
b651b93
modify transfer test to include starting token id
kfishnchips Mar 10, 2023
854b461
checking boundaries
kfishnchips Mar 10, 2023
1c7570d
reduce lookup and rename function for clarity
kfishnchips Mar 10, 2023
ab40061
rename _totalConsecutiveSupply → _nextConsecutiveId
Amxx Mar 10, 2023
1835727
Merge remote-tracking branch 'kfishnchips/master'
Amxx Mar 10, 2023
1fdcbff
Update .changeset/spotty-hotels-type.md
kfishnchips Mar 10, 2023
44cc563
fix minor bug
Amxx Mar 10, 2023
3f8b0f9
Merge branch 'master' of github.com:kfishnchips/openzeppelin-contracts
Amxx Mar 10, 2023
573fa0d
test multiple offsets
Amxx Mar 10, 2023
5d9b21b
make firstConsecutiveId immutable in fuzz tests
Amxx Mar 10, 2023
0fcb048
fix lint
Amxx Mar 10, 2023
dd1d6bf
Merge branch 'master' into master
kfishnchips Mar 10, 2023
361aa8d
Update docs
ernestognw Mar 13, 2023
114a3f6
Merge branch 'master' into master
kfishnchips Mar 13, 2023
6b4e4ee
Merge branch 'master' into master
kfishnchips Mar 27, 2023
78ed610
Merge branch 'master' into master
kfishnchips Apr 6, 2023
7959df3
Merge branch 'master' into master
kfishnchips May 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
test multiple offsets
  • Loading branch information
@Amxx
Amxx committed Mar 10, 2023
commit 573fa0d179741a4aabea5e571e1e24c8a2fe899a
241 changes: 121 additions & 120 deletions test/token/ERC721/extensions/ERC721Consecutive.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ contract('ERC721Consecutive', function (accounts) {

const name = 'Non Fungible Token';
const symbol = 'NFT';
const offset = 42;
const batches = [
{ receiver: user1, amount: 0 },
{ receiver: user1, amount: 1 },
Expand All @@ -21,167 +20,169 @@ contract('ERC721Consecutive', function (accounts) {
];
const delegates = [user1, user3];

describe('with valid batches', function () {
beforeEach(async function () {
this.token = await ERC721ConsecutiveMock.new(
name,
symbol,
offset,
delegates,
batches.map(({ receiver }) => receiver),
batches.map(({ amount }) => amount),
);
});
for (const offset of [0, 1, 42]) {
describe(`with offset ${offset}`, function () {
beforeEach(async function () {
this.token = await ERC721ConsecutiveMock.new(
name,
symbol,
offset,
delegates,
batches.map(({ receiver }) => receiver),
batches.map(({ amount }) => amount),
);
});

describe('minting during construction', function () {
it('events are emitted at construction', async function () {
let first = offset;

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
describe('minting during construction', function () {
it('events are emitted at construction', async function () {
let first = offset;

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;
}
first += batch.amount;
}
});
});

it('ownership is set', async function () {
const owners = [
...Array(offset).fill(constants.ZERO_ADDRESS),
...batches.flatMap(({ receiver, amount }) => Array(amount).fill(receiver)),
];
it('ownership is set', async function () {
const owners = [
...Array(offset).fill(constants.ZERO_ADDRESS),
...batches.flatMap(({ receiver, amount }) => Array(amount).fill(receiver)),
];

for (const tokenId in owners) {
if (owners[tokenId] != constants.ZERO_ADDRESS) {
expect(await this.token.ownerOf(tokenId)).to.be.equal(owners[tokenId]);
for (const tokenId in owners) {
if (owners[tokenId] != constants.ZERO_ADDRESS) {
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);
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));
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));
// 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 });
}
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));
}
// 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',
);
});
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, offset);
it('simple minting is possible after construction', async function () {
const tokenId = batches.reduce((acc, { amount }) => acc + amount, offset);

expect(await this.token.$_exists(tokenId)).to.be.equal(false);
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(),
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, offset) - 1;
it('cannot mint a token that has been batched minted', async function () {
const tokenId = batches.reduce((acc, { amount }) => acc + amount, offset) - 1;

expect(await this.token.$_exists(tokenId)).to.be.equal(true);
expect(await this.token.$_exists(tokenId)).to.be.equal(true);

await expectRevert(this.token.$_mint(user1, tokenId), 'ERC721: token already minted');
await expectRevert(this.token.$_mint(user1, tokenId), 'ERC721: token already minted');
});
});
});

describe('ERC721 behavior', function () {
const tokenId = web3.utils.toBN(offset + 1);
describe('ERC721 behavior', function () {
const tokenId = web3.utils.toBN(offset + 1);

it('core takes over ownership on transfer', async function () {
await this.token.transferFrom(user1, receiver, tokenId, { from: user1 });
it('core takes over ownership on transfer', async function () {
await this.token.transferFrom(user1, receiver, tokenId, { from: user1 });

expect(await this.token.ownerOf(tokenId)).to.be.equal(receiver);
});

it('tokens can be burned and re-minted #1', async function () {
expectEvent(await this.token.$_burn(tokenId, { from: user1 }), 'Transfer', {
from: user1,
to: constants.ZERO_ADDRESS,
tokenId,
expect(await this.token.ownerOf(tokenId)).to.be.equal(receiver);
});

await expectRevert(this.token.ownerOf(tokenId), 'ERC721: invalid token ID');
it('tokens can be burned and re-minted #1', async function () {
expectEvent(await this.token.$_burn(tokenId, { from: user1 }), 'Transfer', {
from: user1,
to: constants.ZERO_ADDRESS,
tokenId,
});

await expectRevert(this.token.ownerOf(tokenId), 'ERC721: invalid token ID');

expectEvent(await this.token.$_mint(user2, tokenId), 'Transfer', {
from: constants.ZERO_ADDRESS,
to: user2,
tokenId,
expectEvent(await this.token.$_mint(user2, tokenId), 'Transfer', {
from: constants.ZERO_ADDRESS,
to: user2,
tokenId,
});

expect(await this.token.ownerOf(tokenId)).to.be.equal(user2);
});

expect(await this.token.ownerOf(tokenId)).to.be.equal(user2);
});
it('tokens can be burned and re-minted #2', async function () {
const tokenId = web3.utils.toBN(batches.reduce((acc, { amount }) => acc + amount, offset));

it('tokens can be burned and re-minted #2', async function () {
const tokenId = web3.utils.toBN(batches.reduce((acc, { amount }) => acc + amount, offset));
expect(await this.token.$_exists(tokenId)).to.be.equal(false);
await expectRevert(this.token.ownerOf(tokenId), 'ERC721: invalid token ID');

expect(await this.token.$_exists(tokenId)).to.be.equal(false);
await expectRevert(this.token.ownerOf(tokenId), 'ERC721: invalid token ID');
// mint
await this.token.$_mint(user1, tokenId);

// mint
await this.token.$_mint(user1, tokenId);
expect(await this.token.$_exists(tokenId)).to.be.equal(true);
expect(await this.token.ownerOf(tokenId), user1);

expect(await this.token.$_exists(tokenId)).to.be.equal(true);
expect(await this.token.ownerOf(tokenId), user1);
// burn
expectEvent(await this.token.$_burn(tokenId, { from: user1 }), 'Transfer', {
from: user1,
to: constants.ZERO_ADDRESS,
tokenId,
});

// burn
expectEvent(await this.token.$_burn(tokenId, { from: user1 }), 'Transfer', {
from: user1,
to: constants.ZERO_ADDRESS,
tokenId,
});
expect(await this.token.$_exists(tokenId)).to.be.equal(false);
await expectRevert(this.token.ownerOf(tokenId), 'ERC721: invalid token ID');

expect(await this.token.$_exists(tokenId)).to.be.equal(false);
await expectRevert(this.token.ownerOf(tokenId), 'ERC721: invalid token ID');
// re-mint
expectEvent(await this.token.$_mint(user2, tokenId), 'Transfer', {
from: constants.ZERO_ADDRESS,
to: user2,
tokenId,
});

// re-mint
expectEvent(await this.token.$_mint(user2, tokenId), 'Transfer', {
from: constants.ZERO_ADDRESS,
to: user2,
tokenId,
expect(await this.token.$_exists(tokenId)).to.be.equal(true);
expect(await this.token.ownerOf(tokenId), user2);
});

expect(await this.token.$_exists(tokenId)).to.be.equal(true);
expect(await this.token.ownerOf(tokenId), user2);
});
});
});
}

describe('invalid use', function () {
it('cannot mint a batch larger than 5000', async function () {
await expectRevert(
ERC721ConsecutiveMock.new(name, symbol, offset, [], [user1], ['5001']),
ERC721ConsecutiveMock.new(name, symbol, 0, [], [user1], ['5001']),
'ERC721Consecutive: batch too large',
);
});
Expand Down