Skip to main content

useRoyaltySettings() function

This feature is currently in beta and may change based on feedback that we receive.

Use this to get the royalty settings of your

Example

const { data: settings, isLoading, error } = useRoyaltySettings(SmartContract);

Signature:

export declare function useRoyaltySettings(
contract: RequiredParam<ValidContractInstance>,
): import("@tanstack/react-query").UseQueryResult<
{
seller_fee_basis_points: number;
fee_recipient: string;
},
unknown
>;

Parameters

ParameterTypeDescription
contractRequiredParam<ValidContractInstance>an instance of a

Returns:

import("@tanstack/react-query").UseQueryResult<{ seller_fee_basis_points: number; fee_recipient: string; }, unknown>

an object containing recipient address and the royalty basis points