# Copyright (c) 2016, Neil Booth # Copyright (c) 2017, the ElectrumX authors # # All rights reserved. # # See the file "LICENCE" for information about the copyright # and warranty status of this software. """Interface to the blockchain database.""" import asyncio import array import os import time import typing import struct import attr import zlib import base64 from typing import Optional, Iterable from functools import partial from asyncio import sleep from bisect import bisect_right, bisect_left from collections import defaultdict from glob import glob from struct import pack, unpack from concurrent.futures.thread import ThreadPoolExecutor from lbry.utils import LRUCacheWithMetrics from lbry.schema.url import URL from lbry.wallet.server import util from lbry.wallet.server.hash import hash_to_hex_str, CLAIM_HASH_LEN from lbry.wallet.server.tx import TxInput from lbry.wallet.server.merkle import Merkle, MerkleCache from lbry.wallet.server.util import formatted_time, pack_be_uint16, unpack_be_uint16_from from lbry.wallet.server.storage import db_class from lbry.wallet.server.db.revertable import RevertablePut, RevertableDelete, RevertableOp, delete_prefix from lbry.wallet.server.db import DB_PREFIXES from lbry.wallet.server.db.prefixes import Prefixes, PendingActivationValue, ClaimTakeoverValue, ClaimToTXOValue from lbry.wallet.server.db.claimtrie import StagedClaimtrieItem, get_update_effective_amount_ops, length_encoded_name from lbry.wallet.server.db.claimtrie import get_expiration_height, get_delay_for_name from lbry.wallet.server.db.elasticsearch import SearchIndex class UTXO(typing.NamedTuple): tx_num: int tx_pos: int tx_hash: bytes height: int value: int TXO_STRUCT = struct.Struct(b'>LH') TXO_STRUCT_unpack = TXO_STRUCT.unpack TXO_STRUCT_pack = TXO_STRUCT.pack HISTORY_PREFIX = b'A' TX_PREFIX = b'B' BLOCK_HASH_PREFIX = b'C' HEADER_PREFIX = b'H' TX_NUM_PREFIX = b'N' TX_COUNT_PREFIX = b'T' UNDO_PREFIX = b'U' TX_HASH_PREFIX = b'X' HASHX_UTXO_PREFIX = b'h' UTXO_PREFIX = b'u' HASHX_HISTORY_PREFIX = b'x' @attr.s(slots=True) class FlushData: height = attr.ib() tx_count = attr.ib() headers = attr.ib() block_hashes = attr.ib() block_txs = attr.ib() claimtrie_stash = attr.ib() # The following are flushed to the UTXO DB if undo_infos is not None undo_infos = attr.ib() adds = attr.ib() deletes = attr.ib() tip = attr.ib() undo = attr.ib() class ResolveResult(typing.NamedTuple): name: str claim_hash: bytes tx_num: int position: int tx_hash: bytes height: int amount: int short_url: str is_controlling: bool canonical_url: str creation_height: int activation_height: int expiration_height: int effective_amount: int support_amount: int last_takeover_height: Optional[int] claims_in_channel: Optional[int] channel_hash: Optional[bytes] reposted_claim_hash: Optional[bytes] OptionalResolveResultOrError = Optional[typing.Union[ResolveResult, LookupError, ValueError]] DB_STATE_STRUCT = struct.Struct(b'>32sLL32sHLBBlll') DB_STATE_STRUCT_SIZE = 92 class DBState(typing.NamedTuple): genesis: bytes height: int tx_count: int tip: bytes utxo_flush_count: int wall_time: int first_sync: bool db_version: int hist_flush_count: int comp_flush_count: int comp_cursor: int def pack(self) -> bytes: return DB_STATE_STRUCT.pack( self.genesis, self.height, self.tx_count, self.tip, self.utxo_flush_count, self.wall_time, 1 if self.first_sync else 0, self.db_version, self.hist_flush_count, self.comp_flush_count, self.comp_cursor ) @classmethod def unpack(cls, packed: bytes) -> 'DBState': return cls(*DB_STATE_STRUCT.unpack(packed[:DB_STATE_STRUCT_SIZE])) class LevelDB: """Simple wrapper of the backend database for querying. Performs no DB update, though the DB will be cleaned on opening if it was shutdown uncleanly. """ DB_VERSIONS = HIST_DB_VERSIONS = [7] class DBError(Exception): """Raised on general DB errors generally indicating corruption.""" def __init__(self, env): self.logger = util.class_logger(__name__, self.__class__.__name__) self.env = env self.coin = env.coin self.executor = None self.logger.info(f'switching current directory to {env.db_dir}') self.db_class = db_class(env.db_dir, self.env.db_engine) self.db = None self.hist_unflushed = defaultdict(partial(array.array, 'I')) self.hist_unflushed_count = 0 self.hist_flush_count = 0 self.hist_comp_flush_count = -1 self.hist_comp_cursor = -1 self.tx_counts = None self.headers = None self.encoded_headers = LRUCacheWithMetrics(1 << 21, metric_name='encoded_headers', namespace='wallet_server') self.last_flush = time.time() self.logger.info(f'using {self.env.db_engine} for DB backend') # Header merkle cache self.merkle = Merkle() self.header_mc = MerkleCache(self.merkle, self.fs_block_hashes) self.headers_db = None self.tx_db = None self._tx_and_merkle_cache = LRUCacheWithMetrics(2 ** 17, metric_name='tx_and_merkle', namespace="wallet_server") self.total_transactions = None self.transaction_num_mapping = {} # Search index self.search_index = SearchIndex(self.env.es_index_prefix, self.env.database_query_timeout) def claim_hash_and_name_from_txo(self, tx_num: int, tx_idx: int): claim_hash_and_name = self.db.get(Prefixes.txo_to_claim.pack_key(tx_num, tx_idx)) if not claim_hash_and_name: return return Prefixes.txo_to_claim.unpack_value(claim_hash_and_name) def get_supported_claim_from_txo(self, tx_num: int, position: int) -> typing.Tuple[Optional[bytes], Optional[int]]: key = Prefixes.support_to_claim.pack_key(tx_num, position) supported_claim_hash = self.db.get(key) if supported_claim_hash: packed_support_amount = self.db.get( Prefixes.claim_to_support.pack_key(supported_claim_hash, tx_num, position) ) if packed_support_amount: return supported_claim_hash, Prefixes.claim_to_support.unpack_value(packed_support_amount).amount return None, None def get_support_amount(self, claim_hash: bytes): total = 0 for packed in self.db.iterator(prefix=DB_PREFIXES.claim_to_support.value + claim_hash, include_key=False): total += Prefixes.claim_to_support.unpack_value(packed).amount return total def get_supports(self, claim_hash: bytes): supports = [] for k, v in self.db.iterator(prefix=DB_PREFIXES.claim_to_support.value + claim_hash): unpacked_k = Prefixes.claim_to_support.unpack_key(k) unpacked_v = Prefixes.claim_to_support.unpack_value(v) supports.append((unpacked_k.tx_num, unpacked_k.position, unpacked_v.amount)) return supports def _prepare_resolve_result(self, tx_num: int, position: int, claim_hash: bytes, name: str, root_tx_num: int, root_position: int, activation_height: int) -> ResolveResult: controlling_claim = self.get_controlling_claim(name) tx_hash = self.total_transactions[tx_num] height = bisect_right(self.tx_counts, tx_num) created_height = bisect_right(self.tx_counts, root_tx_num) last_take_over_height = controlling_claim.height expiration_height = get_expiration_height(height) support_amount = self.get_support_amount(claim_hash) claim_amount = self.get_claim_txo_amount(claim_hash, tx_num, position) effective_amount = support_amount + claim_amount channel_hash = self.get_channel_for_claim(claim_hash) claims_in_channel = None short_url = f'{name}#{claim_hash.hex()}' canonical_url = short_url if channel_hash: channel_vals = self.get_root_claim_txo_and_current_amount(channel_hash) if channel_vals: channel_name = channel_vals[1].name claims_in_channel = self.get_claims_in_channel_count(channel_hash) canonical_url = f'{channel_name}#{channel_hash.hex()}/{name}#{claim_hash.hex()}' return ResolveResult( name, claim_hash, tx_num, position, tx_hash, height, claim_amount, short_url=short_url, is_controlling=controlling_claim.claim_hash == claim_hash, canonical_url=canonical_url, last_takeover_height=last_take_over_height, claims_in_channel=claims_in_channel, creation_height=created_height, activation_height=activation_height, expiration_height=expiration_height, effective_amount=effective_amount, support_amount=support_amount, channel_hash=channel_hash, reposted_claim_hash=None ) def _resolve(self, normalized_name: str, claim_id: Optional[str] = None, amount_order: Optional[int] = None) -> Optional[ResolveResult]: """ :param normalized_name: name :param claim_id: partial or complete claim id :param amount_order: '$' suffix to a url, defaults to 1 (winning) if no claim id modifier is provided """ if not amount_order and not claim_id: # winning resolution controlling = self.get_controlling_claim(normalized_name) if not controlling: return return self._fs_get_claim_by_hash(controlling.claim_hash) encoded_name = length_encoded_name(normalized_name) amount_order = max(int(amount_order or 1), 1) if claim_id: # resolve by partial/complete claim id short_claim_hash = bytes.fromhex(claim_id) prefix = DB_PREFIXES.claim_short_id_prefix.value + encoded_name + short_claim_hash for k, v in self.db.iterator(prefix=prefix): key = Prefixes.claim_short_id.unpack_key(k) claim_txo = Prefixes.claim_short_id.unpack_value(v) return self._prepare_resolve_result( claim_txo.tx_num, claim_txo.position, key.claim_hash, key.name, key.root_tx_num, key.root_position, claim_txo.activation ) return # resolve by amount ordering, 1 indexed for idx, (k, v) in enumerate(self.db.iterator( prefix=DB_PREFIXES.claim_effective_amount_prefix.value + encoded_name)): if amount_order > idx + 1: continue key = Prefixes.claim_effective_amount.unpack_key(k) claim_val = Prefixes.claim_effective_amount.unpack_value(v) return self._prepare_resolve_result( key.tx_num, key.position, claim_val.claim_hash, key.name, claim_val.root_tx_num, claim_val.root_position, claim_val.activation ) return def _resolve_claim_in_channel(self, channel_hash: bytes, normalized_name: str): prefix = DB_PREFIXES.channel_to_claim.value + channel_hash + length_encoded_name(normalized_name) candidates = [] for k, v in self.db.iterator(prefix=prefix): key = Prefixes.channel_to_claim.unpack_key(k) stream = Prefixes.channel_to_claim.unpack_value(v) if not candidates or candidates[-1][-1] == key.effective_amount: candidates.append((stream.claim_hash, key.tx_num, key.position, key.effective_amount)) else: break if not candidates: return return list(sorted(candidates, key=lambda item: item[1]))[0] def _fs_resolve(self, url) -> typing.Tuple[OptionalResolveResultOrError, OptionalResolveResultOrError]: try: parsed = URL.parse(url) except ValueError as e: return e, None stream = channel = resolved_channel = resolved_stream = None if parsed.has_stream_in_channel: channel = parsed.channel stream = parsed.stream elif parsed.has_channel: channel = parsed.channel elif parsed.has_stream: stream = parsed.stream if channel: resolved_channel = self._resolve(channel.normalized, channel.claim_id, channel.amount_order) if not resolved_channel: return None, LookupError(f'Could not find channel in "{url}".') if stream: if resolved_channel: stream_claim = self._resolve_claim_in_channel(resolved_channel.claim_hash, stream.normalized) if stream_claim: stream_claim_id, stream_tx_num, stream_tx_pos, effective_amount = stream_claim resolved_stream = self._fs_get_claim_by_hash(stream_claim_id) else: resolved_stream = self._resolve(stream.normalized, stream.claim_id, stream.amount_order) if not channel and not resolved_channel and resolved_stream and resolved_stream.channel_hash: resolved_channel = self._fs_get_claim_by_hash(resolved_stream.channel_hash) if not resolved_stream: return LookupError(f'Could not find claim at "{url}".'), None return resolved_stream, resolved_channel async def fs_resolve(self, url) -> typing.Tuple[OptionalResolveResultOrError, OptionalResolveResultOrError]: return await asyncio.get_event_loop().run_in_executor(self.executor, self._fs_resolve, url) def _fs_get_claim_by_hash(self, claim_hash): for k, v in self.db.iterator(prefix=DB_PREFIXES.claim_to_txo.value + claim_hash): unpacked_k = Prefixes.claim_to_txo.unpack_key(k) unpacked_v = Prefixes.claim_to_txo.unpack_value(v) return self._prepare_resolve_result( unpacked_k.tx_num, unpacked_k.position, unpacked_k.claim_hash, unpacked_v.name, unpacked_v.root_tx_num, unpacked_v.root_position, unpacked_v.activation ) async def fs_getclaimbyid(self, claim_id): return await asyncio.get_event_loop().run_in_executor( self.executor, self._fs_get_claim_by_hash, bytes.fromhex(claim_id) ) def claim_exists(self, claim_hash: bytes): for _ in self.db.iterator(prefix=DB_PREFIXES.claim_to_txo.value + claim_hash, include_value=False): return True return False def get_root_claim_txo_and_current_amount(self, claim_hash): for k, v in self.db.iterator(prefix=DB_PREFIXES.claim_to_txo.value + claim_hash): unpacked_k = Prefixes.claim_to_txo.unpack_key(k) unpacked_v = Prefixes.claim_to_txo.unpack_value(v) return unpacked_k, unpacked_v def make_staged_claim_item(self, claim_hash: bytes) -> Optional[StagedClaimtrieItem]: claim_info = self.get_root_claim_txo_and_current_amount(claim_hash) k, v = claim_info root_tx_num = v.root_tx_num root_idx = v.root_position value = v.amount name = v.name tx_num = k.tx_num idx = k.position height = bisect_right(self.tx_counts, tx_num) effective_amount = self.get_support_amount(claim_hash) + value signing_hash = self.get_channel_for_claim(claim_hash) activation_height = v.activation if signing_hash: count = self.get_claims_in_channel_count(signing_hash) else: count = 0 return StagedClaimtrieItem( name, claim_hash, value, effective_amount, activation_height, get_expiration_height(height), tx_num, idx, root_tx_num, root_idx, signing_hash, count ) def get_claim_txo_amount(self, claim_hash: bytes, tx_num: int, position: int) -> Optional[int]: v = self.db.get(Prefixes.claim_to_txo.pack_key(claim_hash, tx_num, position)) if v: return Prefixes.claim_to_txo.unpack_value(v).amount def get_claim_from_txo(self, claim_hash: bytes) -> Optional[ClaimToTXOValue]: assert claim_hash for v in self.db.iterator(prefix=DB_PREFIXES.claim_to_txo.value + claim_hash, include_key=False): return Prefixes.claim_to_txo.unpack_value(v) def get_claim_amount(self, claim_hash: bytes) -> Optional[int]: claim = self.get_claim_from_txo(claim_hash) if claim: return claim.amount def get_effective_amount(self, claim_hash: bytes): return (self.get_claim_amount(claim_hash) or 0) + self.get_support_amount(claim_hash) def get_update_effective_amount_ops(self, claim_hash: bytes, effective_amount: int): claim_info = self.get_root_claim_txo_and_current_amount(claim_hash) if not claim_info: return [] root_tx_num = claim_info[1].root_tx_num root_position = claim_info[1].root_position amount = claim_info[1].amount name = claim_info[1].name tx_num = claim_info[0].tx_num position = claim_info[0].position activation = claim_info[1].activation signing_hash = self.get_channel_for_claim(claim_hash) claims_in_channel_count = None if signing_hash: claims_in_channel_count = self.get_claims_in_channel_count(signing_hash) prev_effective_amount = self.get_effective_amount(claim_hash) return get_update_effective_amount_ops( name, effective_amount, prev_effective_amount, tx_num, position, root_tx_num, root_position, claim_hash, activation, activation, signing_hash, claims_in_channel_count ) def get_claims_in_channel_count(self, channel_hash) -> int: for v in self.db.iterator(prefix=DB_PREFIXES.channel_to_claim.value + channel_hash, include_key=False): return Prefixes.channel_to_claim.unpack_value(v).claims_in_channel return 0 def get_channel_for_claim(self, claim_hash) -> Optional[bytes]: return self.db.get(DB_PREFIXES.claim_to_channel.value + claim_hash) def get_expired_by_height(self, height: int): expired = {} for _k, _v in self.db.iterator(prefix=DB_PREFIXES.claim_expiration.value + struct.pack(b'>L', height)): k, v = Prefixes.claim_expiration.unpack_item(_k, _v) tx_hash = self.total_transactions[k.tx_num] tx = self.coin.transaction(self.db.get(DB_PREFIXES.TX_PREFIX.value + tx_hash)) # treat it like a claim spend so it will delete/abandon properly # the _spend_claim function this result is fed to expects a txi, so make a mock one expired[v.claim_hash] = ( k.tx_num, k.position, v.name, TxInput(prev_hash=tx_hash, prev_idx=k.position, script=tx.outputs[k.position].pk_script, sequence=0) ) return expired def get_controlling_claim(self, name: str) -> Optional[ClaimTakeoverValue]: controlling = self.db.get(Prefixes.claim_takeover.pack_key(name)) if not controlling: return return Prefixes.claim_takeover.unpack_value(controlling) def get_claims_for_name(self, name: str): claim_hashes = set() for k in self.db.iterator(prefix=Prefixes.claim_short_id.prefix + length_encoded_name(name), include_value=False): claim_hashes.add(Prefixes.claim_short_id.unpack_key(k).claim_hash) return claim_hashes def get_activated_claims_at_height(self, height: int) -> typing.Set[PendingActivationValue]: claims = set() prefix = Prefixes.pending_activation.prefix + height.to_bytes(4, byteorder='big') for _v in self.db.iterator(prefix=prefix, include_key=False): v = Prefixes.pending_activation.unpack_value(_v) claims.add(v) return claims def get_activation_delay(self, claim_hash: bytes, name: str) -> int: controlling = self.get_controlling_claim(name) if not controlling: return 0 if claim_hash == controlling.claim_hash: return 0 return get_delay_for_name(self.db_height - controlling.height) async def _read_tx_counts(self): if self.tx_counts is not None: return # tx_counts[N] has the cumulative number of txs at the end of # height N. So tx_counts[0] is 1 - the genesis coinbase def get_counts(): return tuple( util.unpack_be_uint64(tx_count) for tx_count in self.db.iterator(prefix=TX_COUNT_PREFIX, include_key=False) ) tx_counts = await asyncio.get_event_loop().run_in_executor(self.executor, get_counts) assert len(tx_counts) == self.db_height + 1, f"{len(tx_counts)} vs {self.db_height + 1}" self.tx_counts = array.array('I', tx_counts) if self.tx_counts: assert self.db_tx_count == self.tx_counts[-1], \ f"{self.db_tx_count} vs {self.tx_counts[-1]} ({len(self.tx_counts)} counts)" else: assert self.db_tx_count == 0 async def _read_txids(self): def get_txids(): return list(self.db.iterator(prefix=TX_HASH_PREFIX, include_key=False)) start = time.perf_counter() self.logger.info("loading txids") txids = await asyncio.get_event_loop().run_in_executor(self.executor, get_txids) assert len(txids) == len(self.tx_counts) == 0 or len(txids) == self.tx_counts[-1] self.total_transactions = txids self.transaction_num_mapping = { txid: i for i, txid in enumerate(txids) } ts = time.perf_counter() - start self.logger.info("loaded %i txids in %ss", len(self.total_transactions), round(ts, 4)) async def _read_headers(self): if self.headers is not None: return def get_headers(): return [ header for header in self.db.iterator(prefix=HEADER_PREFIX, include_key=False) ] headers = await asyncio.get_event_loop().run_in_executor(self.executor, get_headers) assert len(headers) - 1 == self.db_height, f"{len(headers)} vs {self.db_height}" self.headers = headers async def _open_dbs(self, for_sync, compacting): if self.executor is None: self.executor = ThreadPoolExecutor(1) coin_path = os.path.join(self.env.db_dir, 'COIN') if not os.path.isfile(coin_path): with util.open_file(coin_path, create=True) as f: f.write(f'ElectrumX databases and metadata for ' f'{self.coin.NAME} {self.coin.NET}'.encode()) assert self.db is None self.db = self.db_class(f'lbry-{self.env.db_engine}', True) if self.db.is_new: self.logger.info('created new db: %s', f'lbry-{self.env.db_engine}') else: self.logger.info(f'opened db: %s', f'lbry-{self.env.db_engine}') # read db state self.read_db_state() # These are our state as we move ahead of DB state self.fs_height = self.db_height self.fs_tx_count = self.db_tx_count self.last_flush_tx_count = self.fs_tx_count # Log some stats self.logger.info(f'DB version: {self.db_version:d}') self.logger.info(f'coin: {self.coin.NAME}') self.logger.info(f'network: {self.coin.NET}') self.logger.info(f'height: {self.db_height:,d}') self.logger.info(f'tip: {hash_to_hex_str(self.db_tip)}') self.logger.info(f'tx count: {self.db_tx_count:,d}') if self.db.for_sync: self.logger.info(f'flushing DB cache at {self.env.cache_MB:,d} MB') if self.first_sync: self.logger.info(f'sync time so far: {util.formatted_time(self.wall_time)}') if self.hist_db_version not in self.DB_VERSIONS: msg = f'this software only handles DB versions {self.DB_VERSIONS}' self.logger.error(msg) raise RuntimeError(msg) self.logger.info(f'flush count: {self.hist_flush_count:,d}') # self.history.clear_excess(self.utxo_flush_count) # < might happen at end of compaction as both DBs cannot be # updated atomically if self.hist_flush_count > self.utxo_flush_count: self.logger.info('DB shut down uncleanly. Scanning for excess history flushes...') keys = [] for key, hist in self.db.iterator(prefix=DB_PREFIXES.HASHX_HISTORY_PREFIX.value): k = key[1:] flush_id, = unpack_be_uint16_from(k[-2:]) if flush_id > self.utxo_flush_count: keys.append(k) self.logger.info(f'deleting {len(keys):,d} history entries') self.hist_flush_count = self.utxo_flush_count with self.db.write_batch() as batch: for key in keys: batch.delete(DB_PREFIXES.HASHX_HISTORY_PREFIX.value + key) if keys: self.logger.info('deleted %i excess history entries', len(keys)) self.utxo_flush_count = self.hist_flush_count min_height = self.min_undo_height(self.db_height) keys = [] for key, hist in self.db.iterator(prefix=DB_PREFIXES.UNDO_PREFIX.value): height, = unpack('>I', key[-4:]) if height >= min_height: break keys.append(key) if keys: with self.db.write_batch() as batch: for key in keys: batch.delete(key) self.logger.info(f'deleted {len(keys):,d} stale undo entries') # delete old block files prefix = self.raw_block_prefix() paths = [path for path in glob(f'{prefix}[0-9]*') if len(path) > len(prefix) and int(path[len(prefix):]) < min_height] if paths: for path in paths: try: os.remove(path) except FileNotFoundError: pass self.logger.info(f'deleted {len(paths):,d} stale block files') # Read TX counts (requires meta directory) await self._read_tx_counts() if self.total_transactions is None: await self._read_txids() await self._read_headers() # start search index await self.search_index.start() def close(self): self.db.close() self.executor.shutdown(wait=True) self.executor = None async def open_for_compacting(self): await self._open_dbs(True, True) async def open_for_sync(self): """Open the databases to sync to the daemon. When syncing we want to reserve a lot of open files for the synchronization. When serving clients we want the open files for serving network connections. """ self.logger.info("opened for sync") await self._open_dbs(True, False) async def open_for_serving(self): """Open the databases for serving. If they are already open they are closed first. """ if self.db: return # self.logger.info('closing DBs to re-open for serving') # self.db.close() # self.history.close_db() # self.db = None await self._open_dbs(False, False) self.logger.info("opened for serving") # Header merkle cache async def populate_header_merkle_cache(self): self.logger.info('populating header merkle cache...') length = max(1, self.db_height - self.env.reorg_limit) start = time.time() await self.header_mc.initialize(length) elapsed = time.time() - start self.logger.info(f'header merkle cache populated in {elapsed:.1f}s') async def header_branch_and_root(self, length, height): return await self.header_mc.branch_and_root(length, height) # Flushing def assert_flushed(self, flush_data): """Asserts state is fully flushed.""" assert flush_data.tx_count == self.fs_tx_count == self.db_tx_count assert flush_data.height == self.fs_height == self.db_height assert flush_data.tip == self.db_tip assert not flush_data.headers assert not flush_data.block_txs assert not flush_data.adds assert not flush_data.deletes assert not flush_data.undo_infos assert not self.hist_unflushed def flush_dbs(self, flush_data: FlushData): """Flush out cached state. History is always flushed; UTXOs are flushed if flush_utxos.""" if flush_data.height == self.db_height: self.assert_flushed(flush_data) return start_time = time.time() prior_flush = self.last_flush tx_delta = flush_data.tx_count - self.last_flush_tx_count # Flush to file system # self.flush_fs(flush_data) prior_tx_count = (self.tx_counts[self.fs_height] if self.fs_height >= 0 else 0) assert len(flush_data.block_txs) == len(flush_data.headers) assert flush_data.height == self.fs_height + len(flush_data.headers) assert flush_data.tx_count == (self.tx_counts[-1] if self.tx_counts else 0) assert len(self.tx_counts) == flush_data.height + 1 assert len( b''.join(hashes for hashes, _ in flush_data.block_txs) ) // 32 == flush_data.tx_count - prior_tx_count, f"{len(b''.join(hashes for hashes, _ in flush_data.block_txs)) // 32} != {flush_data.tx_count}" # Write the headers start_time = time.perf_counter() with self.db.write_batch() as batch: self.put = batch.put batch_put = self.put batch_delete = batch.delete height_start = self.fs_height + 1 tx_num = prior_tx_count for i, (header, block_hash, (tx_hashes, txs)) in enumerate( zip(flush_data.headers, flush_data.block_hashes, flush_data.block_txs)): batch_put(DB_PREFIXES.HEADER_PREFIX.value + util.pack_be_uint64(height_start), header) self.headers.append(header) tx_count = self.tx_counts[height_start] batch_put(DB_PREFIXES.BLOCK_HASH_PREFIX.value + util.pack_be_uint64(height_start), block_hash[::-1]) batch_put(DB_PREFIXES.TX_COUNT_PREFIX.value + util.pack_be_uint64(height_start), util.pack_be_uint64(tx_count)) height_start += 1 offset = 0 while offset < len(tx_hashes): batch_put(DB_PREFIXES.TX_HASH_PREFIX.value + util.pack_be_uint64(tx_num), tx_hashes[offset:offset + 32]) batch_put(DB_PREFIXES.TX_NUM_PREFIX.value + tx_hashes[offset:offset + 32], util.pack_be_uint64(tx_num)) batch_put(DB_PREFIXES.TX_PREFIX.value + tx_hashes[offset:offset + 32], txs[offset // 32]) tx_num += 1 offset += 32 flush_data.headers.clear() flush_data.block_txs.clear() flush_data.block_hashes.clear() for staged_change in flush_data.claimtrie_stash: # print("ADVANCE", staged_change) if staged_change.is_put: batch_put(staged_change.key, staged_change.value) else: batch_delete(staged_change.key) flush_data.claimtrie_stash.clear() for undo_ops, height in flush_data.undo: batch_put(DB_PREFIXES.undo_claimtrie.value + util.pack_be_uint64(height), undo_ops) flush_data.undo.clear() self.fs_height = flush_data.height self.fs_tx_count = flush_data.tx_count # Then history self.hist_flush_count += 1 flush_id = pack_be_uint16(self.hist_flush_count) unflushed = self.hist_unflushed for hashX in sorted(unflushed): key = hashX + flush_id batch_put(DB_PREFIXES.HASHX_HISTORY_PREFIX.value + key, unflushed[hashX].tobytes()) unflushed.clear() self.hist_unflushed_count = 0 ######################### # New undo information for undo_info, height in flush_data.undo_infos: batch_put(self.undo_key(height), b''.join(undo_info)) flush_data.undo_infos.clear() # Spends for key in sorted(flush_data.deletes): batch_delete(key) flush_data.deletes.clear() # New UTXOs for key, value in flush_data.adds.items(): # suffix = tx_idx + tx_num hashX = value[:-12] suffix = key[-2:] + value[-12:-8] batch_put(DB_PREFIXES.HASHX_UTXO_PREFIX.value + key[:4] + suffix, hashX) batch_put(DB_PREFIXES.UTXO_PREFIX.value + hashX + suffix, value[-8:]) flush_data.adds.clear() # Flush state last as it reads the wall time. start_time = time.time() add_count = len(flush_data.adds) spend_count = len(flush_data.deletes) // 2 if self.db.for_sync: block_count = flush_data.height - self.db_height tx_count = flush_data.tx_count - self.db_tx_count elapsed = time.time() - start_time self.logger.info(f'flushed {block_count:,d} blocks with ' f'{tx_count:,d} txs, {add_count:,d} UTXO adds, ' f'{spend_count:,d} spends in ' f'{elapsed:.1f}s, committing...') self.utxo_flush_count = self.hist_flush_count self.db_height = flush_data.height self.db_tx_count = flush_data.tx_count self.db_tip = flush_data.tip # self.flush_state(batch) # now = time.time() self.wall_time += now - self.last_flush self.last_flush = now self.last_flush_tx_count = self.fs_tx_count self.write_db_state(batch) elapsed = self.last_flush - start_time self.logger.info(f'flush #{self.hist_flush_count:,d} took ' f'{elapsed:.1f}s. Height {flush_data.height:,d} ' f'txs: {flush_data.tx_count:,d} ({tx_delta:+,d})') # Catch-up stats if self.db.for_sync: flush_interval = self.last_flush - prior_flush tx_per_sec_gen = int(flush_data.tx_count / self.wall_time) tx_per_sec_last = 1 + int(tx_delta / flush_interval) self.logger.info(f'tx/sec since genesis: {tx_per_sec_gen:,d}, ' f'since last flush: {tx_per_sec_last:,d}') self.logger.info(f'sync time: {formatted_time(self.wall_time)}') def flush_backup(self, flush_data, touched): """Like flush_dbs() but when backing up. All UTXOs are flushed.""" assert not flush_data.headers assert not flush_data.block_txs assert flush_data.height < self.db_height assert not self.hist_unflushed start_time = time.time() tx_delta = flush_data.tx_count - self.last_flush_tx_count ### self.fs_tx_count = flush_data.tx_count # Truncate header_mc: header count is 1 more than the height. self.header_mc.truncate(flush_data.height + 1) ### # Not certain this is needed, but it doesn't hurt self.hist_flush_count += 1 nremoves = 0 with self.db.write_batch() as batch: batch_put = batch.put batch_delete = batch.delete claim_reorg_height = self.fs_height # print("flush undos", flush_data.undo_claimtrie) for (packed_ops, height) in reversed(flush_data.undo): undo_ops = RevertableOp.unpack_stack(packed_ops) for op in reversed(undo_ops): # print("REWIND", op) if op.is_put: batch_put(op.key, op.value) else: batch_delete(op.key) batch_delete(DB_PREFIXES.undo_claimtrie.value + util.pack_be_uint64(claim_reorg_height)) claim_reorg_height -= 1 flush_data.undo.clear() flush_data.claimtrie_stash.clear() while self.fs_height > flush_data.height: self.fs_height -= 1 self.headers.pop() tx_count = flush_data.tx_count for hashX in sorted(touched): deletes = [] puts = {} for key, hist in self.db.iterator(prefix=DB_PREFIXES.HASHX_HISTORY_PREFIX.value + hashX, reverse=True): k = key[1:] a = array.array('I') a.frombytes(hist) # Remove all history entries >= tx_count idx = bisect_left(a, tx_count) nremoves += len(a) - idx if idx > 0: puts[k] = a[:idx].tobytes() break deletes.append(k) for key in deletes: batch_delete(key) for key, value in puts.items(): batch_put(key, value) # New undo information for undo_info, height in flush_data.undo: batch.put(self.undo_key(height), b''.join(undo_info)) flush_data.undo.clear() # Spends for key in sorted(flush_data.deletes): batch_delete(key) flush_data.deletes.clear() # New UTXOs for key, value in flush_data.adds.items(): # suffix = tx_idx + tx_num hashX = value[:-12] suffix = key[-2:] + value[-12:-8] batch_put(DB_PREFIXES.HASHX_UTXO_PREFIX.value + key[:4] + suffix, hashX) batch_put(DB_PREFIXES.UTXO_PREFIX.value + hashX + suffix, value[-8:]) flush_data.adds.clear() start_time = time.time() add_count = len(flush_data.adds) spend_count = len(flush_data.deletes) // 2 if self.db.for_sync: block_count = flush_data.height - self.db_height tx_count = flush_data.tx_count - self.db_tx_count elapsed = time.time() - start_time self.logger.info(f'flushed {block_count:,d} blocks with ' f'{tx_count:,d} txs, {add_count:,d} UTXO adds, ' f'{spend_count:,d} spends in ' f'{elapsed:.1f}s, committing...') self.utxo_flush_count = self.hist_flush_count self.db_height = flush_data.height self.db_tx_count = flush_data.tx_count self.db_tip = flush_data.tip # Flush state last as it reads the wall time. now = time.time() self.wall_time += now - self.last_flush self.last_flush = now self.last_flush_tx_count = self.fs_tx_count self.write_db_state(batch) self.logger.info(f'backing up removed {nremoves:,d} history entries') elapsed = self.last_flush - start_time self.logger.info(f'backup flush #{self.hist_flush_count:,d} took {elapsed:.1f}s. ' f'Height {flush_data.height:,d} txs: {flush_data.tx_count:,d} ({tx_delta:+,d})') def raw_header(self, height): """Return the binary header at the given height.""" header, n = self.read_headers(height, 1) if n != 1: raise IndexError(f'height {height:,d} out of range') return header def encode_headers(self, start_height, count, headers): key = (start_height, count) if not self.encoded_headers.get(key): compressobj = zlib.compressobj(wbits=-15, level=1, memLevel=9) headers = base64.b64encode(compressobj.compress(headers) + compressobj.flush()).decode() if start_height % 1000 != 0: return headers self.encoded_headers[key] = headers return self.encoded_headers.get(key) def read_headers(self, start_height, count) -> typing.Tuple[bytes, int]: """Requires start_height >= 0, count >= 0. Reads as many headers as are available starting at start_height up to count. This would be zero if start_height is beyond self.db_height, for example. Returns a (binary, n) pair where binary is the concatenated binary headers, and n is the count of headers returned. """ if start_height < 0 or count < 0: raise self.DBError(f'{count:,d} headers starting at ' f'{start_height:,d} not on disk') disk_count = max(0, min(count, self.db_height + 1 - start_height)) if disk_count: return b''.join(self.headers[start_height:start_height + disk_count]), disk_count return b'', 0 def fs_tx_hash(self, tx_num): """Return a par (tx_hash, tx_height) for the given tx number. If the tx_height is not on disk, returns (None, tx_height).""" tx_height = bisect_right(self.tx_counts, tx_num) if tx_height > self.db_height: return None, tx_height try: return self.total_transactions[tx_num], tx_height except IndexError: self.logger.exception( "Failed to access a cached transaction, known bug #3142 " "should be fixed in #3205" ) return None, tx_height def _fs_transactions(self, txids: Iterable[str]): unpack_be_uint64 = util.unpack_be_uint64 tx_counts = self.tx_counts tx_db_get = self.db.get tx_cache = self._tx_and_merkle_cache tx_infos = {} for tx_hash in txids: cached_tx = tx_cache.get(tx_hash) if cached_tx: tx, merkle = cached_tx else: tx_hash_bytes = bytes.fromhex(tx_hash)[::-1] tx_num = tx_db_get(DB_PREFIXES.TX_NUM_PREFIX.value + tx_hash_bytes) tx = None tx_height = -1 if tx_num is not None: tx_num = unpack_be_uint64(tx_num) tx_height = bisect_right(tx_counts, tx_num) if tx_height < self.db_height: tx = tx_db_get(DB_PREFIXES.TX_PREFIX.value + tx_hash_bytes) if tx_height == -1: merkle = { 'block_height': -1 } else: tx_pos = tx_num - tx_counts[tx_height - 1] branch, root = self.merkle.branch_and_root( self.total_transactions[tx_counts[tx_height - 1]:tx_counts[tx_height]], tx_pos ) merkle = { 'block_height': tx_height, 'merkle': [ hash_to_hex_str(hash) for hash in branch ], 'pos': tx_pos } if tx_height + 10 < self.db_height: tx_cache[tx_hash] = tx, merkle tx_infos[tx_hash] = (None if not tx else tx.hex(), merkle) return tx_infos async def fs_transactions(self, txids): return await asyncio.get_event_loop().run_in_executor(self.executor, self._fs_transactions, txids) async def fs_block_hashes(self, height, count): if height + count > len(self.headers): raise self.DBError(f'only got {len(self.headers) - height:,d} headers starting at {height:,d}, not {count:,d}') return [self.coin.header_hash(header) for header in self.headers[height:height + count]] async def limited_history(self, hashX, *, limit=1000): """Return an unpruned, sorted list of (tx_hash, height) tuples of confirmed transactions that touched the address, earliest in the blockchain first. Includes both spending and receiving transactions. By default returns at most 1000 entries. Set limit to None to get them all. """ def read_history(): db_height = self.db_height tx_counts = self.tx_counts cnt = 0 txs = [] for hist in self.db.iterator(prefix=DB_PREFIXES.HASHX_HISTORY_PREFIX.value + hashX, include_key=False): a = array.array('I') a.frombytes(hist) for tx_num in a: tx_height = bisect_right(tx_counts, tx_num) if tx_height > db_height: return txs.append((tx_num, tx_height)) cnt += 1 if limit and cnt >= limit: break if limit and cnt >= limit: break return txs while True: history = await asyncio.get_event_loop().run_in_executor(self.executor, read_history) if history is not None: return [(self.total_transactions[tx_num], tx_height) for (tx_num, tx_height) in history] self.logger.warning(f'limited_history: tx hash ' f'not found (reorg?), retrying...') await sleep(0.25) # -- Undo information def min_undo_height(self, max_height): """Returns a height from which we should store undo info.""" return max_height - self.env.reorg_limit + 1 def undo_key(self, height: int) -> bytes: """DB key for undo information at the given height.""" return DB_PREFIXES.UNDO_PREFIX.value + pack('>I', height) def read_undo_info(self, height): """Read undo information from a file for the current height.""" undo_claims = self.db.get(DB_PREFIXES.undo_claimtrie.value + util.pack_be_uint64(self.fs_height)) return self.db.get(self.undo_key(height)), undo_claims def raw_block_prefix(self): return 'block' def raw_block_path(self, height): return os.path.join(self.env.db_dir, f'{self.raw_block_prefix()}{height:d}') async def read_raw_block(self, height): """Returns a raw block read from disk. Raises FileNotFoundError if the block isn't on-disk.""" def read(): with util.open_file(self.raw_block_path(height)) as f: return f.read(-1) return await asyncio.get_event_loop().run_in_executor(self.executor, read) def write_raw_block(self, block, height): """Write a raw block to disk.""" with util.open_truncate(self.raw_block_path(height)) as f: f.write(block) # Delete old blocks to prevent them accumulating try: del_height = self.min_undo_height(height) - 1 os.remove(self.raw_block_path(del_height)) except FileNotFoundError: pass def clear_excess_undo_info(self): """Clear excess undo info. Only most recent N are kept.""" min_height = self.min_undo_height(self.db_height) keys = [] for key, hist in self.db.iterator(prefix=DB_PREFIXES.UNDO_PREFIX.value): height, = unpack('>I', key[-4:]) if height >= min_height: break keys.append(key) if keys: with self.db.write_batch() as batch: for key in keys: batch.delete(key) self.logger.info(f'deleted {len(keys):,d} stale undo entries') # delete old block files prefix = self.raw_block_prefix() paths = [path for path in glob(f'{prefix}[0-9]*') if len(path) > len(prefix) and int(path[len(prefix):]) < min_height] if paths: for path in paths: try: os.remove(path) except FileNotFoundError: pass self.logger.info(f'deleted {len(paths):,d} stale block files') # -- UTXO database def write_db_state(self, batch): """Write (UTXO) state to the batch.""" db_state = DBState( bytes.fromhex(self.coin.GENESIS_HASH), self.db_height, self.db_tx_count, self.db_tip, self.utxo_flush_count, int(self.wall_time), self.first_sync, self.db_version, self.hist_flush_count, self.hist_comp_flush_count, self.hist_comp_cursor ) batch.put(DB_PREFIXES.db_state.value, db_state.pack()) def read_db_state(self): state = self.db.get(DB_PREFIXES.db_state.value) if not state: self.db_height = -1 self.db_tx_count = 0 self.db_tip = b'\0' * 32 self.db_version = max(self.DB_VERSIONS) self.utxo_flush_count = 0 self.wall_time = 0 self.first_sync = True self.hist_flush_count = 0 self.hist_comp_flush_count = -1 self.hist_comp_cursor = -1 self.hist_db_version = max(self.DB_VERSIONS) else: state = DBState.unpack(state) self.db_version = state.db_version if self.db_version not in self.DB_VERSIONS: raise self.DBError(f'your DB version is {self.db_version} but this ' f'software only handles versions {self.DB_VERSIONS}') # backwards compat genesis_hash = state.genesis if genesis_hash.hex() != self.coin.GENESIS_HASH: raise self.DBError(f'DB genesis hash {genesis_hash} does not ' f'match coin {self.coin.GENESIS_HASH}') self.db_height = state.height self.db_tx_count = state.tx_count self.db_tip = state.tip self.utxo_flush_count = state.utxo_flush_count self.wall_time = state.wall_time self.first_sync = state.first_sync self.hist_flush_count = state.hist_flush_count self.hist_comp_flush_count = state.comp_flush_count self.hist_comp_cursor = state.comp_cursor self.hist_db_version = state.db_version async def all_utxos(self, hashX): """Return all UTXOs for an address sorted in no particular order.""" def read_utxos(): utxos = [] utxos_append = utxos.append s_unpack = unpack fs_tx_hash = self.fs_tx_hash # Key: b'u' + address_hashX + tx_idx + tx_num # Value: the UTXO value as a 64-bit unsigned integer prefix = DB_PREFIXES.UTXO_PREFIX.value + hashX for db_key, db_value in self.db.iterator(prefix=prefix): tx_pos, tx_num = s_unpack('