store

package
v0.29.1-rc0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jan 2, 2019 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source 
const ProofOpMultiStore = "multistore"

the multi-store proof operation constant value

Variables

This section is empty.

Functions

func DefaultProofRuntime added in v0.26.0 

func DefaultProofRuntime() (prt *merkle.ProofRuntime)

XXX: This should be managed by the rootMultiStore which may want to register more proof ops?

func ElemKey added in v0.25.0 

func ElemKey(index uint64) []byte

Key for the elements of the list

func First 

func First(st KVStore, start, end []byte) (kv cmn.KVPair, ok bool)

Gets the first item.

func Last 

func Last(st KVStore, start, end []byte) (kv cmn.KVPair, ok bool)

Gets the last item. `end` is exclusive.

func LengthKey added in v0.25.0 

func LengthKey() []byte

Key for the length of the list

func MultiStoreProofOpDecoder added in v0.26.0 

func MultiStoreProofOpDecoder(pop merkle.ProofOp) (merkle.ProofOperator, error)

MultiStoreProofOpDecoder returns a multi-store merkle proof operator from a given proof operation.

func NewCacheKVStore 

func NewCacheKVStore(parent KVStore) *cacheKVStore

nolint

func NewCommitMultiStore 

func NewCommitMultiStore(db dbm.DB) *rootMultiStore

nolint

func NewGasKVStore added in v0.18.0 

func NewGasKVStore(gasMeter sdk.GasMeter, gasConfig sdk.GasConfig, parent sdk.KVStore) *gasKVStore

NewGasKVStore returns a reference to a new GasKVStore. nolint

func RequireProof added in v0.25.0 

func RequireProof(subpath string) bool

RequireProof returns whether proof is required for the subpath.

func TopKey added in v0.25.0 

func TopKey() []byte

Key for the top element position in the queue

Types

type CacheKVStore 

type CacheKVStore = types.CacheKVStore

Import cosmos-sdk/types/store.go for convenience. nolint

type CacheMultiStore 

type CacheMultiStore = types.CacheMultiStore

Import cosmos-sdk/types/store.go for convenience. nolint

type CacheWrap 

type CacheWrap = types.CacheWrap

Import cosmos-sdk/types/store.go for convenience. nolint

type CacheWrapper 

type CacheWrapper = types.CacheWrapper

Import cosmos-sdk/types/store.go for convenience. nolint

type CommitID 

type CommitID = types.CommitID

Import cosmos-sdk/types/store.go for convenience. nolint

type CommitKVStore 

type CommitKVStore = types.CommitKVStore

Import cosmos-sdk/types/store.go for convenience. nolint

type CommitMultiStore 

type CommitMultiStore = types.CommitMultiStore

Import cosmos-sdk/types/store.go for convenience. nolint

type CommitStore 

type CommitStore = types.CommitStore

Import cosmos-sdk/types/store.go for convenience. nolint

func LoadIAVLStore 

func LoadIAVLStore(db dbm.DB, id CommitID, pruning sdk.PruningStrategy) (CommitStore, error)

load the iavl store

type Committer 

type Committer = types.Committer

Import cosmos-sdk/types/store.go for convenience. nolint

type Gas added in v0.24.0 

type Gas = types.Gas

Import cosmos-sdk/types/store.go for convenience. nolint

type GasConfig added in v0.24.0 

type GasConfig = types.GasConfig

Import cosmos-sdk/types/store.go for convenience. nolint

type GasMeter added in v0.24.0 

type GasMeter = types.GasMeter

Import cosmos-sdk/types/store.go for convenience. nolint

type Iterator 

type Iterator = types.Iterator

Import cosmos-sdk/types/store.go for convenience. nolint

type KVPair added in v0.17.0 

type KVPair = types.KVPair

Import cosmos-sdk/types/store.go for convenience. nolint

type KVStore 

type KVStore = types.KVStore

Import cosmos-sdk/types/store.go for convenience. nolint

type List added in v0.25.0 

type List struct {
	// contains filtered or unexported fields
}

List defines an integer indexable mapper It panics when the element type cannot be (un/)marshalled by the codec

