v1 state

maxLabelLen

maxNameLen

maxDepth

sep

// index-key separator; never appears in names or bech32 addresses

ModeClosed

Registration-policy modes.

ModeOwner

Registration-policy modes.

ModeOpen

Registration-policy modes.

ModeAllowlist

Registration-policy modes.

ModePaid

Registration-policy modes.

reservedNamespaces

Reserved record namespaces (cannot be used by the generic SetRecord API).

errInvalidName

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errInvalidLabel

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errNameUnavailable

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errNameReserved

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errNameExpired

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errNameInGrace

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errUnauthorized

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errCommitmentMissing

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errCommitmentTooNew

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errCommitmentExpired

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errCommitmentMismatch

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errPriceChanged

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errInsufficientPay

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errDurationTooShort

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errDurationTooLong

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errRecordTooLarge

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errRecordLimit

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errOperatorLimit

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errPolicyLocked

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errParentInvalid

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errPaused

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errNotFound

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errNotUser

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errSpoofedRealm

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errEmptyAddress

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errRegistrationClosed

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

errBadRequest

Stable machine-readable error codes. Messages MAY add context, but client logic should depend on these codes.

Permission

Permission enumerates the delegable operator capabilities.

PermManageRecords

PermManageOperators

PermManageSubnames

PermRenew

PermTransfer

PermManagePolicy

Permissions

Permissions is an operator grant. ExpiresAt == 0 means no expiry.

ControlPolicy

ControlPolicy holds the explicit, readable ownership/parent control flags that replace ENS Name Wrapper fuses.

RegistrationPolicy

RegistrationPolicy governs how subnames of a name may be created. The realm-global config drives second-level registration.

Records

Records is the built-in resolver state for a single name.

newRecords

Name

Name is the single object the whole realm operates on.

NameView

NameView is the read-only projection returned by GetName.

Config

Config is the realm-global configuration.

PricingConfig

PricingConfig is the admin-settable pricing surface.

PriceQuote

PriceQuote is returned by Price.

RegisterRequest

RegisterRequest is the reveal payload for Register. The commitment the client submits via Commit MUST equal sha256hex(Name|Owner|Duration|Secret|RecordsHash|PolicyRevision) using the same field values. RecordsHash is an opaque client-computed hex digest of the intended initial records; it binds the reveal so a front-runner cannot change records. NativeAddress/SetPrimary are optional conveniences applied after creation.

RegistrationResult

RegistrationResult is returned by Register.

RenewalResult

RenewalResult is returned by Renew.

SubnameOptions

SubnameOptions configures CreateSubname.

RecordQuery

RecordQuery selects which record Resolve should return.

ResolveMode

ResolveMode selects exact vs inherited resolution.

Exact

NearestAncestor

ResolveResult

ResolveResult is returned by Resolve.

Event

Event is an append-only change record for indexers.

EvNameRegistered

Event types.

EvNameRenewed

Event types.

EvNameTransferred

Event types.

EvNameExpired

Event types.

EvNameDeleted

Event types.

EvSubnameCreated

Event types.

EvPolicyChanged

Event types.

EvOperatorChanged

Event types.

EvRecordChanged

Event types.

EvPrimaryNameChange

Event types.

EvConfigChanged

Event types.

EvPaused

Event types.

EvUnpaused

Event types.

StringPage

Paged result types (gno avoids generics; concrete types keep it simple).

OperatorView

OperatorPage

EventPage

NameStatus

NameStatus mirrors the lifecycle states.

StatusAvailable

StatusCommitted

StatusActive

StatusGrace

StatusExpired

StatusDeleted

StatusReserved

CommitmentView

CommitmentView is the read projection of a pending commitment.

commitment

commitment is the stored commit record.

config

names

// canonical -> \*Name

commitments

// commitment hex -> \*commitment

reverse

// address string -> canonical (primary name)

events

// zero-padded id -> \*Event

byOwner

// "owner|canonical" -> canonical

byParent

// "parent|canonical" -> canonical

nextEventID

init.99

Normalize

Normalize canonicalizes a name: lowercases ASCII, validates every label, and enforces length/depth limits. Non-ASCII input is rejected outright.

validateLabel

mustNormalize

splitLabel

splitLabel returns (label, parent) for a canonical name.

depthOf

MakeCommitment

MakeCommitment is the public helper clients use to derive the commitment hex to pass to Commit. It normalizes the name first so the value matches what Register recomputes at reveal. Returns an error if the name is invalid.

computeCommitment

computeCommitment derives the canonical commitment hex string. Clients MUST compute it identically (see RegisterRequest docs).

digest

digest returns a short hex digest of a byte value, for event payloads (never store full record values in events).

digestStr

now

height

statusOf

statusOf computes the lifecycle status of a (possibly nil) name.

isActive

parentChainValid

parentChainValid verifies every ancestor exists, is active, and matches the stored ParentGeneration (recycling safety, invariant 16 & recycling).

available

available reports whether a name may be registered now.

lengthMultiplier

priceFor

priceFor computes the deterministic, overflow-checked price.

mulChecked

Price

Price returns a price quote for registering/renewing name for duration.

caller

callerUser

authorize

authorize is the single gate for all name mutations. Authority order: 1. admin — NOT here (admin has no routine power over user names); 2. direct owner of an active name; 3. active operator with the matching permission; 4. parent authority, when the child policy allows.

mustAuthorize

parentAuthorized

parentAuthorized checks whether callerAddr controls the parent AND the child's policy grants the parent that specific power.

Commit

Commit stores a registration commitment. The commitment hides the intended name; only its hash is recorded together with the committer and timestamp.

