new RightsBoundAccountClient()
new RightsBoundAccountClient(publicClient,walletClient,contractAddress):RightsBoundAccountClient
Parameters
publicClient
walletClient
contractAddress
`0x${string}`
Returns
RightsBoundAccountClient
Methods
claim()
claim(Claim rewards for a periodperiod):Promise<`0x${string}`>
Parameters
period
bigint
The period to claim rewards for
Returns
Promise<`0x${string}`>
Transaction hash
Remarks
Allows stakeholders to claim their share of royalties for a specific period.Example
setPaymentInfo()
setPaymentInfo(Set payment info for a periodinfo):Promise<`0x${string}`>
Parameters
info
Payment information including participants, amounts, and authorization signatureparticipants
readonly`0x${string}`[]
amounts
readonlybigint[]
totalAmount
bigint
signature
`0x${string}`
signer
`0x${string}`
Returns
Promise<`0x${string}`>
Transaction hash
Remarks
Important Notes:- Cannot override fixed distributions to:
- Attester module (for endorsers who helped achieve Verified Rights status)
- Cultura Treasury
- Used by protocols to define custom royalty distribution logic
- Must include parent digital asset owners if the digital asset is a derivative work
Example
getCurrentPeriod()
getCurrentPeriod():Get current periodPromise<bigint>
Returns
Promise<bigint>
The current period as a bigint
getPaymentAmount()
getPaymentAmount(Get payment amount for a beneficiary in a specific period This can be used to determine if a royalty has been claimedperiod,beneficiary):Promise<bigint>
Parameters
period
bigint
The payment period
beneficiary
`0x${string}`
The address of the beneficiary
Returns
Promise<bigint>
The payment amount for the beneficiary in the specified period
getVerifierModule()
getVerifierModule():Get verifier module addressPromise<`0x${string}`>
Returns
Promise<`0x${string}`>
The address of the verifier module contract
getCulturaTreasury()
getCulturaTreasury():Get Cultura treasury addressPromise<`0x${string}`>
Returns
Promise<`0x${string}`>
The address of the Cultura treasury
