types

Documentation

Index

• Constants
• Variables
• type BasicKVStore
• type BasicMultiStore
• type CacheKVStore
• type CacheMultiStore
• type CacheWrap
• type CommitID
• type CommitKVStore
• type CommitMultiStore
• type Committer
• type Iterator
• type KVPair
• type KVStore
• type KVStoreKey
• type MemoryStoreKey
• type MultiStorePersistentCache
• type PruningOptions
• type Queryable
• type StoreKVPair
• type StoreKey
• type StoreRename
• type StoreType
• type StoreUpgrades
• type TraceContext
• type TransientStoreKey
• type WriteListener

Constants

const (
	StoreTypeMemory     = v1.StoreTypeMemory
	StoreTypeTransient  = v1.StoreTypeTransient
	StoreTypeDB         = v1.StoreTypeDB
	StoreTypeSMT        = v1.StoreTypeSMT
	StoreTypePersistent = v1.StoreTypePersistent
)

Re-export relevant constants, values and utility functions

Variables

var (
	PruneDefault    = v1.PruneDefault
	PruneEverything = v1.PruneEverything
	PruneNothing    = v1.PruneNothing

	NewKVStoreKey                = v1.NewKVStoreKey
	PrefixEndBytes               = v1.PrefixEndBytes
	KVStorePrefixIterator        = v1.KVStorePrefixIterator
	KVStoreReversePrefixIterator = v1.KVStoreReversePrefixIterator

	NewStoreKVPairWriteListener = v1.NewStoreKVPairWriteListener
)

Types

type BasicKVStore

type BasicKVStore = v1.BasicKVStore

Re-export relevant original store types

type BasicMultiStore

type BasicMultiStore interface {
	// Returns a KVStore which has access only to the namespace of the StoreKey.
	// Panics if the key is not found in the schema.
	GetKVStore(StoreKey) KVStore
}

BasicMultiStore defines a minimal interface for accessing root state.

type CacheKVStore

type CacheKVStore = v1.CacheKVStore

Re-export relevant original store types

type CacheMultiStore

type CacheMultiStore interface {
	BasicMultiStore

	// Returns a branched whose modifications are later merged back in.
	CacheMultiStore() CacheMultiStore
	// Write all cached changes back to the source store. Note: this overwrites any intervening changes.
	Write()
	// contains filtered or unexported methods
}

CacheMultiStore defines a branch of the root state which can be written back to the source store.

type CacheWrap

type CacheWrap = v1.CacheWrap

Re-export relevant original store types

type CommitID

type CommitID = v1.CommitID

Re-export relevant original store types

type CommitKVStore

type CommitKVStore = v1.CommitKVStore

Re-export relevant original store types

type CommitMultiStore

type CommitMultiStore interface {
	BasicMultiStore

	Committer
	snapshottypes.Snapshotter

	// Gets a read-only view of the store at a specific version.
	// Returns an error if the version is not found.
	GetVersion(int64) (BasicMultiStore, error)
	// Closes the store and all backing transactions.
	Close() error
	// Returns a branched whose modifications are later merged back in.
	CacheMultiStore() CacheMultiStore
	// Defines the minimum version number that can be saved by this store.
	SetInitialVersion(uint64) error
	// contains filtered or unexported methods
}

CommitMultiStore defines a complete interface for persistent root state, including (read-only) access to past versions, pruning, trace/listen, and state snapshots.

type Committer

type Committer = v1.Committer

Re-export relevant original store types

type Iterator

type Iterator = v1.Iterator

Re-export relevant original store types

type KVPair

type KVPair = v1.KVPair

Re-export relevant original store types

type KVStore

type KVStore = v1.KVStore

Re-export relevant original store types

type KVStoreKey

type KVStoreKey = v1.KVStoreKey

Re-export relevant original store types

type MemoryStoreKey

type MemoryStoreKey = v1.MemoryStoreKey

Re-export relevant original store types

type MultiStorePersistentCache

type MultiStorePersistentCache = v1.MultiStorePersistentCache

MultiStorePersistentCache provides inter-block (persistent) caching capabilities for a CommitMultiStore. TODO: placeholder. Implement and redefine this

type PruningOptions

type PruningOptions = v1.PruningOptions

Re-export relevant original store types

type Queryable

type Queryable = v1.Queryable

Re-export relevant original store types

type StoreKVPair

type StoreKVPair = v1.StoreKVPair

Re-export relevant original store types

type StoreKey

type StoreKey = v1.StoreKey

Re-export relevant original store types

type StoreRename

type StoreRename = v1.StoreRename

Re-export relevant original store types

type StoreType

type StoreType = v1.StoreType

Re-export relevant original store types

type StoreUpgrades

type StoreUpgrades = v1.StoreUpgrades

Re-export relevant original store types

type TraceContext

type TraceContext = v1.TraceContext

Re-export relevant original store types

type TransientStoreKey

type TransientStoreKey = v1.TransientStoreKey

Re-export relevant original store types

type WriteListener

type WriteListener = v1.WriteListener

Re-export relevant original store types