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

migration.get

Reads whether an ENSv1 name can migrate to ENSv2, how, and what it becomes. Parameters, return value, errors and examples for migration.get in @ensforge/sdk.

ReadBatchablestable
Since v1.0.0View source

Reads whether an ENSv1 name can migrate to ENSv2, how, and what it becomes.

When to use

Use to drive a migration screen: route, blockers, resolver plan and the state after.

Details

  • status: eligible, blocked (see blockers), migrated or not-required (already on ENSv2, or not registered).
  • blockers are checked for account (the client's account by default).
  • resolver.plan shows what migration.migrate does with the current resolver for the same resolver option.
  • With an indexer, discovered lists the records and subnames migrate carries over by default (read at the latest block).

Signature

function get(client: Like, options: get.Options): Promise<get.ReturnType>

Call it as ens.migration.get(options) on a client, or Actions.migration.get(client, options).

migration.get.request(options) builds a deferred read for Actions.batch. See Look up many at once.

In React, use useMigrationStatus.

Parameters

OptionTypeDefaultDescription
name (required)stringENS name. Normalized automatically.
accountstringAccount that would migrate. Defaults to the client's account.
resolver"new" | "owned" | "keep" | (string & {})The resolver option migrate would get.

Also takes the read options.

Returns

Resolves to get.ReturnType. Route, blockers, holder, resolver plan and the ENSv2 state after migrating.

Errors

It can also fail with the errors every read can (Errors.CommonError: ConfigError, ContractRevertError, InternalError, NetworkError).

See How errors work.

Examples

Checking a name
const status = await ens.migration.get({ name: "alice.eth" })

Example response

Recorded from Ethereum mainnet on 2026-11-18 at block 26443964. Values change as the chain does.

await ens.migration.get({ name: "nick.eth" })
{
  "name": "nick.eth",
  "status": "migrated",
  "route": null,
  "blockers": [],
  "owner": null,
  "manager": null,
  "fuses": null,
  "expiry": null,
  "reservationExpiry": null,
  "resolver": {
    "current": null,
    "plan": "none"
  },
  "after": {
    "registry": null,
    "subregistry": null,
    "expiry": null,
    "roles": []
  },
  "discovered": null
}

See also

Was this page helpful?