# resolver.link

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

Links an ENS name to the records of another name on the same PermissionedResolver. Options, result, errors and examples for resolver.link.

Source: https://ensforge.com/docs/reference/sdk/resolver/link

<ApiMeta kind="Write" stability="stable" since="1.0.0" source="packages/sdk/src/actions/resolver/link/index.ts#L59" />

Links an ENS name to the records of another name on the same PermissionedResolver. Resolves once the transaction is submitted.

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

Use to make several names share one set of records, such as aliases of a main name. Use [`linkSync`](/docs/reference/sdk/resolver/link#wait-for-the-receipt-with-linksync) to wait for the receipt.

## Details [#details]

- `to` is a name whose records the name will read and write, or a record ID from
  [`resolver.getLink`](/docs/reference/sdk/resolver/get-link).
- Both names must use the same PermissionedResolver, and the target must already have records.
- Needs the `link` role on the resolver.

## Signature [#signature]

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

Call it as `ens.resolver.link(options)` on a client, or `Actions.resolver.link(client, options)`.

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `name` (required) | `string` |  | ENS name. Normalized automatically. |
| `to` (required) | `string \| { recordId: bigint }` |  | Name or record ID to link to. |

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_RECORD_VALUE`](/docs/reference/errors/INVALID_RECORD_VALUE) | invalid input or a target without records. |
| [`NameStateError`](/docs/reference/errors/name-state-error) | [`NAME_EXPIRED`](/docs/reference/errors/NAME_EXPIRED), [`NAME_RESERVED`](/docs/reference/errors/NAME_RESERVED), [`NAME_NOT_REGISTERED`](/docs/reference/errors/NAME_NOT_REGISTERED) | 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. |
| [`NotFoundError`](/docs/reference/errors/not-found-error) | [`RESOLVER_NOT_FOUND`](/docs/reference/errors/RESOLVER_NOT_FOUND) | the name has no resolver of its own. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`RESOLVER_PROFILE_UNSUPPORTED`](/docs/reference/errors/RESOLVER_PROFILE_UNSUPPORTED) | the resolver is not a PermissionedResolver. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`MISSING_ROLES`](/docs/reference/errors/MISSING_ROLES) | without the `link` role. |
| [`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="Sharing records with another name"
const { hash } = await ens.resolver.link({ name: "alice.eth", to: "alice-main.eth" })
```
</Tab>

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

await Actions.resolver.link(ens, { name: "alice.eth", to: "alice-main.eth" })
```
</Tab>

<Tab>
```ts title="Sharing records with another name in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.resolver.link(ens, { name: "alice.eth", to: "alice-main.eth" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

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

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

## Wait for the receipt with `linkSync` [#wait-for-the-receipt-with-linksync]

Links an ENS name to the records of another name on the same PermissionedResolver. Resolves once the receipt is in.

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

`resolver.linkSync` 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="Sharing records with another name and waiting"
const { receipt } = await ens.resolver.linkSync({ name: "alice.eth", to: "alice-main.eth" })
```
</Tab>

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

await Actions.resolver.linkSync(ens, { name: "alice.eth", to: "alice-main.eth" })
```
</Tab>

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

yield* Actions.resolver.linkSync(ens, { name: "alice.eth", to: "alice-main.eth" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`resolver.getLink`](/docs/reference/sdk/resolver/get-link) to read a name's record ID