registry.upgrade
Upgrades an ENSv2 registry to the deployment's latest implementation. Parameters, return value, errors and examples for registry.upgrade in @ensforge/sdk.
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.getreports: theupgraderoot 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:
| 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.
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 registry. |
NotFoundError | REGISTRY_NOT_FOUND | the name has no subregistry. |
UnsupportedError | UPGRADE_NOT_APPROVED | the target is not approved. |
UnauthorizedError | MISSING_ROLES | without the upgrade root role. |
ConfigError | WALLET_NOT_CONFIGURED | no signing account is known. |
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.registry.upgrade({ name: "alice.eth" })Plan methods
Each method takes the same options as registry.upgrade and sends nothing. See 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
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.
const { receipt } = await ens.registry.upgradeSync({ name: "alice.eth" })See also
registry.getto check eligibility
Was this page helpful?