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

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

Writestable
Since v1.0.0View source

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

When to use

Use to move a subregistry to the current UserRegistry implementation. Use upgradeSync to wait for the receipt.

Details

  • Checks before signing what registry.get reports: the upgrade root role, the target accepting the current implementation (canUpgradeFrom), and for emancipated registries the upgrade set.

Signature

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

With name:

OptionTypeDefaultDescription
name (required)string
implementationstringthe deployment's implementation for this kind of registryImplementation to upgrade to.

With registry:

OptionTypeDefaultDescription
registry (required)string
implementationstringthe deployment's implementation for this kind of registryImplementation to upgrade to.

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_ADDRESS, INVALID_RECORD_VALUEinvalid input or an up-to-date registry.
NotFoundErrorREGISTRY_NOT_FOUNDthe name has no subregistry.
UnsupportedErrorUPGRADE_NOT_APPROVEDthe target is not approved.
UnauthorizedErrorMISSING_ROLESwithout the upgrade root role.
ConfigErrorWALLET_NOT_CONFIGUREDno signing account is known.
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

Upgrading a subregistry
const { hash } = await ens.registry.upgrade({ name: "alice.eth" })

Plan methods

Each method takes the same options as registry.upgrade and sends nothing. See Preview before sending.

MethodDescription
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

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.

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

Upgrading a subregistry and waiting
const { receipt } = await ens.registry.upgradeSync({ name: "alice.eth" })

See also

Was this page helpful?