@zoralabs/comments-contracts 0.0.1 → 0.0.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/comments-contracts",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "author": "oveddan",
   "license": "MIT",
   "type": "module",
@@ -16,33 +16,34 @@
     }
   },
   "devDependencies": {
+    "@openzeppelin/contracts": "5.0.2",
+    "@openzeppelin/contracts-upgradeable": "5.0.2",
     "@turnkey/api-key-stamper": "^0.3.1",
     "@turnkey/http": "^2.5.1",
     "@turnkey/viem": "^0.4.4",
     "@types/node": "^20.1.2",
     "@wagmi/cli": "^1.0.1",
     "@zoralabs/chains": "^1.3.1",
-    "@openzeppelin/contracts": "5.0.2",
-    "@openzeppelin/contracts-upgradeable": "5.0.2",
     "ds-test": "https://github.com/dapphub/ds-test#cd98eff28324bfac652e63a239a60632a761790b",
     "forge-std": "https://github.com/foundry-rs/forge-std#v1.9.1",
-    "solady": "0.0.132",
     "glob": "^10.2.2",
     "pathe": "^1.1.2",
     "prettier": "^3.0.3",
     "prettier-plugin-solidity": "^1.3.1",
+    "solady": "0.0.132",
     "tsup": "^7.2.0",
     "tsx": "^3.13.0",
     "typescript": "^5.2.2",
-    "viem": "^1.10.0",
-    "@zoralabs/tsconfig": "^0.0.1",
-    "@zoralabs/protocol-rewards": "^1.2.4",
+    "viem": "^2.21.18",
+    "@zoralabs/sparks-contracts": "^0.2.4",
+    "@zoralabs/protocol-rewards": "^1.2.5",
     "@zoralabs/shared-contracts": "^0.0.1",
-    "@zoralabs/sparks-contracts": "^0.2.2",
-    "@zoralabs/zora-1155-contracts": "^2.12.4"
+    "@zoralabs/tsconfig": "^0.0.1",
+    "@zoralabs/zora-1155-contracts": "^2.13.2"
   },
   "dependencies": {
-    "abitype": "^1.0.2"
+    "abitype": "^1.0.2",
+    "dotenv": "^16.4.5"
   },
   "scripts": {
     "prettier:check": "prettier --check 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'",
@@ -52,7 +53,7 @@
     "test-gas": "forge test --gas-report",
     "storage-inspect:check": "./script/storage-check.sh check ZoraTimedSaleStrategyImpl",
     "storage-inspect:generate": "./script/storage-check.sh generate ZoraTimedSaleStrategyImpl",
-    "build:sizes": "forge build --sizes",
+    "build:sizes": "forge build src/ --sizes",
     "copy-abis": "pnpm tsx script/bundle-abis.ts",
     "coverage": "FOUNDRY_PROFILE=default forge coverage --report lcov",
     "build": "pnpm run wagmi:generate && pnpm run copy-abis && pnpm run prettier:write && tsup",

package/script/AddDelegateCommenterRole.s.sol

@@ -0,0 +1,24 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.23;
+
+import "forge-std/Script.sol";
+import {CommentsDeployerBase} from "./CommentsDeployerBase.sol";
+import {AccessControlUpgradeable} from "@openzeppelin/contracts-upgradeable/access/AccessControlUpgradeable.sol";
+
+contract AddDelegateCommenterRole is CommentsDeployerBase {
+    function run() public view {
+        address owner = getProxyAdmin();
+        bytes32 BACKFILLER_ROLE = keccak256("DELEGATE_COMMENTER");
+
+        address callerAndCommenter = readDeterministicContractConfig("callerAndCommenter").deployedAddress;
+
+        address comments = readDeterministicContractConfig("comments").deployedAddress;
+
+        bytes memory call = abi.encodeWithSelector(AccessControlUpgradeable.grantRole.selector, BACKFILLER_ROLE, callerAndCommenter);
+
+        console.log("multisig", owner);
+        console.log("target", comments);
+        console.log("call:");
+        console.logBytes(call);
+    }
+}

package/script/CommentsDeployerBase.sol

@@ -3,41 +3,65 @@ pragma solidity ^0.8.23;
 
 import "forge-std/Script.sol";
 
-import {ProxyDeployerScript} from "@zoralabs/shared-contracts/deployment/ProxyDeployerScript.sol";
+import {ProxyDeployerScript, DeterministicContractConfig, DeterministicDeployerAndCaller} from "@zoralabs/shared-contracts/deployment/ProxyDeployerScript.sol";
 import {CommentsImpl} from "../src/CommentsImpl.sol";
-import {IProtocolRewards} from "@zoralabs/protocol-rewards/src/interfaces/IProtocolRewards.sol";
+import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
+import {CallerAndCommenterImpl} from "../src/utils/CallerAndCommenterImpl.sol";
+import {CallerAndCommenter} from "../src/proxy/CallerAndCommenter.sol";
 
 // Temp script
 contract CommentsDeployerBase is ProxyDeployerScript {
     uint256 internal constant SPARK_VALUE = 0.000001 ether;
     address internal constant PROTOCOL_REWARDS = 0x7777777F279eba3d3Ad8F4E708545291A6fDBA8B;
     address internal constant ZORA_TIMED_SALE_STRATEGY = 0x777777722D078c97c6ad07d9f36801e653E356Ae;
+    address internal constant SECONDARY_SWAP = 0x777777EDF27Ac61671e3D5718b10bf6a8802f9f1;
+
     using stdJson for string;
 
     struct CommentsDeployment {
         address comments;
         address commentsImpl;
         string commentsVersion;
+        address callerAndCommenter;
+        address callerAndCommenterImpl;
+        string callerAndCommenterVersion;
+        uint256 commentsBlockNumber;
+        uint256 commentsImplBlockNumber;
+    }
+
+    function addressesFile() internal view returns (string memory) {
+        return string.concat("./addresses/", vm.toString(block.chainid), ".json");
     }
 
     function saveDeployment(CommentsDeployment memory deployment) internal {
         string memory objectKey = "config";
 
         vm.serializeAddress(objectKey, "COMMENTS", deployment.comments);
-        string memory result = vm.serializeAddress(objectKey, "COMMENTS_IMPL", deployment.commentsImpl);
+        vm.serializeUint(objectKey, "COMMENTS_BLOCK_NUMBER", deployment.commentsBlockNumber);
+        vm.serializeAddress(objectKey, "COMMENTS_IMPL", deployment.commentsImpl);
+        vm.serializeAddress(objectKey, "CALLER_AND_COMMENTER", deployment.callerAndCommenter);
+        vm.serializeAddress(objectKey, "CALLER_AND_COMMENTER_IMPL", deployment.callerAndCommenterImpl);
+        vm.serializeString(objectKey, "CALLER_AND_COMMENTER_VERSION", deployment.callerAndCommenterVersion);
+        string memory result = vm.serializeUint(objectKey, "COMMENTS_IMPL_BLOCK_NUMBER", deployment.commentsImplBlockNumber);
 
-        vm.writeJson(result, string.concat("./addresses/", vm.toString(block.chainid), ".json"));
+        vm.writeJson(result, addressesFile());
     }
 
-    function readDeployment() internal view returns (CommentsDeployment memory) {
-        string memory json = vm.readFile(string.concat("./addresses/", vm.toString(block.chainid), ".json"));
+    function readDeployment() internal returns (CommentsDeployment memory deployment) {
+        string memory file = addressesFile();
+        if (!vm.exists(file)) {
+            return deployment;
+        }
+        string memory json = vm.readFile(file);
 
-        return
-            CommentsDeployment({
-                comments: readAddressOrDefaultToZero(json, "COMMENTS"),
-                commentsImpl: readAddressOrDefaultToZero(json, "COMMENTS_IMPL"),
-                commentsVersion: readStringOrDefaultToEmpty(json, "COMMENTS_VERSION")
-            });
+        deployment.comments = readAddressOrDefaultToZero(json, "COMMENTS");
+        deployment.commentsImpl = readAddressOrDefaultToZero(json, "COMMENTS_IMPL");
+        deployment.commentsVersion = readStringOrDefaultToEmpty(json, "COMMENTS_VERSION");
+        deployment.commentsBlockNumber = readUintOrDefaultToZero(json, "COMMENTS_BLOCK_NUMBER");
+        deployment.commentsImplBlockNumber = readUintOrDefaultToZero(json, "COMMENTS_IMPL_BLOCK_NUMBER");
+        deployment.callerAndCommenter = readAddressOrDefaultToZero(json, "CALLER_AND_COMMENTER");
+        deployment.callerAndCommenterImpl = readAddressOrDefaultToZero(json, "CALLER_AND_COMMENTER_IMPL");
+        deployment.callerAndCommenterVersion = readStringOrDefaultToEmpty(json, "CALLER_AND_COMMENTER_VERSION");
     }
 
     function commentsImplCreationCode() internal pure returns (bytes memory) {
@@ -45,16 +69,75 @@ contract CommentsDeployerBase is ProxyDeployerScript {
     }
 
     function getBackfillerAccount() internal pure returns (address) {
-        // todo: figure out backfiller.  right now this is made from cast wallet new
-        return 0x9AfA68161f094DAEA62816b6264b3D777978a164;
+        return 0x77baCD258d2E6A5187B7344419A5e2842A49A059;
     }
 
-    function defaultDelegateCommenters() internal pure returns (address[] memory delegateCommenters) {
-        delegateCommenters = new address[](1);
-        delegateCommenters[0] = ZORA_TIMED_SALE_STRATEGY;
+    function deployCommentsImpl() internal returns (CommentsImpl) {
+        return new CommentsImpl(SPARK_VALUE, PROTOCOL_REWARDS, getZoraRecipient());
     }
 
-    function deployCommentsImpl() internal returns (CommentsImpl) {
-        return new CommentsImpl(SPARK_VALUE, PROTOCOL_REWARDS);
+    function deployCommentsDeterministic(CommentsDeployment memory deployment, DeterministicDeployerAndCaller deployer) internal {
+        // read previously saved deterministic royalties config
+        DeterministicContractConfig memory commentsConfig = readDeterministicContractConfig("comments");
+        DeterministicContractConfig memory callerAndCommenterConfig = readDeterministicContractConfig("callerAndCommenter");
+
+        address backfiller = CommentsDeployerBase.getBackfillerAccount();
+        // get deployed implementation address.  it it's not deployed, revert
+        address implAddress = address(deployCommentsImpl());
+
+        if (implAddress.code.length == 0) {
+            revert("Impl not yet deployed.  Make sure to deploy it with DeployImpl.s.sol");
+        }
+
+        address[] memory delegateCommenters = new address[](1);
+        delegateCommenters[0] = callerAndCommenterConfig.deployedAddress;
+
+        // build upgrade to and call for comments, with init call
+        bytes memory upgradeToAndCall = abi.encodeWithSelector(
+            UUPSUpgradeable.upgradeToAndCall.selector,
+            implAddress,
+            abi.encodeWithSelector(CommentsImpl.initialize.selector, getProxyAdmin(), backfiller, delegateCommenters)
+        );
+
+        // sign royalties deployment with turnkey account
+        bytes memory signature = signDeploymentWithTurnkey(commentsConfig, upgradeToAndCall, deployer);
+
+        deployment.comments = deployer.permitSafeCreate2AndCall(
+            signature,
+            commentsConfig.salt,
+            commentsConfig.creationCode,
+            upgradeToAndCall,
+            commentsConfig.deployedAddress
+        );
+        deployment.commentsBlockNumber = block.number;
+    }
+
+    function deployCallerAndCommenterImpl(address commentsAddress) internal returns (address) {
+        return address(new CallerAndCommenterImpl(commentsAddress, ZORA_TIMED_SALE_STRATEGY, SECONDARY_SWAP, SPARK_VALUE));
+    }
+
+    function deployCallerAndCommenterDeterministic(CommentsDeployment memory deployment, DeterministicDeployerAndCaller deployer) internal {
+        address commentsAddress = readDeterministicContractConfig("comments").deployedAddress;
+        DeterministicContractConfig memory callerAndCommenterConfig = readDeterministicContractConfig("callerAndCommenter");
+
+        // deploy caller and commenter impl
+        deployment.callerAndCommenterImpl = address(deployCallerAndCommenterImpl(commentsAddress));
+        deployment.callerAndCommenterVersion = CallerAndCommenterImpl(deployment.callerAndCommenterImpl).contractVersion();
+
+        bytes memory upgradeToAndCall = abi.encodeWithSelector(
+            UUPSUpgradeable.upgradeToAndCall.selector,
+            deployment.callerAndCommenterImpl,
+            abi.encodeWithSelector(CallerAndCommenterImpl.initialize.selector, getProxyAdmin())
+        );
+
+        bytes memory signature = signDeploymentWithTurnkey(callerAndCommenterConfig, upgradeToAndCall, deployer);
+
+        deployment.callerAndCommenter = deployer.permitSafeCreate2AndCall(
+            signature,
+            callerAndCommenterConfig.salt,
+            callerAndCommenterConfig.creationCode,
+            upgradeToAndCall,
+            callerAndCommenterConfig.deployedAddress
+        );
     }
 }

package/script/Deploy.s.sol

@@ -1,62 +1,20 @@
 // SPDX-License-Identifier: UNLICENSED
 pragma solidity ^0.8.13;
 
-import "forge-std/Script.sol";
-
-import {ProxyDeployerScript} from "@zoralabs/shared-contracts/deployment/ProxyDeployerScript.sol";
-import {ImmutableCreate2FactoryUtils} from "@zoralabs/shared-contracts/utils/ImmutableCreate2FactoryUtils.sol";
 import {ProxyDeployerScript, DeterministicDeployerAndCaller, DeterministicContractConfig} from "@zoralabs/shared-contracts/deployment/ProxyDeployerScript.sol";
-import {CommentsImpl} from "../src/CommentsImpl.sol";
-import {CommentsDeployment} from "../src/deployments/CommentsDeployment.sol";
-import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
 import {CommentsDeployerBase} from "./CommentsDeployerBase.sol";
 
-// Temp script
 contract DeployScript is CommentsDeployerBase {
     function run() public {
         CommentsDeployment memory deployment = readDeployment();
 
-        address owner = getProxyAdmin();
-
-        // todo: figure out backfiller.  right now this is made from cast wallet new
-        address backfiller = 0x9AfA68161f094DAEA62816b6264b3D777978a164;
-        address zoraRecipient = getZoraRecipient();
-
-        // get deployed implementation address.  it it's not deployed, revert
-        address implAddress = deployment.commentsImpl;
-
-        if (implAddress.code.length == 0) {
-            revert("Impl not yet deployed.  Make sure to deploy it with DeployImpl.s.sol");
-        }
-
         vm.startBroadcast();
 
         // get deployer contract
         DeterministicDeployerAndCaller deployer = createOrGetDeployerAndCaller();
 
-        // read previously saved deterministic royalties config
-        DeterministicContractConfig memory commentsConfig = readDeterministicContractConfig("comments");
-
-        address[] memory delegateCommenters = defaultDelegateCommenters();
-
-        // build upgrade to and call for comments, with init call
-        bytes memory upgradeToAndCall = abi.encodeWithSelector(
-            UUPSUpgradeable.upgradeToAndCall.selector,
-            implAddress,
-            abi.encodeWithSelector(CommentsImpl.initialize.selector, zoraRecipient, owner, backfiller, delegateCommenters)
-        );
-
-        // sign royalties deployment with turnkey account
-        bytes memory commentsSignature = signDeploymentWithTurnkey(commentsConfig, upgradeToAndCall, deployer);
-
-        // deterministically deploy royalties contract using the signature
-        deployment.comments = deployer.permitSafeCreate2AndCall(
-            commentsSignature,
-            commentsConfig.salt,
-            commentsConfig.creationCode,
-            upgradeToAndCall,
-            commentsConfig.deployedAddress
-        );
+        deployCommentsDeterministic(deployment, deployer);
+        deployCallerAndCommenterDeterministic(deployment, deployer);
 
         vm.stopBroadcast();
 

package/script/DeployCallerAndCommenterImpl.s.sol

@@ -0,0 +1,29 @@
+// SPDX-License-Identifier: UNLICENSED
+pragma solidity ^0.8.13;
+
+import "forge-std/console2.sol";
+
+import {CommentsDeployerBase} from "./CommentsDeployerBase.sol";
+import {CallerAndCommenterImpl} from "../src/utils/CallerAndCommenterImpl.sol";
+import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
+
+contract DeployCallerAndCommenterImpl is CommentsDeployerBase {
+    function run() public {
+        CommentsDeployment memory config = readDeployment();
+
+        vm.startBroadcast();
+
+        config.callerAndCommenterImpl = deployCallerAndCommenterImpl(config.comments);
+        config.callerAndCommenterVersion = CallerAndCommenterImpl(config.callerAndCommenterImpl).contractVersion();
+
+        vm.stopBroadcast();
+
+        console2.log("CallerAndCommenterImpl deployed, to upgrade:");
+        console2.log("target:", config.callerAndCommenter);
+        console2.log("calldata:");
+        console2.logBytes(abi.encodeWithSelector(UUPSUpgradeable.upgradeToAndCall.selector, config.callerAndCommenterImpl, ""));
+        console2.log("multisig:", getProxyAdmin());
+
+        saveDeployment(config);
+    }
+}

package/script/DeployImpl.s.sol

@@ -12,6 +12,7 @@ contract DeployImpl is CommentsDeployerBase {
         vm.startBroadcast();
 
         config.commentsImpl = address(deployCommentsImpl());
+        config.commentsImplBlockNumber = block.number;
 
         vm.stopBroadcast();
 

package/script/DeployNonDeterministic.s.sol

@@ -2,14 +2,11 @@
 pragma solidity ^0.8.13;
 
 import "forge-std/Script.sol";
-
-import {ProxyDeployerScript} from "@zoralabs/shared-contracts/deployment/ProxyDeployerScript.sol";
-import {ImmutableCreate2FactoryUtils} from "@zoralabs/shared-contracts/utils/ImmutableCreate2FactoryUtils.sol";
-import {ProxyDeployerScript, DeterministicDeployerAndCaller, DeterministicContractConfig} from "@zoralabs/shared-contracts/deployment/ProxyDeployerScript.sol";
 import {Comments} from "../src/proxy/Comments.sol";
 import {CommentsImpl} from "../src/CommentsImpl.sol";
-import {UUPSUpgradeable} from "@openzeppelin/contracts-upgradeable/proxy/utils/UUPSUpgradeable.sol";
 import {CommentsDeployerBase} from "./CommentsDeployerBase.sol";
+import {CallerAndCommenterImpl} from "../src/utils/CallerAndCommenterImpl.sol";
+import {CallerAndCommenter} from "../src/proxy/CallerAndCommenter.sol";
 
 contract DeployNonDeterministic is CommentsDeployerBase {
     function run() public {
@@ -17,27 +14,39 @@ contract DeployNonDeterministic is CommentsDeployerBase {
 
         address owner = getProxyAdmin();
 
-        // todo: figure out backfiller.  right now this is made from cast wallet new
-        address backfiller = 0x9AfA68161f094DAEA62816b6264b3D777978a164;
-        address zoraRecipient = getZoraRecipient();
+        address backfiller = CommentsDeployerBase.getBackfillerAccount();
 
         vm.startBroadcast();
-        // deploy comments backfiller
 
-        address implAddress = address(deployCommentsImpl());
+        address implAddress = deployment.commentsImpl;
+
+        if (implAddress.code.length == 0) {
+            revert("impl not deployed");
+        }
 
         Comments comments = new Comments(implAddress);
 
-        address[] memory delegateCommenters = defaultDelegateCommenters();
+        CallerAndCommenterImpl callerAndCommenterImpl = new CallerAndCommenterImpl(address(comments), ZORA_TIMED_SALE_STRATEGY, SECONDARY_SWAP, SPARK_VALUE);
+
+        CallerAndCommenter callerAndCommenter = new CallerAndCommenter(address(callerAndCommenterImpl));
 
-        CommentsImpl(payable(address(comments))).initialize(zoraRecipient, owner, backfiller, delegateCommenters);
+        CallerAndCommenterImpl(payable(address(callerAndCommenter))).initialize(owner);
+
+        address[] memory delegateCommenters = new address[](1);
+        delegateCommenters[0] = address(callerAndCommenter);
+
+        CommentsImpl(payable(address(comments))).initialize(owner, backfiller, delegateCommenters);
 
         vm.stopBroadcast();
 
         deployment.comments = address(comments);
-        deployment.commentsImpl = implAddress;
+        deployment.commentsBlockNumber = block.number;
+        deployment.callerAndCommenter = address(callerAndCommenter);
+        deployment.callerAndCommenterImpl = address(callerAndCommenterImpl);
 
         // save the deployment json
         saveDeployment(deployment);
+
+        console.log("Comments deployed at", address(comments));
     }
 }

package/script/GenerateDeterministicParams.s.sol

@@ -3,11 +3,10 @@ pragma solidity ^0.8.20;
 
 import "forge-std/Script.sol";
 
-import {LibString} from "solady/utils/LibString.sol";
 import {ImmutableCreate2FactoryUtils} from "@zoralabs/shared-contracts/utils/ImmutableCreate2FactoryUtils.sol";
 import {ProxyDeployerScript, DeterministicDeployerAndCaller, DeterministicContractConfig} from "@zoralabs/shared-contracts/deployment/ProxyDeployerScript.sol";
-import {Create2} from "@openzeppelin/contracts/utils/Create2.sol";
 import {Comments} from "../src/proxy/Comments.sol";
+import {CallerAndCommenter} from "../src/proxy/CallerAndCommenter.sol";
 
 /// @dev This script saves the current bytecode, and initialization parameters for the Sparks proxy,
 /// which then need to be populated with a salt and expected address, which can be achieved by
@@ -37,6 +36,32 @@ contract GenerateDeterministicParams is ProxyDeployerScript {
         config.deploymentCaller = caller;
     }
 
+    function mineForCallerAndCommenterAddress(
+        DeterministicDeployerAndCaller deployer,
+        address caller
+    ) private returns (DeterministicContractConfig memory config) {
+        // get proxy creation code
+        // get the expected init code for the proxy from the uupsProxyDeployer
+        bytes memory initCode = deployer.proxyCreationCode(type(CallerAndCommenter).creationCode);
+        bytes32 initCodeHash = keccak256(initCode);
+
+        // uupsProxyDeployer is deployer
+        (bytes32 salt, address expectedAddress) = mineSalt(address(deployer), initCodeHash, "7777777", caller);
+
+        // test deployment
+        // Create2.deploy(0, salt, initCode);
+
+        console2.log("salt");
+        console2.log(vm.toString(salt));
+
+        config.salt = salt;
+        config.deployedAddress = expectedAddress;
+        config.creationCode = initCode;
+        config.constructorArgs = deployer.proxyConstructorArgs();
+        config.contractName = "CallerAndCommenter";
+        config.deploymentCaller = caller;
+    }
+
     function run() public {
         address caller = vm.envAddress("DEPLOYER");
 
@@ -48,8 +73,11 @@ contract GenerateDeterministicParams is ProxyDeployerScript {
 
         vm.stopBroadcast();
 
-        DeterministicContractConfig memory commentsConfig = mineForCommentsAddress(deployer, caller);
+        // DeterministicContractConfig memory commentsConfig = mineForCommentsAddress(deployer, caller);
+
+        DeterministicContractConfig memory callerAndCommenterConfig = mineForCallerAndCommenterAddress(deployer, caller);
 
-        saveDeterministicContractConfig(commentsConfig, "comments");
+        // saveDeterministicContractConfig(commentsConfig, "comments");
+        saveDeterministicContractConfig(callerAndCommenterConfig, "callerAndCommenter");
     }
 }