# dns.setRecords

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

Sets DNS records or the zonehash of a name on its public resolver. Parameters, return value, errors and examples for dns.setRecords in @ensforge/sdk.

Source: https://ensforge.com/docs/reference/sdk/dns/set-records

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

Sets DNS records or the zonehash of a name on its public resolver. Resolves once the transaction is submitted.

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

Use to host DNS records in ENS, for DNS servers that read them from ENS. Use [`setRecordsSync`](/docs/reference/sdk/dns/set-records#wait-for-the-receipt-with-setrecordssync) to wait for the receipt.

## Details [#details]

- `records`: resource records in DNS wire format; a record with no data deletes it. Owner names
  are stored in lowercase, as `dns.getRecords` looks them up; record data is sent as given.
- `zonehash: null` clears the zonehash.
- Only the ENS public resolvers store DNS records.

## Signature [#signature]

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

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

## Parameters [#parameters]

| Option | Type | Default | Description |
| --- | --- | --- | --- |
| `name` (required) | `string` |  | ENS name. Normalized automatically. |
| `records` | `Hex` |  | Resource records in DNS wire format. |
| `zonehash` | `Hex \| null` |  | Zonehash, or `null` to clear it. |

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_RECORD_VALUE`](/docs/reference/errors/INVALID_RECORD_VALUE) | invalid input, such as records that are not DNS wire format. |
| [`NameStateError`](/docs/reference/errors/name-state-error) | [`NAME_EXPIRED`](/docs/reference/errors/NAME_EXPIRED), [`NAME_RESERVED`](/docs/reference/errors/NAME_RESERVED), [`NAME_NOT_REGISTERED`](/docs/reference/errors/NAME_NOT_REGISTERED) | the name is not registered. |
| [`NameStateError`](/docs/reference/errors/name-state-error) | [`NAME_UNREACHABLE`](/docs/reference/errors/NAME_UNREACHABLE) | ENSv2 resolution no longer reaches the name. |
| [`NotFoundError`](/docs/reference/errors/not-found-error) | [`RESOLVER_NOT_FOUND`](/docs/reference/errors/RESOLVER_NOT_FOUND) | the name has no resolver. |
| [`UnsupportedError`](/docs/reference/errors/unsupported-error) | [`RESOLVER_PROFILE_UNSUPPORTED`](/docs/reference/errors/RESOLVER_PROFILE_UNSUPPORTED) | resolvers without DNS records. |
| [`UnauthorizedError`](/docs/reference/errors/unauthorized-error) | [`NOT_OWNER`](/docs/reference/errors/NOT_OWNER) | the account may not edit the records. |
| [`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="Setting a zonehash"
const { hash } = await ens.dns.setRecords({ name: "alice.eth", zonehash: "0xe301…" })
```
</Tab>

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

await Actions.dns.setRecords(ens, { name: "alice.eth", zonehash: "0xe301…" })
```
</Tab>

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

yield* Actions.dns.setRecords(ens, { name: "alice.eth", zonehash: "0xe301…" })
```
</Tab>
</Tabs>

## Plan methods [#plan-methods]

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

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

## Wait for the receipt with `setRecordsSync` [#wait-for-the-receipt-with-setrecordssync]

Sets DNS records or the zonehash of a name on its public resolver. Resolves once the receipt is in.

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

`dns.setRecordsSync` 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="Setting a zonehash and waiting"
const { receipt } = await ens.dns.setRecordsSync({ name: "alice.eth", zonehash: "0xe301…" })
```
</Tab>

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

await Actions.dns.setRecordsSync(ens, { name: "alice.eth", zonehash: "0xe301…" })
```
</Tab>

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

yield* Actions.dns.setRecordsSync(ens, { name: "alice.eth", zonehash: "0xe301…" })
```
</Tab>
</Tabs>

## See also [#see-also]

- [`dns.getRecords`](/docs/reference/sdk/dns/get-records) to read them