Skip to content
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

Add ability to retrieve instance and token information for editions #85

Merged
merged 4 commits into from
Apr 9, 2024
Merged

Add ability to retrieve instance and token information for editions #85

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
60c9929
add ability to retrieve instance and token information for editions
wwhchung Apr 9, 2024
be7eb80
add test
wwhchung Apr 9, 2024
047e66a
try removing test
donpdang Apr 9, 2024
58b0845
Revert "try removing test"
donpdang Apr 9, 2024
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
11 changes: 11 additions & 0 deletions packages/manifold/contracts/edition/IManifoldERC721Edition.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ interface IManifoldERC721Edition {
enum StorageProtocol { INVALID, NONE, ARWEAVE, IPFS }

struct EditionInfo {
uint192 firstTokenId;
uint8 contractVersion;
uint24 totalSupply;
uint24 maxSupply;
Expand All @@ -50,4 +51,14 @@ interface IManifoldERC721Edition {
* @dev Get the EditionInfo for a Series
*/
function getEditionInfo(address creatorCore, uint256 instanceId) external view returns(EditionInfo memory);

/**
* @dev Get the instance ids for a set of token
*/
function getInstanceIdsForTokens(address creatorCore, uint256[] calldata tokenIds) external view returns(uint256[] memory);

/**
* @dev Get all the token ids for an instance
*/
function getInstanceTokenIds(address creatorCore, uint256 instanceId) external view returns(uint256[] memory);
}
101 changes: 90 additions & 11 deletions packages/manifold/contracts/edition/ManifoldERC721Edition.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ contract ManifoldERC721Edition is CreatorExtension, ICreatorExtensionTokenURI, I

uint256 private constant MAX_UINT_24 = 0xffffff;
uint256 private constant MAX_UINT_56 = 0xffffffffffffff;
uint256 private constant MAX_UINT_192 = 0xffffffffffffffffffffffffffffffffffffffffffffffff;

mapping(address => mapping(uint256 => EditionInfo)) _editionInfo;
mapping(address => mapping(uint256 => IndexRange[])) _indexRanges;
Expand Down Expand Up @@ -74,7 +75,8 @@ contract ManifoldERC721Edition is CreatorExtension, ICreatorExtensionTokenURI, I
totalSupply: 0,
contractVersion: creatorContractVersion,
storageProtocol: storageProtocol,
location: location
location: location,
firstTokenId: 0
});

if (creatorContractVersion < 3) {
Expand Down Expand Up @@ -112,14 +114,82 @@ contract ManifoldERC721Edition is CreatorExtension, ICreatorExtensionTokenURI, I
if (info.storageProtocol == StorageProtocol.INVALID) revert InvalidEdition();
}

/**
* @dev See {IManifoldERC721Edition-getInstanceIdsForTokens}.
*/
function getInstanceIdsForTokens(address creatorCore, uint256[] calldata tokenIds) external view override returns(uint256[] memory instanceIds) {
instanceIds = new uint256[](tokenIds.length);
for (uint256 i; i < tokenIds.length;) {
uint256 tokenId = tokenIds[i];
try IERC721CreatorCore(creatorCore).tokenExtension(tokenId) returns(address tokenExtension) {
if (tokenExtension == address(this)) {
uint256 creatorContractVersion;
uint256 instanceId;
try IERC721CreatorCoreVersion(creatorCore).VERSION() returns(uint256 version) {
creatorContractVersion = version;
} catch {}
if (creatorContractVersion >= 3) {
// Contract versions 3+ support storage of data with the token mint, so use that
uint80 tokenData = IERC721CreatorCore(creatorCore).tokenData(tokenId);
instanceId = uint56(tokenData >> 24);
} else {
(instanceId, ) = _tokenInstanceAndIndex(creatorCore, tokenId);
}
instanceIds[i] = instanceId;
}
} catch {}
unchecked{++i;}
}
}

/**
* @dev See {IManifoldERC721Edition-getInstanceTokenIds}.
*/
function getInstanceTokenIds(address creatorCore, uint256 instanceId) external view returns(uint256[] memory tokenIds) {
EditionInfo storage info = _getEditionInfo(creatorCore, instanceId);
uint256 creatorContractVersion;
tokenIds = new uint256[](info.totalSupply);
try IERC721CreatorCoreVersion(creatorCore).VERSION() returns(uint256 version) {
creatorContractVersion = version;
} catch {}
if (creatorContractVersion >= 3) {
// We do not have index ranges, so seek based on first tokenId
uint256 tokenId = info.firstTokenId;
uint256 foundTokens;
while (foundTokens < info.totalSupply) {
try IERC721CreatorCore(creatorCore).tokenExtension(tokenId) returns(address tokenExtension) {
if (tokenExtension == address(this)) {
uint80 tokenData = IERC721CreatorCore(creatorCore).tokenData(tokenId);
if (instanceId == uint56(tokenData >> 24)) {
tokenIds[foundTokens] = tokenId;
unchecked{++foundTokens;}
}
}
} catch {}
unchecked{++tokenId;}
}
} else {
// We have index ranges, so we can just iterate through them
IndexRange[] memory indexRanges = _indexRanges[creatorCore][instanceId];
uint256 current;
for (uint256 i; i < indexRanges.length;) {
IndexRange memory currentIndex = indexRanges[i];
for (uint256 j; j < currentIndex.count;) {
tokenIds[current] = currentIndex.startIndex + j;
unchecked{++current; ++j;}
}
unchecked{++i;}
}
}
}

