♻️ Refactors and deployments

.gitignore

@@ -10,6 +10,7 @@ cache/
 artifacts/
 cache/
 out/
+zkout/
 
 # Ignore Environment Variables!
 .env

script/DeployAll.s.sol

@@ -0,0 +1,19 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+
+import {Script} from "forge-std/Script.sol";
+import "../src/Sheepy404.sol";
+import "../src/Sheepy404Mirror.sol";
+import "../src/SheepySale.sol";
+
+contract DeployAllScript is Script {
+    function run() external {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        vm.startBroadcast(deployerPrivateKey);
+        bytes32 salt = keccak256(abi.encode(block.timestamp, "hehe"));
+        new Sheepy404{salt: salt}();
+        new Sheepy404Mirror{salt: salt}();
+        new SheepySale{salt: salt}();
+        vm.stopBroadcast();
+    }
+}

script/DeploySheepy404.s.sol

@@ -0,0 +1,14 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.4;
+
+import {Script} from "forge-std/Script.sol";
+import "../src/Sheepy404.sol";
+
+contract DeploySheepy404Script is Script {
+    function run() external {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        vm.startBroadcast(deployerPrivateKey);
+        new Sheepy404();
+        vm.stopBroadcast();
+    }
+}

src/Sheepy404.sol

@@ -4,9 +4,14 @@ pragma solidity ^0.8.4;
 import {SheepyBase} from "./SheepyBase.sol";
 import {DN404} from "dn404/src/DN404.sol";
 import {LibString} from "solady/utils/LibString.sol";
