# subname.update

> For the complete documentation index, see [llms.txt](https://ensforge.com/llms.txt).

Changes a subname from its parent: owner, resolver or expiry, in one plan. Parameters, return value, errors and examples for subname.update in @ensforge/sdk.

Source: https://ensforge.com/docs/reference/sdk/subname/update

<ApiMeta kind="Write" stability="stable" since="1.0.0" source="packages/sdk/src/actions/subname/update/index.ts#L67" />

Changes a subname from its parent: owner, resolver or expiry, in one plan. Resolves once the transaction is submitted.

## When to use [#when-to-use]

Use to repoint or extend names you gave out without asking their owners. Use [`updateSync`](/docs/reference/sdk/subname/update#wait-for-the-receipt-with-updatesync) to wait for the receipt.

## Details [#details]

- ENSv2: `setResolver` and `renew` in the parent's subregistry. The owner moves with
  [`name.transfer`](/docs/reference/sdk/name/transfer), or by removing and recreating the child. On the deployment's
  current UserRegistry, extending the expiry needs the `renew` role at the subregistry's root;
  older registries also accept it on the child.
- ENSv1: one `setSubnodeRecord` keeps what is not changed; wrapped children extend their
  expiry with `extendExpiry`. Unwrapped ENSv1 subnames have no expiry. Under an unwrapped
  parent the registry rewrites a wrapped child, which unwraps it.

<Callout type="warn" title="Gotchas">
- An expired wrapped child the parent still controls keeps its owner, and the parent extends
  it. An emancipated child loses its owner when it expires: recreate it with
  [`subname.create`](/docs/reference/sdk/subname/create).
</Callout>

## Signature [#signature]

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

Call it as `ens.subname.update(options)` on a client, or `Actions.subname.update(client, options)`.

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `name` (required) | `string` |  | Full name of the child. Normalized automatically. |
| `owner` | `string` |  | New owner (ENSv1 only). |
| `resolver` | `string \| null` |  | New resolver, or `null` to remove it. |
| `expiry` | `bigint` |  | New expiry as a Unix timestamp; it can only grow. |

Also takes the [write options](/docs/reference/sdk/client#write-options).

## Returns [#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 [#errors]

| Error | Codes | When |
| --- | --- | --- |
| [`InvalidInputError`](/docs/reference/errors/invalid-input-error) | [`INVALID_NAME`](/docs/reference/errors/INVALID_NAME), [`INVALID_ADDRESS`](/docs/reference/errors/INVALID_ADDRESS), [`INVALID_RECORD_VALUE`](/docs/reference/errors/INVALID_RECORD_VALUE), [`INVALID_EXPIRY`](/docs/reference/errors/INVALID_EXPIRY) | invalid input. |
| [`NameStateError`](/docs/reference/errors/name-state-error) | [`NAME_NOT_REGISTERED`](/docs/reference/errors/NAME_NOT_REGISTERED), [`NAME_EXPIRED`](/docs/reference/errors/NAME_EXPIRED) | the child or parent does not exist, or an emancipated child expired. |
| [`NameStateError`](/docs/reference/errors/name-state-error) | [`NAME_RESERVED`](/docs/reference/errors/NAME_RESERVED), [`NAME_UNREACHABLE`](/docs/reference/errors/NAME_UNREACHABLE) | the parent is reserved or ENSv2 resolution no longer reaches it. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`UNSUPPORTED_PROTOCOL`](/docs/reference/errors/UNSUPPORTED_PROTOCOL) | an ENSv2 owner change or an unwrapped ENSv1 expiry. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`MISSING_ROLES`](/docs/reference/errors/MISSING_ROLES), [`NOT_OWNER`](/docs/reference/errors/NOT_OWNER), [`FUSE_BURNED`](/docs/reference/errors/FUSE_BURNED) | the account may not change it. |
| [`UserRejectedError`](/docs/reference/errors/user-rejected-error) | [`USER_REJECTED`](/docs/reference/errors/USER_REJECTED) | the user rejects the request. |
| [`WalletError`](/docs/reference/errors/wallet-error) | [`CHAIN_MISMATCH`](/docs/reference/errors/CHAIN_MISMATCH), [`ACCOUNT_NOT_FOUND`](/docs/reference/errors/ACCOUNT_NOT_FOUND) | the wallet is on another chain or has no account to sign with. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`WALLET_BATCH_UNSUPPORTED`](/docs/reference/errors/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](/docs/sdk/errors-explained).

## Examples [#examples]

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Repointing a subname"
const { hash } = await ens.subname.update({ name: "pay.alice.eth", resolver: "0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63" })
```
</Tab>

<Tab>
```ts title="Repointing a subname with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.subname.update(ens, { name: "pay.alice.eth", resolver: "0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63" })
```
</Tab>

<Tab>
```ts title="Repointing a subname in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.subname.update(ens, { name: "pay.alice.eth", resolver: "0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

Each method takes the same options as `subname.update` and sends nothing. See [Preview before sending](/docs/sdk/preview-before-sending).

| Method | Description |
| --- | --- |
| `subname.update.prepare(options)` | Builds the plan without sending anything. |
| `subname.update.simulate(options)` | Simulates the plan with `eth_call`, reporting each step. |
| `subname.update.estimateGas(options)` | Estimates the gas and ETH the plan needs. |

## Wait for the receipt with `updateSync` [#wait-for-the-receipt-with-updatesync]

Changes a subname from its parent: owner, resolver or expiry, in one plan. Resolves once the receipt is in.

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

`subname.updateSync` takes the same options plus [`confirmations` and `timeout`](/docs/reference/sdk/client#sync-options).

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

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Repointing a subname and waiting"
const { receipt } = await ens.subname.updateSync({ name: "pay.alice.eth", resolver: "0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63" })
```
</Tab>

<Tab>
```ts title="Waiting with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.subname.updateSync(ens, { name: "pay.alice.eth", resolver: "0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63" })
```
</Tab>

<Tab>
```ts title="Waiting in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.subname.updateSync(ens, { name: "pay.alice.eth", resolver: "0x231b0Ee14048e9dCcD1d247744d114a4EB5E8E63" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`name.get`](/docs/reference/sdk/name/get) to read the child