add prettier and changes (#2)

ourzora · Aug 1, 2023 · 64b14fa · 64b14fa
1 parent 9e847bb
commit 64b14fa
Show file tree

Hide file tree

Showing 16 changed files with 215 additions and 320 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -0,0 +1,19 @@
+name: Lint
+on: [pull_request]
+
+jobs:
+  inspect-storage:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16
+          cache: "yarn"
+
+      - name: Install project dependencies
+        run: yarn
+
+      - name: Run prettier
+        run: yarn run prettier:check
diff --git a/.prettierignore b/.prettierignore
@@ -0,0 +1,2 @@
+
+src/lib
diff --git a/.prettierrc b/.prettierrc
@@ -0,0 +1,15 @@
+{
+  "plugins": ["prettier-plugin-solidity"],
+  "overrides": [
+    {
+      "files": "*.sol",
+      "options": {
+        "printWidth": 160,
+        "tabWidth": 4,
+        "useTabs": false,
+        "singleQuote": false,
+        "bracketSpacing": false
+      }
+    }
+  ]
+}
diff --git a/package.json b/package.json
@@ -7,11 +7,15 @@
     "dist/"
   ],
   "scripts": {
-    "prepack": "mkdir -p dist && cp -r src/ dist/contracts && cp -r addresses/ dist/addresses && cp -r out/ dist/artifacts/"
+    "prepack": "mkdir -p dist && cp -r src/ dist/contracts && cp -r addresses/ dist/addresses && cp -r out/ dist/artifacts/",
+    "prettier:check": "prettier --check 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'",
+    "prettier": "prettier --write 'src/**/*.sol' 'test/**/*.sol' 'script/**/*.sol'"
   },
   "dependencies": {},
   "devDependencies": {
     "@types/node": "^20.3.2",
-    "@wagmi/cli": "^1.3.0"
+    "@wagmi/cli": "^1.3.0",
+    "prettier": "^3.0.0",
+    "prettier-plugin-solidity": "^1.1.3"
   }
 }
diff --git a/script/Deploy.s.sol b/script/Deploy.s.sol
@@ -3,7 +3,7 @@ pragma solidity ^0.8.17;
 
 import "forge-std/Script.sol";
 
