Documentation for agents: an index at /llms.txt, every docs page in one file at /llms-full.txt, and Markdown for any docs page by adding .md to its URL.

Skip to Content
ensforgeSDK

registration.getCommitmentStatus

Reads where a registration commitment is in its window. Parameters, return value, errors and examples for registration.getCommitmentStatus in @ensforge/sdk.

ReadBatchablestable
Since v1.0.0View source

Reads where a registration commitment is in its window.

When to use

Use to show a countdown between registration.commit and registration.register.

Details

  • pending: too new to register; ready: register now; expired: commit again.
  • unknown: never made, or already used by a registration.

Signature

function getCommitmentStatus(
  client: Like,
  options: getCommitmentStatus.Options,
): Promise<getCommitmentStatus.ReturnType>

Call it as ens.registration.getCommitmentStatus(options) on a client, or Actions.registration.getCommitmentStatus(client, options).

registration.getCommitmentStatus.request(options) builds a deferred read for Actions.batch. See Look up many at once.

Parameters

OptionTypeDefaultDescription
commitment (required)HexCommitment hash returned by registration.commit.

Also takes the read options.

Returns

Resolves to getCommitmentStatus.ReturnType. The status and the window's timestamps (null when unknown).

FieldTypeDescription
status"pending" | "ready" | "expired" | "unknown"
committedAtbigint | null
readyAtbigint | null
expiresAtbigint | null

Errors

It can also fail with the errors every read can (Errors.CommonError: ConfigError, ContractRevertError, InternalError, NetworkError).

See How errors work.

Examples

Waiting for a commitment
const { status, readyAt } = await ens.registration.getCommitmentStatus({ commitment })

See also

Was this page helpful?