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

wrapper.unwrap

Unwraps an ENSv1 name from the NameWrapper. Parameters, return value, errors and examples for wrapper.unwrap in @ensforge/sdk.

Writestable
Since v1.0.0View source

Unwraps an ENSv1 name from the NameWrapper. Resolves once the transaction is submitted.

When to use

Use to return a wrapped name to the ENSv1 registry (and the .eth registrar). Use unwrapSync to wait for the receipt.

Details

  • owner becomes the registry owner and, for .eth names, the registrant. Defaults to the signer.
  • Blocked once cannotUnwrap is burned.

Signature

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

Call it as ens.wrapper.unwrap(options) on a client, or Actions.wrapper.unwrap(client, options).

Parameters

OptionTypeDefaultDescription
name (required)stringENSv1 name. Normalized automatically.
ownerstringOwner after unwrapping. Defaults to the signer.

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_REGISTERED, NAME_NOT_WRAPPEDthe name is not wrapped.
NameStateErrorNAME_UNREACHABLEENSv2 resolution no longer reaches the name.
UnsupportedErrorUNSUPPORTED_PROTOCOLENSv2 names; migrated names have no NameWrapper.
UnauthorizedErrorNOT_OWNER, FUSE_BURNEDthe account may not unwrap 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

Unwrapping a name
const { hash } = await ens.wrapper.unwrap({ name: "alice.eth" })

Plan methods

Each method takes the same options as wrapper.unwrap and sends nothing. See Preview before sending.

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

Wait for the receipt with unwrapSync

Unwraps an ENSv1 name from the NameWrapper. Resolves once the receipt is in.

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

wrapper.unwrapSync takes the same options plus confirmations and timeout.

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

Unwrapping a name and waiting
const { receipt } = await ens.wrapper.unwrapSync({ name: "alice.eth" })

See also

Was this page helpful?