dbnamespace.go

// Package dbnamespace contains constants that define the database namespaces
// for the purpose of the blockchain, so that external callers may easily access
// this data.
package dbnamespace

import (
	"encoding/binary"
)

var (
	// ByteOrder is the preferred byte order used for serializing numeric
	// fields for storage in the database.
	ByteOrder = binary.LittleEndian

	// BCDBInfoBucketName is the name of the database bucket used to house
	// global versioning and date information for the blockchain database.
	BCDBInfoBucketName = []byte("dbinfo")

	// BCDBInfoVersionKeyName is the name of the database key used to house
	// the database version.  It is itself under the BCDBInfoBucketName
	// bucket.
	BCDBInfoVersionKeyName = []byte("version")

	// BCDBInfoCompressionVersionKeyName is the name of the database key
	// used to house the database compression version.  It is itself under
	// the BCDBInfoBucketName bucket.
	BCDBInfoCompressionVersionKeyName = []byte("compver")

	// BCDBInfoBlockIndexVersionKeyName is the name of the database key
	// used to house the database block index version.  It is itself under
	// the BCDBInfoBucketName bucket.
	BCDBInfoBlockIndexVersionKeyName = []byte("bidxver")

	// BCDBInfoCreatedKeyName is the name of the database key used to house
	// date the database was created.  It is itself under the
	// BCDBInfoBucketName bucket.
	BCDBInfoCreatedKeyName = []byte("created")

	// ChainStateKeyName is the name of the db key used to store the best
	// chain state.
	ChainStateKeyName = []byte("chainstate")

	// SpendJournalBucketName is the name of the db bucket used to house
	// transactions outputs that are spent in each block.
	SpendJournalBucketName = []byte("spendjournal")

	// UtxoSetBucketName is the name of the db bucket used to house the
	// unspent transaction output set.
	UtxoSetBucketName = []byte("utxoset")

	// BlockIndexBucketName is the name of the db bucket used to house the
	// block index which consists of metadata for all known blocks both in
	// the main chain and on side chains.
	BlockIndexBucketName = []byte("blockidx")

	// GCSFilterBucketName is the name of the db bucket used to house GCS
	// filters.
	GCSFilterBucketName = []byte("gcsfilters")
)