dns.setRecords
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.
Sets DNS records or the zonehash of a name on its public resolver. Resolves once the transaction is submitted.
When to use
Use to host DNS records in ENS, for DNS servers that read them from ENS. Use setRecordsSync to wait for the receipt.
Details
records: resource records in DNS wire format; a record with no data deletes it. Owner names are stored in lowercase, asdns.getRecordslooks them up; record data is sent as given.zonehash: nullclears the zonehash.- Only the ENS public resolvers store DNS records.
Signature
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
| 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.
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_RECORD_VALUE | invalid input, such as records that are not DNS wire format. |
NameStateError | NAME_EXPIRED, NAME_RESERVED, NAME_NOT_REGISTERED | the name is not registered. |
NameStateError | NAME_UNREACHABLE | ENSv2 resolution no longer reaches the name. |
NotFoundError | RESOLVER_NOT_FOUND | the name has no resolver. |
UnsupportedError | RESOLVER_PROFILE_UNSUPPORTED | resolvers without DNS records. |
UnauthorizedError | NOT_OWNER | the account may not edit the records. |
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.dns.setRecords({ name: "alice.eth", zonehash: "0xe301…" })Plan methods
Each method takes the same options as dns.setRecords and sends nothing. See 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
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.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.dns.setRecordsSync({ name: "alice.eth", zonehash: "0xe301…" })See also
dns.getRecordsto read them
Was this page helpful?