Documentation for agents: an index at /llms.txt, every docs page in one file at /llms-full.txt, and Markdown for any docs page by adding .md to its URL.

Skip to Content
ensforgeSDK

registry.attach

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

Writestable
Since v1.0.0View source

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

  • 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

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

OptionTypeDefaultDescription
name (required)stringENSv2 name. Normalized automatically.
registry (required)string | nullRegistry to attach, or null to detach.
setParentbooleantrueAlso call setParent on the registry.

Also takes the write options.

Returns

Resolves to Write.Result. Submitted transaction hashes and the plan that produced them.

FieldTypeDescription
hashHexHash of the last transaction.
hashesreadonly Hex[]Every submitted transaction, in order.
idstringEIP-5792 bundle id when the calls were sent as one batch.
planPlanThe plan the write executed: its steps, in order, as they were submitted.

Errors

ErrorCodesWhen
InvalidInputErrorINVALID_NAME, INVALID_ADDRESSinvalid input.
NameStateErrorNAME_NOT_REGISTERED, NAME_EXPIREDthe name is not registered.
NameStateErrorNAME_UNREACHABLEENSv2 resolution no longer reaches the name.
UnsupportedErrorUNSUPPORTED_PROTOCOLENSv1 names.
UnauthorizedErrorMISSING_ROLESthe account may not change it.
UserRejectedErrorUSER_REJECTEDthe user rejects the request.
WalletErrorCHAIN_MISMATCH, ACCOUNT_NOT_FOUNDthe wallet is on another chain or has no account to sign with.
UnsupportedErrorWALLET_BATCH_UNSUPPORTEDwith 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

Attaching a registry
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.

MethodDescription
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.

Attaching a registry and waiting
const { receipt } = await ens.registry.attachSync({ name: "alice.eth", registry: "0x02cA46F62f6C9F655364bf9Fd4f11Fb8f01C5753" })

See also

Was this page helpful?