Skip to main content

useRevokeRole

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

Use this to revoke a WalletAddress a specific role on a

Example​

const Component = () => {
  const {
    mutate: revokeRole,
    isLoading,
    error,
  } = useRevokeRole(SmartContract);

  if (error) {
    console.error("failed to revoke role", error);
  }

  return (
    <button
      disabled={isLoading}
      onClick={() => revokeRole({  role: "admin", address: "0x123" })}
    >
      Revoke Role
    </button>
  );
};

Signature:

export declare function useRevokeRole<TContract extends ContractWithRoles>(contract: RequiredParam<TContract>): import("@tanstack/react-query").UseMutationResult<void, unknown, {
    role: RolesForContract<TContract>;
    address: WalletAddress;
}, unknown>;

Parameters​

ParameterTypeDescription
contractRequiredParam<TContract>an instance of a

Returns:

import("@tanstack/react-query").UseMutationResult<void, unknown, { role: RolesForContract<TContract>; address: WalletAddress; }, unknown>

a mutation object that can be used to revoke a role from a member on the contract