name.setManager
Sets the ENSv1 manager (registry owner) of a name. Parameters, return value, errors and examples for name.setManager in @ensforge/sdk.
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
.ethnames: 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
| Option | Type | Default | Description |
|---|---|---|---|
name (required) | string | ENS name. Normalized automatically. | |
manager (required) | string | New manager address. |
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_EXPIRED, NAME_RESERVED, NAME_NOT_REGISTERED | the name is not registered. |
NameStateError | NAME_UNREACHABLE | ENSv2 resolution no longer reaches the name. |
UnsupportedError | UNSUPPORTED_PROTOCOL | wrapped and ENSv2 names. |
UnauthorizedError | NOT_OWNER | the account is neither registrant nor manager. |
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.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.
| Method | Description |
|---|---|
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.
const { receipt } = await ens.name.setManagerSync({ name: "alice.eth", manager: "0xB0b0000000000000000000000000000000000000" })See also
name.getto read the name's current state
Was this page helpful?