Merge pull request #125 from Hats-Protocol/multicallable

Multicallable

.gitmodules

@@ -4,3 +4,6 @@
 [submodule "lib/solbase"]
 	path = lib/solbase
 	url = https://github.com/sol-dao/solbase
+[submodule "lib/solady"]
+	path = lib/solady
+	url = https://github.com/vectorized/solady

README.md

@@ -401,6 +401,10 @@ The wearer of a Hat can "take off" their Hat via `Hats.renounceHat`. This burns
 
 <p align="right">(<a href="#table-of-contents">back to contents</a>)</p>
 
+### Multicall
+
+This contract inherits from [Multicallable](https://github.com/Vectorized/solady/blob/main/src/utils/Multicallable.sol), which adds a non-payable `multicall` function to the contract. This enables EOAs to make multiple calls to the contract atomically, unlocking a number of useful batch operations that were previously only available to smart contracts.
+
 ## License
 
 Distributed under the AGPLv3 License. See `LICENSE.txt` for more information.

foundry.toml

@@ -9,7 +9,8 @@ solc = "0.8.17"
 remappings = [
   "ds-test/=lib/forge-std/lib/ds-test/src/",
   "forge-std/=lib/forge-std/src/",
-  "solbase/=lib/solbase/src/"
+  "solbase/=lib/solbase/src/",
+  "solady/=lib/solady/src/"
 ]
 
 [fmt]

remappings.txt

@@ -0,0 +1,4 @@
+ds-test/=lib/forge-std/lib/ds-test/src/
+forge-std/=lib/forge-std/src/
+solady/=lib/solady/src/
+solbase/=lib/solbase/src/

script/Hats.s.sol

@@ -5,9 +5,9 @@ import { Script, console2 } from "forge-std/Script.sol";
 import { Hats } from "../src/Hats.sol";
 
 contract DeployHats is Script {
-    string public constant baseImageURI = "ipfs://bafybeigcimbqwfajsnhoq7fqnbdllz7kye7cpdy3adj2sob3wku2llu5bi";
+    string public constant baseImageURI = "ipfs://bafkreiflezpk3kjz6zsv23pbvowtatnd5hmqfkdro33x5mh2azlhne3ah4";
 
-    string public constant name = "Hats Protocol v1.0"; // increment this each deployment
+    string public constant name = "Hats Protocol v1"; // increment this each deployment
 
     bytes32 internal constant SALT = bytes32(abi.encode(0x4a75)); // ~ H(4) A(a) T(7) S(5)
 
@@ -30,12 +30,10 @@ contract DeployHats is Script {
         console2.log("Hats contract: ", address(hats));
     }
 
-    // forge script script/Hats.s.sol:DeployHats -f mainnet
-    // forge script script/Hats.s.sol:DeployHats -f mainnet --broadcast --verify
+    // forge script script/Hats.s.sol:DeployHats -f goerli
+    // forge script script/Hats.s.sol:DeployHats -f goerli --broadcast --verify
 
-    // forge script script/Hats.s.sol:DeployHats --rpc-url http://localhost:8545 --broadcast
-
-    // forge verify-contract --chain-id 1 --num-of-optimizations 10000 --watch --constructor-args $(cast abi-encode "constructor(string,string)" "Hats Protocol v1.0" "ipfs://bafybeigcimbqwfajsnhoq7fqnbdllz7kye7cpdy3adj2sob3wku2llu5bi") --compiler-version v0.8.17 0x9D2dfd6066d5935267291718E8AA16C8Ab729E9d src/Hats.sol:Hats --etherscan-api-key $ETHERSCAN_KEY
+    // forge verify-contract --chain-id 5 --num-of-optimizations 10000 --watch --constructor-args $(cast abi-encode "constructor(string,string)" "Hats Protocol v1" "ipfs://bafkreiflezpk3kjz6zsv23pbvowtatnd5hmqfkdro33x5mh2azlhne3ah4") --compiler-version v0.8.17 0x3bc1A0Ad72417f2d411118085256fC53CBdDd137 src/Hats.sol:Hats --etherscan-api-key $ETHERSCAN_KEY
 }
 
 contract DeployHatsAndMintTopHat is Script {

src/Hats.sol

@@ -24,12 +24,16 @@ import "./Interfaces/IHatsToggle.sol";
 import "./Interfaces/IHatsEligibility.sol";
 import "solbase/utils/Base64.sol";
 import "solbase/utils/LibString.sol";
+import "solady/utils/Multicallable.sol";
 
-/// @title Hats Protocol
+/// @title Hats Protocol v1
 /// @notice Hats are DAO-native, revocable, and programmable roles that are represented as non-transferable ERC-1155-similar tokens for composability
-/// @dev This is a multitenant contract that can manage all hats for a given chain. While it fully implements the ERC1155 interface, it does not fully comply with the ERC1155 standard.
+/// @dev This is a multi-tenant contract that can manage all hats for a given chain. While it fully implements the ERC1155 interface, it does not fully comply with the ERC1155 standard.
 /// @author Haberdasher Labs
-contract Hats is IHats, ERC1155, HatsIdUtilities {
+contract Hats is IHats, ERC1155, Multicallable, HatsIdUtilities {
+    /// @notice This contract's version is labeled v1. Previous versions labeled similarly as v1 and v1.0 are deprecated,
+    ///         and should be treated as beta deployments.
+
     /*//////////////////////////////////////////////////////////////
                               HATS DATA MODELS
     //////////////////////////////////////////////////////////////*/

test/Hats.t.sol

@@ -2395,3 +2395,112 @@ contract MalformedInputsTests is TestSetup2 {
         hats.checkHatStatus(secondHatId);
     }
 }
+
+contract MulticallTests is TestSetup {
+    bytes[] data;
+    string topDeets;
+    string secondDeets;
+    string topImage;
+    string secondImage;
+
+    function test_mintNewTopHat_andCreateHat() public {
+        topHatId = 0x00000002_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000;
+        secondHatId = 0x00000002_0001_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000_0000;
+        topDeets = "multicall tophat";
+        secondDeets = "multicall second hat";
+        topImage = "hatsprotocol.eth/tophat.png";
+        secondImage = "hatsprotocol.eth/secondhat.png";
+
+        // craft the data for the mintTopHat call
+        bytes memory mintTopHatData =
+            abi.encodeWithSignature("mintTopHat(address,string,string)", topHatWearer, topDeets, topImage);
+
+        // craft the data for the createHat call
+        bytes memory createHatData = abi.encodeWithSignature(
+            "createHat(uint256,string,uint32,address,address,bool,string)",
+            topHatId,
+            secondDeets,
+            500,
+            _eligibility,
+            _toggle,
+            true,
+            secondImage
+        );
+
+        // craft the data for the multicall
+        data = new bytes[](2);
+        data[0] = mintTopHatData;
+        data[1] = createHatData;
+
+        // expect hat created, hat minted, and hat created events
+        vm.expectEmit();
+        emit HatCreated(topHatId, topDeets, 1, address(0), address(0), false, topImage);
+        vm.expectEmit();
+        emit TransferSingle(topHatWearer, address(0), topHatWearer, topHatId, 1);
+        vm.expectEmit();
+        emit HatCreated(secondHatId, secondDeets, 500, _eligibility, _toggle, true, secondImage);
+
+        // call the multicall from topHatWearer
+        vm.prank(topHatWearer);
+        hats.multicall(data);
+
+        // check that the hats were created
+        assertTrue(hats.isWearerOfHat(topHatWearer, topHatId));
+        assertEq(hats.getHatMaxSupply(secondHatId), 500);
+    }
+
+    function test_editHat() public {
+        // create a mutable hat
+        test_mintNewTopHat_andCreateHat();
+
+        // craft the data for the details change
+        bytes memory changeDetailsData =
+            abi.encodeWithSignature("changeHatDetails(uint256,string)", secondHatId, "new details");
+
+        // craft the data for the image change
+        bytes memory changeImageData =
+            abi.encodeWithSignature("changeHatImageURI(uint256,string)", secondHatId, "hatsprotocol.eth/newimage.png");
+
+        // craft the data for the eligibility change
+        bytes memory changeEligibilityData =
+            abi.encodeWithSignature("changeHatEligibility(uint256,address)", secondHatId, address(1234));
+
+        // craft the data for the toggle change
+        bytes memory changeToggleData =
+            abi.encodeWithSignature("changeHatToggle(uint256,address)", secondHatId, address(5678));
+
+        // craft the data for the max supply change
+        bytes memory changeMaxSupplyData =
+            abi.encodeWithSignature("changeHatMaxSupply(uint256,uint32)", secondHatId, 1000);
+
+        // craft the data to make the hat immutable
+        bytes memory makeHatImmutableData = abi.encodeWithSignature("makeHatImmutable(uint256)", secondHatId);
+
+        // craft the data for the multicall
+        data = new bytes[](6);
+        data[0] = changeDetailsData;
+        data[1] = changeImageData;
+        data[2] = changeEligibilityData;
+        data[3] = changeToggleData;
+        data[4] = changeMaxSupplyData;
+        data[5] = makeHatImmutableData;
+
+        // expect the details, image, eligibility, toggle, max supply, and immutable events
+        vm.expectEmit();
+        emit HatDetailsChanged(secondHatId, "new details");
+        vm.expectEmit();
+        emit HatImageURIChanged(secondHatId, "hatsprotocol.eth/newimage.png");
+        vm.expectEmit();
+        emit HatEligibilityChanged(secondHatId, address(1234));
+        vm.expectEmit();
+        emit HatToggleChanged(secondHatId, address(5678));
+        vm.expectEmit();
+        emit HatMaxSupplyChanged(secondHatId, 1000);
+        vm.expectEmit();
+        emit HatMutabilityChanged(secondHatId);
+
+        // call the multicall from topHatWearer
+        vm.prank(topHatWearer);
+        hats.multicall(data);
+    }
+}