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

Custom errors, etc #619

Merged
merged 16 commits into from
Feb 26, 2024
Merged

Custom errors, etc #619

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
97dbb23
custom error for extensions
kumaryash90 Feb 22, 2024
6ec6f40
contract publisher
kumaryash90 Feb 22, 2024
e892db2
legacy contracts
kumaryash90 Feb 22, 2024
198d986
custom error for CurrencyTransferLib
kumaryash90 Feb 22, 2024
2fc59bb
efficient hash function MerkleProof
kumaryash90 Feb 22, 2024
9c730f0
Pack without forwarder
kumaryash90 Feb 22, 2024
cd5b7ea
fix test
kumaryash90 Feb 22, 2024
a634d23
fix tests
kumaryash90 Feb 23, 2024
5df8e99
fix btt tests
kumaryash90 Feb 23, 2024
5a4aa79
extension tests
kumaryash90 Feb 23, 2024
fe3b2a6
extension tests
kumaryash90 Feb 23, 2024
68d9c4d
test pack
kumaryash90 Feb 23, 2024
9244a28
more btt
kumaryash90 Feb 23, 2024
442ebd5
more tests
kumaryash90 Feb 23, 2024
97d02f3
drop prebuilt tests
kumaryash90 Feb 23, 2024
83e83fd
fix lint
kumaryash90 Feb 23, 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
27 changes: 21 additions & 6 deletions contracts/extension/BatchMintMetadata.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,15 @@ pragma solidity ^0.8.0;
*/

contract BatchMintMetadata {
/// @dev Invalid index for batch
error BatchMintInvalidBatchId(uint256 index);

/// @dev Invalid token
error BatchMintInvalidTokenId(uint256 tokenId);

/// @dev Metadata frozen
error BatchMintMetadataFrozen(uint256 batchId);

/// @dev Largest tokenId of each batch of tokens with the same baseURI + 1 {ex: batchId 100 at position 0 includes tokens 0-99}
uint256[] private batchIds;

Expand Down Expand Up @@ -46,7 +55,7 @@ contract BatchMintMetadata {
*/
function getBatchIdAtIndex(uint256 _index) public view returns (uint256) {
if (_index >= getBaseURICount()) {
revert("Invalid index");
revert BatchMintInvalidBatchId(_index);
}
return batchIds[_index];
}
Expand All @@ -65,7 +74,7 @@ contract BatchMintMetadata {
}
}

revert("Invalid tokenId");
revert BatchMintInvalidTokenId(_tokenId);
}

/// @dev Returns the baseURI for a token. The intended metadata URI for the token is baseURI + tokenId.
Expand All @@ -78,7 +87,8 @@ contract BatchMintMetadata {
return baseURI[indices[i]];
}
}
revert("Invalid tokenId");

revert BatchMintInvalidTokenId(_tokenId);
}

/// @dev returns the starting tokenId of a given batchId.
Expand All @@ -94,20 +104,25 @@ contract BatchMintMetadata {
return 0;
}
}
revert("Invalid batchId");

revert BatchMintInvalidBatchId(_batchID);
}

/// @dev Sets the base URI for the batch of tokens with the given batchId.
function _setBaseURI(uint256 _batchId, string memory _baseURI) internal {
require(!batchFrozen[_batchId], "Batch frozen");
if (batchFrozen[_batchId]) {
revert BatchMintMetadataFrozen(_batchId);
}
baseURI[_batchId] = _baseURI;
emit BatchMetadataUpdate(_getBatchStartId(_batchId), _batchId);
}

/// @dev Freezes the base URI for the batch of tokens with the given batchId.
function _freezeBaseURI(uint256 _batchId) internal {
string memory baseURIForBatch = baseURI[_batchId];
require(bytes(baseURIForBatch).length > 0, "Invalid batch");
if (bytes(baseURIForBatch).length == 0) {
revert BatchMintInvalidBatchId(_batchId);
}
batchFrozen[_batchId] = true;
emit MetadataFrozen();
}
Expand Down
5 changes: 4 additions & 1 deletion contracts/extension/ContractMetadata.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ import "./interface/IContractMetadata.sol";
*/

