Colle Marketplace
Colle.ioWebApp (Live)WebApp (Test)
  • Contracts Overview
  • Functional Requirements
  • Contract Descriptions
  • Technical Project & Audit Details
  • Test Coverage Report
  • Static Analysis
  • Royalty Pool Explained
  • Sale State Explained
  • Sales Tax Explained
  • marketplace
    • IMarketHub
    • IMarketHubRegistrar
    • MarketHub
    • MarketHubRegistrar
    • MarketHubRegistrarUpgradeable
    • collections
      • ColleCollection
      • ColleCollectionUpgradeable
      • CollectionRegistry
      • IColleCollection
      • IColleCollectionUpgradeable
      • ICollectionRegistry
    • currencies
      • BaseCurrency
      • CurrencyRegistry
      • ICurrency
      • ICurrencyRegistry
      • USDCCurrency
    • escrow
      • EscrowUpgradeable
      • IEscrow
      • IEscrowRegistry
    • kycs
      • Account
      • IKYCRegistry
      • KYCRegistry
    • markets
      • BaseMarketUpgradeable
      • IListingMarket
      • IMarket
      • IMarketRegistry
      • IOfferMarket
      • ListingMarketUpgradeable
      • MarketRegistry
      • OfferMarketUpgradeable
    • royalties
      • BaseRoyalty
      • BlackTierRoyalty
      • GoldTierRoyalty
      • GreenTierRoyalty
      • IRoyalty
      • IRoyaltyPool
      • IRoyaltyRegistry
      • PlatinumTierRoyalty
      • RoyaltyPool
      • RoyaltyRegistry
      • v1
        • BlackTierRoyaltyV1
        • GoldTierRoyaltyV1
        • GreenTierRoyaltyV1
        • PlatinumTierRoyaltyV1
    • taxes
      • ITaxPolicyRegistry
      • Tax
      • TaxPolicyRegistry
    • upgrade-gatekeeper
      • IUpgradeGatekeeper
      • UpgradeGatekeeper
    • vaults
      • IVault
      • IVaultRegistry
      • VaultUpgradeable
  • team-smart-wallet
    • ITeamSmartWallet
    • ITeamSmartWalletHelper
    • TeamSmartWallet
    • TeamSmartWalletFactory
    • TeamSmartWalletPermitHelper
  • utils
    • MarketAccess
    • MarketAccessUpgradeable
    • Signature
    • SignatureValidator
Powered by GitBook
On this page
  • RegisteredRoyalty
  • UnregisteredRoyalty
  • RegisteredRoyaltyPool
  • UpdatedColleComissions
  • registerRoyalty
  • Parameters
  • unregisterRoyalty
  • Parameters
  • registerRoyaltyPool
  • Parameters
  • registerColleCommissions
  • Parameters
  • getRoyalty
  • Parameters
  • Return Values
  • getRoyaltyPool
  • Return Values
  • getColleComissions
  • Return Values
  • isRoyaltyRegistered
  • Parameters
  • Return Values
  1. marketplace
  2. royalties

IRoyaltyRegistry

This interface describes the functions exposed by the royalty registry.

RegisteredRoyalty

event RegisteredRoyalty(address royalty, bytes32 accountTier)

Emitted when a royalty is registered.

UnregisteredRoyalty

event UnregisteredRoyalty(address royalty, bytes32 accountTier)

Emitted when a royalty is unregistered.

RegisteredRoyaltyPool

event RegisteredRoyaltyPool(address royaltyPool)

Emitted when a royalty pool is registered.

UpdatedColleComissions

event UpdatedColleComissions(address colleComission)

Emitted when the comission payout address has been updated.

registerRoyalty

function registerRoyalty(bytes32 _accountTier, address _royalty) external

Register a new royalty.

Parameters

Name
Type
Description

_accountTier

bytes32

The tier of the account for which to register the royalty.

_royalty

address

The address of the royalty contract.

unregisterRoyalty

function unregisterRoyalty(bytes32 _accountTier) external

Unregister an existing royalty.

Parameters

Name
Type
Description

_accountTier

bytes32

The tier of the account for which to unregister the royalty.

registerRoyaltyPool

function registerRoyaltyPool(address _royaltyPool) external

Register a new royalty pool.

Parameters

Name
Type
Description

_royaltyPool

address

The address of the royalty pool contract.

registerColleCommissions

function registerColleCommissions(address _colleCommissions) external

Register a new colleCommissions.

Parameters

Name
Type
Description

_colleCommissions

address

The address of the colleCommissions contract.

getRoyalty

function getRoyalty(bytes32 _accountTier) external view returns (contract BaseRoyalty)

Get the royalty of a specific account tier.

Parameters

Name
Type
Description

_accountTier

bytes32

The tier of the account for which to get the royalty.

Return Values

Name
Type
Description

[0]

contract BaseRoyalty

The royalty contract of the specified account tier.

getRoyaltyPool

function getRoyaltyPool() external view returns (contract IRoyaltyPool)

Get the royalty pool.

Return Values

Name
Type
Description

[0]

contract IRoyaltyPool

The royalty pool contract.

getColleComissions

function getColleComissions() external view returns (address)

Get the colleComissions.

Return Values

Name
Type
Description

[0]

address

The address of the colleComissions contract.

isRoyaltyRegistered

function isRoyaltyRegistered(bytes32 _accountTier) external view returns (bool)

Check if a royalty is registered for a specific account tier.

Parameters

Name
Type
Description

_accountTier

bytes32

The tier of the account for which to check the royalty.

Return Values

Name
Type
Description

[0]

bool

True if a royalty is registered for the specified account tier, false otherwise.

PreviousIRoyaltyPoolNextPlatinumTierRoyalty

Last updated 1 year ago