Skip to content

Commit b0e9841

Browse files
add notice for non ethereum chains, update chain list, add foundry section
1 parent 94a5576 commit b0e9841

File tree

1 file changed

+26
-2
lines changed

1 file changed

+26
-2
lines changed

README.md

Lines changed: 26 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Operator Filter Registry
22

3+
## **Note on Grace Period for Non-Ethereum Chains**
4+
5+
Currently, OpenSea only requires creator fee enforcement on Ethereum Mainnet and Goerli for collections to be eligible for creator fees. However, starting **January 2nd, 2023**, Opensea will begin validating creator fee enforcement on all supported EVM chains.
6+
37
## Introduction
48

59
This repository contains a number of tools to help token contracts manage the operators allowed to transfer tokens on behalf of users - including the smart contracts and delegates of marketplaces that do not respect creator fees.
@@ -99,7 +103,11 @@ Ethereum Mainnet
99103
<tr><td>Arbitrum Goerli</td></tr>
100104
<tr><td>Avalanche</td></tr>
101105
<tr><td>Avalanche Fuji</td></tr>
102-
<tr><td>Klaytn</td></tr><tr><td>Baobab</td></tr>
106+
<tr><td>Klaytn</td></tr>
107+
<tr><td>Baobab</td></tr>
108+
<tr><td>BSC</td></tr>
109+
<tr><td>BSC Testnet</td></tr>
110+
<tr><td>Gnosis</td></tr>
103111

104112
</table>
105113

@@ -109,6 +117,22 @@ Token contracts that wish to manage lists of filtered operators and restrict tra
109117

110118
See the [ExampleERC721](src/example/ExampleERC721.sol) and [ExampleERC1155](src/example/ExampleERC1155.sol) contracts for basic implementations that inherit the `DefaultOperatorFilterer`.
111119

120+
## Getting Started with Foundry
121+
122+
This package can be installed into a [Foundry](https://github.com/foundry-rs/foundry#installation) project with the following command
123+
124+
```bash
125+
foundry install ProjectOpenSea/operator-filter-registry
126+
```
127+
128+
With default remappings provided by `forge remappings`, the default operator filterer can be imported into your project with the following statement
129+
130+
```solidity
131+
import "operator-filter-registry/DefaultOperatorFilterer.sol";
132+
```
133+
134+
See NPM section below for further details.
135+
112136
## Getting started with NPM
113137

114138
This package can be found on NPM to integrate with tools like hardhat.
@@ -131,7 +155,7 @@ yarn add operator-filter-registry
131155

132156
Add to your smart contract in the import section:
133157

134-
```
158+
```solidity
135159
import "operator-filter-registry/src/DefaultOperatorFilterer.sol";
136160
```
137161

0 commit comments

Comments
 (0)