Skip to content

Registry file ​

This page is the reference for the registry file: one JSON file per contributor and chain ID in the registry repository. To add one, follow Contribute snapshots. The feed it points at is described in Feed format.

File location ​

The file lives at chains/<network>/<chain ID>/<contributor>.json. The first directory level is the network, capitalized for display. The second level is the chain ID, which decides the chain. Each file holds one contributor and one chain ID.

FolderChain IDChain
celestia/celestiaMainnet
mocha-4/mocha-4Testnet
mocha-5/mocha-5Testnet

New chain IDs

A new chain ID needs an issue first.

ItemRule
Directory namesMatch ^[A-Za-z0-9._-]{1,64}$
File namesMatch ^[A-Za-z0-9._-]{1,100}\.json$ and are not only dots before .json. The file name does not have to equal contributor.name, but every file of one contributor uses the same file name.
ChainA chain ID is testnet when it is exactly mocha-4 or mocha-5, or when it contains test (case-insensitive). Every other chain ID is mainnet.

Fields ​

A value of null or "" counts as absent. An invalid profile field is dropped from the profile, and an invalid snapshots[] element skips that feed.

Contributor profile ​

FieldRequiredRule
contributorYesObject
contributor.nameYesDisplay name, 1 to 64 characters after trimming, no control, bidirectional or zero-width characters. Compared without case and extra spaces, so a name belongs to one contributor.
contributor.website, x, telegramOptionalProfile links. URL rules, # fragment allowed.
contributor.descriptionOptionalOne line about the contributor, at most 500 characters. Control characters become spaces.
contributor.emailOptionalContact address: ^[A-Za-z0-9._+-]+@[A-Za-z0-9.-]+\.[A-Za-z]{2,63}$, at most 254 characters
contributor.discordOptionalDiscord username, such as bombermine, shown as text: ^[A-Za-z0-9._#-]{2,40}$, not a link
contributor.identity or contributor.logoUrlOptionalAvatar: the 16-character Keybase key suffix (identity, 16 hex characters), or an HTTPS image URL (logoUrl, URL rules with # allowed). Without either, the default avatar is shown.

Feeds ​

snapshots is an array with at least one feed. One file can list several feeds, for example a pruned feed and an archive feed.

FieldRequiredMeaning
snapshots[].snapshotsYesURL of the feed. URL rules, no fragment. A feed URL belongs to one contributor.
snapshots[].typeYes, here or in the feedpruned or archive. Applies to every entry of the feed. Matches ^[A-Za-z0-9._-]{1,32}$.
snapshots[].periodRecommendedHow often the feed updates, such as 4h, 6h or 1d. Drives "next update". Matches ^[A-Za-z0-9._-]{1,32}$.
snapshots[].tx_indexOptionaltrue when the snapshots include the TX index. A boolean or "true" or "false".

Next steps ​

SnapsVault, Open Snapshot Marketplace