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.

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

Premint - get array of supported premint versions #309

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
5 changes: 5 additions & 0 deletions .changeset/serious-goats-exist.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@zoralabs/zora-1155-contracts": patch
---

Premint - added method getSupportedPremintSignatureVersions(contractAddress) that returns an array of the premint signature versions an 1155 contract supports. If the contract hasn't been created yet, assumes that when it will be created it will support the latest versions of the signatures, so the function returns all versions.
2 changes: 1 addition & 1 deletion .changeset/thirty-dragons-pretend.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,4 @@
"@zoralabs/zora-1155-contracts": patch
---

Added method `IZoraCreator1155PremintExecutor.supportedPremintSignatureVersion(contractAddress)` that tells what version of the premint signature the contract supports, and added corresponding method `ZoraCreator1155Impl.supportedPremintSignatureVersion()` to fetch supported version. If premint not supported, returns 0.
Added method `IZoraCreator1155PremintExecutor.supportedPremintSignatureVersions(contractAddress)` that tells what version of the premint signature the contract supports, and added corresponding method `ZoraCreator1155Impl.supportedPremintSignatureVersions()` to fetch supported version. If premint not supported, returns an empty array.
Original file line number Diff line number Diff line change
Expand Up @@ -416,6 +416,12 @@ library DelegatedTokenCreation {
revert IZoraCreator1155Errors.InvalidSignatureVersion();
}

function supportedPremintSignatureVersions() external pure returns (string[] memory versions) {
versions = new string[](2);
versions[0] = ZoraCreator1155Attribution.VERSION_1;
versions[1] = ZoraCreator1155Attribution.VERSION_2;
}

function _recoverCreatorAttribution(
string memory version,
bytes32 structHash,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -214,21 +214,28 @@ contract ZoraCreator1155PremintExecutorImpl is
);
}

/// @notice Returns the version of the premint signature that the contract supports
/// @notice Returns the versions of the premint signature that the contract supports
/// @param contractAddress The address of the contract to check
/// @return The version of the premint signature that the contract supports. If it doesn't support premint
/// returns 0
function supportedPremintSignatureVersion(address contractAddress) external view returns (string memory) {
/// @return versions The versions of the premint signature that the contract supports. If contract hasn't been created yet,
/// assumes that when it will be created it will support the latest versions of the signatures, so the function returns all versions.
function supportedPremintSignatureVersions(address contractAddress) external view returns (string[] memory versions) {
// if contract hasn't been created yet, assume it will be created with the latest version
// and thus supports all versions of the signature
if (contractAddress.code.length == 0) {
return ZoraCreator1155Attribution.allVersions();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should we return all versions here or just an array of 1 with the latest?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good q. if the contract hasn't been created yet, and a premint v1 signature has been created for that address, then the new contract can be created with the v1 version, so in theory both v1 and v2 would work

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i do see how this is wierd that we are returning all versions if the contract hasn't been created yet. may be just simpler to revert. what do you think @iainnash @kulkarohan ?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind all versions tbh, feels cleaner.

}

IZoraCreator1155 creatorContract = IZoraCreator1155(contractAddress);
if (creatorContract.supportsInterface(type(IZoraCreator1155DelegatedCreation).interfaceId)) {
return IZoraCreator1155DelegatedCreation(contractAddress).supportedPremintSignatureVersion();
return IZoraCreator1155DelegatedCreation(contractAddress).supportedPremintSignatureVersions();
}

// try get token id for uid 0 - if call fails, we know this didn't support premint
try ERC1155DelegationStorageV1(contractAddress).delegatedTokenId(uint32(0)) returns (uint256) {
return "1";
versions = new string[](1);
versions[0] = ZoraCreator1155Attribution.VERSION_1;
} catch {
return "0";
versions = new string[](0);
}
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ pragma solidity 0.8.17;
interface IZoraCreator1155DelegatedCreation {
event CreatorAttribution(bytes32 structHash, string domainName, string version, address creator, bytes signature);

function supportedPremintSignatureVersion() external pure returns (string memory);
function supportedPremintSignatureVersions() external pure returns (string[] memory);

function delegateSetupNewToken(
bytes memory premintConfigEncoded,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -94,5 +94,5 @@ interface IZoraCreator1155PremintExecutor is

function getContractAddress(ContractCreationConfig calldata contractConfig) external view returns (address);

function supportedPremintSignatureVersion(address contractAddress) external view returns (string memory);
function supportedPremintSignatureVersions(address contractAddress) external view returns (string[] memory);
}
4 changes: 2 additions & 2 deletions packages/1155-contracts/src/nft/ZoraCreator1155Impl.sol
Original file line number Diff line number Diff line change
Expand Up @@ -752,8 +752,8 @@ contract ZoraCreator1155Impl is
return _getImplementation();
}

function supportedPremintSignatureVersion() external pure returns (string memory) {
return ZoraCreator1155Attribution.VERSION_2;
function supportedPremintSignatureVersions() external pure returns (string[] memory) {
return DelegatedTokenCreation.supportedPremintSignatureVersions();
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How much codespace does this approach use? What about using a bitmap :P?

}

/// Sets up a new token using a token configuration and a signature created for the token creation parameters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -171,7 +171,9 @@ contract Zora1155PremintExecutorProxyTest is Test, ForkDeploymentConfig, IHasCon

// 3. create premint on old version of contract using new version of preminter
// verify the 1155 supports up to version 1
assertEq(forkedPreminterProxy.supportedPremintSignatureVersion(deterministicAddress), "1");
string[] memory supportedVersions = forkedPreminterProxy.supportedPremintSignatureVersions(deterministicAddress);
assertEq(supportedVersions.length, 1);
assertEq(supportedVersions[0], "1");

uint32 existingUid = premintConfig.uid;
premintConfig = Zora1155PremintFixtures.makeDefaultV1PremintConfig(fixedPriceMinter, creator);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -742,7 +742,33 @@ contract ZoraCreator1155PreminterTest is Test {

// if contract is not a known 1155 contract that supports getting uid or premint sig version,
// this should return 0
assertEq(preminter.supportedPremintSignatureVersion(erc1155BeforePremint), "0");
assertEq(preminter.supportedPremintSignatureVersions(erc1155BeforePremint).length, 0);
}

function test_premintVersion_beforeCreated_returnsAllVersion() external {
// build a premint
string[] memory supportedVersions = preminter.supportedPremintSignatureVersions(makeAddr("randomContract"));

assertEq(supportedVersions.length, 2);
assertEq(supportedVersions[0], "1");
assertEq(supportedVersions[1], "2");
}

function test_premintVersion_whenCreated_returnsAllVersion() external {
// build a premint
ContractCreationConfig memory contractConfig = makeDefaultContractCreationConfig();
PremintConfigV2 memory premintConfig = makeDefaultPremintConfig();

// sign and execute premint
address deterministicAddress = preminter.getContractAddress(contractConfig);

_signAndExecutePremint(contractConfig, premintConfig, creatorPrivateKey, block.chainid, premintExecutor, 1, "hi");

string[] memory supportedVersions = preminter.supportedPremintSignatureVersions(deterministicAddress);

assertEq(supportedVersions.length, 2);
assertEq(supportedVersions[0], "1");
assertEq(supportedVersions[1], "2");
}

function testPremintWithCreateReferral() public {
Expand Down
Loading