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

name.reclaim

Resets the ENSv1 registry owner (manager) of an unwrapped .eth name, as its registrant. Options, result, errors and examples for name.reclaim.

Writestable
Since v1.0.0View source

Resets the ENSv1 registry owner (manager) of an unwrapped .eth name, as its registrant. Resolves once the transaction is submitted.

When to use

Use to take over the manager after receiving a .eth registrar token, or to repair a lost manager. Use reclaimSync to wait for the receipt.

Details

  • Only the registrar token holder (registrant) can reclaim.
  • owner defaults to the signing account.

Signature

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

Call it as ens.name.reclaim(options) on a client, or Actions.name.reclaim(client, options).

Parameters

OptionTypeDefaultDescription
name (required)stringENS name. Normalized automatically.
ownerstringthe signing accountNew registry owner.

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_RESERVED, NAME_NOT_REGISTEREDthe name is not registered.
NameStateErrorNAME_UNREACHABLEENSv2 resolution no longer reaches the name.
UnsupportedErrorUNSUPPORTED_PROTOCOLwrapped, ENSv2 and non-.eth names.
UnauthorizedErrorNOT_OWNERthe account is not the registrant.
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

Reclaiming a name
const { hash } = await ens.name.reclaim({ name: "alice.eth" })

Plan methods

Each method takes the same options as name.reclaim and sends nothing. See Preview before sending.

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

Wait for the receipt with reclaimSync

Resets the ENSv1 registry owner (manager) of an unwrapped .eth name, as its registrant. Resolves once the receipt is in.

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

name.reclaimSync takes the same options plus confirmations and timeout.

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

Reclaiming a name and waiting
const { receipt } = await ens.name.reclaimSync({ name: "alice.eth" })

See also

  • name.get to read the name's current state

Was this page helpful?