approval.setDelegate
Approves or revokes a delegate who may edit a name's records on its public resolver. Options, result, errors and examples for approval.setDelegate.
Approves or revokes a delegate who may edit a name's records on its public resolver. Resolves once the transaction is submitted.
When to use
Use to let another account manage a profile on a PublicResolver. Use setDelegateSync to wait for the receipt.
Details
- A delegate can edit every record of the name; for per-record access on a
PermissionedResolver use
permission.setRecordAccess.
Signature
function setDelegate(
client: Like,
options: setDelegate.Options & Write.Options,
): Promise<setDelegate.ReturnType>Call it as ens.approval.setDelegate(options) on a client, or Actions.approval.setDelegate(client, options).
Parameters
| Option | Type | Default | Description |
|---|---|---|---|
name (required) | string | ENS name. Normalized automatically. | |
delegate (required) | string | Account to approve or revoke. | |
approved (required) | boolean | true to approve the delegate, false to revoke it. |
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_NAME, INVALID_ADDRESS | invalid input. |
NotFoundError | RESOLVER_NOT_FOUND | the name has no resolver. |
UnsupportedError | RESOLVER_PROFILE_UNSUPPORTED | PermissionedResolvers. |
UnauthorizedError | NOT_OWNER | the signer does not own the name. |
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.setDelegate({ name: "alice.eth", delegate: "0xB0b0000000000000000000000000000000000000", approved: true })Plan methods
Each method takes the same options as approval.setDelegate and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
approval.setDelegate.prepare(options) | Builds the plan without sending anything. |
approval.setDelegate.simulate(options) | Simulates the plan with eth_call, reporting each step. |
approval.setDelegate.estimateGas(options) | Estimates the gas and ETH the plan needs. |
Wait for the receipt with setDelegateSync
Approves or revokes a delegate who may edit a name's records on its public resolver. Resolves once the receipt is in.
Use when the next step depends on the change being on-chain.
approval.setDelegateSync takes the same options plus confirmations and timeout.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.approval.setDelegateSync({ name: "alice.eth", delegate: "0xB0b0000000000000000000000000000000000000", approved: true })See also
approval.getDelegateto read it
Was this page helpful?