# importDnsName

Runs the resumable DNSSEC proof and ENS import workflow.

## Import

```ts
import { importDnsName } from "@ensforge/core";
```

## Usage

:::code-group
```ts [index.ts]
import { importDnsName } from "@ensforge/core";
import { config } from "./config";

const result = await importDnsName(config, {
  name: "example.eth",
  proof: [],
});
```

```ts [config.ts]
// [!include ~/snippets/core/config.ts]
```
:::

## Parameters

```ts
import type { ImportDnsNameParameters } from "@ensforge/core";
```

### name

`string`

ENS name to operate on. ensforge normalizes it before hashing or contract interaction.

### proof

`ReadonlyArray<DnssecProof>`

DNSSEC proof records supplied to the import.

### resolver

`string | undefined`

Resolver address used by the operation.

### address

`string | undefined`

Address used by this operation.

### walletClient

`WalletClient | undefined`

Viem wallet client override for this operation. Defaults to the wallet resolved from the config.

### account

`Account | Address | undefined`

Account used to authorize this operation. Defaults to the account exposed by the resolved wallet client.

### mode

`WriteMode | undefined`

Write execution strategy. `auto` uses wallet capabilities and falls back to sequential transactions.

### confirmation

`ConfirmationPolicy | undefined`

Controls whether the action returns after submission or waits for one or more confirmations.

### resume

`ImportDnsNameResult | undefined`

Previously returned progress used to continue an incomplete workflow.

## Return Type

```ts
import type { ImportDnsNameResult } from "@ensforge/core";
```

| Property   | Type                                             | Description                                                  |
| ---------- | ------------------------------------------------ | ------------------------------------------------------------ |
| `status`   | `"completed" \| "not-required" \| "partial"`     | Current query, transaction, batch, or workflow status.       |
| `name`     | `string & Brand<"NormalizedName">`               | Normalized ENS name.                                         |
| `owner`    | `&#96;0x${string}&#96; \| null`                  | Current owner address, or `null` when the name has no owner. |
| `resolver` | `&#96;0x${string}&#96; \| null \| null`          | The resolver value returned by the operation.                |
| `write`    | `WritePlanProgress \| null \| WritePlanProgress` | Progress for the write plan used by the workflow.            |

## Effect

Use `.effect` when composing the action in an Effect program. The success and error channels remain
fully typed.

```ts
import { Effect } from "effect";

const program = importDnsName.effect(config, parameters);

type Success = Effect.Effect.Success<typeof program>;
type Failure = Effect.Effect.Error<typeof program>;

const result = await Effect.runPromise(program);
```

## Error

```ts
import type { ImportDnsNameError } from "@ensforge/core";
```

The Promise API rejects with the same typed failures exposed by the Effect error channel. Errors
have a stable `_tag`, `code`, and `message`; boundary errors retain their original `cause`.

See [Error Handling](/core/guides/error-handling).

## Related

* [`sdk.dns.importDnsName`](/sdk/api/dns/import-dns-name)