wrapper.wrap
Wraps an ENSv1 name in the NameWrapper. Parameters, return value, errors and examples for wrapper.wrap in @ensforge/sdk.
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
.ethsecond-level names: one transaction from the registrant, which may burn owner fuses (cannotUnwrapfirst).- Other names: the registry owner approves the NameWrapper, if needed, then wraps.
- The wrapped name stays with its current holder (registrant or manager) unless
owneris given, also when an approved operator wraps it. - Keeps the current resolver unless
resolveris given.
Gotchas
- ENSv2 has no NameWrapper. Wrapped names migrate to ENSv2 like unwrapped ones.
- An operator of a non-
.ethname'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
| Option | Type | Default | Description |
|---|---|---|---|
name (required) | string | ENSv1 name. Normalized automatically. | |
owner | string | Owner of the wrapped name. Defaults to its current holder, else the signer. | |
fuses | readonly Fuse.Name[] | Fuses to burn while wrapping (.eth second-level names only). | |
resolver | string | Resolver 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.
| 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_RECORD_VALUE | invalid input or fuses. |
NameStateError | NAME_EXPIRED, NAME_NOT_REGISTERED, NAME_WRAPPED | the name cannot be wrapped. |
NameStateError | NAME_UNREACHABLE | ENSv2 resolution no longer reaches the name. |
UnsupportedError | UNSUPPORTED_PROTOCOL | ENSv2 names; migrated names have no NameWrapper. |
UnauthorizedError | NOT_OWNER, NOT_APPROVED | the account does not own the name, or the manager has not approved the NameWrapper. |
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.wrapper.wrap({ name: "alice.eth" })Plan methods
Each method takes the same options as wrapper.wrap and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
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.
const { receipt } = await ens.wrapper.wrapSync({ name: "alice.eth" })See also
wrapper.unwrapto unwrap it
Was this page helpful?