Royalty Client

RoyaltyClient

The RoyaltyClient is used to distribute and manage royalty payouts.

Methods

• mintRoyaltyToken

• claimRoyalty

• payRoyalty

• payLicenseRoyaltyFee

mintRoyaltyToken

Mint royalty token to recipient address.

Method	Type
mintRoyaltyToken	(request: mintRoyaltyTokenRequest) => Promise<mintRoyaltyTokenResponse>

• Parameters:

  • response.recipient - The recipient address.

  • response.amount - Amount of token to mint.

  • request.chainId: The identifier for the blockchain network in the request.

• Returns:

  • response.txHash - The transaction hash.

claimRoyalty

Royalty token holders can claim their royalties proportionate to their share of tokens held.

Method	Type
claimRoyalty	(request: claimRoyaltyRequest) => Promise<claimRoyaltyResponse>

• Parameters:

  • response.recipient - The recipient address.

  • request.chainId: The identifier for the blockchain network in the request.

• Returns:

  • response.txHash - The transaction hash.

payRoyalty

The payRoyalty function disburses royalties to token holders based on their ownership share.

Method	Type
payRoyalty	(request: payRoyaltyRequest) => Promise<payRoyaltyResponse>

• Parameters:

  • response.ipId - The Ip asset Id for which royalties are to be paid.

  • request.chainId: The identifier for the blockchain network in the request.

• Returns:

  • response.txHash - The transaction hash.

payLicenseRoyaltyFee

The payLicenseRoyaltyFee function is designed to mint a license token by paying the necessary license fee.

Method	Type
payLicenseRoyaltyFee	(request: payLicenseRoyaltyFeeRequest) => Promise<payLicenseRoyaltyFeeResponse>

• Parameters:

  • response.ipId - The Ip asset Id for which license fee to be paid.

  • response.licenseId - License Id.

  • response.amount - Amount to be paid.

  • request.chainId: The identifier for the blockchain network in the request.

• Returns:

  • response.txHash - The transaction hash.