func NewList added in v0.25.0 

func NewList(cdc *codec.Codec, store sdk.KVStore) List

NewList constructs new List

func (List) Delete added in v0.25.0 

func (m List) Delete(index uint64)

Delete() deletes the element in the given position Other elements' indices are preserved after deletion Panics when the index is out of range

func (List) Get added in v0.25.0 

func (m List) Get(index uint64, ptr interface{}) error

Get() returns the element by its index

func (List) Iterate added in v0.25.0 

func (m List) Iterate(ptr interface{}, fn func(uint64) bool)

CONTRACT: No writes may happen within a domain while iterating over it.

func (List) Len added in v0.25.0 

func (m List) Len() (res uint64)

Len() returns the length of the list The length is only increased by Push() and not decreased List dosen't check if an index is in bounds The user should check Len() before doing any actions

func (List) Push added in v0.25.0 

func (m List) Push(value interface{})

Push() inserts the element to the end of the list It will increase the length when it is called

func (List) Set added in v0.25.0 

func (m List) Set(index uint64, value interface{})

Set() stores the element to the given position Setting element out of range will break length counting Use Push() instead of Set() to append a new element

type MultiStore 

type MultiStore = types.MultiStore

Import cosmos-sdk/types/store.go for convenience. nolint

type MultiStoreProof added in v0.25.0 

type MultiStoreProof struct {
	StoreInfos []storeInfo
}

MultiStoreProof defines a collection of store proofs in a multi-store

func NewMultiStoreProof added in v0.26.0 

func NewMultiStoreProof(storeInfos []storeInfo) *MultiStoreProof

func (*MultiStoreProof) ComputeRootHash added in v0.26.0 

func (proof *MultiStoreProof) ComputeRootHash() []byte

ComputeRootHash returns the root hash for a given multi-store proof.

type MultiStoreProofOp added in v0.26.0 

type MultiStoreProofOp struct {

	// To encode in ProofOp.Data.
	Proof *MultiStoreProof `json:"proof"`
	// contains filtered or unexported fields
}

TODO: document

func NewMultiStoreProofOp added in v0.26.0 

func NewMultiStoreProofOp(key []byte, proof *MultiStoreProof) MultiStoreProofOp

func (MultiStoreProofOp) GetKey added in v0.26.0 

func (op MultiStoreProofOp) GetKey() []byte

GetKey returns the key for a multi-store proof operation.

func (MultiStoreProofOp) ProofOp added in v0.26.0 

func (op MultiStoreProofOp) ProofOp() merkle.ProofOp

ProofOp return a merkle proof operation from a given multi-store proof operation.

func (MultiStoreProofOp) Run added in v0.26.0 

func (op MultiStoreProofOp) Run(args [][]byte) ([][]byte, error)

Run executes a multi-store proof operation for a given value. It returns the root hash if the value matches all the store's commitID's hash or an error otherwise.

func (MultiStoreProofOp) String added in v0.26.0 

func (op MultiStoreProofOp) String() string

String implements the Stringer interface for a mult-store proof operation.

type PruningStrategy added in v0.24.0 

type PruningStrategy = types.PruningStrategy

Import cosmos-sdk/types/store.go for convenience. nolint

type Queryable 

type Queryable = types.Queryable

Import cosmos-sdk/types/store.go for convenience. nolint

type Queue added in v0.25.0 

type Queue struct {
	List List
}

Queue is a List wrapper that provides queue-like functions It panics when the element type cannot be (un/)marshalled by the codec

func NewQueue added in v0.25.0 

func NewQueue(cdc *codec.Codec, store sdk.KVStore) Queue

NewQueue constructs new Queue

func (Queue) Flush added in v0.25.0 

func (m Queue) Flush(ptr interface{}, fn func() bool)

Flush() removes elements it processed Return true in the continuation to break The interface{} is unmarshalled before the continuation is called Starts from the top(head) of the queue CONTRACT: Pop() or Push() should not be performed while flushing

func (Queue) IsEmpty added in v0.25.0 

func (m Queue) IsEmpty() bool

IsEmpty() checks if the queue is empty

