resolver.link
Links an ENS name to the records of another name on the same PermissionedResolver. Options, result, errors and examples for resolver.link.
Links an ENS name to the records of another name on the same PermissionedResolver. Resolves once the transaction is submitted.
When to use
Use to make several names share one set of records, such as aliases of a main name. Use linkSync to wait for the receipt.
Details
tois a name whose records the name will read and write, or a record ID fromresolver.getLink.- Both names must use the same PermissionedResolver, and the target must already have records.
- Needs the
linkrole on the resolver.
Signature
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
| 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.
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_RECORD_VALUE | invalid input or a target without records. |
NameStateError | NAME_EXPIRED, NAME_RESERVED, NAME_NOT_REGISTERED | the name is not registered. |
NameStateError | NAME_UNREACHABLE | ENSv2 resolution no longer reaches the name. |
NotFoundError | RESOLVER_NOT_FOUND | the name has no resolver of its own. |
UnsupportedError | RESOLVER_PROFILE_UNSUPPORTED | the resolver is not a PermissionedResolver. |
UnauthorizedError | MISSING_ROLES | without the link role. |
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.resolver.link({ name: "alice.eth", to: "alice-main.eth" })Plan methods
Each method takes the same options as resolver.link and sends nothing. See 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
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.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.resolver.linkSync({ name: "alice.eth", to: "alice-main.eth" })See also
resolver.getLinkto read a name's record ID
Was this page helpful?