Documentation Index
Fetch the complete documentation index at: https://docs.cultura.xyz/llms.txt
Use this file to discover all available pages before exploring further.
Solidity API
Contract: IRoyaltyInfo
External Functions
getRoyaltyInfo
function getRoyaltyInfofunction getRoyaltyInfo(uint256 rightsId) external view returns (address[] parents, uint256[] percentages)
Parameters
| Name | Description |
|---|
rightsId | The rights token ID. |
Return Values
| Description |
|---|
| An array of beneficiary addresses. |
| An array of their corresponding split percentages (in basis points, e.g. 10000 = 100%). |
Contract: CulturaRightsBoundAccount
This contract is “bound” to a specific rights.
There are two main functions:
-
setPaymentInfo
- Intended to be called by a royalty module.
- Requires a valid EIP‑712 signature from the rights holder.
- Accepts payment data (beneficiaries and ERC20 token amounts) for a given payment period,
representing 75% of the total payment.
- Pulls ERC20 tokens from the rights holder into the contract.
- Then appends the mandatory splits (Cultura Treasury and Verifier Module) so that
the total payment is divided as:
• Provided splits: 75%
• Cultura Treasury: 5%
• Verifier Module: 20%
-
claim
- Each beneficiary can claim their individual share for a given period.
setPaymentInfo
function setPaymentInfofunction setPaymentInfo(struct ICulturaRightsBoundAccount.PaymentInput input) external
Parameters
| Name | Description |
|---|
input | PaymentInput containing participants, amounts, totalAmount, signature and signer. |
claim
function claimfunction claim(uint256 period) external
Parameters
| Name | Description |
|---|
period | The payment period identifier. |
claimForVerifierModule
function claimForVerifierModulefunction claimForVerifierModule(uint256 period) external
Parameters
| Name | Description |
|---|
period | The payment period identifier |
getPaymentAmount
function getPaymentAmountfunction getPaymentAmount(uint256 period, address beneficiary) external view returns (uint256 amount)
Parameters
| Name | Description |
|---|
period | The payment period |
beneficiary | The address of the beneficiary |
Return Values
| Description |
|---|
| The amount allocated to the beneficiary |
Public Functions
constructor
function constructorconstructor(address _rightsContract, uint256 _rightsId, address _tokenAddress, address _culturaTreasury, address _verifierModule) public
Parameters
| Name | Description |
|---|
_rightsContract | The address of the rights contract. |
_rightsId | The rights’s token ID. |
_tokenAddress | The ERC20 token address used for royalty payments. |
_culturaTreasury | The address that always receives 5% of the total. |
_verifierModule | The address that always receives 20% of the total. |
Events
PaymentInfoSet
event PaymentInfoSetevent PaymentInfoSet(uint256 period, address[] beneficiaries, uint256[] amounts, uint256 totalAmount)
Claimed
event Claimedevent Claimed(uint256 period, address beneficiary, uint256 amount)
Custom Errors
ZeroAddressNotAllowed
error ZeroAddressNotAllowederror ZeroAddressNotAllowed(string paramName)
InvalidSignature
error InvalidSignatureerror InvalidSignature(string reason)
ArrayLengthMismatch
error ArrayLengthMismatcherror ArrayLengthMismatch()
PaymentInfoAlreadySet
error PaymentInfoAlreadySeterror PaymentInfoAlreadySet()
InvalidProvidedAmount
error InvalidProvidedAmounterror InvalidProvidedAmount()
NoPaymentInfoForPeriod
error NoPaymentInfoForPerioderror NoPaymentInfoForPeriod()
NothingToClaim
error NothingToClaimerror NothingToClaim()
error VerifiersShouldClaimThroughModuleerror VerifiersShouldClaimThroughModule()
OnlyVerifierModuleCanCall
error OnlyVerifierModuleCanCallerror OnlyVerifierModuleCanCall()
VerifierModuleNotEnabled
error VerifierModuleNotEnablederror VerifierModuleNotEnabled()
