LBRYCommunity/hub
1
0
Fork 0
Code Issues 35 Pull requests 6 Projects Releases Packages Wiki Activity

doc strings

Browse source
This commit is contained in:
Jack Robison 2022-03-08 21:09:32 -05:00
parent bcb0dedad1
commit 85725d6611
No known key found for this signature in database
GPG key ID: DF25C68FE0239BB2
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
scribe/reader/interface.py
View file

@ -84,6 +84,12 @@ class BaseBlockchainReader:
) )
async def poll_for_changes(self): async def poll_for_changes(self):
"""
Detect and handle if the db has advanced to a new block or unwound during a chain reorganization
If a reorg is detected, this will first unwind() to the branching height and then advance() forward
to the new block(s).
"""
await asyncio.get_event_loop().run_in_executor(self._executor, self._detect_changes) await asyncio.get_event_loop().run_in_executor(self._executor, self._detect_changes)
async def refresh_blocks_forever(self, synchronized: asyncio.Event): async def refresh_blocks_forever(self, synchronized: asyncio.Event):
@ -100,9 +106,15 @@ class BaseBlockchainReader:
synchronized.set() synchronized.set()
def clear_caches(self): def clear_caches(self):
"""
Called after finished advancing, used for invalidating caches
"""
pass pass
def advance(self, height: int): def advance(self, height: int):
"""
Advance to the given block height
"""
tx_count = self.db.prefix_db.tx_count.get(height).tx_count tx_count = self.db.prefix_db.tx_count.get(height).tx_count
assert tx_count not in self.db.tx_counts, f'boom {tx_count} in {len(self.db.tx_counts)} tx counts' assert tx_count not in self.db.tx_counts, f'boom {tx_count} in {len(self.db.tx_counts)} tx counts'
assert len(self.db.tx_counts) == height, f"{len(self.db.tx_counts)} != {height}" assert len(self.db.tx_counts) == height, f"{len(self.db.tx_counts)} != {height}"
@ -110,10 +122,14 @@ class BaseBlockchainReader:
self.db.headers.append(self.db.prefix_db.header.get(height, deserialize_value=False)) self.db.headers.append(self.db.prefix_db.header.get(height, deserialize_value=False))
def unwind(self): def unwind(self):
"""
Go backwards one block
"""
self.db.tx_counts.pop() self.db.tx_counts.pop()
self.db.headers.pop() self.db.headers.pop()
async def start(self): async def start(self):
# TODO: make the method here useful
if not self._executor: if not self._executor:
self._executor = ThreadPoolExecutor(self._thread_workers, thread_name_prefix=self._thread_prefix) self._executor = ThreadPoolExecutor(self._thread_workers, thread_name_prefix=self._thread_prefix)
self.db._executor = self._executor self.db._executor = self._executor