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: VerifierModule
registerVerifierBond
function registerVerifierBondfunction registerVerifierBond(address digitalAssetAddress, uint256 digitalAssetId, address verifier, uint256 bondedAmount) external
Parameters
| Name | Description |
|---|
digitalAssetAddress | The address of the digital asset contract |
digitalAssetId | The token ID of the digital asset |
verifier | The address of the verifier |
bondedAmount | The amount of tokens bonded by the verifier |
receiveFees
function receiveFeesfunction receiveFees(address digitalAssetAddress, uint256 digitalAssetId, uint256 amount, address sender) external
Parameters
| Name | Description |
|---|
digitalAssetAddress | The address of the DigitalAsset contract |
digitalAssetId | The token ID of the DigitalAsset |
amount | The amount of tokens that should have been sent to this contract |
sender | The address that sent the tokens |
claimRewards
function claimRewardsfunction claimRewards(address digitalAssetAddress, uint256 digitalAssetId) external
Parameters
| Name | Description |
|---|
digitalAssetAddress | The address of the DigitalAsset contract |
digitalAssetId | The token ID of the DigitalAsset |
distributeRewards
function distributeRewardsfunction distributeRewards(address digitalAssetAddress, uint256 digitalAssetId, address boundAccount, uint256 period) external
Parameters
| Name | Description |
|---|
digitalAssetAddress | The address of the DigitalAsset contract |
digitalAssetId | The token ID of the DigitalAsset |
boundAccount | The address of the CulturaRightsBoundAccount |
period | The payment period to claim from |
getVerifierBond
function getVerifierBondfunction getVerifierBond(address digitalAssetAddress, uint256 digitalAssetId, address verifier) external view returns (uint256)
Parameters
| Name | Description |
|---|
digitalAssetAddress | The address of the DigitalAsset contract |
digitalAssetId | The token ID of the DigitalAsset |
verifier | The address of the verifier |
Return Values
| Description |
|---|
| The amount of tokens bonded by the verifier |
getTotalBondedAmount
function getTotalBondedAmountfunction getTotalBondedAmount(address digitalAssetAddress, uint256 digitalAssetId) external view returns (uint256)
Parameters
| Name | Description |
|---|
digitalAssetAddress | The address of the DigitalAsset contract |
digitalAssetId | The token ID of the DigitalAsset |
Return Values
| Description |
|---|
| The total amount of tokens bonded for the VR |
Public Functions
constructor
function constructorconstructor(address _paymentToken, address _casAddress) public
Parameters
| Name | Description |
|---|
_paymentToken | The address of the ERC20 token used for payments |
_casAddress | The address of the Cultura Attestation Service |
calculateClaimableRewards
function calculateClaimableRewardsfunction calculateClaimableRewards(address digitalAssetAddress, uint256 digitalAssetId, address verifier) public view returns (uint256 claimableAmount)
Parameters
| Name | Description |
|---|
digitalAssetAddress | The address of the DigitalAsset contract |
digitalAssetId | The token ID of the DigitalAsset |
verifier | The address of the verifier |
Return Values
| Description |
|---|
| The amount of tokens the verifier can claim |
Events
VerifierRegistered
event VerifierRegisteredevent VerifierRegistered(bytes32 vrId, address verifier, uint256 bondedAmount)
RewardsReceived
event RewardsReceivedevent RewardsReceived(bytes32 vrId, uint256 amount)
RewardsClaimed
event RewardsClaimedevent RewardsClaimed(bytes32 vrId, address verifier, uint256 amount)
RewardsDistributed
event RewardsDistributedevent RewardsDistributed(bytes32 vrId, address boundAccount, uint256 period, uint256 amount)
Custom Errors
ZeroAddress
error ZeroAddresserror ZeroAddress(string paramName)
OnlyCASCanRegisterVerifiers
error OnlyCASCanRegisterVerifierserror OnlyCASCanRegisterVerifiers()
NoVerifiersRegisteredForVR
error NoVerifiersRegisteredForVRerror NoVerifiersRegisteredForVR()
TokenTransferFailed
error TokenTransferFailederror TokenTransferFailed()
NoRewardsToClaim
error NoRewardsToClaimerror NoRewardsToClaim()
NotAnVerifierForVR
error NotAnVerifierForVRerror NotAnVerifierForVR()
NoRewardsToDistribute
error NoRewardsToDistributeerror NoRewardsToDistribute()
