registry.attach
Sets or removes the subregistry of an ENSv2 name. Parameters, return value, errors and examples for registry.attach in @ensforge/sdk.
Sets or removes the subregistry of an ENSv2 name. Resolves once the transaction is submitted.
When to use
Use to move a name's children to another registry, or to detach them. Use attachSync to wait for the receipt.
Details
setSubregistryon the registry holding the name, thensetParenton the new registry so its canonical name points back to the name (skip withsetParent: false).registry: nulldetaches the current subregistry.
Signature
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
| 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.
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 input. |
NameStateError | NAME_NOT_REGISTERED, NAME_EXPIRED | the name is not registered. |
NameStateError | NAME_UNREACHABLE | ENSv2 resolution no longer reaches the name. |
UnsupportedError | UNSUPPORTED_PROTOCOL | ENSv1 names. |
UnauthorizedError | MISSING_ROLES | the account may not change it. |
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.registry.attach({ name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })Plan methods
Each method takes the same options as registry.attach and sends nothing. See 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
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.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.registry.attachSync({ name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })See also
registry.getto inspect it
Was this page helpful?