+import {LibBitmap} from "solady/utils/LibBitmap.sol";
+import {DynamicArrayLib} from "solady/utils/DynamicArrayLib.sol";
 
 /// @dev This contract can be used by itself or as an proxy's implementation.
 contract Sheepy404 is DN404, SheepyBase {
+    using LibBitmap for *;
+    using DynamicArrayLib for *;
+
     /*«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-*/
     /*                           EVENTS                           */
     /*-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»*/
@@ -30,6 +35,9 @@ contract Sheepy404 is DN404, SheepyBase {
     /// @dev The base URI of the contract.
     string internal _baseURI;
 
+    /// @dev Whether a certain `tokenId` has been revealed.
+    LibBitmap.Bitmap internal _revealed;
+
     /// @dev How much native currency required to reveal a token.
     uint256 public revealPrice;
 
@@ -38,12 +46,14 @@ contract Sheepy404 is DN404, SheepyBase {
     /*-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»*/
 
     /// @dev For initialization.
-    function initialize(address initialOwner, address initialAdmin, address mirror)
-        public
-        virtual
-    {
+    function initialize(
+        address initialOwner,
+        address initialAdmin,
+        address mirror,
+        string memory notSoSecret
+    ) public virtual {
         uint256 initialSupply = 1_000_000_000 * 10 ** 18;
-        _initializeSheepyBase(initialOwner, initialAdmin);
+        _initializeSheepyBase(initialOwner, initialAdmin, notSoSecret);
         _initializeDN404(initialSupply, initialOwner, mirror);
     }
 
@@ -75,15 +85,25 @@ contract Sheepy404 is DN404, SheepyBase {
     /*-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»*/
 
     /// @dev Allows the public to pay to reveal the `tokenIds`.
-    function reveal(uint256[] calldata tokenIds) public payable virtual {
+    function reveal(uint256[] memory tokenIds) public payable virtual {
         require(msg.value == revealPrice * tokenIds.length, "Wrong payment.");
         for (uint256 i; i < tokenIds.length; ++i) {
-            uint256 id = tokenIds[i];
+            uint256 id = tokenIds.get(i);
             if (!_exists(id)) revert TokenDoesNotExist();
+            _revealed.set(id);
             emit Reveal(id);
         }
     }
 
+    /// @dev Returns if each of the `tokenIds` has been revealed.
+    function revealed(uint256[] memory tokenIds) public view returns (bool[] memory) {
+        uint256[] memory results = DynamicArrayLib.malloc(tokenIds.length);
+        for (uint256 i; i < tokenIds.length; ++i) {
+            results.set(i, _revealed.get(tokenIds.get(i)));
+        }
+        return results.asBoolArray();
+    }
+
     /*«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-*/
     /*                      ADMIN FUNCTIONS                       */
     /*-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»*/
@@ -127,8 +147,17 @@ contract Sheepy404 is DN404, SheepyBase {
         // Emit a {Reset} event for each id if the caller isn't the mirror.
         if (msg.sender != _getDN404Storage().mirrorERC721) {
             for (uint256 i; i < ids.length; ++i) {
-                if (from[i] != to[i]) emit Reset(ids[i]);
+                if (from.toUint256Array().get(i) != to.toUint256Array().get(i)) {
+                    uint256 id = ids.get(i);
+                    _revealed.unset(id);
+                    emit Reset(id);
+                }
             }
         }
     }
+
+    /// @dev Need to override this.
+    function _useAfterNFTTransfers() internal virtual override returns (bool) {
+        return true;
+    }
 }

src/SheepyBase.sol

@@ -24,8 +24,16 @@ contract SheepyBase is Ownable, EnumerableRoles {
     /*-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»*/
 
     /// @dev For initialization.
-    function _initializeSheepyBase(address initialOwner, address initialAdmin) internal virtual {
+    function _initializeSheepyBase(
+        address initialOwner,
+        address initialAdmin,
+        string memory notSoSecret
+    ) internal virtual {
         _initializeOwner(initialOwner);
+        require(
+            keccak256(bytes(notSoSecret))
+                == 0x9f6dc27901fd3c0399e319e16bba7e24d8bb2b077fe896daffd2108aa65c40cc
+        );
         if (initialAdmin != address(0)) _setRole(initialAdmin, ADMIN_ROLE, true);
     }
 

src/SheepySale.sol

@@ -17,7 +17,7 @@ contract SheepySale is SheepyBase {
     /// @dev For configuring a sale.
     struct SaleConfig {
         address erc20ToSell;
-        uint256 price; // Per `10** erc20.decimals()`.
+        uint256 price; // Per `10 ** erc20ToSell.decimals()`.
         uint256 startTime;
         uint256 endTime;
         uint256 totalQuota; // The maximum amount that can be bought.
@@ -69,8 +69,11 @@ contract SheepySale is SheepyBase {
     /*-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»-»*/
 
     /// @dev For initialization.
-    function initialize(address initialOwner, address initialAdmin) public virtual {
-        _initializeSheepyBase(initialOwner, initialAdmin);
+    function initialize(address initialOwner, address initialAdmin, string memory notSoSecret)
+        public
+        virtual
+    {
+        _initializeSheepyBase(initialOwner, initialAdmin, notSoSecret);
     }
 
     /*«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-«-*/
@@ -88,8 +91,7 @@ contract SheepySale is SheepyBase {
     ) public payable {
         Sale storage s = _sales[saleId];
         require(s.erc20ToSell != address(0), "ERC20 not set.");
-        require(s.startTime <= block.timestamp, "Not open.");
-        require(block.timestamp <= s.endTime, "Not open.");
+        require(s.startTime <= block.timestamp && block.timestamp <= s.endTime, "Not open.");
         require((s.totalBought += amount) <= s.totalQuota, "Exceeded total quota.");
         uint256 minAddressQuota = FixedPointMathLib.min(customAddressQuota, s.addressQuota);
         require((s.bought[msg.sender] += amount) <= minAddressQuota, "Exceeded address quota.");

test/Sheepy404.t.sol

@@ -1,15 +1,21 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.4;
 
-import "./utils/SoladyTest.sol";
+import "forge-std/Test.sol";
 import "../src/Sheepy404.sol";
 import "../src/Sheepy404Mirror.sol";
+import "../src/SheepySale.sol";
+import "solady/utils/DynamicArrayLib.sol";
 
-import "solady/utils/LibClone.sol";
+contract Sheepy404Test is Test {
+    using DynamicArrayLib for *;
+
+    event Reveal(uint256 indexed tokenId);
+    event Reset(uint256 indexed tokenId);
 
-contract Sheepy404Test is SoladyTest {
     Sheepy404 sheepy;
     Sheepy404Mirror mirror;
+    SheepySale sale;
 
     address internal _ALICE = address(0x111);
     address internal _BOB = address(0x222);
@@ -19,18 +25,21 @@ contract Sheepy404Test is SoladyTest {
     uint256 internal _WAD = 10 ** 18;
     uint256 internal _INITIAL_SUPPLY = 1_000_000_000 * _WAD;
     uint256 internal _UNIT = _INITIAL_SUPPLY / 10_000;
+    uint256 internal _REVEAL_PRICE = 0.001 ether;
 
     string internal constant _NAME = "Sheepy";
     string internal constant _SYMBOL = "Sheepy404";
     string internal constant _BASE_URI = "https://sheepyapi.com/{id}.json";
+    string internal constant _NOT_SO_SECRET = "SomethingSomethingNoGrief";
 
     function setUp() public {
         sheepy = new Sheepy404();
         mirror = new Sheepy404Mirror();
+        sale = new SheepySale();
     }
 
-    function testInitialize() public {
-        sheepy.initialize(_ALICE, _BOB, address(mirror));
+    function _initialize() internal {
+        sheepy.initialize(_ALICE, _BOB, address(mirror), _NOT_SO_SECRET);
         assertEq(sheepy.balanceOf(_ALICE), _INITIAL_SUPPLY);
         mirror.pullOwner();
         assertEq(mirror.owner(), _ALICE);
@@ -40,12 +49,22 @@ contract Sheepy404Test is SoladyTest {
         vm.prank(_ALICE);
         sheepy.setNameAndSymbol(_NAME, _SYMBOL);
 
+        vm.prank(_ALICE);
+        sheepy.setRevealPrice(_REVEAL_PRICE);
+
+        sale.initialize(_ALICE, address(0), _NOT_SO_SECRET);
+    }
+
+    function testInitialize() public {
+        _initialize();
+
         assertEq(sheepy.name(), _NAME);
         assertEq(sheepy.symbol(), _SYMBOL);
-
         assertEq(mirror.name(), _NAME);
         assertEq(mirror.symbol(), _SYMBOL);
 
+        assertEq(sheepy.revealPrice(), _REVEAL_PRICE);
+
         assertEq(mirror.balanceOf(_BOB), 0);
         vm.prank(_ALICE);
         sheepy.transfer(_BOB, _UNIT - 1);
@@ -57,4 +76,63 @@ contract Sheepy404Test is SoladyTest {
 
         assertEq(mirror.tokenURI(1), "https://sheepyapi.com/1.json");
     }
+
+    function testSale() public {
+        _initialize();
+
+        SheepySale.SaleConfig memory c;
+        c.erc20ToSell = address(sheepy);
+        c.price = 0.03 ether;
+        c.startTime = 1;
+        c.endTime = 10000;
+        c.totalQuota = 10;
+        c.addressQuota = 2;
+
+        vm.prank(_ALICE);
+        sale.setSale(1, c);
+    }
+
+    function testSalePriceOf() public view {
+        uint256 amount = _WAD / 50;
+        uint256 pricePerWad = 0.03 ether;
+        uint256 totalPrice = sale.priceOf(address(sheepy), amount, pricePerWad);
+        assertEq(totalPrice, (10 ** 18 / 50) * 0.03 ether / 10 ** 18);
+    }
+
+    function testResetAndReveal() public {
+        _initialize();
+
+        vm.expectEmit();
+        emit Reset(1);
+        vm.prank(_ALICE);
+        sheepy.transfer(_BOB, _UNIT * 2);
+        assertEq(mirror.balanceOf(_BOB), 2);
+        assertEq(mirror.ownerOf(1), _BOB);
+        assertEq(mirror.ownerOf(2), _BOB);
+
+        vm.recordLogs();
+        vm.prank(_BOB);
+        mirror.transferFrom(_BOB, _CHARLIE, 1);
+        Vm.Log[] memory entries = vm.getRecordedLogs();
+        for (uint256 i; i < entries.length; ++i) {
+            assert(entries[i].topics[0] != keccak256("Reset(uint256)"));
+        }
+        assertEq(mirror.ownerOf(1), _CHARLIE);
+
+        assertEq(_revealed(1), false);
+        vm.deal(_CHARLIE, 100 ether);
+        vm.prank(_CHARLIE);
+        vm.expectEmit();
+        emit Reveal(1);
+        sheepy.reveal{value: _REVEAL_PRICE}(DynamicArrayLib.p(1).asUint256Array());
+        assertEq(_revealed(1), true);
+
+        vm.prank(_CHARLIE);
+        sheepy.transfer(_BOB, _UNIT);
+        assertEq(mirror.ownerOf(1), _BOB);
+    }
+
+    function _revealed(uint256 i) internal view returns (bool) {
+        return sheepy.revealed(DynamicArrayLib.p(i).asUint256Array())[0];
+    }
 }