/**
* @dev See {ICreatorExtensionTokenURI-tokenURI}.
*/
function tokenURI(address creatorCore, uint256 tokenId) external view override returns (string memory) {
uint8 creatorContractVersion;
uint256 creatorContractVersion;
try IERC721CreatorCoreVersion(creatorCore).VERSION() returns(uint256 version) {
require(version <= 255, "Unsupported contract version");
creatorContractVersion = uint8(version);
creatorContractVersion = version;
} catch {}

uint256 instanceId;
Expand Down Expand Up @@ -158,6 +228,7 @@ contract ManifoldERC721Edition is CreatorExtension, ICreatorExtensionTokenURI, I
if (recipients.length == 0) revert InvalidInput();
if (info.totalSupply+1 > info.maxSupply) revert TooManyRequested();

uint256[] memory tokenIdResults;
if (info.contractVersion >= 3) {
uint16 count = 0;
uint24 totalSupply_ = info.totalSupply;
Expand All @@ -173,29 +244,37 @@ contract ManifoldERC721Edition is CreatorExtension, ICreatorExtensionTokenURI, I
uint80[] memory tokenDatas = new uint80[](mintCount);
for (uint256 j; j < mintCount;) {
tokenDatas[j] = uint56(instanceId) << 24 | uint24(newMintIndex+j);
unchecked { ++j; }
unchecked {++j;}
}
// Airdrop the tokens
IERC721CreatorCore(creatorCore).mintExtensionBatch(recipients[i].recipient, tokenDatas);

tokenIdResults = IERC721CreatorCore(creatorCore).mintExtensionBatch(recipients[i].recipient, tokenDatas);
if (i == 0 && info.firstTokenId == 0) {
if (tokenIdResults[0] > MAX_UINT_192) revert InvalidInput();
info.firstTokenId = uint192(tokenIdResults[0]);
}
// Increment newMintIndex for the next airdrop
unchecked{ newMintIndex += mintCount; }
unchecked{newMintIndex += mintCount;}

unchecked{ ++i; }
unchecked{++i;}
}
info.totalSupply += count;
} else {
uint256 startIndex;
uint16 count = 0;
uint256[] memory tokenIdResults;
uint24 totalSupply_ = info.totalSupply;
uint24 maxSupply_ = info.maxSupply;
for (uint256 i; i < recipients.length;) {
if (recipients[i].count == 0) revert InvalidInput();
count += recipients[i].count;
if (totalSupply_+count > maxSupply_) revert TooManyRequested();
tokenIdResults = IERC721CreatorCore(creatorCore).mintExtensionBatch(recipients[i].recipient, recipients[i].count);
if (i == 0) startIndex = tokenIdResults[0];
if (i == 0) {
startIndex = tokenIdResults[0];
if (info.firstTokenId == 0) {
if (startIndex > MAX_UINT_192) revert InvalidInput();
info.firstTokenId = uint192(startIndex);
}
}
unchecked{++i;}
}
_updateIndexRanges(creatorCore, instanceId, info, startIndex, count);
Expand Down
25 changes: 25 additions & 0 deletions packages/manifold/test/edition/ManifoldERC721Edition.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,31 @@ contract ManifoldERC721EditionTest is Test {
assertEq("http://creator1series1new/3", creatorCore1.tokenURI(13));
assertEq("http://creator1series1new/5", creatorCore1.tokenURI(15));

// Test get tokens for instance
uint256[] memory tokens = example.getInstanceTokenIds(address(creatorCore1), 1);
assertEq(tokens.length, 6);
assertEq(tokens[0], 1);
assertEq(tokens[1], 2);
assertEq(tokens[2], 13);
assertEq(tokens[3], 14);
assertEq(tokens[4], 15);
assertEq(tokens[5], 18);

// Test getting instanceIds for tokens
uint256[] memory searchTokens = new uint256[](3);
searchTokens[0] = 1;
searchTokens[1] = 3;
searchTokens[2] = 16;
uint256[] memory instanceIds = example.getInstanceIdsForTokens(address(creatorCore1), searchTokens);
assertEq(instanceIds.length, 3);
assertEq(instanceIds[0], 1);
assertEq(instanceIds[1], 0);
assertEq(instanceIds[2], 2);

// Test getting first token id
edition = example.getEditionInfo(address(creatorCore1), 2);
assertEq(edition.firstTokenId, 16);

vm.stopPrank();
}

Expand Down
Loading