ROJIVerseRoyaltiesFacet
ROJIVerseRoyaltiesFacet
royaltiesDetermineForTier
function royaltiesDetermineForTier(bytes32 tier) external view returns (address royaltyReceiver, uint16 bps)
Returns the royalty information for a given tier, or the default value if not active.
Parameters
tier
bytes32
The tier to retrieve the royalty information for. This is a keccak of the tier string.
setRoyaltiesForTier
function setRoyaltiesForTier(bytes32 tier, bool isActive, uint16 bps) external
Sets the royalty information for a given tier.
Parameters
tier
bytes32
The tier to set the royalty information for.
isActive
bool
Boolean that indicates the tier is active. If set to false then the default bps (royaltyBPS
) will be returned.
bps
uint16
Tbe basis points for the royalty. Allowed range is 0 to 10000, with an upper limit of 1000 recommended.
setRoyaltiesReceiver
function setRoyaltiesReceiver(address royaltyReceiver) external
set the default royalities receiver.
Parameters
royaltyReceiver
address
A valid address that will receive the royalties. Must not be address(0)
setRoyaltiesBPS
function setRoyaltiesBPS(uint16 royaltyBPS) external
set the default royalities BPS. This is the fallback value if the tier is not found or is inactive.
Parameters
royaltyBPS
uint16
Tbe basis points for the royalty. Allowed range is 0 to 10000, with an upper limit of 1000 recommended.
royaltiesForTier
function royaltiesForTier(bytes32 tier) external view returns (bool isActive, uint16 bps)
Returns the royalty information for a given tier, or the default value if not active.
Parameters
tier
bytes32
The tier to retrieve the royalty information for. This is a keccak of the tier string.
royaltiesReceiver
function royaltiesReceiver() external view returns (address royaltyReceiver)
Returns the receiver for the royalties. This is guaranteed to be a valid address and not address(0)
.
Return Values
royaltyReceiver
address
The address of the royalties receiver.
royaltiesBPS
function royaltiesBPS() external view returns (uint16 royaltyBPS)
Returns the default BPS for the royalties.
Return Values
royaltyBPS
uint16
The default BPS for the royalties. Always between 0 and 10,000. 1% equals 100 bps.
Was this helpful?