@zoralabs/coins 0.1.1 → 0.3.0

package/src/interfaces/ICoin.sol

@@ -1,7 +1,11 @@
 // SPDX-License-Identifier: MIT
 pragma solidity ^0.8.23;
 
-interface ICoin {
+import {IERC165} from "@openzeppelin/contracts/utils/introspection/IERC165.sol";
+import {IERC721Receiver} from "@openzeppelin/contracts/token/ERC721/IERC721Receiver.sol";
+import {IERC7572} from "./IERC7572.sol";
+
+interface ICoin is IERC165, IERC721Receiver, IERC7572 {
     /// @notice Thrown when an operation is attempted with a zero address
     error AddressZero();
 
@@ -66,13 +70,13 @@ interface ICoin {
     }
 
     /// @notice Emitted when market rewards are distributed
-    /// @param creatorPayoutAddress The address of the creator payout recipient
+    /// @param payoutRecipient The address of the creator rewards payout recipient
     /// @param platformReferrer The address of the platform referrer
     /// @param protocolRewardRecipient The address of the protocol reward recipient
     /// @param currency The address of the currency
     /// @param marketRewards The rewards accrued from the market's liquidity position
     event CoinMarketRewards(
-        address indexed creatorPayoutAddress,
+        address indexed payoutRecipient,
         address indexed platformReferrer,
         address protocolRewardRecipient,
         address currency,
@@ -94,8 +98,7 @@ interface ICoin {
         uint256 coinsPurchased,
         address currency,
         uint256 amountFee,
-        uint256 amountSold,
-        string comment // TODO remove after backend approval
+        uint256 amountSold
     );
 
     /// @notice Emitted when coins are sold
@@ -113,8 +116,7 @@ interface ICoin {
         uint256 coinsSold,
         address currency,
         uint256 amountFee,
-        uint256 amountPurchased,
-        string comment // TODO remove after backend approval
+        uint256 amountPurchased
     );
 
     /// @notice Emitted when a coin is transferred
@@ -126,7 +128,7 @@ interface ICoin {
     event CoinTransfer(address indexed sender, address indexed recipient, uint256 amount, uint256 senderBalance, uint256 recipientBalance);
 
     /// @notice Emitted when trade rewards are distributed
-    /// @param creatorPayoutRecipient The address of the creator payout recipient
+    /// @param payoutRecipient The address of the creator rewards payout recipient
     /// @param platformReferrer The address of the platform referrer
     /// @param tradeReferrer The address of the trade referrer
     /// @param protocolRewardRecipient The address of the protocol reward recipient
@@ -136,7 +138,7 @@ interface ICoin {
     /// @param protocolReward The reward for the protocol
     /// @param currency The address of the currency
     event CoinTradeRewards(
-        address indexed creatorPayoutRecipient,
+        address indexed payoutRecipient,
         address indexed platformReferrer,
         address indexed tradeReferrer,
         address protocolRewardRecipient,

package/src/interfaces/IZoraFactory.sol

@@ -3,27 +3,27 @@ pragma solidity ^0.8.23;
 
 interface IZoraFactory {
     /// @notice Emitted when a coin is created
-    /// @param deployer The msg.sender address of coin creation
-    /// @param creator The address of the creator of the coin
+    /// @param caller The msg.sender address
     /// @param payoutRecipient The address of the creator payout recipient
     /// @param platformReferrer The address of the platform referrer
     /// @param currency The address of the currency
-    /// @param tokenURI The URI of the coin
+    /// @param uri The URI of the coin
     /// @param name The name of the coin
     /// @param symbol The symbol of the coin
     /// @param coin The address of the coin
     /// @param pool The address of the pool
+    /// @param version The coin contract version
     event CoinCreated(
-        address indexed deployer,
-        address indexed creator, // TODO remove after backend approval
+        address indexed caller,
         address indexed payoutRecipient,
-        address platformReferrer,
+        address indexed platformReferrer,
         address currency,
-        string tokenURI,
+        string uri,
         string name,
         string symbol,
         address coin,
-        address pool
+        address pool,
+        string version
     );
 
     /// @notice Thrown when the amount of ERC20 tokens transferred does not match the expected amount

package/src/utils/CoinConstants.sol

@@ -60,7 +60,7 @@ abstract contract CoinConstants {
 
     /// @notice The LP's lower tick
     /// @dev This is only used if the currency is WETH
-    int24 internal constant LP_TICK_LOWER_WETH = -219200;
+    int24 internal constant LP_TICK_LOWER_WETH = -199200;
 
     /// @notice The LP's upper tick
     int24 internal constant LP_TICK_UPPER = 887200;

package/src/version/ContractVersionBase.sol

@@ -9,6 +9,6 @@ import {IVersionedContract} from "@zoralabs/shared-contracts/interfaces/IVersion
 contract ContractVersionBase is IVersionedContract {
     /// @notice The version of the contract
     function contractVersion() external pure override returns (string memory) {
-        return "0.1.1";
+        return "0.3.0";
     }
 }

package/test/Coin.t.sol

@@ -377,19 +377,22 @@ contract CoinTest is BaseTest {
         MarketRewards memory marketRewards = _calculateMarketRewards(expectedLpFee);
 
         assertEq(marketRewards.creator + marketRewards.platformReferrer + marketRewards.protocol, expectedLpFee, "Secondary rewards incorrect");
-        assertEq(
+        assertApproxEqAbs(
             protocolRewards.balanceOf(users.creator),
             initialTokenCreatorBalance + orderFees.creator + marketRewards.creator,
+            0.0000000000000001 ether,
             "Token creator rewards incorrect"
         );
-        assertEq(
+        assertApproxEqAbs(
             protocolRewards.balanceOf(users.platformReferrer),
             initialPlatformReferrerBalance + orderFees.platformReferrer + marketRewards.platformReferrer,
+            0.0000000000000001 ether,
             "Platform referrer rewards incorrect"
         );
-        assertEq(
+        assertApproxEqAbs(
             protocolRewards.balanceOf(users.feeRecipient),
             initialFeeRecipientBalance + orderFees.protocol + marketRewards.protocol,
+            0.0000000000000001 ether,
             "Protocol rewards incorrect"
         );
         assertEq(protocolRewards.balanceOf(users.tradeReferrer), initialOrderReferrerBalance + orderFees.tradeReferrer, "Order referrer rewards incorrect");
@@ -438,6 +441,6 @@ contract CoinTest is BaseTest {
     }
 
     function test_contract_version() public view {
-        assertEq(coin.contractVersion(), "0.1.1");
+        assertEq(coin.contractVersion(), "0.3.0");
     }
 }