dns.claim
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.
Imports a DNS name into ENS with a DNSSEC proof of its _ens TXT record. Resolves once the transaction is submitted.
When to use
Use to claim a DNS name after adding the TXT record _ens.<name> = a=<address>. Use claimSync to wait for the receipt.
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
proofis given. - With
resolver, the claim also sets it; then only the DNS owner may send it. Set records withrecord.setafterwards.
Gotchas
- Read
dns.getStatusfirst: a proof that does not verify on-chain fails.
Signature
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
| Option | Type | Default | Description |
|---|---|---|---|
name (required) | string | DNS name. Normalized automatically. | |
proof | Proof | Proof from dns.getProof, 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.
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_ADDRESS, INVALID_RECORD_VALUE | invalid input. |
DnsError | DNS_RECORD_MISSING, PROOF_STALE, DNSSEC_PROOF_FAILED, TLD_NOT_PUBLIC | the name cannot be proven. |
GatewayError | GATEWAY_REQUEST_FAILED, GATEWAY_RESPONSE_INVALID | the proof cannot be fetched. |
UnauthorizedError | NOT_OWNER | someone other than the DNS owner claims with a resolver. |
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.claim({ name: "example.com" })Plan methods
Each method takes the same options as dns.claim and sends nothing. See 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
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.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.dns.claimSync({ name: "example.com" })See also
dns.getStatusto check the name first
Was this page helpful?