1const (
2	ModeClosed    = "closed"
3	ModeOwner     = "owner"
4	ModeOpen      = "open"
5	ModeAllowlist = "allowlist"
6	ModePaid      = "paid"
7)

 1const (
 2	EvNameRegistered    = "NameRegistered"
 3	EvNameRenewed       = "NameRenewed"
 4	EvNameTransferred   = "NameTransferred"
 5	EvNameExpired       = "NameExpired"
 6	EvNameDeleted       = "NameDeleted"
 7	EvSubnameCreated    = "SubnameCreated"
 8	EvPolicyChanged     = "PolicyChanged"
 9	EvOperatorChanged   = "OperatorChanged"
10	EvRecordChanged     = "RecordChanged"
11	EvPrimaryNameChange = "PrimaryNameChanged"
12	EvConfigChanged     = "ConfigChanged"
13	EvPaused            = "Paused"
14	EvUnpaused          = "Unpaused"
15)

1const (
2	StatusAvailable NameStatus = "Available"
3	StatusCommitted NameStatus = "Committed"
4	StatusActive    NameStatus = "Active"
5	StatusGrace     NameStatus = "Grace"
6	StatusExpired   NameStatus = "Expired"
7	StatusDeleted   NameStatus = "Deleted"
8	StatusReserved  NameStatus = "Reserved"
9)

1const (
2	PermManageRecords Permission = iota
3	PermManageOperators
4	PermManageSubnames
5	PermRenew
6	PermTransfer
7	PermManagePolicy
8)

1const (
2	Exact ResolveMode = iota
3	NearestAncestor
4)

1func ABI(name string, contentType string) ([]byte, bool)

1func AcceptAdmin(cur realm)

1func Address(name string) (string, bool)

1func ClearPrimaryName(cur realm)

1func CoinAddress(name string, coinType string) ([]byte, bool)

1func Commit(cur realm, commit string)

1func ContentHash(name string) ([]byte, bool)

1func CreateSubname(cur realm, parent string, label string, owner address, options SubnameOptions)

1func DeleteSubname(cur realm, name string)

1func Exists(name string) bool

1func Interface(name string, interfaceID string) (string, bool)

1func LockPolicy(cur realm, name string, restrictions ControlPolicy)

1func MakeCommitment(name string, owner address, duration int64, secret, recordsHash string, policyRevision uint64) (string, error)

1func Normalize(name string) (string, error)

1func OwnerOf(name string) (string, bool)

1func PrimaryName(addr string) (string, bool)

1func PublicKey(name string) ([]byte, bool)

1func Record(name string, namespace string, key string) ([]byte, bool)

1func RemoveOperator(cur realm, name string, operator address)

1func Render(path string) string

1func ReserveName(cur realm, name string, reserved bool)

1func SetABI(cur realm, name string, contentType string, value []byte)

1func SetAddress(cur realm, name string, addr string)

1func SetCoinAddress(cur realm, name string, coinType string, value []byte)

1func SetContentHash(cur realm, name string, value []byte)

1func SetInterface(cur realm, name string, interfaceID string, target string)

1func SetLimits(cur realm, maxRecords, maxOperators uint16, maxText, maxBinary uint32)

1func SetOperator(cur realm, name string, operator address, permissions Permissions)

1func SetPaused(cur realm, paused bool)

1func SetPricing(cur realm, pricing PricingConfig)

1func SetPrimaryName(cur realm, name string)

1func SetPublicKey(cur realm, name string, value []byte)

1func SetRecord(cur realm, name string, namespace string, key string, value []byte)

1func SetRegistrationOpen(cur realm, open bool)

1func SetRegistrationPolicy(cur realm, name string, policy RegistrationPolicy)

1func SetTTL(cur realm, name string, ttl uint64)

1func SetText(cur realm, name string, key string, value string)

1func SetTreasury(cur realm, treasury address)

1func Text(name string, key string) (string, bool)

1func Transfer(cur realm, name string, newOwner address, clearOperators, clearRecords bool)

1func TransferAdmin(cur realm, next address)

1func CommitmentStatus(commit string) CommitmentView

1func EventsAfter(id uint64, limit uint16) EventPage

1func EventsForName(name string, after uint64, limit uint16) EventPage

1func Status(name string) NameStatus

1func GetName(name string) (NameView, bool)

1func Operators(name string, cursor string, limit uint16) OperatorPage

1func Price(name string, duration int64) (PriceQuote, error)

1func Register(cur realm, request RegisterRequest) RegistrationResult

1func Renew(cur realm, name string, duration int64) RenewalResult

1func Resolve(name string, query RecordQuery, mode ResolveMode) ResolveResult

1func CoinTypes(name string, cursor string, limit uint16) StringPage

1func NamesByOwner(owner string, cursor string, limit uint16) StringPage

1func Subnames(parent string, cursor string, limit uint16) StringPage

1func TextKeys(name string, cursor string, limit uint16) StringPage

