cosmos/store

Table of Contents

• cosmos/store/internal/kv/v1beta1/kv.proto
  • MPair
  • MPairs
• cosmos/store/snapshots/v1/snapshot.proto
  • MMetadata
  • MSnapshot
  • MSnapshotExtensionMeta
  • MSnapshotExtensionPayload
  • MSnapshotIAVLItem
  • MSnapshotItem
  • MSnapshotStoreItem
• cosmos/store/streaming/abci/grpc.proto
  • MListenCommitRequest
  • MListenCommitResponse
  • MListenFinalizeBlockRequest
  • MListenFinalizeBlockResponse
  • SABCIListenerService
• cosmos/store/v1beta1/commit_info.proto
  • MCommitID
  • MCommitInfo
  • MStoreInfo
• cosmos/store/v1beta1/listening.proto
  • MBlockMetadata
  • MStoreKVPair
• Scalar Value Types

cosmos/store/internal/kv/v1beta1/kv.proto

Top

Pair

Pair defines a key/value bytes tuple.

Field	Type	Label	Description
key	bytes
value	bytes

Pairs

Pairs defines a repeated slice of Pair objects.

Field	Type	Label	Description
pairs	Pair	repeated

cosmos/store/snapshots/v1/snapshot.proto

Top

Metadata

Metadata contains SDK-specific snapshot metadata.

Field	Type	Label	Description
chunk_hashes	bytes	repeated	SHA-256 chunk hashes

Snapshot

Snapshot contains Tendermint state sync snapshot info.

Field	Type	Label	Description
height	uint64
format	uint32
chunks	uint32
hash	bytes
metadata	Metadata

SnapshotExtensionMeta

SnapshotExtensionMeta contains metadata about an external snapshotter.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
name	string
format	uint32

SnapshotExtensionPayload

SnapshotExtensionPayload contains payloads of an external snapshotter.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
payload	bytes

SnapshotIAVLItem

SnapshotIAVLItem is an exported IAVL node.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
key	bytes
value	bytes
version	int64		version is block height
height	int32		height is depth of the tree.

SnapshotItem

SnapshotItem is an item contained in a rootmulti.Store snapshot.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
store	SnapshotStoreItem
iavl	SnapshotIAVLItem
extension	SnapshotExtensionMeta
extension_payload	SnapshotExtensionPayload

SnapshotStoreItem

SnapshotStoreItem contains metadata about a snapshotted store.

Since: cosmos-sdk 0.46

Field	Type	Label	Description
name	string

cosmos/store/streaming/abci/grpc.proto

Top

ListenCommitRequest

ListenCommitRequest is the request type for the ListenCommit RPC method

Field	Type	Label	Description
block_height	int64		explicitly pass in block height as ResponseCommit does not contain this info
res	tendermint.abci.ResponseCommit
change_set	cosmos.store.v1beta1.StoreKVPair	repeated

ListenCommitResponse

ListenCommitResponse is the response type for the ListenCommit RPC method

ListenFinalizeBlockRequest

ListenEndBlockRequest is the request type for the ListenEndBlock RPC method

Field	Type	Label	Description
req	tendermint.abci.RequestFinalizeBlock
res	tendermint.abci.ResponseFinalizeBlock

ListenFinalizeBlockResponse

ListenEndBlockResponse is the response type for the ListenEndBlock RPC method

ABCIListenerService

ABCIListenerService is the service for the BaseApp ABCIListener interface

Method Name	Request Type	Response Type	Description
ListenFinalizeBlock	ListenFinalizeBlockRequest	ListenFinalizeBlockResponse	ListenFinalizeBlock is the corresponding endpoint for ABCIListener.ListenEndBlock
ListenCommit	ListenCommitRequest	ListenCommitResponse	ListenCommit is the corresponding endpoint for ABCIListener.ListenCommit

cosmos/store/v1beta1/commit_info.proto

Top

CommitID

CommitID defines the commitment information when a specific store is

committed.

Field	Type	Label	Description
version	int64
hash	bytes

CommitInfo

CommitInfo defines commit information used by the multi-store when committing

a version/height.

Field	Type	Label	Description
version	int64
store_infos	StoreInfo	repeated
timestamp	google.protobuf.Timestamp

StoreInfo

StoreInfo defines store-specific commit information. It contains a reference

between a store name and the commit ID.

Field	Type	Label	Description
name	string
commit_id	CommitID

cosmos/store/v1beta1/listening.proto

Top

BlockMetadata

BlockMetadata contains all the abci event data of a block

the file streamer dump them into files together with the state changes.

Field	Type	Label	Description
response_commit	tendermint.abci.ResponseCommit
request_finalize_block	tendermint.abci.RequestFinalizeBlock
response_finalize_block	tendermint.abci.ResponseFinalizeBlock		TODO: should we renumber this?

StoreKVPair

StoreKVPair is a KVStore KVPair used for listening to state changes (Sets and Deletes)

It optionally includes the StoreKey for the originating KVStore and a Boolean flag to distinguish between Sets and

Deletes

Since: cosmos-sdk 0.43

Field	Type	Label	Description
store_key	string		the store key for the KVStore this pair originates from
delete	bool		true indicates a delete operation, false indicates a set operation
key	bytes
value	bytes

Scalar Value Types

.proto Type	Notes	Python Type
double		float
float		float
int32	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.	int
int64	Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.	int/long
uint32	Uses variable-length encoding.	int/long
uint64	Uses variable-length encoding.	int/long
sint32	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.	int
sint64	Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.	int/long
fixed32	Always four bytes. More efficient than uint32 if values are often greater than 2^28.	int
fixed64	Always eight bytes. More efficient than uint64 if values are often greater than 2^56.	int/long
sfixed32	Always four bytes.	int
sfixed64	Always eight bytes.	int/long
bool		boolean
string	A string must always contain UTF-8 encoded or 7-bit ASCII text.	str/unicode
bytes	May contain any arbitrary sequence of bytes.	str