NEP: 24 Title: NFT Royalty Standard Author: Owen Zhang<zhangzhihong@ngd.neo.org>, Vincent Geneste<vincentgeneste@gmail.com> Type: Standard Status: Accepted Created: 2022-09-05
This NEP defines a global standard to get royalty payment information for Non-Fungible Tokens (NFTs) in order to enable support for royalty payments across all NFT marketplaces in the NEO Smart Economy. Reference: The NFT Standard [NEP-11](https://github.com/neo-project/proposals/blob/master/nep-11.mediawiki)
There is a need for supporting royalty information, which is useful not only for royalty payments across NFT marketplaces but also good to protect creative copyright. Currently, there is no standard for creators to declare royalty to all marketplaces in their NFTs. In this sense, they have to discuss the royalty with different marketplaces, otherwise these marketplaces, which haven't touched with the creators, can't get royalty details and define the royalty in their marketplace contract by themselves. This standard is compatible with [NEP-11](https://github.com/neo-project/proposals/blob/master/nep-11.mediawiki).
NEP-11 compliant contracts MAY implement this NEP for royalties to provide a standard method of specifying royalty payment information.
{
"name": "royaltyInfo",
"safe": true,
"parameters": [
{
"name": "tokenId",
"type": "ByteString"
},
{
"name": "royaltyToken",
"type": "Hash160"
},
{
"name": "salePrice",
"type": "Integer"
}
],
"returntype": "Array"
}
Returns a NeoVM Array stack item with single or multi array, each array still has two elements, for example:
Single royaltyRecipient
[
[
{
"name":"royaltyRecipient",
"type":"Hash160"
},
{
"name":"royaltyAmount",
"type":"Integer"
}
]
]
Multi royaltyRecipient
[
[
{
"name":"royaltyRecipient",
"type":"Hash160"
},
{
"name":"royaltyAmount",
"type":"Integer"
}
],
[
{
"name":"royaltyRecipient",
"type":"Hash160"
},
{
"name":"royaltyAmount",
"type":"Integer"
}
],
[
{
"name":"royaltyRecipient",
"type":"Hash160"
},
{
"name":"royaltyAmount",
"type":"Integer"
}
]
]
royaltyToken is the token hash for royalty payment.
salePrice MUST be amount without decimals.
royaltyRecipient is the address of who will be sent the royalty payment, MUST be a 20-byte address.
royaltyAmount MUST be the royalty amount without decimals rather than a percentage so there's no dispute between marketplaces about how much is the calculated result.
This function is not for initial sale or mint, it's only for secondary marketplaces.
Marketplaces that support this method MAY implement any method of calculating or transferring royalties to the royalty recipient.
Marketplaces MUST pay the royalty in the same unit of exchange as that of the salePrice passed to royaltyInfo(). For example, if the sale price is in NEO, then the royalty payment must also be paid in NEO, and if the sale price is in GAS, then the royalty payment must also be paid in GAS.
The royaltyInfo() function MUST NOT ignore the salePrice, royaltyAmount MAY be dynamic due to salePrice and time.
Marketplaces that support this standard MUST emit the event, RoyaltiesTransferred for each recipient, after sending a payment.
{
"name": "RoyaltiesTransferred",
"parameters": [
{
"name": "royaltyToken",
"type": "Hash160"
},
{
"name": "royaltyRecipient",
"type": "Hash160"
},
{
"name": "buyer",
"type": "Hash160"
},
{
"name": "tokenId",
"type": "ByteString"
},
{
"name": "amount",
"type": "Integer"
}
]
}
royaltyToken MUST be the same address as that in royaltyInfo method.
royaltyRecipient MUST be the same address as that in royaltyInfo method.
MUST trigger after marketplaces transferring royalties to the royalty recipient if royaltyInfo method is implemented.
Each royaltyRecipient has 1 event. That means if there are 5 royaltyRecipient in royaltyInfo method, 5 RoyaltiesTransferred events MUST be triggered.