Register

Register reveals and consumes a commitment to create a second-level name.

collectPayment

collectPayment reads the attached ugnot, requires it to cover price, and forwards price to the treasury while refunding any overpayment.

Renew

Renew extends a name's expiry. Anyone may pay to renew (a socially useful property: third parties can prevent expiry but gain no authority). Renewal is allowed while Active or in Grace, never once fully Expired.

Transfer

Transfer moves ownership of a name.

CreateSubname

CreateSubname creates label.parent according to the parent registration policy.

DeleteSubname

DeleteSubname removes a subname. Callable by the owner, or by the parent when ParentCanDelete is set.

SetRegistrationPolicy

SetRegistrationPolicy sets the subname-issuance policy for a name.

LockPolicy

LockPolicy makes a name's control policy strictly more restrictive (emancipation). Flags may only move true->false; once Permanent, no field may be relaxed. Only the owner may lock.

mergeRestrictive

mergeRestrictive returns a policy where each boolean can only go from permissive (true) to restrictive (false); Permanent can only be turned on.

SetOperator

SetOperator grants (or updates) an operator's permissions on a name.

RemoveOperator

RemoveOperator revokes an operator.

mustAuthorizeOwnerOrOp

mustAuthorizeOwnerOrOp allows the active owner directly or an operator with the given permission (used for record/operator management).

requireRecordsMutable

bumpRecords

recordMutation

recordMutation is the shared preamble for every typed record setter: pause gate, caller authentication, name resolution, record-management authority, and records-mutable check. Returns the name and the caller address.

SetAddress

SetAddress sets the native address record.

setNativeAddressInternal

Address

Address returns the native address record.

SetCoinAddress

SetCoinAddress sets a multichain address for coinType (decimal string).

CoinAddress

CoinAddress returns a multichain address.

SetText

SetText sets a text record; empty value deletes it (physical removal).

Text

Text returns a text record.

SetContentHash

SetContentHash sets the content hash record.

ContentHash

ContentHash returns the content hash record.

SetPublicKey

SetPublicKey sets the public key record.

PublicKey

PublicKey returns the public key record.

SetABI

SetABI sets an ABI blob by content type.

ABI

ABI returns an ABI blob.

SetInterface

SetInterface sets an interface target by interface ID.

Interface

Interface returns an interface target.

SetRecord

SetRecord sets an arbitrary namespaced record. Reserved namespaces are rejected; use the typed setters for those.

Record

Record returns an arbitrary namespaced record.

SetTTL

SetTTL sets the name's TTL metadata.

guardBinary

Resolve

Resolve returns a record either at the exact name or from the nearest valid ancestor (wildcard-style). Inheritance is explicit, never implicit in the primitive getters.

lookupRecord

SetPrimaryName

SetPrimaryName sets the caller's primary (reverse) name. The name must be active and forward-resolve (Address) to the caller.

PrimaryName

PrimaryName returns the verified primary name for an address, checking that (1) a reverse record exists, (2) the name is active, and (3) forward resolution still matches. Any failure returns not-found.

ClearPrimaryName

ClearPrimaryName clears the caller's reverse record.

invalidateReverseFor

invalidateReverseFor lazily clears a reverse record if the just-changed name no longer forward-verifies for the old owner. PrimaryName also re-verifies, so this is best-effort cleanup.

capLimit

NamesByOwner

NamesByOwner lists canonical names owned by owner.

Subnames

Subnames lists direct subnames of parent.

TextKeys

TextKeys lists text-record keys for a name.

CoinTypes

CoinTypes lists multichain coin types set for a name.

Operators

Operators lists operators and their permissions for a name.

treeKeys

eventKey

recordEvent

emit

emitOwner

emitRecord

EventsAfter

EventsAfter returns events with ID strictly greater than id.

EventsForName

EventsForName returns events for a specific name with ID greater than after.

requireAdmin

requireNotPaused

SetPaused

SetPaused toggles the global pause. Paused blocks registration, subname creation, transfers and record mutation; reads, renewals and primary-name clearing remain available. It never confiscates or mutates ownership.

SetRegistrationOpen

SetRegistrationOpen toggles whether new second-level registrations are open.

SetPricing

SetPricing updates future pricing and bumps the policy revision so pending commitments that priced against the old rules are rejected at reveal.

SetTreasury

SetTreasury updates the treasury address.

ReserveName

ReserveName reserves (or unreserves) an unregistered name so it cannot be publicly registered. Admin may not reserve an actively-owned name.

TransferAdmin

TransferAdmin begins a two-step admin handover.

AcceptAdmin

AcceptAdmin completes the two-step admin handover.

SetLimits

SetLimits updates operational storage/abuse limits (future registrations and mutations). Existing names are unaffected until next mutation.

Status

Status returns the lifecycle status of a name.

Exists

Exists reports whether a name currently resolves to a live registration.

OwnerOf

OwnerOf returns the owner of an active/grace name.

GetName

GetName returns a read-only view of a name.

CommitmentStatus

CommitmentStatus returns the state of a pending commitment.

Render

Render is a human-readable explorer. It never mutates state.

renderHome

renderName

renderAddress

renderAvailable

renderEvents

renderHelp

coins

treeGet

treeGet adapts the avl v0 API (Get returns a single value; existence is via Has) to the (value, ok) idiom used throughout this file.

getRaw

resolvableName

resolvableName returns the name only if it is currently Active (records resolve only for active names).

mustName

mustName returns an existing name or panics with not\_found.

putName

deleteName

ownerKey

getCommitment

getOperator

allowlistHas

collectPaymentDenom

prefixEnd