func (Queue) Peek added in v0.25.0 

func (m Queue) Peek(ptr interface{}) error

Popping/Peeking on an empty queue will cause panic The user should check IsEmpty() before doing any actions Peek() returns the element at the front of the queue without removing it

func (Queue) Pop added in v0.25.0 

func (m Queue) Pop()

Pop() returns the element at the front of the queue and removes it

func (Queue) Push added in v0.25.0 

func (m Queue) Push(value interface{})

Push() inserts the elements to the rear of the queue

type Store 

type Store = types.Store

Import cosmos-sdk/types/store.go for convenience. nolint

type StoreKey 

type StoreKey = types.StoreKey

Import cosmos-sdk/types/store.go for convenience. nolint

type StoreType 

type StoreType = types.StoreType

Import cosmos-sdk/types/store.go for convenience. nolint

type TraceContext added in v0.21.0 

type TraceContext = types.TraceContext

Import cosmos-sdk/types/store.go for convenience. nolint

type TraceKVStore added in v0.21.0 

type TraceKVStore struct {
	// contains filtered or unexported fields
}

TraceKVStore implements the KVStore interface with tracing enabled. Operations are traced on each core KVStore call and written to the underlying io.writer.

TODO: Should we use a buffered writer and implement Commit on TraceKVStore?

func NewTraceKVStore added in v0.21.0 

func NewTraceKVStore(parent sdk.KVStore, writer io.Writer, tc TraceContext) *TraceKVStore

NewTraceKVStore returns a reference to a new traceKVStore given a parent KVStore implementation and a buffered writer.

func (*TraceKVStore) CacheWrap added in v0.21.0 

func (tkv *TraceKVStore) CacheWrap() sdk.CacheWrap

CacheWrap implements the KVStore interface. It panics as a TraceKVStore cannot be cache wrapped.

func (*TraceKVStore) CacheWrapWithTrace added in v0.21.0 

func (tkv *TraceKVStore) CacheWrapWithTrace(_ io.Writer, _ TraceContext) CacheWrap

CacheWrapWithTrace implements the KVStore interface. It panics as a TraceKVStore cannot be cache wrapped.

func (*TraceKVStore) Delete added in v0.21.0 

func (tkv *TraceKVStore) Delete(key []byte)

Delete implements the KVStore interface. It traces a write operation and delegates the Delete call to the parent KVStore.

func (*TraceKVStore) Gas added in v0.24.0 

func (tkv *TraceKVStore) Gas(meter GasMeter, config GasConfig) KVStore

Gas implements the KVStore interface.

func (*TraceKVStore) Get added in v0.21.0 

func (tkv *TraceKVStore) Get(key []byte) []byte

Get implements the KVStore interface. It traces a read operation and delegates a Get call to the parent KVStore.

func (*TraceKVStore) GetStoreType added in v0.21.0 

func (tkv *TraceKVStore) GetStoreType() sdk.StoreType

GetStoreType implements the KVStore interface. It returns the underlying KVStore type.

func (*TraceKVStore) Has added in v0.21.0 

func (tkv *TraceKVStore) Has(key []byte) bool

Has implements the KVStore interface. It delegates the Has call to the parent KVStore.

func (*TraceKVStore) Iterator added in v0.21.0 

func (tkv *TraceKVStore) Iterator(start, end []byte) sdk.Iterator

Iterator implements the KVStore interface. It delegates the Iterator call the to the parent KVStore.

func (*TraceKVStore) Prefix added in v0.21.0 

func (tkv *TraceKVStore) Prefix(prefix []byte) KVStore

Prefix implements the KVStore interface.

func (*TraceKVStore) ReverseIterator added in v0.21.0 

func (tkv *TraceKVStore) ReverseIterator(start, end []byte) sdk.Iterator

ReverseIterator implements the KVStore interface. It delegates the ReverseIterator call the to the parent KVStore.

func (*TraceKVStore) Set added in v0.21.0 

func (tkv *TraceKVStore) Set(key []byte, value []byte)

Set implements the KVStore interface. It traces a write operation and delegates the Set call to the parent KVStore.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.