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

name.setManager

Sets the ENSv1 manager (registry owner) of a name. Parameters, return value, errors and examples for name.setManager in @ensforge/sdk.

Writestable
Since v1.0.0View source

Sets the ENSv1 manager (registry owner) of a name. Resolves once the transaction is submitted.

When to use

Use to let another account edit records and subnames while keeping ownership. Use setManagerSync to wait for the receipt.

Details

  • Unwrapped .eth names: the registrant reclaims to the new manager; a manager who is not the registrant changes the registry owner directly.
  • Other unwrapped ENSv1 names change their registry owner.
  • Wrapped and ENSv2 names have no manager; ENSv2 uses roles instead.

Signature

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

Call it as ens.name.setManager(options) on a client, or Actions.name.setManager(client, options).

Parameters

OptionTypeDefaultDescription
name (required)stringENS name. Normalized automatically.
manager (required)stringNew manager address.

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_EXPIRED, NAME_RESERVED, NAME_NOT_REGISTEREDthe name is not registered.
NameStateErrorNAME_UNREACHABLEENSv2 resolution no longer reaches the name.
UnsupportedErrorUNSUPPORTED_PROTOCOLwrapped and ENSv2 names.
UnauthorizedErrorNOT_OWNERthe account is neither registrant nor manager.
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

Setting a manager
const { hash } = await ens.name.setManager({ name: "alice.eth", manager: "0xB0b0000000000000000000000000000000000000" })

Plan methods

Each method takes the same options as name.setManager and sends nothing. See Preview before sending.

MethodDescription
name.setManager.prepare(options)Builds the plan without sending anything.
name.setManager.simulate(options)Simulates the plan with eth_call, reporting each step.
name.setManager.estimateGas(options)Estimates the gas and ETH the plan needs.

Wait for the receipt with setManagerSync

Sets the ENSv1 manager (registry owner) of a name. Resolves once the receipt is in.

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

name.setManagerSync takes the same options plus confirmations and timeout.

Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.

Setting a manager and waiting
const { receipt } = await ens.name.setManagerSync({ name: "alice.eth", manager: "0xB0b0000000000000000000000000000000000000" })

See also

  • name.get to read the name's current state

Was this page helpful?