1type CommitmentView struct {
2	Exists    bool
3	Committer string
4	CreatedAt int64
5	ReadyAt   int64
6	ExpiresAt int64
7}

 1type Config struct {
 2	Admin        address
 3	PendingAdmin address
 4
 5	RegistrationOpen bool
 6
 7	MinCommitAge int64
 8	MaxCommitAge int64
 9
10	MinRegistrationDuration int64
11	MaxRegistrationDuration int64
12
13	GracePeriod int64
14
15	BasePricePerSecond int64
16	PremiumByLength    map[uint8]int64
17
18	PaymentDenom string
19	Treasury     address
20
21	MaxTextValueBytes   uint32
22	MaxBinaryValueBytes uint32
23	MaxRecordsPerName   uint16
24	MaxOperatorsPerName uint16
25
26	PolicyRevision uint64 // bumped whenever pricing/registration rules change
27	Paused         bool
28}

 1type ControlPolicy struct {
 2	OwnerCanTransfer       bool
 3	OwnerCanCreateSubnames bool
 4	RecordsMutable         bool
 5
 6	ParentCanReclaim      bool
 7	ParentCanTransfer     bool
 8	ParentCanDelete       bool
 9	ParentCanChangePolicy bool
10
11	// Permanent means the policy can only become MORE restrictive. It does not
12	// make records immutable by itself.
13	Permanent bool
14}

 1type Event struct {
 2	ID        uint64
 3	Height    int64
 4	Timestamp int64
 5
 6	Type string
 7	Name string
 8
 9	Actor  string
10	Owner  string
11	Target string
12
13	Revision uint64
14
15	Key       string
16	OldDigest string
17	NewDigest string
18}

1type EventPage struct {
2	Items []Event
3	Next  string
4}

 1type Name struct {
 2	Canonical string
 3	Owner     address
 4
 5	CreatedAt   int64
 6	UpdatedAt   int64
 7	ExpiresAt   int64 // 0 == permanent subname (follows parent validity)
 8	GraceEndsAt int64
 9
10	Parent string
11	Label  string
12	Depth  uint8
13
14	TTL uint64
15
16	Generation       uint64
17	ParentGeneration uint64
18
19	RegistrationPolicy RegistrationPolicy
20	ControlPolicy      ControlPolicy
21
22	Records *Records
23
24	Operators     *avl.Tree // address string -> Permissions
25	OperatorCount int
26
27	Revision uint64
28	Reserved bool
29	Deleted  bool
30}

1type NameStatus string

 1type NameView struct {
 2	Canonical   string
 3	Owner       string
 4	Status      string
 5	CreatedAt   int64
 6	UpdatedAt   int64
 7	ExpiresAt   int64
 8	GraceEndsAt int64
 9	Parent      string
10	Label       string
11	Depth       uint8
12	TTL         uint64
13	Generation  uint64
14	Revision    uint64
15	Reserved    bool
16	NativeAddr  string
17}

1type OperatorPage struct {
2	Items []OperatorView
3	Next  string
4}

1type OperatorView struct {
2	Address     string
3	Permissions Permissions
4}

1type Permission int

1type Permissions struct {
2	ManageRecords   bool
3	ManageOperators bool
4	ManageSubnames  bool
5	Renew           bool
6	Transfer        bool
7	ManagePolicy    bool
8	ExpiresAt       int64
9}

1type PriceQuote struct {
2	Amount     int64
3	Denom      string
4	ValidUntil int64
5	Revision   uint64
6}

1type PricingConfig struct {
2	BasePricePerSecond int64
3	PremiumByLength    map[uint8]int64
4	PaymentDenom       string
5}

1type RecordQuery struct {
2	Kind string // "address" | "text" | "coin" | "content" | "pubkey" | "abi" | "interface" | "record"
3	Key1 string // text key / coin type / abi content type / interface id / namespace
4	Key2 string // arbitrary record key (with namespace in Key1)
5}

 1type Records struct {
 2	NativeAddress string
 3	ContentHash   []byte
 4	PublicKey     []byte
 5
 6	Addresses  *avl.Tree // coinType (decimal string) -> []byte
 7	Text       *avl.Tree // key -> string
 8	ABIs       *avl.Tree // contentType -> []byte
 9	Interfaces *avl.Tree // interfaceID -> string
10	Arbitrary  *avl.Tree // "namespace/key" -> []byte
11
12	Count int // number of stored entries, for MaxRecordsPerName enforcement
13}

 1type RegisterRequest struct {
 2	Name           string
 3	Owner          address
 4	Duration       int64
 5	Secret         string
 6	RecordsHash    string
 7	PolicyRevision uint64
 8
 9	NativeAddress string
10	SetPrimary    bool
11}

 1type RegistrationPolicy struct {
 2	Mode string // closed | owner | open | allowlist | paid
 3
 4	MinDuration int64
 5	MaxDuration int64
 6
 7	PricePerSecond int64
 8	PaymentDenom   string
 9
10	Allowlist *avl.Tree // address string -> bool
11
12	DefaultControlPolicy ControlPolicy
13}

1type RegistrationResult struct {
2	Canonical  string
3	Owner      string
4	ExpiresAt  int64
5	Generation uint64
6	Paid       int64
7	Refunded   int64
8}

1type RenewalResult struct {
2	Canonical string
3	ExpiresAt int64
4	Paid      int64
5}

1type ResolveMode int

1type ResolveResult struct {
2	Found      bool
3	Requested  string
4	SourceName string
5	Value      []byte
6	Revision   uint64
7	ExpiresAt  int64
8}

1type StringPage struct {
2	Items []string
3	Next  string
4}

1type SubnameOptions struct {
2	Duration      int64 // 0 == permanent (follows parent)
3	ControlPolicy ControlPolicy
4	NativeAddress string
5}