# role.revoke

> For the complete documentation index, see [llms.txt](https://ensforge.com/llms.txt).

Revokes ENSv2 roles from an account on a name, or at the root of a registry or resolver. Options, result, errors and examples for role.revoke.

Source: https://ensforge.com/docs/reference/sdk/role/revoke

<ApiMeta kind="Write" stability="stable" since="1.0.0" source="packages/sdk/src/actions/role/revoke/index.ts#L55" />

Revokes ENSv2 roles from an account on a name, or at the root of a registry or resolver. Resolves once the transaction is submitted.

## When to use [#when-to-use]

Use to take back powers granted with [`role.grant`](/docs/reference/sdk/role/grant). Use [`revokeSync`](/docs/reference/sdk/role/revoke#wait-for-the-receipt-with-revokesync) to wait for the receipt.

## Details [#details]

- Revoking needs the matching admin roles.
- Some roles regenerate the name's token ID; the plan carries a `TOKEN_ID_REGENERATED` warning.

## Signature [#signature]

```ts
function revoke(
  client: Like,
  options: revoke.Options & Write.Options,
): Promise<revoke.ReturnType>
```

Call it as `ens.role.revoke(options)` on a client, or `Actions.role.revoke(client, options)`.

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `holder` (required) | `string` |  | Account that loses the roles. |
| `roles` (required) | `readonly Role.Name[] \| bigint` |  | Roles by name, e.g. `["setResolver"]`, or as a bitmap. |
| `target` (required) | `"registry" \| "resolver"` |  | Registry or PermissionedResolver roles (resolvers: root only). |
| `name` | `string` |  | ENS name whose registry or resolver to use. Normalized automatically. |
| `contract` | `string` |  | Registry or resolver address, instead of the name's. |
| `root` | `boolean` |  | Root roles, applying to every name, instead of the name's. |

Also takes the [write options](/docs/reference/sdk/client#write-options).

## Returns [#returns]

Resolves to `Write.Result`. Submitted transaction hashes and the plan that produced them.

| Field | Type | Description |
| --- | --- | --- |
| `hash` | `Hex` | Hash of the last transaction. |
| `hashes` | `readonly Hex[]` | Every submitted transaction, in order. |
| `id` | `string` | EIP-5792 bundle id when the calls were sent as one batch. |
| `plan` | `Plan` | The plan the write executed: its steps, in order, as they were submitted. |

## Errors [#errors]

| Error | Codes | When |
| --- | --- | --- |
| [`InvalidInputError`](/docs/reference/errors/invalid-input-error) | [`INVALID_NAME`](/docs/reference/errors/INVALID_NAME), [`INVALID_ADDRESS`](/docs/reference/errors/INVALID_ADDRESS), [`INVALID_ROLES`](/docs/reference/errors/INVALID_ROLES), [`INVALID_RECORD_VALUE`](/docs/reference/errors/INVALID_RECORD_VALUE) | invalid input or targets. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`UNSUPPORTED_PROTOCOL`](/docs/reference/errors/UNSUPPORTED_PROTOCOL) | ENSv1 names. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`CANNOT_GRANT_ROLES`](/docs/reference/errors/CANNOT_GRANT_ROLES) | without the admin roles. |
| [`UserRejectedError`](/docs/reference/errors/user-rejected-error) | [`USER_REJECTED`](/docs/reference/errors/USER_REJECTED) | the user rejects the request. |
| [`WalletError`](/docs/reference/errors/wallet-error) | [`CHAIN_MISMATCH`](/docs/reference/errors/CHAIN_MISMATCH), [`ACCOUNT_NOT_FOUND`](/docs/reference/errors/ACCOUNT_NOT_FOUND) | the wallet is on another chain or has no account to sign with. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`WALLET_BATCH_UNSUPPORTED`](/docs/reference/errors/WALLET_BATCH_UNSUPPORTED) | with `mode: "batch"` or a paymaster when the wallet cannot send calls as one batch. |

It can also fail with the errors every write can (`Errors.WriteError`: the common errors plus `InsufficientFundsError`, `TransactionError`, `UnsupportedError`, `UserRejectedError`, `WalletError`).

See [How errors work](/docs/sdk/errors-explained).

## Examples [#examples]

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Revoking a role"
const { hash } = await ens.role.revoke({ name: "alice.eth", holder: "0xB0b0000000000000000000000000000000000000", roles: ["renew"], target: "registry" })
```
</Tab>

<Tab>
```ts title="Revoking a role with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.role.revoke(ens, { name: "alice.eth", holder: "0xB0b0000000000000000000000000000000000000", roles: ["renew"], target: "registry" })
```
</Tab>

<Tab>
```ts title="Revoking a role in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.role.revoke(ens, { name: "alice.eth", holder: "0xB0b0000000000000000000000000000000000000", roles: ["renew"], target: "registry" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

Each method takes the same options as `role.revoke` and sends nothing. See [Preview before sending](/docs/sdk/preview-before-sending).

| Method | Description |
| --- | --- |
| `role.revoke.prepare(options)` | Builds the plan without sending anything. |
| `role.revoke.simulate(options)` | Simulates the plan with `eth_call`, reporting each step. |
| `role.revoke.estimateGas(options)` | Estimates the gas and ETH the plan needs. |

## Wait for the receipt with `revokeSync` [#wait-for-the-receipt-with-revokesync]

Revokes ENSv2 roles from an account on a name, or at the root of a registry or resolver. Resolves once the receipt is in.

Use when the next step depends on the change being on-chain.

`role.revokeSync` takes the same options plus [`confirmations` and `timeout`](/docs/reference/sdk/client#sync-options).

Resolves to `Write.SyncResult`. Receipts plus the submitted hashes and plan.

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Revoking a role and waiting"
const { receipt } = await ens.role.revokeSync({ name: "alice.eth", holder: "0xB0b0000000000000000000000000000000000000", roles: ["renew"], target: "registry" })
```
</Tab>

<Tab>
```ts title="Waiting with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.role.revokeSync(ens, { name: "alice.eth", holder: "0xB0b0000000000000000000000000000000000000", roles: ["renew"], target: "registry" })
```
</Tab>

<Tab>
```ts title="Waiting in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.role.revokeSync(ens, { name: "alice.eth", holder: "0xB0b0000000000000000000000000000000000000", roles: ["renew"], target: "registry" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`role.get`](/docs/reference/sdk/role/get) to read roles