Admin

The data models produced by the tools in the Admin category relate to scraping the chain, producing the Unchained Index, and querying the configuration of the system. Additional data related to sharing the indexes via IPFS and pinning the same are also produced by tools in this category.

Each data structure is created by one or more tools which are detailed below.

Status#

The chifra config tool reports on the state (and size) of the various TrueBlocks local binary caches. TrueBlocks produces nine difference caches: abis, blocks, monitors, names, objs, recons, slurps, traces, txs. In general practice, these caches may take up a few GB of hard drive space, however, for very popular smart contract the size of the caches may grow rather large. Keep an eye on it.

The status data model is a complex beast. It contains various information including a list of registered chains, information about many of the internal binary caches maintained by chifra as well as current status information about the system including version information for both chifra and the node it’s running against.

The following commands produce and manage Statuses:

• chifra config

Statuses consist of the following fields:

Manifest#

The Manifest details the index of appearance’s PinnedChunks. Each record in the Manifest details the block range represented by the chunk as well as the IPFS hash of the index chunk along with the associated IPFS hash for the Bloom filter of the chunk. The manifest itself is also pushed to IPFS and the IPFS of the hash of the manifest is published periodically to the Unchained Index smart contract.

The following commands produce and manage Manifests:

• chifra chunks
• chifra init
• chifra scrape

Manifests consist of the following fields:

PinnedChunk#

The TrueBlocks index scraper periodically creates a chunked portion of the index so that it can be more easily stored in a content-addresable data store such as IPFS. We call these periodically-created chunks, PinnedChunks. The format of said item is described here. A pinned chunk is effectively a relational table relating all of the addresses appearing in the chunk with a list of appearances appearing in the chunk.

The following commands produce and manage PinnedChunks:

• chifra chunks
• chifra init
• chifra scrape

PinnedChunks consist of the following fields:

ChunkIndex#

The indexchunk data model represents internal information about each Unchained Index index chunk. It is used mostly interenally to study the characteristics of the Unchained Index.

The following commands produce and manage ChunkIndexes:

• chifra chunks

ChunkIndexes consist of the following fields:

ChunkBlooms#

The blooms data model represents the bloom filter files that front the Unchained Index index portions. The information here is mostly for internal use only as it includes the size and number of the bloom filters present as well as the number of addresses inserted into the bloom. This information is used to study the characteristics of the Unchained Index.

The following commands produce and manage ChunkBlooms:

• chifra chunks

ChunkBlooms consist of the following fields:

ChunkAddresses#

The addresses data model is produced by chifra chunks and represents the records found in the addresses table of each Unchained Index chunk. The offset and count fields represent the location and number of records in the appearances table to which the address table is related.

The following commands produce and manage ChunkAddresses:

• chifra chunks

ChunkAddresses consist of the following fields:

ChunkAppearances#

The appearances data model is the second of two tables inside of the Unchained Index chunks. The other is the addresses table which relates the addresses in that table to this table via the offset and count fields.

The following commands produce and manage ChunkAppearances:

• chifra chunks

ChunkAppearances consist of the following fields:

ChunkStats#

The stats data model is produced by chifra chunks and brings together various statistical information such as average number of addresses in an Unchained Index chunk among other information.

The following commands produce and manage ChunkStats:

• chifra chunks

ChunkStats consist of the following fields:

Cache#

The chifra config reports on the binary caches. Those reports come in the form of the Cache data type. Each cache data object may carry unique information for the given cache. See the source code for more information.

The following commands produce and manage Caches:

• chifra config

Caches consist of the following fields:

CacheEntry#

The cacheEntry data model is used to display various caches displayed from the chifra config tool.

The following commands produce and manage CacheEntries:

• chifra config

CacheEntries consist of the following fields:

IndexCacheItem#

The indexCacheItem is used to present a single Unchained Index chunk in the Explorer app.

The following commands produce and manage IndexCacheItems:

• chifra config

IndexCacheItems consist of the following fields:

Chain#

The chain data model represents the configured chain data found in the trueBlocks.toml configuration file.

The following commands produce and manage Chains:

• chifra config

Chains consist of the following fields:

Base types#

This documentation mentions the following basic data types.

Edit this page on GitHub