abstract contract ContractMetadata is IContractMetadata {
/// @dev The sender is not authorized to perform the action
error ContractMetadataUnauthorized();

/// @notice Returns the contract metadata URI.
string public override contractURI;

Expand All @@ -26,7 +29,7 @@ abstract contract ContractMetadata is IContractMetadata {
*/
function setContractURI(string memory _uri) external override {
if (!_canSetContractURI()) {
revert("Not authorized");
revert ContractMetadataUnauthorized();
}

_setupContractURI(_uri);
Expand Down
15 changes: 13 additions & 2 deletions contracts/extension/DelayedReveal.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ import "./interface/IDelayedReveal.sol";
*/

abstract contract DelayedReveal is IDelayedReveal {
/// @dev The contract doesn't have any url to be delayed revealed
error DelayedRevealNothingToReveal();

/// @dev The result of the returned an incorrect hash
error DelayedRevealIncorrectResultHash(bytes32 expected, bytes32 actual);

/// @dev Mapping from tokenId of a batch of tokens => to delayed reveal data.
mapping(uint256 => bytes) public encryptedData;

Expand All @@ -34,14 +40,19 @@ abstract contract DelayedReveal is IDelayedReveal {
function getRevealURI(uint256 _batchId, bytes calldata _key) public view returns (string memory revealedURI) {
bytes memory data = encryptedData[_batchId];
if (data.length == 0) {
revert("Nothing to reveal");
revert DelayedRevealNothingToReveal();
}

(bytes memory encryptedURI, bytes32 provenanceHash) = abi.decode(data, (bytes, bytes32));

revealedURI = string(encryptDecrypt(encryptedURI, _key));

require(keccak256(abi.encodePacked(revealedURI, _key, block.chainid)) == provenanceHash, "Incorrect key");
if (keccak256(abi.encodePacked(revealedURI, _key, block.chainid)) != provenanceHash) {
revert DelayedRevealIncorrectResultHash(
provenanceHash,
keccak256(abi.encodePacked(revealedURI, _key, block.chainid))
);
}
}

/**
Expand Down
44 changes: 37 additions & 7 deletions contracts/extension/Drop.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ import "./interface/IDrop.sol";
import "../lib/MerkleProof.sol";

abstract contract Drop is IDrop {
/// @dev The sender is not authorized to perform the action
error DropUnauthorized();

/// @dev Exceeded the max token total supply
error DropExceedMaxSupply();

/// @dev No active claim condition
error DropNoActiveCondition();

/// @dev Claim condition invalid currency or price
error DropClaimInvalidTokenPrice(
address expectedCurrency,
uint256 expectedPricePerToken,
address actualCurrency,
uint256 actualExpectedPricePerToken
);

/// @dev Claim condition exceeded limit
error DropClaimExceedLimit(uint256 expected, uint256 actual);

/// @dev Claim condition exceeded max supply
error DropClaimExceedMaxSupply(uint256 expected, uint256 actual);

/// @dev Claim condition not started yet
error DropClaimNotStarted(uint256 expected, uint256 actual);

/*///////////////////////////////////////////////////////////////
State variables
//////////////////////////////////////////////////////////////*/
Expand Down Expand Up @@ -54,7 +80,7 @@ abstract contract Drop is IDrop {
bool _resetClaimEligibility
) external virtual override {
if (!_canSetClaimConditions()) {
revert("Not authorized");
revert DropUnauthorized();
}

uint256 existingStartIndex = claimCondition.currentStartId;
Expand All @@ -81,7 +107,7 @@ abstract contract Drop is IDrop {

uint256 supplyClaimedAlready = claimCondition.conditions[newStartIndex + i].supplyClaimed;
if (supplyClaimedAlready > _conditions[i].maxClaimableSupply) {
revert("max supply claimed");
revert DropExceedMaxSupply();
}

claimCondition.conditions[newStartIndex + i] = _conditions[i];
Expand Down Expand Up @@ -163,18 +189,22 @@ abstract contract Drop is IDrop {
uint256 supplyClaimedByWallet = claimCondition.supplyClaimedByWallet[_conditionId][_claimer];

if (_currency != claimCurrency || _pricePerToken != claimPrice) {
revert("!PriceOrCurrency");
revert DropClaimInvalidTokenPrice(_currency, _pricePerToken, claimCurrency, claimPrice);
}

if (_quantity == 0 || (_quantity + supplyClaimedByWallet > claimLimit)) {
revert("!Qty");
revert DropClaimExceedLimit(claimLimit, _quantity + supplyClaimedByWallet);
}

if (currentClaimPhase.supplyClaimed + _quantity > currentClaimPhase.maxClaimableSupply) {
revert("!MaxSupply");
revert DropClaimExceedMaxSupply(
currentClaimPhase.maxClaimableSupply,
currentClaimPhase.supplyClaimed + _quantity
);
}

if (currentClaimPhase.startTimestamp > block.timestamp) {
revert("cant claim yet");
revert DropClaimNotStarted(currentClaimPhase.startTimestamp, block.timestamp);
}
}

Expand All @@ -186,7 +216,7 @@ abstract contract Drop is IDrop {
}
}

revert("!CONDITION.");
revert DropNoActiveCondition();
}

/// @dev Returns the claim condition at the given uid.
Expand Down
43 changes: 36 additions & 7 deletions contracts/extension/Drop1155.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ import "./interface/IDrop1155.sol";
import "../lib/MerkleProof.sol";

abstract contract Drop1155 is IDrop1155 {
/// @dev The sender is not authorized to perform the action
error DropUnauthorized();

/// @dev Exceeded the max token total supply
error DropExceedMaxSupply();

/// @dev No active claim condition
error DropNoActiveCondition();

/// @dev Claim condition invalid currency or price
error DropClaimInvalidTokenPrice(
address expectedCurrency,
uint256 expectedPricePerToken,
address actualCurrency,
uint256 actualExpectedPricePerToken
);

/// @dev Claim condition exceeded limit
error DropClaimExceedLimit(uint256 expected, uint256 actual);

/// @dev Claim condition exceeded max supply
error DropClaimExceedMaxSupply(uint256 expected, uint256 actual);

/// @dev Claim condition not started yet
error DropClaimNotStarted(uint256 expected, uint256 actual);

/*///////////////////////////////////////////////////////////////
State variables
//////////////////////////////////////////////////////////////*/
Expand Down Expand Up @@ -64,7 +90,7 @@ abstract contract Drop1155 is IDrop1155 {
bool _resetClaimEligibility
) external virtual override {
if (!_canSetClaimConditions()) {
revert("Not authorized");
revert DropUnauthorized();
}
ClaimConditionList storage conditionList = claimCondition[_tokenId];
uint256 existingStartIndex = conditionList.currentStartId;
Expand All @@ -91,7 +117,7 @@ abstract contract Drop1155 is IDrop1155 {

uint256 supplyClaimedAlready = conditionList.conditions[newStartIndex + i].supplyClaimed;
if (supplyClaimedAlready > _conditions[i].maxClaimableSupply) {
revert("max supply claimed");
revert DropExceedMaxSupply();
}

conditionList.conditions[newStartIndex + i] = _conditions[i];
Expand Down Expand Up @@ -174,19 +200,22 @@ abstract contract Drop1155 is IDrop1155 {
uint256 supplyClaimedByWallet = claimCondition[_tokenId].supplyClaimedByWallet[_conditionId][_claimer];

if (_currency != claimCurrency || _pricePerToken != claimPrice) {
revert("!PriceOrCurrency");
revert DropClaimInvalidTokenPrice(_currency, _pricePerToken, claimCurrency, claimPrice);
}

if (_quantity == 0 || (_quantity + supplyClaimedByWallet > claimLimit)) {
revert("!Qty");
revert DropClaimExceedLimit(claimLimit, _quantity + supplyClaimedByWallet);
}

if (currentClaimPhase.supplyClaimed + _quantity > currentClaimPhase.maxClaimableSupply) {
revert("!MaxSupply");
revert DropClaimExceedMaxSupply(
currentClaimPhase.maxClaimableSupply,
currentClaimPhase.supplyClaimed + _quantity
);
}

if (currentClaimPhase.startTimestamp > block.timestamp) {
revert("cant claim yet");
revert DropClaimNotStarted(currentClaimPhase.startTimestamp, block.timestamp);
}
}

Expand All @@ -199,7 +228,7 @@ abstract contract Drop1155 is IDrop1155 {
}
}

revert("!CONDITION.");
revert DropNoActiveCondition();
}

/// @dev Returns the claim condition at the given uid.
Expand Down
41 changes: 35 additions & 6 deletions contracts/extension/DropSinglePhase.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,32 @@ import "./interface/IDropSinglePhase.sol";
import "../lib/MerkleProof.sol";

abstract contract DropSinglePhase is IDropSinglePhase {
/// @dev The sender is not authorized to perform the action
error DropUnauthorized();

/// @dev Exceeded the max token total supply
error DropExceedMaxSupply();

/// @dev No active claim condition
error DropNoActiveCondition();

/// @dev Claim condition invalid currency or price
error DropClaimInvalidTokenPrice(
address expectedCurrency,
uint256 expectedPricePerToken,
address actualCurrency,
uint256 actualExpectedPricePerToken
);

/// @dev Claim condition exceeded limit
error DropClaimExceedLimit(uint256 expected, uint256 actual);

/// @dev Claim condition exceeded max supply
error DropClaimExceedMaxSupply(uint256 expected, uint256 actual);

/// @dev Claim condition not started yet
error DropClaimNotStarted(uint256 expected, uint256 actual);

/*///////////////////////////////////////////////////////////////
State variables
//////////////////////////////////////////////////////////////*/
Expand Down Expand Up @@ -63,7 +89,7 @@ abstract contract DropSinglePhase is IDropSinglePhase {
/// @dev Lets a contract admin set claim conditions.
function setClaimConditions(ClaimCondition calldata _condition, bool _resetClaimEligibility) external override {
if (!_canSetClaimConditions()) {
revert("Not authorized");
revert DropUnauthorized();
}

bytes32 targetConditionId = conditionId;
Expand All @@ -75,7 +101,7 @@ abstract contract DropSinglePhase is IDropSinglePhase {
}

if (supplyClaimedAlready > _condition.maxClaimableSupply) {
revert("max supply claimed");
revert DropExceedMaxSupply();
}

claimCondition = ClaimCondition({
Expand Down Expand Up @@ -140,19 +166,22 @@ abstract contract DropSinglePhase is IDropSinglePhase {
uint256 _supplyClaimedByWallet = supplyClaimedByWallet[conditionId][_claimer];

if (_currency != claimCurrency || _pricePerToken != claimPrice) {
revert("!PriceOrCurrency");
revert DropClaimInvalidTokenPrice(_currency, _pricePerToken, claimCurrency, claimPrice);
}

if (_quantity == 0 || (_quantity + _supplyClaimedByWallet > claimLimit)) {
revert("!Qty");
revert DropClaimExceedLimit(claimLimit, _quantity + _supplyClaimedByWallet);
}

if (currentClaimPhase.supplyClaimed + _quantity > currentClaimPhase.maxClaimableSupply) {
revert("!MaxSupply");
revert DropClaimExceedMaxSupply(
currentClaimPhase.maxClaimableSupply,
currentClaimPhase.supplyClaimed + _quantity
);
}

if (currentClaimPhase.startTimestamp > block.timestamp) {
revert("cant claim yet");
revert DropClaimNotStarted(currentClaimPhase.startTimestamp, block.timestamp);
}
}

Expand Down
Loading
Loading