IRoyalty

Interface for managing royalties. This interface provides the basis for creating custom royalties models by enabling the derivation of subclasses.

getRoyaltyPoolBasisPoints

function getRoyaltyPoolBasisPoints(address _erc20, uint256 _totalAmount) external view returns (uint256 royaltyPoolBasisPoints)

Calculates the basis points for the royalty pool

Parameters

Name	Type	Description
_erc20	address	The address of the ERC20 token
_totalAmount	uint256	The total amount of tokens

Return Values

Name	Type	Description
royaltyPoolBasisPoints	uint256	The calculated basis points for the royalty pool

getCommissionBasisPoints

function getCommissionBasisPoints(address _erc20, uint256 _totalAmount) external view returns (uint256 commissionBasisPoints)

Calculates the commission basis points

Parameters

Name	Type	Description
_erc20	address	The address of the ERC20 token
_totalAmount	uint256	The total amount of tokens

Return Values

Name	Type	Description
commissionBasisPoints	uint256	The calculated commission basis points

getRoyaltyBreakdown

function getRoyaltyBreakdown(address _erc20, uint256 _totalAmount) external view returns (uint256 _royaltyPoolAmount, uint256 _comissionAmount)

Calculates the royalty and commission amounts

Parameters

Name	Type	Description
_erc20	address	The address of the ERC20 token
_totalAmount	uint256	The total amount of tokens

Return Values

Name	Type	Description
_royaltyPoolAmount	uint256	The calculated amount for the royalty pool
_comissionAmount	uint256	The calculated commission amount

requiresManualAuthentication

function requiresManualAuthentication() external view returns (bool)

Determines whether a product sold through this royalty tier requires manual authentication or not

Return Values

Name	Type	Description
[0]	bool	True if the product requires manual authentication, false otherwise