1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315
// Copyright (c) The Diem Core Contributors
// SPDX-License-Identifier: Apache-2.0
// Copyright 2021 Conflux Foundation. All rights reserved.
// Conflux is free software and distributed under GNU General Public License.
// See http://www.gnu.org/licenses/
//! This file defines event store APIs that are related to the event accumulator
//! and events themselves.
#![allow(unused)]
use super::PosLedgerDB;
use crate::{
change_set::ChangeSet,
errors::DiemDbError,
ledger_counters::{LedgerCounter, LedgerCounterBumps},
schema::{
event::EventSchema, event_accumulator::EventAccumulatorSchema,
event_by_key::EventByKeySchema, event_by_version::EventByVersionSchema,
},
};
use accumulator::{HashReader, MerkleAccumulator};
use anyhow::{ensure, format_err, Result};
use diem_crypto::{
hash::{CryptoHash, EventAccumulatorHasher},
HashValue,
};
use diem_types::{
account_address::AccountAddress,
block_metadata::new_block_event_key,
contract_event::ContractEvent,
event::EventKey,
proof::{position::Position, EventAccumulatorProof, EventProof},
transaction::Version,
};
use schemadb::{schema::ValueCodec, ReadOptions, SchemaIterator, DB};
use std::{
convert::{TryFrom, TryInto},
iter::Peekable,
sync::Arc,
};
#[derive(Debug)]
pub(crate) struct EventStore {
db: Arc<DB>,
}
impl EventStore {
pub fn new(db: Arc<DB>) -> Self { Self { db } }
/// Get all of the events given a transaction version.
/// We don't need a proof for this because it's only used to get all events
/// for a version which can be proved from the root hash of the event tree.
pub fn get_events_by_version(
&self, version: Version,
) -> Result<Vec<ContractEvent>> {
let mut events = vec![];
let mut iter = self.db.iter::<EventSchema>(ReadOptions::default())?;
// Grab the first event and then iterate until we get all events for
// this version.
iter.seek(&version)?;
while let Some(((ver, index), event)) = iter.next().transpose()? {
if ver != version {
break;
}
events.push(event);
}
Ok(events)
}
pub fn get_events_by_version_iter(
&self, start_version: Version, num_versions: usize,
) -> Result<EventsByVersionIter> {
let mut iter = self.db.iter::<EventSchema>(Default::default())?;
iter.seek(&start_version)?;
Ok(EventsByVersionIter {
inner: iter.peekable(),
expected_next_version: start_version,
end_version: start_version
.checked_add(num_versions as u64)
.ok_or_else(|| format_err!("Too many versions requested."))?,
})
}
fn get_event_by_version_and_index(
&self, version: Version, index: u64,
) -> Result<ContractEvent> {
self.db
.get::<EventSchema>(&(version, index))?
.ok_or_else(|| {
DiemDbError::NotFound(format!(
"Event {} of Txn {}",
index, version
))
.into()
})
}
/// Get the event raw data given transaction version and the index of the
/// event queried.
pub fn get_event_with_proof_by_version_and_index(
&self, version: Version, index: u64,
) -> Result<(ContractEvent, EventAccumulatorProof)> {
// Get event content.
let event = self.get_event_by_version_and_index(version, index)?;
// Get the number of events in total for the transaction at `version`.
let mut iter = self.db.iter::<EventSchema>(ReadOptions::default())?;
iter.seek_for_prev(&(version + 1))?;
let num_events = match iter.next().transpose()? {
Some(((ver, index), _)) if ver == version => (index + 1),
_ => unreachable!(), /* since we've already got at least one
* event above */
};
// Get proof.
let proof = Accumulator::get_proof(
&EventHashReader::new(self, version),
num_events,
index,
)?;
Ok((event, proof))
}
// fn get_event_by_key(
// &self, event_key: &EventKey, seq_num: u64, ledger_version: Version,
// ) -> Result<ContractEvent> {
// let (version, index) =
// self.lookup_event_by_key(event_key, seq_num, ledger_version)?;
// self.get_event_by_version_and_index(version, index)
// }
// /// Given `event_key` and `start_seq_num`, returns events identified by
// /// transaction version and index among all events emitted by the same
// /// transaction. Result won't contain records with a transaction version
// /// > `ledger_version` and is in ascending order.
// pub fn lookup_events_by_key(
// &self, event_key: &EventKey, start_seq_num: u64, limit: u64,
// ledger_version: u64,
// ) -> Result<
// Vec<(
// Version, // transaction version it belongs to
// u64, // index among events for the same transaction
// )>,
// >
// {
// let mut iter =
// self.db.iter::<EventByKeySchema>(ReadOptions::default())?;
// iter.seek(event_key)?;
//
// let mut result = Vec::new();
// let mut cur_seq = 0;
// for res in iter.take(limit as usize) {
// let (path, (ver, idx)) = res?;
// if path != *event_key || ver > ledger_version {
// break;
// }
// if cur_seq >= start_seq_num {
// result.push((ver, idx));
// }
// cur_seq += 1;
// }
//
// Ok(result)
// }
// fn lookup_event_by_key(
// &self, event_key: &EventKey, seq_num: u64, ledger_version: Version,
// ) -> Result<(Version, u64)> {
// let indices =
// self.lookup_events_by_key(event_key, seq_num, 1,
// ledger_version)?; if indices.is_empty() {
// return Err(DiemDbError::NotFound(format!(
// "Event {} of seq num {}.",
// event_key, seq_num
// ))
// .into());
// }
// let (version, index) = indices[0];
//
// Ok((version, index))
// }
/// Save contract events yielded by the transaction at `version` and return
/// root hash of the event accumulator formed by these events.
pub fn put_events(
&self, version: u64, events: &[ContractEvent], cs: &mut ChangeSet,
) -> Result<HashValue> {
cs.counter_bumps(version)
.bump(LedgerCounter::EventsCreated, events.len());
// Event table and indices updates
events.iter().enumerate().try_for_each::<_, Result<_>>(
|(idx, event)| {
cs.batch.put::<EventSchema>(&(version, idx as u64), event)?;
cs.batch.put::<EventByKeySchema>(
event.key(),
&(version, idx as u64),
)?;
cs.batch.put::<EventByVersionSchema>(
&(*event.key(), version),
&(idx as u64),
)?;
Ok(())
},
)?;
// EventAccumulatorSchema updates
let event_hashes: Vec<HashValue> =
events.iter().map(ContractEvent::hash).collect();
let (root_hash, writes) =
EmptyAccumulator::append(&EmptyReader, 0, &event_hashes)?;
writes.into_iter().try_for_each(|(pos, hash)| {
cs.batch
.put::<EventAccumulatorSchema>(&(version, pos), &hash)
})?;
Ok(root_hash)
}
pub(crate) fn put_events_multiple_versions(
&self, first_version: u64, event_vecs: &[Vec<ContractEvent>],
cs: &mut ChangeSet,
) -> Result<Vec<HashValue>> {
event_vecs
.iter()
.enumerate()
.map(|(idx, events)| {
let version = first_version
.checked_add(idx as Version)
.ok_or_else(|| format_err!("version overflow"))?;
self.put_events(version, events, cs)
})
.collect::<Result<Vec<_>>>()
}
}
type Accumulator<'a> =
MerkleAccumulator<EventHashReader<'a>, EventAccumulatorHasher>;
struct EventHashReader<'a> {
store: &'a EventStore,
version: Version,
}
impl<'a> EventHashReader<'a> {
fn new(store: &'a EventStore, version: Version) -> Self {
Self { store, version }
}
}
impl<'a> HashReader for EventHashReader<'a> {
fn get(&self, position: Position) -> Result<HashValue> {
self.store
.db
.get::<EventAccumulatorSchema>(&(self.version, position))?
.ok_or_else(|| {
format_err!("Hash at position {:?} not found.", position)
})
}
}
type EmptyAccumulator = MerkleAccumulator<EmptyReader, EventAccumulatorHasher>;
struct EmptyReader;
// Asserts `get()` is never called.
impl HashReader for EmptyReader {
fn get(&self, _position: Position) -> Result<HashValue> { unreachable!() }
}
pub struct EventsByVersionIter<'a> {
inner: Peekable<SchemaIterator<'a, EventSchema>>,
expected_next_version: Version,
end_version: Version,
}
impl<'a> EventsByVersionIter<'a> {
fn next_impl(&mut self) -> Result<Option<Vec<ContractEvent>>> {
if self.expected_next_version >= self.end_version {
return Ok(None);
}
let mut ret = Vec::new();
while let Some(res) = self.inner.peek() {
let ((version, _index), _event) = res.as_ref().map_err(|e| {
format_err!("Hit error iterating events: {}", e)
})?;
if *version != self.expected_next_version {
break;
}
let ((_version, _index), event) =
self.inner.next().transpose()?.expect("Known to exist.");
ret.push(event);
}
self.expected_next_version = self
.expected_next_version
.checked_add(1)
.ok_or_else(|| format_err!("expected version overflowed."))?;
Ok(Some(ret))
}
}
impl<'a> Iterator for EventsByVersionIter<'a> {
type Item = Result<Vec<ContractEvent>>;
fn next(&mut self) -> Option<Self::Item> { self.next_impl().transpose() }
}
#[cfg(test)]
mod test;