# registry.upgrade

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

Upgrades an ENSv2 registry to the deployment's latest implementation. Parameters, return value, errors and examples for registry.upgrade in @ensforge/sdk.

Source: https://ensforge.com/docs/reference/sdk/registry/upgrade

<ApiMeta kind="Write" stability="stable" since="1.0.0" source="packages/sdk/src/actions/registry/upgrade/index.ts#L57" />

Upgrades an ENSv2 registry to the deployment's latest implementation. Resolves once the transaction is submitted.

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

Use to move a subregistry to the current UserRegistry implementation. Use [`upgradeSync`](/docs/reference/sdk/registry/upgrade#wait-for-the-receipt-with-upgradesync) to wait for the receipt.

## Details [#details]

- Checks before signing what [`registry.get`](/docs/reference/sdk/registry/get) reports: the `upgrade` root role,
  the target accepting the current implementation (`canUpgradeFrom`), and for emancipated
  registries the upgrade set.

## Signature [#signature]

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

Call it as `ens.registry.upgrade(options)` on a client, or `Actions.registry.upgrade(client, options)`.

## Parameters [#parameters]

With `name`:

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `name` (required) | `string` |  |  |
| `implementation` | `string` | the deployment's implementation for this kind of registry | Implementation to upgrade to. |

With `registry`:

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `registry` (required) | `string` |  |  |
| `implementation` | `string` | the deployment's implementation for this kind of registry | Implementation to upgrade to. |

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 input or an up-to-date registry. |
| [`NotFoundError`](/docs/reference/errors/not-found-error) | [`REGISTRY_NOT_FOUND`](/docs/reference/errors/REGISTRY_NOT_FOUND) | the name has no subregistry. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`UPGRADE_NOT_APPROVED`](/docs/reference/errors/UPGRADE_NOT_APPROVED) | the target is not approved. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`MISSING_ROLES`](/docs/reference/errors/MISSING_ROLES) | without the `upgrade` root role. |
| [`ConfigError`](/docs/reference/errors/config-error) | [`WALLET_NOT_CONFIGURED`](/docs/reference/errors/WALLET_NOT_CONFIGURED) | no signing account is known. |
| [`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="Upgrading a subregistry"
const { hash } = await ens.registry.upgrade({ name: "alice.eth" })
```
</Tab>

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

await Actions.registry.upgrade(ens, { name: "alice.eth" })
```
</Tab>

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

yield* Actions.registry.upgrade(ens, { name: "alice.eth" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

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

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

## Wait for the receipt with `upgradeSync` [#wait-for-the-receipt-with-upgradesync]

Upgrades an ENSv2 registry to the deployment's latest implementation. Resolves once the receipt is in.

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

`registry.upgradeSync` 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="Upgrading a subregistry and waiting"
const { receipt } = await ens.registry.upgradeSync({ name: "alice.eth" })
```
</Tab>

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

await Actions.registry.upgradeSync(ens, { name: "alice.eth" })
```
</Tab>

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

yield* Actions.registry.upgradeSync(ens, { name: "alice.eth" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`registry.get`](/docs/reference/sdk/registry/get) to check eligibility