# PBAB Royalty Registry Setup

# Royalty Registry

The Royalty Registry is an on-chain tool used by many marketplaces (OpenSea, Coinbase NFT, etc.) to query royalty payment addresses and percentages when a token is sold. The Royalty Registry lives on the Ethereum blockchain and is decentralized.

# Royalties Overview

For PBAB contracts, the following addresses may receive royalties:

Party Address defined: Royalty Percentage
Platform (PBAB Partner) defined and configured on Royalty Registry override contract default 2.5%, configurable on override contract
Render Provider (Art Blocks) defined on PBAB core contract default 2.5%, configurable on override contract
Artist defined on PBAB core contract defined on PBAB contract, typically 5%
Additional Payee defined on PBAB core contract defined on PBAB contract

# Required Setup

Two setup steps are required before Art Blocks PBAB contracts will integrate properly with the Royalty Registry:

  1. Create a new override on the Royalty Registry for your PBAB core contract
  2. Set your Platform royalty payment address
    • Connect your PBAB admin wallet to the Art Blocks PBAB royalty override contract, 0x31E1cC72E6f9E27C2ECbB500d978de1691173F5f, on etherscan
    • Call the updatePlatformRoyaltyAddressForContract function with your PBAB token contract address as _tokenContract, and your desired platform royalty payment address as _platformRoyaltyAddress

Now you will automatically be receiving royalties from sales on secondary markets that support use of the Royalty Registry!

# Optional Configuring

Royalty percentages of 2.5% are used by default by the Art Blocks PBAB royalty override contract. The admin of any given PBAB core contract can override these percentages by calling updatePlatformBpsForContract or updateRenderProviderBpsForContract on the Art Blocks PBAB royalty override contract, 0x31E1cC72E6f9E27C2ECbB500d978de1691173F5f, on etherscan

Note that royalty proportions are defined in terms of Basis points. For example, 250 BPS = 2.5% royalty. See this article for more information.

After initial setup, the Platform (PBAB partner) royalty payment address may be updated at any time by the admin of a given PBAB core contract by calling the updatePlatformRoyaltyAddressForContract function on the Art Blocks PBAB royalty override contract, 0x31E1cC72E6f9E27C2ECbB500d978de1691173F5f, on etherscan