# dns.claim

> For the complete documentation index, see [llms.txt](https://ensforge.com/llms.txt).

Imports a DNS name into ENS with a DNSSEC proof of its _ens TXT record. Parameters, return value, errors and examples for dns.claim in @ensforge/sdk.

Source: https://ensforge.com/docs/reference/sdk/dns/claim

<ApiMeta kind="Write" stability="stable" since="1.0.0" source="packages/sdk/src/actions/dns/claim/index.ts#L62" />

Imports a DNS name into ENS with a DNSSEC proof of its `_ens` TXT record. Resolves once the transaction is submitted.

## When to use [#when-to-use]

Use to claim a DNS name after adding the TXT record `_ens.<name>` = `a=<address>`. Use [`claimSync`](/docs/reference/sdk/dns/claim#wait-for-the-receipt-with-claimsync) to wait for the receipt.

## Details [#details]

- The name goes to the address in the TXT record, whoever sends the claim.
- The proof comes from the deployment's DNSSEC gateway unless `proof` is given.
- With `resolver`, the claim also sets it; then only the DNS owner may send it. Set records
  with [`record.set`](/docs/reference/sdk/record/set) afterwards.

<Callout type="warn" title="Gotchas">
- Read [`dns.getStatus`](/docs/reference/sdk/dns/get-status) first: a proof that does not verify on-chain fails.
</Callout>

## Signature [#signature]

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

Call it as `ens.dns.claim(options)` on a client, or `Actions.dns.claim(client, options)`.

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `name` (required) | `string` |  | DNS name. Normalized automatically. |
| `proof` | `Proof` |  | Proof from [`dns.getProof`](/docs/reference/sdk/dns/get-proof), instead of fetching one. |
| `resolver` | `string` |  | Resolver to set while claiming. |
| `gatewayUrls` | `readonly string[]` |  | DNSSEC gateways to fetch the proof from, instead of the deployment's. |

Also takes the [write options](/docs/reference/sdk/client#write-options).

## Returns [#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 [#errors]

| Error | Codes | When |
| --- | --- | --- |
| [`InvalidInputError`](/docs/reference/errors/invalid-input-error) | [`INVALID_NAME`](/docs/reference/errors/INVALID_NAME), [`INVALID_ADDRESS`](/docs/reference/errors/INVALID_ADDRESS), [`INVALID_RECORD_VALUE`](/docs/reference/errors/INVALID_RECORD_VALUE) | invalid input. |
| [`DnsError`](/docs/reference/errors/dns-error) | [`DNS_RECORD_MISSING`](/docs/reference/errors/DNS_RECORD_MISSING), [`PROOF_STALE`](/docs/reference/errors/PROOF_STALE), [`DNSSEC_PROOF_FAILED`](/docs/reference/errors/DNSSEC_PROOF_FAILED), [`TLD_NOT_PUBLIC`](/docs/reference/errors/TLD_NOT_PUBLIC) | the name cannot be proven. |
| [`GatewayError`](/docs/reference/errors/gateway-error) | [`GATEWAY_REQUEST_FAILED`](/docs/reference/errors/GATEWAY_REQUEST_FAILED), [`GATEWAY_RESPONSE_INVALID`](/docs/reference/errors/GATEWAY_RESPONSE_INVALID) | the proof cannot be fetched. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`NOT_OWNER`](/docs/reference/errors/NOT_OWNER) | someone other than the DNS owner claims with a resolver. |
| [`UserRejectedError`](/docs/reference/errors/user-rejected-error) | [`USER_REJECTED`](/docs/reference/errors/USER_REJECTED) | the user rejects the request. |
| [`WalletError`](/docs/reference/errors/wallet-error) | [`CHAIN_MISMATCH`](/docs/reference/errors/CHAIN_MISMATCH), [`ACCOUNT_NOT_FOUND`](/docs/reference/errors/ACCOUNT_NOT_FOUND) | the wallet is on another chain or has no account to sign with. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`WALLET_BATCH_UNSUPPORTED`](/docs/reference/errors/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](/docs/sdk/errors-explained).

## Examples [#examples]

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Claiming a DNS name"
const { hash } = await ens.dns.claim({ name: "example.com" })
```
</Tab>

<Tab>
```ts title="Claiming a DNS name with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.dns.claim(ens, { name: "example.com" })
```
</Tab>

<Tab>
```ts title="Claiming a DNS name in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.dns.claim(ens, { name: "example.com" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

Each method takes the same options as `dns.claim` and sends nothing. See [Preview before sending](/docs/sdk/preview-before-sending).

| Method | Description |
| --- | --- |
| `dns.claim.prepare(options)` | Builds the plan without sending anything. |
| `dns.claim.simulate(options)` | Simulates the plan with `eth_call`, reporting each step. |
| `dns.claim.estimateGas(options)` | Estimates the gas and ETH the plan needs. |

## Wait for the receipt with `claimSync` [#wait-for-the-receipt-with-claimsync]

Imports a DNS name into ENS with a DNSSEC proof of its `_ens` TXT record. Resolves once the receipt is in.

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

`dns.claimSync` takes the same options plus [`confirmations` and `timeout`](/docs/reference/sdk/client#sync-options).

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

<Tabs groupId="api" items={["Client","Standalone","Effect"]} persist>
<Tab>
```ts title="Claiming a DNS name and waiting"
const { receipt } = await ens.dns.claimSync({ name: "example.com" })
```
</Tab>

<Tab>
```ts title="Waiting with a standalone call"
import { Actions } from "@ensforge/sdk"

await Actions.dns.claimSync(ens, { name: "example.com" })
```
</Tab>

<Tab>
```ts title="Waiting in an Effect program"
import { Actions } from "@ensforge/sdk/effect"

yield* Actions.dns.claimSync(ens, { name: "example.com" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`dns.getStatus`](/docs/reference/sdk/dns/get-status) to check the name first