Royalty
RoyaltyClient
Methods
- collectRoyaltyTokens
- claimableRevenue
- claimRevenue
- snapshot
- payRoyaltyOnBehalf
collectRoyaltyTokens
Allows ancestors to claim the royalty tokens and any accrued revenue tokens
| Method | Type |
|---|---|
collectRoyaltyTokens | (request: CollectRoyaltyTokensRequest) => Promise<CollectRoyaltyTokensResponse> |
Parameters:
request: The request object that contains all data needed to collect royalty tokens.request.parentIpId: The ip id of the ancestor to whom the royalty tokens belong to.request.royaltyVaultIpId: The id of the royalty vault.request.txOptions: [Optional] The transaction options.
claimableRevenue
Calculates the amount of revenue token claimable by a token holder at certain snapshot.
| Method | Type |
|---|---|
claimableRevenue | (request: ClaimableRevenueRequest) => Promise<ClaimableRevenueResponse> |
Parameters:
request: The request object that contains all data needed to claim Revenue.request.royaltyVaultIpId: The id of the royalty vault.request.account: The address of the token holder.request.snapshotId: The snapshot id.request.token: The revenue token to claim.request.txOptions: [Optional] The transaction options.
claimRevenue
Allows token holders to claim by a list of snapshot ids based on the token balance at certain snapshot.
| Method | Type |
|---|---|
claimRevenue | (request: ClaimRevenueRequest) => Promise<ClaimRevenueResponse> |
Parameters:
request: The request object that contains all data needed to claim revenue.request.snapshotIds: The list of snapshot ids.request.royaltyVaultIpId: The id of the royalty vault.request.token: The revenue token to claim.request.account: [Optional]The ipId of the IP Account you want to claim to instead of the wallet running the transaction.request.txOptions: [Optional] The transaction options.
snapshot
Snapshots the claimable revenue and royalty token amounts.
| Method | Type |
|---|---|
snapshot | (request: SnapshotRequest) => Promise<SnapshotResponse> |
Parameters:
request: The request object that contains all data needed to snapshot.request.royaltyVaultIpId: The id of the royalty vault.request.txOptions: [Optional] The transaction options.
payRoyaltyOnBehalf
Allows the function caller to pay royalties to the receiver IP asset on behalf of the payer IP asset.
| Method | Type |
|---|---|
payRoyaltyOnBehalf | (request: PayRoyaltyOnBehalfRequest) => Promise<PayRoyaltyOnBehalfResponse> |
Parameters:
request: The request object that contains all data needed to pay royalty on behalf.request.receiverIpId: The ipId that receives the royalties.request.payerIpId: The ID of the IP asset that pays the royalties.request.token: The token to use to pay the royalties.request.amount: The amount to pay.request.txOptions: [Optional] The transaction options.
Updated 2 months ago