name.reclaim
Resets the ENSv1 registry owner (manager) of an unwrapped .eth name, as its registrant. Options, result, errors and examples for name.reclaim.
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.
ownerdefaults 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
| Option | Type | Default | Description |
|---|---|---|---|
name (required) | string | ENS name. Normalized automatically. | |
owner | string | the signing account | New registry owner. |
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. |
NameStateError | NAME_EXPIRED, NAME_RESERVED, NAME_NOT_REGISTERED | the name is not registered. |
NameStateError | NAME_UNREACHABLE | ENSv2 resolution no longer reaches the name. |
UnsupportedError | UNSUPPORTED_PROTOCOL | wrapped, ENSv2 and non-.eth names. |
UnauthorizedError | NOT_OWNER | the account is not the registrant. |
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.name.reclaim({ name: "alice.eth" })Plan methods
Each method takes the same options as name.reclaim and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
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.
const { receipt } = await ens.name.reclaimSync({ name: "alice.eth" })See also
name.getto read the name's current state
Was this page helpful?