useIsAddressRole

Hook to check if an address is a member of a role on a smart contract.

Available to use on contracts that implement Permission Controls.

import { useIsAddressRole } from "@thirdweb-dev/react";

const isMember = useIsAddressRole(
  contract,
  "{{role_name}}",
  "{{wallet_address}}",
);

Usage

Provide the following arguments to the hook:

1. contract - The contract instance to check the role on.
2. roleName - The name of the role to check.
3. address - The wallet address to see if it is a member of the role.

import { useIsAddressRole, useContract } from "@thirdweb-dev/react";

// Your smart contract address (must implement permission controls)
const contractAddress = "{{contract_address}}";

// Address of the wallet to check
const walletAddress = "{{wallet_address}}";

// Name of the role to check
const roleName = "admin";

function App() {
  const { contract } = useContract(contractAddress);
  const isMember = useIsAddressRole(contract, roleName, walletAddress);
}

Configuration

roleName (required)

roleName (required)

The name of the role to check. Can be any custom role, or a built-in role, such as admin, transfer, minter, pauser, lister, asset, unwrap, or factory.

import { useIsAddressRole, useContract } from "@thirdweb-dev/react";

// Your smart contract address (must implement permission controls)
const contractAddress = "{{contract_address}}";

// Address of the wallet to check
const walletAddress = "{{wallet_address}}";

// Name of the role to check
const roleName = "admin";

function App() {
  const { contract } = useContract(contractAddress);
  // Address of the wallet to check
  const isMember = useIsAddressRole(
    contract,
    roleName,
    walletAddress,
  );
}

walletAddress (required)

walletAddress (required)

The wallet address to check if it is a member of the role.

Use the useAddress hook to get the current wallet address.

import { useIsAddressRole, useContract, useAddress } from "@thirdweb-dev/react";

// Your smart contract address (must implement permission controls)
const contractAddress = "{{contract_address}}";

// Name of the role to check
const roleName = "admin";

function App() {
  const { contract } = useContract(contractAddress);
  // Address of the wallet to check
  const address = useAddress();
  const isMember = useIsAddressRole(
    contract,
    roleName,
    address,
  );
}

Return Value

Return Value

The hook's returns a boolean, indicating if the given address is a member of the role. true if it is, and false if it isn't.

boolean;