# 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.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://techdocs.korprotocol.io/sdk-reference/client_methods/royalty_client.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.