Quantum
  • Welcome to Quantum
  • Developer portal
    • Pricing
  • Self-Custody Infrastructure
    • Pincode Management
    • Private Key Management
  • Quickstart guide
  • Authentication
    • API Authentication
  • Faucets
  • Networks & URLs
  • Walletify Api
    • Overview
    • Getting started
    • User Management
    • Signing Methods
    • Testnet Assets
    • Basic Guides
      • Create a user
      • Retrieve a user
      • Update a user
      • Delete a user
      • Create a signing method
      • Update a signing method
      • Delete a signing method
      • Create a wallet
      • Retrieve wallet
      • Archive a wallet
      • Import a wallet
      • Export a wallet
      • Retrieve native balance
      • Retrieve ERC20 tokens
      • Retrieve NFTs
      • Transfer a native token
      • Transfer an ERC20 token
      • Transfer an NFT
      • Transfer a fungible token
      • Signatures
      • Read a contract
      • Execute a contract call
      • Get Transaction status
      • Resubmit a transaction
      • Get wallet events
      • Webhooks
    • Advanced Guides
      • Burn an NFT
      • Filter Spam NFTs
      • Filter NSFW NFTs
      • SWAP Token Pairs
      • Gasless/Meta Transactions
      • Sign RAW Transactions
      • Using Fiat Onramp with Walletify-API
      • Deploy an Ethereum contract
      • Integrate with WalletConnect
      • Set Up NFT Token Gating
      • Chain Specific Fields
      • Integrate with WalletConnect
      • Encrypted PIN Transfer
  • Nft Wizard Api
    • Overview
    • Getting started
    • Basic Guides
      • Get any NFT info
      • Get any NFT contract
      • Get NFTs by any wallet
      • Get wallets by any NFT
      • Create contract
      • Retrieve Contract
      • Delete Contract
      • Check Contract Status
      • Retrieve Contract Metadata
      • Update Contract Metadata
      • Create Token-type (NFT template)
      • Retrieve Token-type (NFT template)
      • Delete Token-type (NFT Template)
      • Check Token-type Status
      • Retrieve Token-type Metadata
      • Update Token-type Metadata
      • Mint an NFT
      • Batch Mint NFTs
      • Update NFT Metadata
      • Retrieve NFT Metadata
      • Add Audio to your NFTs
      • Add Video to your NFTs
      • Store NFT Media
      • Webhooks
    • Advanced Guides
      • Mass Minting
      • Speed Up Minting
      • Dynamic NFTs
      • Configure Royalties
      • Create Company Minter Wallet
      • Retrieve Company Minter Wallets
      • Store NFT Metadata on IPFS
      • View NFT on sandbox/testnet
    • NFT Configuration
      • Attributes
      • Animation & Media
      • Collection Info
      • Max Supply
      • Mint Number
      • Burnable
      • Metadata Storage
  • TMINTER API
    • Overview
    • Getting started
    • Basic Guide
      • Retrieve Any NFT Information
      • Retrieve NFT Contract Information
      • Retrieve NFTs by Wallet Address
      • Retrieve Wallets by NFT
      • Create a New NFT Contract
      • Retrieve a Contract
      • Delete a Contract
      • Check Contract Status
      • Retrieve Contract Metadata
      • Update Contract Metadata
      • Create Token-Type
      • Retrieve Token-Type
      • Delete Token-Type
      • Check Token-Type Status
      • Retrieve Token-Type Metadata
      • Update Token-Type Metadata
      • Mint a Single NFT
      • Batch Mint Multiple NFTs
      • Update NFT Metadata
      • Retrieve NFT Metadata
      • Add Audio to Your NFTs
      • Add Video to Your NFTs
      • Store NFT Media
      • Webhooks for NFT Events
    • Advance Guide
      • Dynamic NFT Creation
      • Token Economics and Supply Control
      • Advanced Minting: Royalty Distribution
      • Cross-Chain NFT Minting
      • NFT Sharding (Fractional Ownership)
      • Batch NFT Minting with Custom Metadata
      • Add Interactivity to NFTs
      • Advanced Media Integration: VR and AR
      • Webhook Triggers for Automated Processes
Powered by GitBook
On this page
  • Intro
  • Royalty Registry
  • Prerequisites
  • How to configure ownership when creating an NFT contract?
  • Configure royalties on your NFT smart contract
  • Configure Royalties per Token
  1. Nft Wizard Api
  2. Advanced Guides

Configure Royalties

PreviousDynamic NFTsNextCreate Company Minter Wallet

Last updated 10 months ago

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 . (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.

HTTP

 POST /api/v2/contracts/deployments

Request Body:

Parameter
Description
Type
Required

name

The name of your NFT collection/contract

String

✅

description

The description of your NFT collection/contract

String

✅

image

The image URL for your NFT collection/contract that will be displayed

String

✅

chain

This is the blockchain on which you want to create the contract on

String

✅

externalUrl

This can be any link such as a link to your website, landing page, etc.

String

✅

owner

The wallet address that will have admin access to the contract. The owner can call the admin rights functions on the contract.

String

✅

JSON

{
  "name": "Quantum NFT Contract",
  "description": "Royalties will be configured on this NFT contract using Royalty Registry.",
  "image": "https://storage.quantum.io/applications/5e0e7dc0-141c-4635-9e82-535ba458171e/QuantumLogoSquare.png",
  "chain": "MATIC",
  "externalUrl": "https://www.quantum.io/",
  "owner": "0x91A0b0b6cE96583282bD3B8842BC09d790f8153c"
}

Configure royalties on your NFT smart contract

  1. Enter the token contract address to configure.

  1. Click on CREATE NEW OVERRIDE.

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

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

  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

  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.

Request Endpoint:

Go to the website.

Enter the token address to override with royalties
Create a new override on the smart contract
Confirm Override
Deploying override contract

Read about .

Configuring default royalty for a contract
Configuring royalties per token
Metamask
reference
Royalty Registry Configuration
Basis Points
Enter the token address to override with royalties
Configuring royalties per token
Configuring default royalty for a contract
Create a new override on the smart contract
Confirm Override
Deploying override contract