Merge branch 'main' into deprecate_supply_royalty

ourzora · Oct 13, 2023 · a1716d2 · a1716d2
2 parents 24bea9e + 64f028a
commit a1716d2
Show file tree

Hide file tree

Showing 5 changed files with 43 additions and 8 deletions.
diff --git a/.changeset/odd-poems-lie.md b/.changeset/odd-poems-lie.md
diff --git a/packages/1155-contracts/CHANGELOG.md b/packages/1155-contracts/CHANGELOG.md
@@ -1,5 +1,11 @@
 # @zoralabs/zora-1155-contracts
 
+## 2.0.4
+
+### Patch Changes
+
+- 64da698: Exporting abi
+
 ## 2.0.3
 
 ### Patch Changes

diff --git a/packages/1155-contracts/package.json b/packages/1155-contracts/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@zoralabs/zora-1155-contracts",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "repository": "git@github.com:ourzora/zora-protocol.git",
   "author": "Iain <iain@zora.co>",
   "license": "MIT",

diff --git a/packages/1155-contracts/src/version/ContractVersionBase.sol b/packages/1155-contracts/src/version/ContractVersionBase.sol
@@ -1,5 +1,5 @@
 // This file is automatically generated by code; do not manually update
-// Last updated on 2023-10-05T22:37:20.442Z
+// Last updated on 2023-10-13T15:34:50.319Z
 // SPDX-License-Identifier: MIT
 pragma solidity 0.8.17;
 
@@ -10,6 +10,6 @@ import {IVersionedContract} from "../interfaces/IVersionedContract.sol";
 contract ContractVersionBase is IVersionedContract {
     /// @notice The version of the contract
     function contractVersion() external pure override returns (string memory) {
-        return "2.0.3";
+        return "2.0.4";
     }
 }
diff --git a/packages/protocol-rewards/README.md b/packages/protocol-rewards/README.md
@@ -0,0 +1,34 @@
+# Zora Protocol Rewards
+
+Zora is about bringing creativity onchain. Protocol Rewards is our latest offering for creators and developers to earn from their contributions to our growing ecosystem. 
+
+This repository features:
+- The `ERC721Rewards` and `ERC1155Rewards` abstract smart contracts which handle reward computation and routing for Zora [ERC-721](https://github.com/ourzora/zora-drops-contracts) and [ERC-1155](https://github.com/ourzora/zora-1155-contracts) NFT mints
+- The `ProtocolRewards` singleton smart contract used to deposit and withdraw rewards
+
+Documentation is available at [docs.zora.co](https://docs.zora.co).
+
+## Implementation Caveats
+
+The `ProtocolRewards` contract has a implementation caveat. If you send any value to a zero (`address(0)`) address in `depositRewards`, that value is implicitly burnt by being locked in the contract at the zero address. The function will not revert or redirect those funds as currently designed. We may re-visit this design in the future but for the release of  v1.1 this is the current and expected behavior.
+
+## Deployed Addresses
+
+`ProtocolRewards` v1.1 is deterministically deployed at 0x7777777F279eba3d3Ad8F4E708545291A6fDBA8B.
+
+Current Supported Chains:
+- Zora Mainnet
+- Zora Goerli
+- Ethereum Mainnet
+- Ethereum Goerli
+- OP Mainnet
+- OP Goerli
+- Base Mainnet
+- Base Goerli
+
+## Install
+
+To interact with the `ProtocolRewards` contract:
+```sh
+yarn add @zoralabs/protocol-rewards
+```