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
  • getRoyaltyPoolBasisPoints
  • Parameters
  • Return Values
  • getCommissionBasisPoints
  • Parameters
  • Return Values
  • getRoyaltyBreakdown
  • Parameters
  • Return Values
  • supportsInterface
  • Parameters
  • Return Values
  1. marketplace
  2. royalties

BaseRoyalty

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

getRoyaltyPoolBasisPoints

function getRoyaltyPoolBasisPoints(address _erc20, uint256 _totalAmount) external view virtual 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 virtual 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) public 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

supportsInterface

function supportsInterface(bytes4 _interfaceId) public view virtual returns (bool)

Checks if the contract implements an interface.

Parameters

Name
Type
Description

_interfaceId

bytes4

The ID of the interface.

Return Values

Name
Type
Description

[0]

bool

True if the contract implements the interface, false otherwise.

PreviousroyaltiesNextBlackTierRoyalty

Last updated 2 years ago