Documentation for agents: an index at /llms.txt, every docs page in one file at /llms-full.txt, and Markdown for any docs page by adding .md to its URL.

Skip to Content
ensforgeSDK

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.

Writestable
Since v1.0.0View source

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

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

OptionTypeDefaultDescription
name (required)stringENS name. Normalized automatically.
delegate (required)stringAccount to approve or revoke.
approved (required)booleantrue 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.

FieldTypeDescription
hashHexHash of the last transaction.
hashesreadonly Hex[]Every submitted transaction, in order.
idstringEIP-5792 bundle id when the calls were sent as one batch.
planPlanThe plan the write executed: its steps, in order, as they were submitted.

Errors

ErrorCodesWhen
InvalidInputErrorINVALID_NAME, INVALID_ADDRESSinvalid input.
NotFoundErrorRESOLVER_NOT_FOUNDthe name has no resolver.
UnsupportedErrorRESOLVER_PROFILE_UNSUPPORTEDPermissionedResolvers.
UnauthorizedErrorNOT_OWNERthe signer does not own the name.
UserRejectedErrorUSER_REJECTEDthe user rejects the request.
WalletErrorCHAIN_MISMATCH, ACCOUNT_NOT_FOUNDthe wallet is on another chain or has no account to sign with.
UnsupportedErrorWALLET_BATCH_UNSUPPORTEDwith 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

Approving a delegate
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.

MethodDescription
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.

Approving a delegate and waiting
const { receipt } = await ens.approval.setDelegateSync({ name: "alice.eth", delegate: "0xB0b0000000000000000000000000000000000000", approved: true })

See also

Was this page helpful?