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

Approves one address to transfer one ENSv1 name token, or clears the approval. Options, result, errors and examples for approval.setToken.

Writestable
Since v1.0.0View source

Approves one address to transfer one ENSv1 name token, or clears the approval. Resolves once the transaction is submitted.

When to use

Use to let a buyer or escrow take a single name. Use setTokenSync to wait for the receipt.

Details

  • Wrapped names approve on the NameWrapper (blocked by cannotApprove); unwrapped .eth names on the BaseRegistrar.
  • to: null clears it. ENSv2 names use operators instead.

Signature

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

Call it as ens.approval.setToken(options) on a client, or Actions.approval.setToken(client, options).

Parameters

OptionTypeDefaultDescription
name (required)stringENS name. Normalized automatically.
to (required)string | nullAddress to approve, or null to clear.

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.
NameStateErrorNAME_EXPIRED, NAME_NOT_REGISTEREDthe name is not registered.
NameStateErrorNAME_UNREACHABLEENSv2 resolution no longer reaches the name.
UnsupportedErrorUNSUPPORTED_PROTOCOLENSv2 names and unwrapped subnames.
UnauthorizedErrorNOT_OWNER, FUSE_BURNEDthe account may not approve it.
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 buyer
const { hash } = await ens.approval.setToken({ name: "alice.eth", to: "0xB0b0000000000000000000000000000000000000" })

Plan methods

Each method takes the same options as approval.setToken and sends nothing. See Preview before sending.

MethodDescription
approval.setToken.prepare(options)Builds the plan without sending anything.
approval.setToken.simulate(options)Simulates the plan with eth_call, reporting each step.
approval.setToken.estimateGas(options)Estimates the gas and ETH the plan needs.

Wait for the receipt with setTokenSync

Approves one address to transfer one ENSv1 name token, or clears the approval. Resolves once the receipt is in.

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

approval.setTokenSync takes the same options plus confirmations and timeout.

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

Approving a buyer and waiting
const { receipt } = await ens.approval.setTokenSync({ name: "alice.eth", to: "0xB0b0000000000000000000000000000000000000" })

See also

Was this page helpful?