\n \n | \n Ethereum | \n Polygon | \n
\n \n | Gnosis Safe | \n 0xA70e7Ef659C209D977f0f5Ab932F3f775a94502F | \n 0xdAC451C0b1c13d7aF7f38022e6A2A29211Cc80d5 | \n
\n \n | TimeLock Controller | \n 0x178AD648e66815E1B01791eBBdbF7b2D7C5B1626 | \n 0x87bCD4735CbCF9CE98ea2822fBf3F05F2ce10f96 | \n
\n \n | Proxy Admin | \n 0xc9198CbbB57708CF31e0caBCe963c98e60d333c3 | \n 0x40d603b2e9B3dE39ddc28Fb93a46BbB8E82b8a88 | \n
\n \n | Royalty Registry | \n 0xaD2184FB5DBcfC05d8f056542fB25b04fa32A95D | \n 0xe7c9Cb6D966f76f3B5142167088927Bf34966a1f | \n
\n \n | Royalty Engine | \n 0x0385603ab55642cb4Dd5De3aE9e306809991804f | \n 0x28EdFcF0Be7E86b07493466e7631a213bDe8eEF2 | \n
\n \n | Royalty Registry Impl | \n 0x64427932eFE137F80b012552B6772F7f58ddd9a6 | \n
\n \n | Royalty Engine Impl | \n 0x43A48AbF383D7508C03c20e1e46b58e0cd735669 | \n
\n \n | Royalty Override Factory | \n 0x734513F61a65B3745fC7BB574aDFe18379355a1C | \n
\n \n | Royalty Fallback Registry | \n 0xB78fC2052717C7AE061a14dB1fB2038d5AC34D29 | \n
\n
\n\n\n\n### Other EVM Chains\n\n\n \n | Gnosis Safe | \n 0x520f09e18895ACd6A9E75dE01355b5691Bf3D92B | \n
\n \n | TimeLock Controller | \n 0xe3A6CD067a1193b903143C36dA00557c9d95C41e | \n
\n \n | Proxy Admin | \n 0x0779702742c1397700e452A0976EfEF18D874764 | \n
\n \n | Royalty Registry | \n 0x3D1151dc590ebF5C04501a7d4E1f8921546774eA | \n
\n \n | Royalty Engine | \n 0xEF770dFb6D5620977213f55f99bfd781D04BBE15 | \n
\n \n | Royalty Registry Impl | \n 0x64427932eFE137F80b012552B6772F7f58ddd9a6 | \n
\n \n | Royalty Engine Impl | \n 0x43A48AbF383D7508C03c20e1e46b58e0cd735669 | \n
\n \n | Royalty Override Factory | \n 0x734513F61a65B3745fC7BB574aDFe18379355a1C | \n
\n \n | Royalty Fallback Registry | \n 0xB78fC2052717C7AE061a14dB1fB2038d5AC34D29 | \n
\n
\n\n## Overview\n\nThe royalty registry was designed with the following goals\n- support backwards/legacy compatibility (by allowing all token contracts that didn't implement royalties to add an override)\n - an override only needs to support any one of the royalty standards defined in the registry.\n- support a common interface for all prominent royalty standards (currently Rarible, Foundation, Manifold and EIP2981)\n\nThe Royalty Registry is comprised of two components.\n\n### 1. Royalty Registry\nThis is the central contract to be used for determining what address should be used for royalty lookup given a token address.\nThe reason that this registry is necessary is to provide backwards compatability with contracts created prior to any on-chain royalty specs.\nIt provides the ability for these contracts to set up an on-chain royalty override with support for:\n- @openzeppelin Ownable\n- @openzepplin AccessControl (DEFAULT_ADMIN_ROLE)\n- @manifoldxyz AdminControl https://github.com/manifoldxyz/libraries-solidity/tree/main/contracts/access\n\nOverride permissions can be expanded in the future by the community.\n\nOverrides are emitted as events so that any other systems that want to cache this data can do so.\n\n#### Methods\n\n---\n\n```\nfunction setRoyaltyLookupAddress(address tokenAddress, address royaltyLookupAddress) public\n```\nOverride where to get royalty information from for a given token contract. Only callable by the owner of the token contract (relies on @openzeppelin's Ownable implementation) or the owner of the Royalty Registry (i.e. DAO governance access control). This allows legacy contracts to set royalties.\n\n- Input parameter: *tokenAddress* - address of token contract\n- Input parameter: *royaltyAddress* - new contract location to lookup royalties\n\n---\n\n```\nfunction getRoyaltyLookupAddress(address tokenAddress) public view returns(address)\n```\nReturns the address that should be used to lookup royalties. Defaults to return the tokenAddress unless an override is set.\n\n---\n\n```\nfunction overrideAllowed(address tokenAddress) public view returns(bool)\n```\nReturns whether or not the address sender can override the royalty lookup address for the given token address.\nExample Use Case: A royalty lookup dApp can also show override functionality if it detects that they can override\n\n---\n\n### 2. Royalty Engine (v1)\n\nThe royalty engine provides a common interface to unify the lookup for various royalty specifications currently in existence.\n\nAs new standards are adopted, they can be added to the royalty engine. If new standards require a more complex output, the royalty engine can be upgraded.\n\nThe royalty engine also contains a spec cache to make lookups faster. The cache is filled only if getRoyaltyAndCacheSpec is called, which is only useable within another contract as it is a mutable function.\n\n#### Methods\n\n---\n\n```\nfunction getRoyalty(address tokenAddress, uint256 tokenId, uint256 value) public override returns(address payable[] memory recipients, uint256[] memory amounts)\n```\nGet the royalties for a given token and sale amount. Also cache the royalty spec for the given tokenAddress for more gas efficient future lookup.\nUse this within marketplace contracts.\n\n- Input parameter: *tokenAddress* - address of token\n- Input parameter: *tokenId* - id of token\n- Input parameter: *value* - sale value of token\n\nReturns two arrays, first is the list of royalty recipients, second is the amounts for each recipient.\n\n---\n\n```\nfunction getRoyaltyView(address tokenAddress, uint256 tokenId, uint256 value) public view override returns(address payable[] memory recipients, uint256[] memory amounts)\n```\nView only version of getRoyalty. Useful for dApps that want to provide lookup functionality.\n\n- Input parameter: *tokenAddress* - address of token\n- Input parameter: *tokenId* - id of token\n- Input parameter: *value* - sale value of token\n\nReturns two arrays, first is the list of royalty recipients, second is the amounts for each recipient.\n\n---\n\n## Usage\n\nAn upgradeable version of both the Royalty Registry and Royalty Engine (v1) has been deployed for public consumption. There should only be one instance of the Royalty Registry (in order to ensure that people who wish to override do not have to do so in multiple places), while many instances of the Royalty Engine can exist.\n\nMarketplaces may choose to directly inherit the Royalty Engine to save a bit of gas (from our testing, a possible savings of 6400 gas per lookup).\n\nTo find the location of the Royalty Registry and Royalty Engine, please visit https://royaltyregistry.xyz, or reference the mainnnet locations above.\n\n## Example Override Implementations\n\nSee ```contracts/overrides/RoyaltyOverride.sol``` for a reference override implementation.\n\nSee ```contracts/overrides/RoyaltyOverrideCore.sol``` if you would like to inherit EIP2981RoyaltyOverrideCore for your own smart contract.\n\nSee ```contracts/token/ERC721.sol``` and ```contracts/token/ERC1155.sol``` for reference ERC721 and ERC1155 reference implementations.\n\n## Contributions\n\nAll contributions should come with accompanying test coverage.\n\n### Installing Dependencies\n`npm install`\n\n### Running The Tests\n\nStart development network (in separate terminal):\n\n`npm run test:start-network`\n\nRun tests:\n\n`npm test`\n","readmeFilename":"README.md"}