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

resolver.upgrade

Upgrades the PermissionedResolver of an ENS name to a newer implementation. Parameters, return value, errors and examples for resolver.upgrade in @ensforge/sdk.

Writestable
Since v1.0.0View source

Upgrades the PermissionedResolver of an ENS name to a newer implementation. Resolves once the transaction is submitted.

When to use

Use to move a name's resolver to the deployment's latest PermissionedResolver implementation. Use upgradeSync to wait for the receipt.

Details

  • Targets the deployment's current implementation unless implementation is given.
  • Checks that the target accepts the current implementation (canUpgradeFrom) before sending.
  • Needs the upgrade role on the resolver.

Signature

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

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

Parameters

OptionTypeDefaultDescription
name (required)stringENS name. Normalized automatically.
implementationstringthe deployment's PermissionedResolver implementationImplementation 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 resolver.
NotFoundErrorRESOLVER_NOT_FOUNDthe name has no resolver of its own.
UnsupportedErrorRESOLVER_PROFILE_UNSUPPORTED, UPGRADE_NOT_APPROVEDthe resolver or target cannot be upgraded.
UnauthorizedErrorMISSING_ROLESwithout the upgrade role.
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 resolver
const { hash } = await ens.resolver.upgrade({ name: "alice.eth" })

Plan methods

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

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

Wait for the receipt with upgradeSync

Upgrades the PermissionedResolver of an ENS name to a newer implementation. Resolves once the receipt is in.

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

resolver.upgradeSync takes the same options plus confirmations and timeout.

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

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

See also

Was this page helpful?