@zoralabs/comments-contracts 0.0.1

package/.env.example

@@ -0,0 +1,11 @@
+ALCHEMY_KEY=
+TENDERLY_KEY=
+
+CONDUIT_KEY=
+
+# Turnkey authentication and private key information
+TURNKEY_API_PUBLIC_KEY=""
+TURNKEY_API_PRIVATE_KEY=""
+TURNKEY_ORGANIZATION_ID=""
+TURNKEY_PRIVATE_KEY_ID="xxxx-xxx-xxxx-xxxx-xxxxxxxx"
+TURNKEY_TARGET_ADDRESS="xxxxxxxx"

package/.turbo/turbo-build.log

@@ -0,0 +1,60 @@
+
+> @zoralabs/comments-contracts@0.0.1 build /home/runner/work/zora-protocol-private/zora-protocol-private/packages/comments
+> pnpm run wagmi:generate && pnpm run copy-abis && pnpm run prettier:write && tsup
+
+
+> @zoralabs/comments-contracts@0.0.1 wagmi:generate /home/runner/work/zora-protocol-private/zora-protocol-private/packages/comments
+> FOUNDRY_PROFILE=dev forge build && wagmi generate
+
+Compiling 93 files with Solc 0.8.23
+Solc 0.8.23 finished in 23.33s
+Compiler run successful!
+- Validating plugins
+✔ Validating plugins
+- Resolving contracts
+✔ Resolving contracts
+- Running plugins
+✔ Running plugins
+- Writing to package/wagmiGenerated.ts
+✔ Writing to package/wagmiGenerated.ts
+
+> @zoralabs/comments-contracts@0.0.1 copy-abis /home/runner/work/zora-protocol-private/zora-protocol-private/packages/comments
+> pnpm tsx script/bundle-abis.ts
+
+
+> @zoralabs/comments-contracts@0.0.1 prettier:write /home/runner/work/zora-protocol-private/zora-protocol-private/packages/comments
+> prettier --write 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'
+
+src/CommentsImpl.sol 1251ms (unchanged)
+src/deployments/CommentsDeployment.sol 19ms (unchanged)
+src/interfaces/IComments.sol 55ms (unchanged)
+src/interfaces/IZoraCreator1155.sol 10ms (unchanged)
+src/proxy/Comments.sol 25ms (unchanged)
+src/utils/EIP712UpgradeableWithChainId.sol 36ms (unchanged)
+src/version/ContractVersionBase.sol 4ms (unchanged)
+test/Comments_mintAndComment.t.sol 162ms (unchanged)
+test/Comments_permit.t.sol 423ms (unchanged)
+test/Comments.t.sol 577ms (unchanged)
+test/CommentsTestBase.sol 68ms (unchanged)
+test/mocks/Mock1155.sol 34ms (unchanged)
+test/mocks/MockMinter.sol 17ms (unchanged)
+test/mocks/ProtocolRewards.sol 693ms (unchanged)
+script/CommentsDeployerBase.sol 63ms (unchanged)
+script/Deploy.s.sol 57ms (unchanged)
+script/DeployImpl.s.sol 39ms (unchanged)
+script/DeployNonDeterministic.s.sol 29ms (unchanged)
+script/GenerateDeterministicParams.s.sol 31ms (unchanged)
+CLI Building entry: package/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v7.3.0
+CLI Using tsup config: /home/runner/work/zora-protocol-private/zora-protocol-private/packages/comments/tsup.config.ts
+CLI Target: es2021
+CLI Cleaning output folder
+CJS Build start
+ESM Build start
+ESM dist/index.js     27.14 KB
+ESM dist/index.js.map 47.24 KB
+ESM ⚡️ Build success in 30ms
+CJS dist/index.cjs     28.16 KB
+CJS dist/index.cjs.map 47.51 KB
+CJS ⚡️ Build success in 32ms

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Zora Labs
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,70 @@
+# Comments
+
+## Deployment
+
+The `Comments` contract is deployed deterministically using a turnkey account. The deployment process uses a helper contract, [DeterministicDeployerAndCaller](../../packages/shared-contracts/src/deployment/DeterministicDeployerAndCaller.sol).
+
+### Prerequisites
+
+- Ensure you have [Forge](https://book.getfoundry.sh/getting-started/installation) installed.
+- Familiarity with [turnkey accounts](https://docs.turnkey.com/) is recommended.
+
+### Setting up environment variables
+
+In the `packages/comments` directory:
+
+1. Copy `.env.example` to `.env`
+2. Populate the parameters in `.env`
+3. Set `TURNKEY_TARGET_ADDRESS` to the address of the turnkey account that will sign the deployment.
+
+### Deploying the Comments Contract
+
+1. Generate deterministic config (if not already done):
+
+```bash
+DEPLOYER={TURNKEY_DEPLOYER_ADDRESS} forge script script/GenerateDeterministicParams.s.sol $(chains zora --rpc) --ffi
+```
+
+This saves the config to `./deterministicConfig/comments.json`.
+
+2. Deploy the `Comments` contract:
+
+```bash
+forge script script/Deploy.s.sol $(chains {chainName} --rpc) --broadcast --verify
+```
+
+where `{chainName}` is the emdash name of the chain you want to deploy on.
+
+## Seeding a Comments Contract
+
+### Backfilling MintComments
+
+`MintComment` events are legacy events for commenting when minting on
+Zora 1155 contracts. To import the into a Comments contract, so that
+they can be replied to and sparked, the following script can be run.
+
+```
+pnpm tsx scripts/backfillComments.ts {chainName}
+```
+
+where `{chainName}` is the emdash name of the chain you want to backfill on.
+
+Example usages:
+
+```
+// for zora sepolia
+pnpm tsx scripts/backfillComments.ts zora-sepolia
+// for zora mainnet
+pnpm tsx scripts/backfillComments.ts zora
+// for base
+pnpm tsx scripts/backfillComments.ts base
+```
+
+### Seeding Comments Contract with some Test Data
+
+Currently only on Zora Sepolia, this will create some comments, replies,
+and sparked comments.
+
+```
+pnpm tsx scripts/generateCommentsTestData.ts
+```

package/_imagine/Enjoy.sol

@@ -0,0 +1,41 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.23;
+
+/*
+
+
+
+
+
+             ░░░░░░░░░░░░░░              
+        ░░▒▒░░░░░░░░░░░░░░░░░░░░        
+      ░░▒▒▒▒░░░░░░░░░░░░░░░░░░░░░░      
+    ░░▒▒▒▒░░░░░░░░░░░░░░    ░░░░░░░░    
+   ░▓▓▒▒▒▒░░░░░░░░░░░░        ░░░░░░░    
+  ░▓▓▓▒▒▒▒░░░░░░░░░░░░        ░░░░░░░░  
+  ░▓▓▓▒▒▒▒░░░░░░░░░░░░░░    ░░░░░░░░░░  
+  ░▓▓▓▒▒▒▒▒▒░░░░░░░░░░░░░░░░░░░░░░░░░░░  
+  ░▓▓▓▓▓▒▒▒▒░░░░░░░░░░░░░░░░░░░░░░░░░░  
+   ░▓▓▓▓▒▒▒▒▒▒░░░░░░░░░░░░░░░░░░░░░░░  
+    ░░▓▓▓▓▒▒▒▒▒▒░░░░░░░░░░░░░░░░░░░░    
+    ░░▓▓▓▓▓▓▒▒▒▒▒▒▒▒░░░░░░░░░▒▒▒▒▒░░    
+      ░░▓▓▓▓▓▓▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒░░      
+          ░░▓▓▓▓▓▓▓▓▓▓▓▓▒▒░░░          
+
+               OURS TRULY,
+
+
+
+
+
+
+
+
+
+
+
+ */
+
+interface Enjoy {
+
+}

package/abis/AccessControlUpgradeable.json

@@ -0,0 +1,250 @@
+[
+  {
+    "type": "function",
+    "name": "DEFAULT_ADMIN_ROLE",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "getRoleAdmin",
+    "inputs": [
+      {
+        "name": "role",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "grantRole",
+    "inputs": [
+      {
+        "name": "role",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "account",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "hasRole",
+    "inputs": [
+      {
+        "name": "role",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "account",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "function",
+    "name": "renounceRole",
+    "inputs": [
+      {
+        "name": "role",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "callerConfirmation",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "revokeRole",
+    "inputs": [
+      {
+        "name": "role",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      },
+      {
+        "name": "account",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "outputs": [],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "function",
+    "name": "supportsInterface",
+    "inputs": [
+      {
+        "name": "interfaceId",
+        "type": "bytes4",
+        "internalType": "bytes4"
+      }
+    ],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "view"
+  },
+  {
+    "type": "event",
+    "name": "Initialized",
+    "inputs": [
+      {
+        "name": "version",
+        "type": "uint64",
+        "indexed": false,
+        "internalType": "uint64"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "RoleAdminChanged",
+    "inputs": [
+      {
+        "name": "role",
+        "type": "bytes32",
+        "indexed": true,
+        "internalType": "bytes32"
+      },
+      {
+        "name": "previousAdminRole",
+        "type": "bytes32",
+        "indexed": true,
+        "internalType": "bytes32"
+      },
+      {
+        "name": "newAdminRole",
+        "type": "bytes32",
+        "indexed": true,
+        "internalType": "bytes32"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "RoleGranted",
+    "inputs": [
+      {
+        "name": "role",
+        "type": "bytes32",
+        "indexed": true,
+        "internalType": "bytes32"
+      },
+      {
+        "name": "account",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "sender",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "event",
+    "name": "RoleRevoked",
+    "inputs": [
+      {
+        "name": "role",
+        "type": "bytes32",
+        "indexed": true,
+        "internalType": "bytes32"
+      },
+      {
+        "name": "account",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      },
+      {
+        "name": "sender",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "error",
+    "name": "AccessControlBadConfirmation",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "AccessControlUnauthorizedAccount",
+    "inputs": [
+      {
+        "name": "account",
+        "type": "address",
+        "internalType": "address"
+      },
+      {
+        "name": "neededRole",
+        "type": "bytes32",
+        "internalType": "bytes32"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "InvalidInitialization",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "NotInitializing",
+    "inputs": []
+  }
+]

package/abis/Address.json

@@ -0,0 +1,29 @@
+[
+  {
+    "type": "error",
+    "name": "AddressEmptyCode",
+    "inputs": [
+      {
+        "name": "target",
+        "type": "address",
+        "internalType": "address"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "AddressInsufficientBalance",
+    "inputs": [
+      {
+        "name": "account",
+        "type": "address",
+        "internalType": "address"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "FailedInnerCall",
+    "inputs": []
+  }
+]

package/abis/Comments.json

@@ -0,0 +1,62 @@
+[
+  {
+    "type": "constructor",
+    "inputs": [
+      {
+        "name": "_logic",
+        "type": "address",
+        "internalType": "address"
+      }
+    ],
+    "stateMutability": "nonpayable"
+  },
+  {
+    "type": "fallback",
+    "stateMutability": "payable"
+  },
+  {
+    "type": "event",
+    "name": "Upgraded",
+    "inputs": [
+      {
+        "name": "implementation",
+        "type": "address",
+        "indexed": true,
+        "internalType": "address"
+      }
+    ],
+    "anonymous": false
+  },
+  {
+    "type": "error",
+    "name": "AddressEmptyCode",
+    "inputs": [
+      {
+        "name": "target",
+        "type": "address",
+        "internalType": "address"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "ERC1967InvalidImplementation",
+    "inputs": [
+      {
+        "name": "implementation",
+        "type": "address",
+        "internalType": "address"
+      }
+    ]
+  },
+  {
+    "type": "error",
+    "name": "ERC1967NonPayable",
+    "inputs": []
+  },
+  {
+    "type": "error",
+    "name": "FailedInnerCall",
+    "inputs": []
+  }
+]

package/abis/CommentsDeployerBase.json

@@ -0,0 +1,15 @@
+[
+  {
+    "type": "function",
+    "name": "IS_SCRIPT",
+    "inputs": [],
+    "outputs": [
+      {
+        "name": "",
+        "type": "bool",
+        "internalType": "bool"
+      }
+    ],
+    "stateMutability": "view"
+  }
+]