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

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

Writestable
Since v1.0.0View source

Wraps an ENSv1 name in the NameWrapper. Resolves once the transaction is submitted.

When to use

Use to turn an ENSv1 name into an ERC-1155 token, or to burn fuses on a .eth name. Use wrapSync to wait for the receipt.

Details

  • .eth second-level names: one transaction from the registrant, which may burn owner fuses (cannotUnwrap first).
  • Other names: the registry owner approves the NameWrapper, if needed, then wraps.
  • The wrapped name stays with its current holder (registrant or manager) unless owner is given, also when an approved operator wraps it.
  • Keeps the current resolver unless resolver is given.

Gotchas

  • ENSv2 has no NameWrapper. Wrapped names migrate to ENSv2 like unwrapped ones.
  • An operator of a non-.eth name's manager cannot approve the NameWrapper for the manager: the manager approves it first (NOT_APPROVED).

Signature

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

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

Parameters

OptionTypeDefaultDescription
name (required)stringENSv1 name. Normalized automatically.
ownerstringOwner of the wrapped name. Defaults to its current holder, else the signer.
fusesreadonly Fuse.Name[]Fuses to burn while wrapping (.eth second-level names only).
resolverstringResolver to set. Defaults to the current one.

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_ADDRESS, INVALID_RECORD_VALUEinvalid input or fuses.
NameStateErrorNAME_EXPIRED, NAME_NOT_REGISTERED, NAME_WRAPPEDthe name cannot be wrapped.
NameStateErrorNAME_UNREACHABLEENSv2 resolution no longer reaches the name.
UnsupportedErrorUNSUPPORTED_PROTOCOLENSv2 names; migrated names have no NameWrapper.
UnauthorizedErrorNOT_OWNER, NOT_APPROVEDthe account does not own the name, or the manager has not approved the NameWrapper.
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

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

Plan methods

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

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

Wait for the receipt with wrapSync

Wraps an ENSv1 name in the NameWrapper. Resolves once the receipt is in.

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

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

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

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

See also

Was this page helpful?