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.
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
implementationis given. - Checks that the target accepts the current implementation (
canUpgradeFrom) before sending. - Needs the
upgraderole 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
| Option | Type | Default | Description |
|---|---|---|---|
name (required) | string | ENS name. Normalized automatically. | |
implementation | string | the deployment's PermissionedResolver implementation | Implementation to upgrade to. |
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_RECORD_VALUE | invalid input or an up-to-date resolver. |
NotFoundError | RESOLVER_NOT_FOUND | the name has no resolver of its own. |
UnsupportedError | RESOLVER_PROFILE_UNSUPPORTED, UPGRADE_NOT_APPROVED | the resolver or target cannot be upgraded. |
UnauthorizedError | MISSING_ROLES | without the upgrade role. |
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.resolver.upgrade({ name: "alice.eth" })Plan methods
Each method takes the same options as resolver.upgrade and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
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.
const { receipt } = await ens.resolver.upgradeSync({ name: "alice.eth" })See also
resolver.getto inspect the resolver
Was this page helpful?