approval.setOperator
Approves or revokes an operator for everything the signer holds on an ENS contract (setApprovalForAll). Options, errors and examples for approval.setOperator.
Approves or revokes an operator for everything the signer holds on an ENS contract (setApprovalForAll). Resolves once the transaction is submitted.
When to use
Use to let a marketplace or manager act on all your names in one contract. Use setOperatorSync to wait for the receipt.
Details
contract: the ENSv1"registry","registrar"or"wrapper", or any ENSv2 registry or resolver by address.- On ENSv2 registries an operator can transfer names; other changes need roles.
Signature
function setOperator(
client: Like,
options: setOperator.Options & Write.Options,
): Promise<setOperator.ReturnType>Call it as ens.approval.setOperator(options) on a client, or Actions.approval.setOperator(client, options).
Parameters
| Option | Type | Default | Description |
|---|---|---|---|
operator (required) | string | Account to approve or revoke. | |
approved (required) | boolean | true to approve the operator, false to revoke it. | |
contract (required) | ApprovalContract | "registry", "registrar", "wrapper", or a registry or resolver address. |
Also takes the write options.
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
| Error | Codes | When |
|---|---|---|
InvalidInputError | INVALID_ADDRESS | invalid addresses. |
UnsupportedError | UNSUPPORTED_ON_DEPLOYMENT | ENSv1 contracts without ENSv1. |
UserRejectedError | USER_REJECTED | the user rejects the request. |
WalletError | CHAIN_MISMATCH, ACCOUNT_NOT_FOUND | the wallet is on another chain or has no account to sign with. |
UnsupportedError | 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.
Examples
const { hash } = await ens.approval.setOperator({ operator: "0xB0b0000000000000000000000000000000000000", approved: true, contract: "wrapper" })Plan methods
Each method takes the same options as approval.setOperator and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
approval.setOperator.prepare(options) | Builds the plan without sending anything. |
approval.setOperator.simulate(options) | Simulates the plan with eth_call, reporting each step. |
approval.setOperator.estimateGas(options) | Estimates the gas and ETH the plan needs. |
Wait for the receipt with setOperatorSync
Approves or revokes an operator for everything the signer holds on an ENS contract (setApprovalForAll). Resolves once the receipt is in.
Use when the next step depends on the change being on-chain.
approval.setOperatorSync takes the same options plus confirmations and timeout.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.approval.setOperatorSync({ operator: "0xB0b0000000000000000000000000000000000000", approved: true, contract: "wrapper" })See also
approval.getOperatorto read it
Was this page helpful?