Struct near_chain::ChainStore

pub struct ChainStore { /* fields omitted */ }

All chain-related database operations.

Implementations

impl ChainStore

pub fn new(store: Arc<Store>, genesis_height: BlockHeight) -> ChainStore

pub fn owned_store(&self) -> Arc<Store>

pub fn store_update(&mut self) -> ChainStoreUpdate<'_>

pub fn iterate_state_sync_infos(&self) -> Vec<(CryptoHash, StateSyncInfo)>

pub fn get_state_changes_for_split_states(
    &self,
    block_hash: &CryptoHash,
    shard_id: ShardId
) -> Result<StateChangesForSplitStates, Error>

pub fn get_outgoing_receipts_for_shard(
    &mut self,
    runtime_adapter: &dyn RuntimeAdapter,
    prev_block_hash: CryptoHash,
    shard_id: ShardId,
    last_included_height: BlockHeight
) -> Result<Vec<Receipt>, Error>

Get outgoing receipts that will be sent from shard shard_id from block whose prev block is prev_block_hash Note that the meaning of outgoing receipts here are slightly different from save_outgoing_receipts or get_outgoing_receipts. There, outgoing receipts for a shard refers to receipts that are generated from the shard from block prev_block_hash. Here, outgoing receipts for a shard refers to receipts that will be sent from this shard to other shards in the block after prev_block_hash The difference of one block is important because shard layout may change between the previous block and the current block and the meaning of shard_id will change.

Note, the current way of implementation assumes that at least one chunk is generated before shard layout are changed twice. This is not a problem right now because we are changing shard layout for the first time for simple nightshade and generally not a problem if shard layout changes very rarely. But we need to implement a more theoretically correct algorithm if shard layouts will change more often in the future https://github.com/near/nearcore/issues/4877

pub fn check_transaction_validity_period(
    &mut self,
    prev_block_header: &BlockHeader,
    base_block_hash: &CryptoHash,
    validity_period: BlockHeight
) -> Result<(), InvalidTxError>

For a given transaction, it expires if the block that the chunk points to is more than validity_period ahead of the block that has base_block_hash.

impl ChainStore

pub fn get_outcomes_by_id(
    &self,
    id: &CryptoHash
) -> Result<Vec<ExecutionOutcomeWithIdAndProof>, Error>

Returns all outcomes generated by applying transaction or receipt with the given id.

pub fn get_outcomes_by_block_hash_and_shard_id(
    &self,
    block_hash: &CryptoHash,
    shard_id: ShardId
) -> Result<Vec<CryptoHash>, Error>

Returns a vector of Outcome ids for given block and shard id

pub fn get_all_block_hashes_by_height(
    &mut self,
    height: BlockHeight
) -> Result<&HashMap<EpochId, HashSet<CryptoHash>>, Error>

Returns a hashmap of epoch id -> set of all blocks got for current (height, epoch_id)

pub fn get_all_chunk_hashes_by_height(
    &mut self,
    height: BlockHeight
) -> Result<HashSet<ChunkHash>, Error>

Returns a HashSet of Chunk Hashes for current Height

pub fn get_all_header_hashes_by_height(
    &mut self,
    height: BlockHeight
) -> Result<HashSet<CryptoHash>, Error>

Returns a HashSet of Header Hashes for current Height

pub fn get_state_header(
    &mut self,
    shard_id: ShardId,
    block_hash: CryptoHash
) -> Result<ShardStateSyncResponseHeader, Error>

pub fn get_latest_known(&mut self) -> Result<LatestKnown, Error>

Returns latest known height and time it was seen.

pub fn save_latest_known(
    &mut self,
    latest_known: LatestKnown
) -> Result<(), Error>

Save the latest known.

pub fn get_state_changes_in_block(
    &self,
    block_hash: &CryptoHash
) -> Result<StateChangesKinds, Error>

Retrieve the kinds of state changes occurred in a given block.

We store different types of data, so we prefer to only expose minimal information about the changes (i.e. a kind of the change and an account id).

pub fn get_state_changes_with_cause_in_block(
    &self,
    block_hash: &CryptoHash
) -> Result<StateChanges, Error>

pub fn get_state_changes(
    &self,
    block_hash: &CryptoHash,
    state_changes_request: &StateChangesRequest
) -> Result<StateChanges, Error>

Retrieve the key-value changes from the store and decode them appropriately.

We store different types of data, so we need to take care of all the types. That is, the account data and the access keys are internally-serialized and we have to deserialize those values appropriately. Code and data changes are simple blobs of data, so we return them as base64-encoded blobs.

Trait Implementations

impl ChainStoreAccess for ChainStore

fn head(&self) -> Result<Tip, Error>

The chain head.

fn tail(&self) -> Result<BlockHeight, Error>

The chain Blocks Tail height, used by GC.

fn chunk_tail(&self) -> Result<BlockHeight, Error>

The chain Chunks Tail height, used by GC.

fn head_header(&mut self) -> Result<&BlockHeader, Error>

Header of the block at the head of the block chain (not the same thing as header_head).

fn largest_target_height(&self) -> Result<BlockHeight, Error>

Largest height for which we created a doomslug endorsement

fn header_head(&self) -> Result<Tip, Error>

Head of the header chain (not the same thing as head_header).

fn final_head(&self) -> Result<Tip, Error>

Final head of the chain.

fn get_block(&mut self, h: &CryptoHash) -> Result<&Block, Error>

Get full block.

