# registry.attach

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

Sets or removes the subregistry of an ENSv2 name. Parameters, return value, errors and examples for registry.attach in @ensforge/sdk.

Source: https://ensforge.com/docs/reference/sdk/registry/attach

<ApiMeta kind="Write" stability="stable" since="1.0.0" source="packages/sdk/src/actions/registry/attach/index.ts#L57" />

Sets or removes the subregistry of an ENSv2 name. Resolves once the transaction is submitted.

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

Use to move a name's children to another registry, or to detach them. Use [`attachSync`](/docs/reference/sdk/registry/attach#wait-for-the-receipt-with-attachsync) to wait for the receipt.

## Details [#details]

- `setSubregistry` on the registry holding the name, then `setParent` on the new registry so
  its canonical name points back to the name (skip with `setParent: false`).
- `registry: null` detaches the current subregistry.

## Signature [#signature]

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

Call it as `ens.registry.attach(options)` on a client, or `Actions.registry.attach(client, options)`.

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `name` (required) | `string` |  | ENSv2 name. Normalized automatically. |
| `registry` (required) | `string \| null` |  | Registry to attach, or `null` to detach. |
| `setParent` | `boolean` | `true` | Also call `setParent` on the registry. |

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 input. |
| [`NameStateError`](/docs/reference/errors/name-state-error) | [`NAME_NOT_REGISTERED`](/docs/reference/errors/NAME_NOT_REGISTERED), [`NAME_EXPIRED`](/docs/reference/errors/NAME_EXPIRED) | the name is not registered. |
| [`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) | ENSv1 names. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`MISSING_ROLES`](/docs/reference/errors/MISSING_ROLES) | the account may not change it. |
| [`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="Attaching a registry"
const { hash } = await ens.registry.attach({ name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })
```
</Tab>

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

await Actions.registry.attach(ens, { name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })
```
</Tab>

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

yield* Actions.registry.attach(ens, { name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

Each method takes the same options as `registry.attach` and sends nothing. See [Preview before sending](/docs/sdk/preview-before-sending).

| Method | Description |
| --- | --- |
| `registry.attach.prepare(options)` | Builds the plan without sending anything. |
| `registry.attach.simulate(options)` | Simulates the plan with `eth_call`, reporting each step. |
| `registry.attach.estimateGas(options)` | Estimates the gas and ETH the plan needs. |

## Wait for the receipt with `attachSync` [#wait-for-the-receipt-with-attachsync]

Sets or removes the subregistry of an ENSv2 name. Resolves once the receipt is in.

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

`registry.attachSync` 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="Attaching a registry and waiting"
const { receipt } = await ens.registry.attachSync({ name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })
```
</Tab>

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

await Actions.registry.attachSync(ens, { name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })
```
</Tab>

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

yield* Actions.registry.attachSync(ens, { name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`registry.get`](/docs/reference/sdk/registry/get) to inspect it