Configure Royalties

This guides explains how to configure royalties on your existing/new NFT smart contract using Royalty Registry.

๐Ÿšง

You can only override an NFT smart contract with a royalty configuration if you are the owner of the smart contract. This is required because the owner can call the admin rights functions on the contract.

Intro

When an NFT is sold in a marketplace, a portion of the sale goes to the original creator as royalties. But how does the marketplace know how much to give and where to send it? That's where on-chain royalties come in.

On-chain royalties are built-in royalty settings included in the original token contract. They allow marketplaces to easily determine the correct royalty amount and identify the royalty recipient for any token within that contract.

Royalty Registry

The Royalty Registry has two main goals:

  1. Simplify Royalty Payments for Marketplaces: It helps online marketplaces easily use the correct on-chain royalty configurations for each NFT sold under a contract.
  2. Add Royalty Support to Older Contracts: It allows older smart contracts that didn't originally have royalty features to include them.

Think of the Royalty Registry as a special online tool that stores and manages royalty settings. This tool ensures that artists and creators get paid their fair share when their NFTs are sold. Even if a contract didn't have a way to handle royalties before, the Royalty Registry can add this feature, making it easier for owners to get paid.

๐Ÿ‘

With Royalty Registry, you can deploy your own on-chain royalty configuration for your old token contracts (provided you are the owner of the smart contract).

Prerequisites

  1. You must be the owner of the smart contract. (you need admin rights)
  2. Your wallet address, which is the owner of the smart contract must be used via Metamask. (you can import your wallet to Metamask if needed)

How to configure ownership when creating an NFT contract?

When creating an NFT contract, supply the owner param in the request body with the value of your public wallet address that will manage the smart contract and receive royalties.

Request Endpoint: reference

 POST /api/v2/contracts/deployments

Request Body:

ParameterDescriptionTypeRequired
nameThe name of your NFT collection/contractStringโœ…
descriptionThe description of your NFT collection/contractStringโœ…
imageThe image URL for your NFT collection/contract that will be displayedStringโœ…
chainThis is the blockchain on which you want to create the contract onStringโœ…
externalUrlThis can be any link such as a link to your website, landing page, etc.Stringโœ…
ownerThe wallet address that will have admin access to the contract. The owner can call the admin rights functions on the contract.Stringโœ…
{
  "name": "Venly NFT Contract",
  "description": "Royalties will be configured on this NFT contract using Royalty Registry.",
  "image": "https://storage.venly.io/applications/5e0e7dc0-141c-4635-9e82-535ba458171e/VenlyLogoSquare.png",
  "chain": "MATIC",
  "externalUrl": "https://www.venly.io/",
  "owner": "0x91A0b0b6cE96583282bD3B8842BC09d790f8153c"
}

Configure royalties on your NFT smart contract

  1. Click here to go to the Royalty Registry Configuration page.
  2. Enter the token contract address to configure.
Enter the token address to override with royalties

Enter the token address to override with royalties

  1. Click on CREATE NEW OVERRIDE.
Create a new override on the smart contract

Create a new override on the smart contract

  1. Metamask will pop up asking you to confirm adding the override. Click on Confirm.
Confirm Override

Confirm Override

  1. Once you have deployed the override contract, the next step is configuring the new override. Click on CONFIGURE OVERRIDE to continue.
Deploying override contract

Deploying override contract

  1. Enter the recipient wallet address where you want the royalties to be transferred. You also need to specify the Royalty Basis Points which represents the percentage of royalties. In this example, we have defined the recipient wallet address with 2000 BPS (20% of each NFT sale under the contract will be royalties). Proceed by clicking on SAVE DEFAULT ROYALTY.

๐Ÿ“˜

Example

  • 1% = 100 BPS
  • 10% = 1000 BPS
  • 25% = 2500 BPS
  • Click here to read about Basis Points.
Configuring default royalty for a contract

Configuring default royalty for a contract

  1. Finally, the Metamask pop-up will appear again asking you to confirm the changes.

๐Ÿ‘

Once done, you'll have successfully overridden the smart contract and saved your royalty configurations.

Configure Royalties per Token

Optionally, you can also configure royalties per token based on the token ID. Enter the token ID, the recipient wallet address, and the royalty basis points. Click SAVE, and confirm on the Metamask pop-up to save changes.

Configuring royalties per token

Configuring royalties per token