-
Notifications
You must be signed in to change notification settings - Fork 80
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add missing protocol rewards readme (#265)
- Loading branch information
Showing
1 changed file
with
34 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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 | ||
``` |