fn get_chunk(&mut self, chunk_hash: &ChunkHash) -> Result<&ShardChunk, Error>

Get full chunk.

fn get_partial_chunk(
    &mut self,
    chunk_hash: &ChunkHash
) -> Result<&PartialEncodedChunk, Error>

Get partial chunk.

fn block_exists(&self, h: &CryptoHash) -> Result<bool, Error>

Does this full block exist?

fn get_previous_header(
    &mut self,
    header: &BlockHeader
) -> Result<&BlockHeader, Error>

Get previous header.

fn get_block_extra(
    &mut self,
    block_hash: &CryptoHash
) -> Result<&BlockExtra, Error>

Information from applying block.

fn get_chunk_extra(
    &mut self,
    block_hash: &CryptoHash,
    shard_uid: &ShardUId
) -> Result<&ChunkExtra, Error>

Information from applying chunk.

fn get_block_header(&mut self, h: &CryptoHash) -> Result<&BlockHeader, Error>

Get block header.

fn get_block_hash_by_height(
    &mut self,
    height: BlockHeight
) -> Result<CryptoHash, Error>

Returns hash of the block on the main chain for given height.

fn get_outgoing_receipts(
    &mut self,
    prev_block_hash: &CryptoHash,
    shard_id: ShardId
) -> Result<&Vec<Receipt>, Error>

Get outgoing receipts generated from shard shard_id in block prev_hash Note that this function is different from get_outgoing_receipts_for_shard, see comments there

fn store(&self) -> &Store

Returns underlaying store.

fn fork_tail(&self) -> Result<BlockHeight, Error>

Tail height of the fork cleaning process.

fn get_next_block_hash(
    &mut self,
    hash: &CryptoHash
) -> Result<&CryptoHash, Error>

fn get_epoch_light_client_block(
    &mut self,
    hash: &CryptoHash
) -> Result<&LightClientBlockView, Error>

fn get_block_refcount(&mut self, block_hash: &CryptoHash) -> Result<&u64, Error>

Returns a number of references for Block with block_hash

fn get_any_chunk_hash_by_height_shard(
    &mut self,
    height: BlockHeight,
    shard_id: ShardId
) -> Result<&ChunkHash, Error>

Check if we saw chunk hash at given height and shard id.

fn get_incoming_receipts(
    &mut self,
    block_hash: &CryptoHash,
    shard_id: ShardId
) -> Result<&Vec<ReceiptProof>, Error>

fn get_blocks_to_catchup(
    &self,
    hash: &CryptoHash
) -> Result<Vec<CryptoHash>, Error>

fn is_block_challenged(&mut self, hash: &CryptoHash) -> Result<bool, Error>

Returns whether the block with the given hash was challenged

fn is_invalid_chunk(
    &mut self,
    chunk_hash: &ChunkHash
) -> Result<Option<&EncodedShardChunk>, Error>

Returns encoded chunk if it’s invalid otherwise None.

fn get_shard_id_for_receipt_id(
    &mut self,
    receipt_id: &CryptoHash
) -> Result<&ShardId, Error>

Get destination shard id for receipt id.

fn get_next_block_hash_with_new_chunk(
    &mut self,
    block_hash: &CryptoHash,
    shard_id: u64
) -> Result<Option<&CryptoHash>, Error>

For a given block and a given shard, get the next block hash where a new chunk for the shard is included.

fn get_last_block_with_new_chunk(
    &mut self,
    shard_id: u64
) -> Result<Option<&CryptoHash>, Error>

fn get_transaction(
    &mut self,
    tx_hash: &CryptoHash
) -> Result<Option<&SignedTransaction>, Error>

fn get_receipt(
    &mut self,
    receipt_id: &CryptoHash
) -> Result<Option<&Receipt>, Error>

fn get_genesis_height(&self) -> BlockHeight

fn get_block_merkle_tree(
    &mut self,
    block_hash: &CryptoHash
) -> Result<&PartialMerkleTree, Error>

fn get_block_hash_from_ordinal(
    &mut self,
    block_ordinal: NumBlocks
) -> Result<&CryptoHash, Error>

fn is_height_processed(&mut self, height: BlockHeight) -> Result<bool, Error>

fn get_chunk_clone_from_header(
    &mut self,
    header: &ShardChunkHeader
) -> Result<ShardChunk, Error>

Get full chunk from header, with possible error that contains the header for further retrieval.

fn get_earliest_block_hash(&mut self) -> Result<Option<CryptoHash>, Error>

Returns hash of the first available block after genesis.

fn get_header_by_height(
    &mut self,
    height: BlockHeight
) -> Result<&BlockHeader, Error>

Returns block header from the current chain for given height if present.

fn get_header_on_chain_by_height(
    &mut self,
    sync_hash: &CryptoHash,
    height: BlockHeight
) -> Result<&BlockHeader, Error>

Returns block header from the current chain defined by sync_hash for given height if present.

fn get_block_merkle_tree_from_ordinal(
    &mut self,
    block_ordinal: NumBlocks
) -> Result<&PartialMerkleTree, Error>

fn get_block_height(&mut self, hash: &CryptoHash) -> Result<BlockHeight, Error>

fn get_epoch_id_of_last_block_with_chunk(
    &mut self,
    runtime_adapter: &dyn RuntimeAdapter,
    hash: &CryptoHash,
    shard_id: ShardId
) -> Result<EpochId, Error>

Get epoch id of the last block with existing chunk for the given shard id.