approval.setToken
Approves one address to transfer one ENSv1 name token, or clears the approval. Options, result, errors and examples for approval.setToken.
Approves one address to transfer one ENSv1 name token, or clears the approval. Resolves once the transaction is submitted.
When to use
Use to let a buyer or escrow take a single name. Use setTokenSync to wait for the receipt.
Details
- Wrapped names approve on the NameWrapper (blocked by
cannotApprove); unwrapped.ethnames on the BaseRegistrar. to: nullclears it. ENSv2 names use operators instead.
Signature
function setToken(
client: Like,
options: setToken.Options & Write.Options,
): Promise<setToken.ReturnType>Call it as ens.approval.setToken(options) on a client, or Actions.approval.setToken(client, options).
Parameters
| Option | Type | Default | Description |
|---|---|---|---|
name (required) | string | ENS name. Normalized automatically. | |
to (required) | string | null | Address to approve, or null to clear. |
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 input. |
NameStateError | NAME_EXPIRED, NAME_NOT_REGISTERED | the name is not registered. |
NameStateError | NAME_UNREACHABLE | ENSv2 resolution no longer reaches the name. |
UnsupportedError | UNSUPPORTED_PROTOCOL | ENSv2 names and unwrapped subnames. |
UnauthorizedError | NOT_OWNER, FUSE_BURNED | the account may not approve it. |
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.approval.setToken({ name: "alice.eth", to: "0xB0b0000000000000000000000000000000000000" })Plan methods
Each method takes the same options as approval.setToken and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
approval.setToken.prepare(options) | Builds the plan without sending anything. |
approval.setToken.simulate(options) | Simulates the plan with eth_call, reporting each step. |
approval.setToken.estimateGas(options) | Estimates the gas and ETH the plan needs. |
Wait for the receipt with setTokenSync
Approves one address to transfer one ENSv1 name token, or clears the approval. Resolves once the receipt is in.
Use when the next step depends on the change being on-chain.
approval.setTokenSync takes the same options plus confirmations and timeout.
Resolves to Write.SyncResult. Receipts plus the submitted hashes and plan.
const { receipt } = await ens.approval.setTokenSync({ name: "alice.eth", to: "0xB0b0000000000000000000000000000000000000" })See also
approval.getTokento read it
Was this page helpful?