Entities

Relationship Diagram

entity-relationship

Entities

Tld

The Tld is the parent entity, capturing all crucial data related to Top-Level Domains. This includes details about ownership, token IDs, block registration details, and transfer counts.

SaleSettings: Directly linked to a Tld in a one-to-one relationship, this sub-entity contains details regarding the sales configurations, such as pricing tiers, discounts, premium prices, and reserved names.
Royalty and RoyaltyHistory: These sub-entities define the EIP-2981 (opens in a new tab) royalty settings for a TLD and keep track of historical changes.

Field	Description
`id`	Unique identifier for the TLD.
`claimant`	Account that claimed the TLD.
`owner`	Account that owns the TLD.
`tokenId`	Unique token ID associated with the TLD.
`label`	Label of the TLD.
`registrationBlockNumber`	Block number when the TLD was registered.
`registrationBlockTimestamp`	Block timestamp when the TLD was registered.
`registrationTransactionHash`	Transaction hash for the registration event.
`lastUpdateBlockNumber`	Block number of the last update event.
`lastUpdateTimestamp`	Block timestamp when the TLD was last updated.
`lastUpdateTransactionHash`	Transaction hash for the last update event.
`saleSettings`	Sales settings associated with the TLD.
`slds`	Array of Second-Level Domains (SLDs) associated with this TLD.
`royalty`	Royalty settings for this TLD.
`royaltyHistory`	Historical record of royalty changes for this TLD.
`resolver`	Resolver settings for the TLD.
`transferCount`	Count of transfers associated with the TLD.
`transfers`	Array of TLD transfers.
`resolverVersion`	Current version of the resolver settings for this TLD.
`delegate`	Delegate account authorized to make changes to resolver settings.

Sld

Sld represents Second-Level Domains. It captures details similar to Tld but specifically concerns itself registration, resolver and renewal data.

Renewal: Provides granular information about each renewal of an SLD.
SldTransfer: Records the history of ownership transfers for each SLD.

Field	Description
`id`	Unique identifier for the SLD.
`label`	Label of the SLD.
`fullName`	Full name of the SLD.
`owner`	Account that owns the SLD.
`registrant`	Account that registered the SLD.
`parentTld`	Parent TLD of this SLD.
`registrationBlockNumber`	Block number when the SLD was registered.
`registrationTimestamp`	Timestamp when the SLD was registered.
`registrationTransactionHash`	Transaction hash for the registration.
`lastUpdateBlockNumber`	Block number of the last update.
`lastUpdateTimestamp`	Timestamp of the last update.
`lastUpdateTransactionHash`	Transaction hash for the last update.
`expirationTimestamp`	Expiry date of the SLD as a number.
`resolver`	Resolver settings for this SLD.
`renewalCount`	Count of renewals of the SLD.
`renewals`	Array of SLD renewals.
`transferCount`	Count of transfers of the SLD.
`transfers`	Array of SLD transfers.
`resolverVersion`	Current version of the Resolver settings for this SLD.
`delegate`	Delegate account authorized to make changes to resolver settings.

Royalty

Settings that specify how royalties are distributed for a TLD.

Field	Description
`id`	Unique identifier for the Royalty setting.
`percentage`	Percentage of sales to be paid out as royalty.
`payoutAddress`	Address to which the royalties will be paid.

RoyaltyHistory

Historical changes to the royalty settings for a TLD.

Field	Description
`id`	Unique identifier for the historical record.
`tld`	Associated TLD.
`percentage`	Royalty percentage at this point in history.
`payoutAddress`	Address to which royalties were to be paid at this point in history.
`blockNumber`	Block number when the settings were last updated.
`blockTimestamp`	Timestamp of the block when settings were updated.
`transactionHash`	Transaction hash for the event.

Resolver

These entities manage DNS resolver configurations for TLDs and SLDs.

Address: This sub-entity specifies coin-type and string-formatted addresses associated with the Resolver.
TextRecordand TextRecordHistory : It includes key-value pairs for text records and is part of the Resolver's configuration, and also tracks their historical changes.
DnsRecord and DnsRecordHistory: These sub-entities hold DNS record data, such as node identifiers, resource types, and records, and also track their historical changes.

Field	Description
`id`	Unique identifier for the Resolver.
`addresses`	Array of addresses managed by this Resolver.
`textRecords`	Array of text records.
`textRecordHistory`	Historical changes to text records.
`contenthash`	Content hash associated with this Resolver.
`dnsRecords`	Array of DNS records.
`dnsRecordHistory`	Historical changes to DNS records.
`resolverHistory`	Array of changes made to the Resolver settings.
`dnsZonehash`	DNS Zone hash associated with this Resolver.
`version`	Current version number of the Resolver settings.

SaleSettings

Settings for selling SLDs under a TLD.

Field	Description
`id`	Unique identifier for the SaleSettings.
`tld`	Associated TLD.
`enabled`	Whether the sale is enabled.
`prices`	Array of prices for different label lengths.
`discounts`	Array of discounts for multi-year purchases.
`premiumPrices`	Premium prices for specific labels.
`reservedNames`	List of names reserved and not available for general registration.
`blockNumber`	Block number when the settings were last updated.
`blockTimestamp`	Timestamp when the settings were last updated.
`transactionHash`	Transaction hash for the last update.

Account

The Account entity maintains records of individual accounts' ownership of TLDs and SLDs.

Field	Description
`id`	Unique identifier for the Account.
`tlds`	TLDs owned by the account.
`slds`	SLDs owned by the account.

Introduction Querying