registration.commit
Commits to registering .eth names, the first half of a registration. Parameters, return value, errors and examples for registration.commit in @ensforge/sdk.
Commits to registering .eth names, the first half of a registration. Resolves once the transaction is submitted.
When to use
Use when registration is split across sessions or devices; register alone does both halves. Use commitSync to wait for the receipt.
Details
- Takes the same options as
registration.register; they are hashed into the commitment. - Keep the returned
secret, then callregisterwith the same options andsecretonce the commitment is ready (seeregistration.getCommitmentStatus).
Gotchas
.prepareand.simulatewithoutsecretuse a throwaway secret.
Signature
function commit(
client: Like,
options: commit.Options & Write.Options,
): Promise<commit.ReturnType>Call it as ens.registration.commit(options) on a client, or Actions.registration.commit(client, options).
Parameters
| Option | Type | Default | Description |
|---|---|---|---|
names (required) | string | readonly string[] | One or more .eth second-level names; several share one plan. Normalized automatically. | |
duration (required) | bigint | Registration length in seconds, e.g. Duration.years(1). | |
owner | string | the signing account | Owner of the names. |
resolver | string | null | Resolver for the names. By default each name gets its own PermissionedResolver, deployed in the same plan with records written at creation. "owned" uses the signer's shared PermissionedResolver (the ENS app's address), deployed once and reused; its roles cover every name on it. null registers without a resolver. | |
records | Omit<recordSet.Options, "name" | "resolver" | "clear" | "pubkey"> | Records for every name, written when its resolver is created (or right after registering). | |
primaryName | boolean | Set the (single) name as the signer's primary name; adds its eth address record. | |
paymentToken | PaymentToken | "usdc" | Token to pay with. |
subregistry | string | ENSv2 registry for the names' subnames. | |
referrer | Hex | Referrer recorded by the registrar: 32 bytes, or an address (left-padded). | |
secret | Hex | Secret from an earlier commit or register, to finish that registration. |
Also takes the write options.
Returns
Resolves to Write.Result & { readonly secret: Hex; readonly commitments: readonly Hex[] }. Submitted hashes, the plan, the secret and the commitments.
Errors
| Error | Codes | When |
|---|---|---|
InvalidInputError | INVALID_NAME, INVALID_ADDRESS, DURATION_TOO_SHORT, INVALID_RECORD_VALUE | invalid input. |
NameStateError | NAME_NOT_AVAILABLE | a name is taken or in its grace period. |
CommitmentError | COMMITMENT_TOO_NEW, COMMITMENT_TOO_OLD, COMMITMENT_EXISTS | a resumed commitment outside its window. |
UnsupportedError | PAYMENT_TOKEN_UNSUPPORTED, UNSUPPORTED_ON_DEPLOYMENT | an unaccepted token or without ENSv2. |
ConfigError | WALLET_NOT_CONFIGURED | no signing account is known. |
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 { secret, commitments } = await ens.registration.commit({ names: "alice.eth", duration: 31536000n })Plan methods
Each method takes the same options as registration.commit and sends nothing. See Preview before sending.
| Method | Description |
|---|---|
registration.commit.prepare(options) | Builds the plan without sending anything. |
registration.commit.simulate(options) | Simulates the plan with eth_call, reporting each step. |
registration.commit.estimateGas(options) | Estimates the gas and ETH the plan needs. |
Wait for the receipt with commitSync
Commits to registering .eth names, the first half of a registration. Resolves once the receipt is in.
Use when the next step depends on the change being on-chain.
registration.commitSync takes the same options plus confirmations and timeout.
Resolves to commitSync.ReturnType. Receipts, the secret, the commitments and when they can be used.
const { receipt } = await ens.registration.commitSync({ names: "alice.eth", duration: 31536000n })See also
registration.registerto finish
Was this page helpful?