-import { ProtocolRewards } from "../src/ProtocolRewards.sol";
+import {ProtocolRewards} from "../src/ProtocolRewards.sol";
 
 contract DeployScript is Script {
     uint256 internal deployerPK;

diff --git a/src/ProtocolRewards.sol b/src/ProtocolRewards.sol
@@ -6,10 +6,7 @@ import {IProtocolRewards} from "./interfaces/IProtocolRewards.sol";
 
 contract ProtocolRewards is IProtocolRewards, EIP712 {
     uint256 internal constant WITHDRAW_GAS_LIMIT = 200_000;
-    bytes32 public constant WITHDRAW_TYPEHASH =
-        keccak256(
-            "Withdraw(address owner,uint256 amount,uint256 nonce,uint256 deadline)"
-        );
+    bytes32 public constant WITHDRAW_TYPEHASH = keccak256("Withdraw(address owner,uint256 amount,uint256 nonce,uint256 deadline)");
 
     mapping(address => uint256) public balanceOf;
     mapping(address => uint256) public nonces;
@@ -20,10 +17,7 @@ contract ProtocolRewards is IProtocolRewards, EIP712 {
         return address(this).balance;
     }
 
-    function deposit(
-        address recipient,
-        string calldata comment
-    ) external payable {
+    function deposit(address recipient, string calldata comment) external payable {
         if (recipient == address(0)) {
             revert ADDRESS_ZERO();
         }
@@ -35,11 +29,7 @@ contract ProtocolRewards is IProtocolRewards, EIP712 {
         emit Deposit(msg.sender, recipient, msg.value, comment);
     }
 
-    function depositBatch(
-        address[] calldata recipients,
-        uint256[] calldata amounts,
-        string calldata comment
-    ) external payable {
+    function depositBatch(address[] calldata recipients, uint256[] calldata amounts, string calldata comment) external payable {
         uint256 numRecipients = recipients.length;
 
         if (numRecipients != amounts.length) {
@@ -95,14 +85,7 @@ contract ProtocolRewards is IProtocolRewards, EIP712 {
         address zora,
         uint256 zoraReward
     ) external payable {
-        if (
-            msg.value !=
-            (creatorReward +
-                mintReferralReward +
-                createReferralReward +
-                firstMinterReward +
-                zoraReward)
-        ) {
+        if (msg.value != (creatorReward + mintReferralReward + createReferralReward + firstMinterReward + zoraReward)) {
             revert INVALID_DEPOSIT();
         }
 
@@ -152,39 +135,22 @@ contract ProtocolRewards is IProtocolRewards, EIP712 {
 
         emit Withdraw(owner, amount);
 
-        (bool success, ) = owner.call{value: amount, gas: WITHDRAW_GAS_LIMIT}(
-            ""
-        );
+        (bool success, ) = owner.call{value: amount, gas: WITHDRAW_GAS_LIMIT}("");
 
         if (!success) {
             revert TRANSFER_FAILED();
         }
     }
 
-    function withdrawWithSig(
-        address owner,
-        uint256 amount,
-        uint256 deadline,
-        uint8 v,
-        bytes32 r,
-        bytes32 s
-    ) external {
+    function withdrawWithSig(address owner, uint256 amount, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external {
         if (block.timestamp > deadline) {
             revert SIGNATURE_DEADLINE_EXPIRED();
         }
 
         bytes32 withdrawHash;
 
         unchecked {
-            withdrawHash = keccak256(
-                abi.encode(
-                    WITHDRAW_TYPEHASH,
-                    owner,
-                    amount,
-                    nonces[owner]++,
-                    deadline
-                )
-            );
+            withdrawHash = keccak256(abi.encode(WITHDRAW_TYPEHASH, owner, amount, nonces[owner]++, deadline));
         }
 
         bytes32 digest = _hashTypedDataV4(withdrawHash);
@@ -205,9 +171,7 @@ contract ProtocolRewards is IProtocolRewards, EIP712 {
 
         emit Withdraw(owner, amount);
 
-        (bool success, ) = owner.call{value: amount, gas: WITHDRAW_GAS_LIMIT}(
-            ""
-        );
+        (bool success, ) = owner.call{value: amount, gas: WITHDRAW_GAS_LIMIT}("");
 
         if (!success) {
             revert TRANSFER_FAILED();

diff --git a/src/abstract/ERC1155/ERC1155Rewards.sol b/src/abstract/ERC1155/ERC1155Rewards.sol
@@ -1,17 +1,14 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.17;
 
-import { RewardSplits } from "../RewardSplits.sol";
+import {RewardSplits} from "../RewardSplits.sol";
 
 contract ERC1155RewardsStorage {
     mapping(uint256 => address) public createReferrals;
 }
 
 abstract contract ERC1155Rewards is RewardSplits {
-    constructor(address _protocolRewards, address _zoraRewardRecipient)
-        payable
-        RewardSplits(_protocolRewards, _zoraRewardRecipient)
-    { }
+    constructor(address _protocolRewards, address _zoraRewardRecipient) payable RewardSplits(_protocolRewards, _zoraRewardRecipient) {}
 
     function _handleRewardsAndGetValueSent(
         uint256 msgValue,

diff --git a/src/abstract/ERC721/ERC721Rewards.sol b/src/abstract/ERC721/ERC721Rewards.sol
@@ -1,23 +1,12 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.17;
 
-import { RewardSplits } from "../RewardSplits.sol";
-
+import {RewardSplits} from "../RewardSplits.sol";
 
 abstract contract ERC721Rewards is RewardSplits {
-    constructor(address _protocolRewards, address _zoraRewardRecipient)
-        payable
-        RewardSplits(_protocolRewards, _zoraRewardRecipient)
-    { }
-
-    function _handleRewards(
-        uint256 msgValue,
-        uint256 numTokens,
-        uint256 salePrice,
-        address creator,
-        address mintReferral,
-        address createReferral
-    ) internal {
+    constructor(address _protocolRewards, address _zoraRewardRecipient) payable RewardSplits(_protocolRewards, _zoraRewardRecipient) {}
+
+    function _handleRewards(uint256 msgValue, uint256 numTokens, uint256 salePrice, address creator, address mintReferral, address createReferral) internal {
         if (creator == address(0)) {
             revert CREATOR_FUNDS_RECIPIENT_NOT_SET();
         }

diff --git a/src/abstract/RewardSplits.sol b/src/abstract/RewardSplits.sol
@@ -1,7 +1,7 @@
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.17;
 
-import { IProtocolRewards } from "../interfaces/IProtocolRewards.sol";
+import {IProtocolRewards} from "../interfaces/IProtocolRewards.sol";
 
 abstract contract RewardSplits {
     error CREATOR_FUNDS_RECIPIENT_NOT_SET();
@@ -38,47 +38,26 @@ abstract contract RewardSplits {
         return numTokens * TOTAL_REWARD_PER_MINT;
     }
 
-    function computeFreeMintRewards(uint256 numTokens)
-        public
-        pure
-        returns (
-            uint256 creatorReward,
-            uint256 mintReferralReward,
-            uint256 createReferralReward,
-            uint256 firstMinterReward,
-            uint256 zoraReward
-        )
-    {
+    function computeFreeMintRewards(
+        uint256 numTokens
+    ) public pure returns (uint256 creatorReward, uint256 mintReferralReward, uint256 createReferralReward, uint256 firstMinterReward, uint256 zoraReward) {
         creatorReward = numTokens * CREATOR_REWARD;
         mintReferralReward = numTokens * MINT_REFERRAL_FREE_MINT_REWARD;
         createReferralReward = numTokens * CREATE_REFERRAL_FREE_MINT_REWARD;
         firstMinterReward = numTokens * FIRST_MINTER_REWARD;
         zoraReward = numTokens * ZORA_FREE_MINT_REWARD;
     }
 
-    function computePaidMintRewards(uint256 numTokens)
-        public
-        pure
-        returns (
-            uint256 mintReferralReward,
-            uint256 createReferralReward,
-            uint256 firstMinterReward,
-            uint256 zoraReward
-        )
-    {
+    function computePaidMintRewards(
+        uint256 numTokens
+    ) public pure returns (uint256 mintReferralReward, uint256 createReferralReward, uint256 firstMinterReward, uint256 zoraReward) {
         mintReferralReward = numTokens * MINT_REFERRAL_PAID_MINT_REWARD;
         createReferralReward = numTokens * CREATE_REFERRAL_PAID_MINT_REWARD;
         firstMinterReward = numTokens * FIRST_MINTER_REWARD;
         zoraReward = numTokens * ZORA_PAID_MINT_REWARD;
     }
 
-    function _depositFreeMintRewards(
-        uint256 totalReward,
-        uint256 numTokens,
-        address creator,
-        address mintReferral,
-        address createReferral
-    ) internal {
+    function _depositFreeMintRewards(uint256 totalReward, uint256 numTokens, address creator, address mintReferral, address createReferral) internal {
         (
             uint256 creatorReward,
             uint256 mintReferralReward,
@@ -95,7 +74,7 @@ abstract contract RewardSplits {
             createReferral = zoraRewardRecipient;
         }
 
-        protocolRewards.depositRewards{ value: totalReward }(
+        protocolRewards.depositRewards{value: totalReward}(
             creator,
             creatorReward,
             mintReferral,
@@ -109,15 +88,8 @@ abstract contract RewardSplits {
         );
     }
 
-    function _depositPaidMintRewards(
-        uint256 totalReward,
-        uint256 numTokens,
-        address creator,
-        address mintReferral,
-        address createReferral
-    ) internal {
-        (uint256 mintReferralReward, uint256 createReferralReward, uint256 firstMinterReward, uint256 zoraReward) =
-            computePaidMintRewards(numTokens);
+    function _depositPaidMintRewards(uint256 totalReward, uint256 numTokens, address creator, address mintReferral, address createReferral) internal {
+        (uint256 mintReferralReward, uint256 createReferralReward, uint256 firstMinterReward, uint256 zoraReward) = computePaidMintRewards(numTokens);
 
         if (mintReferral == address(0)) {
             mintReferral = zoraRewardRecipient;
@@ -127,7 +99,7 @@ abstract contract RewardSplits {
             createReferral = zoraRewardRecipient;
         }
 
-        protocolRewards.depositRewards{ value: totalReward }(
+        protocolRewards.depositRewards{value: totalReward}(
             address(0),
             0,
             mintReferral,

diff --git a/src/interfaces/IProtocolRewards.sol b/src/interfaces/IProtocolRewards.sol
@@ -38,10 +38,12 @@ interface IProtocolRewards {
         address zora,
         uint256 zoraReward
     ) external payable;
+
     function deposit(address recipient, string calldata comment) external payable;
-    function depositBatch(address[] calldata recipients, uint256[] calldata amounts, string calldata comment)
-        external
-        payable;
+
+    function depositBatch(address[] calldata recipients, uint256[] calldata amounts, string calldata comment) external payable;
+
     function withdraw(uint256 amount) external;
+
     function withdrawWithSig(address owner, uint256 amount, uint256 deadline, uint8 v, bytes32 r, bytes32 s) external;
 }