# wrapper.wrap

> For the complete documentation index, see [llms.txt](https://ensforge.com/llms.txt).

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

Source: https://ensforge.com/docs/reference/sdk/wrapper/wrap

<ApiMeta kind="Write" stability="stable" since="1.0.0" source="packages/sdk/src/actions/wrapper/wrap/index.ts#L67" />

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

## When to use [#when-to-use]

Use to turn an ENSv1 name into an ERC-1155 token, or to burn fuses on a `.eth` name. Use [`wrapSync`](/docs/reference/sdk/wrapper/wrap#wait-for-the-receipt-with-wrapsync) to wait for the receipt.

## Details [#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.

<Callout type="warn" title="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`](/docs/reference/errors/NOT_APPROVED)).
</Callout>

## Signature [#signature]

```ts
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 [#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](/docs/reference/sdk/client#write-options).

## Returns [#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 [#errors]

| Error | Codes | When |
| --- | --- | --- |
| [`InvalidInputError`](/docs/reference/errors/invalid-input-error) | [`INVALID_NAME`](/docs/reference/errors/INVALID_NAME), [`INVALID_ADDRESS`](/docs/reference/errors/INVALID_ADDRESS), [`INVALID_RECORD_VALUE`](/docs/reference/errors/INVALID_RECORD_VALUE) | invalid input or fuses. |
| [`NameStateError`](/docs/reference/errors/name-state-error) | [`NAME_EXPIRED`](/docs/reference/errors/NAME_EXPIRED), [`NAME_NOT_REGISTERED`](/docs/reference/errors/NAME_NOT_REGISTERED), [`NAME_WRAPPED`](/docs/reference/errors/NAME_WRAPPED) | the name cannot be wrapped. |
| [`NameStateError`](/docs/reference/errors/name-state-error) | [`NAME_UNREACHABLE`](/docs/reference/errors/NAME_UNREACHABLE) | ENSv2 resolution no longer reaches the name. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`UNSUPPORTED_PROTOCOL`](/docs/reference/errors/UNSUPPORTED_PROTOCOL) | ENSv2 names; migrated names have no NameWrapper. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`NOT_OWNER`](/docs/reference/errors/NOT_OWNER), [`NOT_APPROVED`](/docs/reference/errors/NOT_APPROVED) | the account does not own the name, or the manager has not approved the NameWrapper. |
| [`UserRejectedError`](/docs/reference/errors/user-rejected-error) | [`USER_REJECTED`](/docs/reference/errors/USER_REJECTED) | the user rejects the request. |
| [`WalletError`](/docs/reference/errors/wallet-error) | [`CHAIN_MISMATCH`](/docs/reference/errors/CHAIN_MISMATCH), [`ACCOUNT_NOT_FOUND`](/docs/reference/errors/ACCOUNT_NOT_FOUND) | the wallet is on another chain or has no account to sign with. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`WALLET_BATCH_UNSUPPORTED`](/docs/reference/errors/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](/docs/sdk/errors-explained).

## Examples [#examples]

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Wrapping a name"
const { hash } = await ens.wrapper.wrap({ name: "alice.eth" })
```
</Tab>

<Tab>
```ts title="Wrapping a name with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.wrapper.wrap(ens, { name: "alice.eth" })
```
</Tab>

<Tab>
```ts title="Wrapping a name in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.wrapper.wrap(ens, { name: "alice.eth" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

Each method takes the same options as `wrapper.wrap` and sends nothing. See [Preview before sending](/docs/sdk/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` [#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`](/docs/reference/sdk/client#sync-options).

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

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Wrapping a name and waiting"
const { receipt } = await ens.wrapper.wrapSync({ name: "alice.eth" })
```
</Tab>

<Tab>
```ts title="Waiting with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.wrapper.wrapSync(ens, { name: "alice.eth" })
```
</Tab>

<Tab>
```ts title="Waiting in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.wrapper.wrapSync(ens, { name: "alice.eth" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`wrapper.unwrap`](/docs/reference/sdk/wrapper/unwrap) to unwrap it