class AccountDB(BaseAccountDB):
logger = logging.getLogger('hvm.db.account.AccountDB')
def __init__(self, db):
r"""
Internal implementation details (subject to rapid change):
Journaling sequesters writes at the _journal* attrs ^, until persist is called.
_batchdb and _batchtrie together enable us to make the state root,
without saving everything to the database.
_journaldb is a journaling of the keys and values used to store
code and account storage.
TODO: add cache
_trie_cache is a cache tied to the state root of the trie. It
is important that this cache is checked *after* looking for
the key in _journaltrie, because the cache is only invalidated
after a state root change.
AccountDB synchronizes the snapshot/revert/persist the
journal.
"""
self.db = db
self._batchdb = BatchDB(db)
self._journaldb = JournalDB(self._batchdb)
#
# Storage
#
def get_storage(self, address, slot):
validate_canonical_address(address, title="Storage Address")
validate_uint256(slot, title="Storage Slot")
account = self._get_account(address)
storage = HashTrie(HexaryTrie(self._journaldb, account.storage_root))
slot_as_key = pad32(int_to_big_endian(slot))
if slot_as_key in storage:
encoded_value = storage[slot_as_key]
return rlp.decode(encoded_value, sedes=rlp.sedes.big_endian_int)
else:
return 0
def set_storage(self, address, slot, value):
validate_uint256(value, title="Storage Value")
validate_uint256(slot, title="Storage Slot")
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
storage = HashTrie(HexaryTrie(self._journaldb, account.storage_root))
slot_as_key = pad32(int_to_big_endian(slot))
if value:
encoded_value = rlp.encode(value)
storage[slot_as_key] = encoded_value
else:
del storage[slot_as_key]
self._set_account(address, account.copy(storage_root=storage.root_hash))
def delete_storage(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
self._set_account(address, account.copy(storage_root=BLANK_ROOT_HASH))
#
# Balance
#
def get_balance(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.balance
def set_balance(self, address, balance):
validate_canonical_address(address, title="Storage Address")
validate_uint256(balance, title="Account Balance")
account = self._get_account(address)
self._set_account(address, account.copy(balance=balance))
#
# Nonce
#
def get_nonce(self, address: Address) -> int:
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.nonce
def set_nonce(self, address, nonce):
validate_canonical_address(address, title="Storage Address")
validate_uint256(nonce, title="Nonce")
account = self._get_account(address)
self._set_account(address, account.copy(nonce=nonce))
def increment_nonce(self, address):
current_nonce = self.get_nonce(address)
self.set_nonce(address, current_nonce + 1)
#
# Block number
#
def get_block_number(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.block_number
def set_block_number(self, address, block_number):
validate_canonical_address(address, title="Storage Address")
validate_uint256(block_number, title="Block Number")
account = self._get_account(address)
self._set_account(address, account.copy(block_number=block_number))
def increment_block_number(self, address):
current_block_number = self.get_block_number(address)
self.set_block_number(address, current_block_number + 1)
#
# Receivable Transactions
#
def get_receivable_transactions(self, address: Address) -> List[TransactionKey]:
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.receivable_transactions
def has_receivable_transactions(self, address: Address) -> bool:
tx = self.get_receivable_transactions(address)
if len(tx) == 0:
return False
else:
return True
def get_receivable_transaction(self, address: Address, transaction_hash: Hash32) -> Optional[TransactionKey]:
validate_is_bytes(transaction_hash, title="Transaction Hash")
all_tx = self.get_receivable_transactions(address)
for tx_key in all_tx:
if tx_key.transaction_hash == transaction_hash:
return tx_key
return None
def add_receivable_transactions(self, address: Address, transaction_keys: TransactionKey) -> None:
validate_canonical_address(address, title="Wallet Address")
for tx_key in transaction_keys:
self.add_receivable_transaction(address, tx_key.transaction_hash, tx_key.sender_block_hash)
def add_receivable_transaction(self, address: Address, transaction_hash: Hash32, sender_block_hash: Hash32, is_contract_deploy:bool = False) -> None:
validate_canonical_address(address, title="Wallet Address")
validate_is_bytes(transaction_hash, title="Transaction Hash")
validate_is_bytes(sender_block_hash, title="Sender Block Hash")
#this is the wallet address people send money to when slashed. It is a sink
if address == SLASH_WALLET_ADDRESS:
return
account = self._get_account(address)
receivable_transactions = account.receivable_transactions
# first lets make sure we don't already have the transaction
for tx_key in receivable_transactions:
if tx_key.transaction_hash == transaction_hash:
raise ValueError("Tried to save a receivable transaction that was already saved. TX HASH = {}".format(encode_hex(transaction_hash)))
new_receivable_transactions = receivable_transactions + (TransactionKey(transaction_hash, sender_block_hash), )
#self.logger.debug(new_receivable_transactions)
self.logger.debug("Adding receivable transaction {} to account {}".format(encode_hex(transaction_hash), encode_hex(address)))
self._set_account(address, account.copy(receivable_transactions=new_receivable_transactions))
#finally, if this is a smart contract, lets add it to the list of smart contracts with pending transactions
if is_contract_deploy or self.get_code_hash(address) != EMPTY_SHA3:
self.logger.debug("Adding address to list of smart contracts with pending transactions")
#we only need to run this when adding the first one.
self._add_address_to_smart_contracts_with_pending_transactions(address)
def delete_receivable_transaction(self, address: Address, transaction_hash: Hash32) -> None:
validate_canonical_address(address, title="Storage Address")
validate_is_bytes(transaction_hash, title="Transaction Hash")
self.logger.debug("deleting receivable tx {} from account {}".format(encode_hex(transaction_hash), encode_hex(address)))
account = self._get_account(address)
receivable_transactions = list(self.get_receivable_transactions(address))
i = 0
found = False
for tx_key in receivable_transactions:
if tx_key.transaction_hash == transaction_hash:
found = True
break
i +=1
if found == True:
del receivable_transactions[i]
else:
raise ReceivableTransactionNotFound("transaction hash {0} not found in receivable_transactions database for wallet {1}".format(transaction_hash, address))
self._set_account(address, account.copy(receivable_transactions=tuple(receivable_transactions)))
if self.get_code_hash(address) != EMPTY_SHA3:
if len(receivable_transactions) == 0:
self.logger.debug("Removing address from list of smart contracts with pending transactions")
self._remove_address_from_smart_contracts_with_pending_transactions(address)
#
# Code
#
def get_code(self, address):
validate_canonical_address(address, title="Storage Address")
try:
return self._journaldb[self.get_code_hash(address)]
except KeyError:
return b""
def set_code(self, address, code):
validate_canonical_address(address, title="Storage Address")
validate_is_bytes(code, title="Code")
account = self._get_account(address)
code_hash = keccak(code)
self._journaldb[code_hash] = code
self._set_account(address, account.copy(code_hash=code_hash))
def get_code_hash(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.code_hash
def delete_code(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
self._set_account(address, account.copy(code_hash=EMPTY_SHA3))
#
# Internal use smart contract transaction queue system
#
def _add_address_to_smart_contracts_with_pending_transactions(self, address: Address) -> None:
key = SchemaV1.make_smart_contracts_with_pending_transactions_lookup_key()
address_set = set(self.get_smart_contracts_with_pending_transactions())
address_set.add(address)
self.db[key] = rlp.encode(list(address_set), sedes=rlp.sedes.FCountableList(address))
def _remove_address_from_smart_contracts_with_pending_transactions(self, address: Address) -> None:
key = SchemaV1.make_smart_contracts_with_pending_transactions_lookup_key()
address_set = set(self.get_smart_contracts_with_pending_transactions())
address_set.remove(address)
self.db[key] = rlp.encode(list(address_set), sedes=rlp.sedes.FCountableList(address))
def has_pending_smart_contract_transactions(self, address: Address) -> bool:
validate_canonical_address(address, title="Storage Address")
address_set = set(self.get_smart_contracts_with_pending_transactions())
return address in address_set
def get_smart_contracts_with_pending_transactions(self) -> List[Address]:
key = SchemaV1.make_smart_contracts_with_pending_transactions_lookup_key()
try:
address_list = rlp.decode(self.db[key], sedes=rlp.sedes.FCountableList(address), use_list=True)
return address_list
except KeyError:
return []
#
# Account Methods
#
def account_has_code_or_nonce(self, address):
return self.get_nonce(address) != 0 or self.account_has_code(address)
def account_has_code(self, address: Address) -> bool:
return self.get_code_hash(address) != EMPTY_SHA3
def delete_account(self, address):
validate_canonical_address(address, title="Storage Address")
account_lookup_key = SchemaV1.make_account_lookup_key(address)
#try:
del self._journaldb[account_lookup_key]
#except KeyError:
# self.logger.debug("tried to delete an account that doesnt exist")
def account_exists(self, address):
validate_canonical_address(address, title="Storage Address")
account_lookup_key = SchemaV1.make_account_lookup_key(address)
return self._journaldb.get(account_lookup_key, b'') != b''
def touch_account(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
self._set_account(address, account)
def account_is_empty(self, address):
return not self.account_has_code_or_nonce(address) and self.get_balance(address) == 0 and self.has_receivable_transactions(address) is False
def get_account_hash(self, address: Address) -> Hash32:
account = self._get_account(address)
account_hashable = account.copy(
receivable_transactions = (),
block_conflicts = (),
)
account_hashable_encoded = rlp.encode(account_hashable, sedes=Account)
return keccak(account_hashable_encoded)
#
# Internal
#
def _get_account(self, address):
account_lookup_key = SchemaV1.make_account_lookup_key(address)
rlp_account = self._journaldb.get(account_lookup_key, b'')
if rlp_account:
account = rlp.decode(rlp_account, sedes=Account)
#account = hm_decode(rlp_account, sedes_classes=[Account])
else:
account = Account()
return account
def _set_account(self, address, account):
encoded_account = rlp.encode(account, sedes=Account)
#encoded_account = hm_encode(account)
account_lookup_key = SchemaV1.make_account_lookup_key(address)
self._journaldb[account_lookup_key] = encoded_account
#
# Record and discard API
#
def record(self) -> UUID:
self.logger.debug("Recording account db changeset")
return (self._journaldb.record())
def discard(self, changeset: UUID) -> None:
self.logger.debug("Discarding account db changes")
db_changeset = changeset
self._journaldb.discard(db_changeset)
def commit(self, changeset: UUID) -> None:
db_changeset = changeset
self._journaldb.commit(db_changeset)
def persist(self, save_account_hash = False, wallet_address = None) -> None:
self.logger.debug('Persisting account db. save_account_hash {} | wallet_address {}'.format(save_account_hash, wallet_address))
self._journaldb.persist()
self._batchdb.commit(apply_deletes=True)
if save_account_hash:
validate_canonical_address(wallet_address, title="Address")
self.save_current_account_with_hash_lookup(wallet_address)
#
# Saving account state at particular account hash
#
def save_current_account_with_hash_lookup(self, wallet_address):
validate_canonical_address(wallet_address, title="Address")
account_hash = self.get_account_hash(wallet_address)
account = self._get_account(wallet_address)
rlp_account = rlp.encode(account, sedes=Account)
lookup_key = SchemaV1.make_account_by_hash_lookup_key(account_hash)
self.db[lookup_key] = rlp_account
def revert_to_account_from_hash(self, account_hash, wallet_address):
validate_canonical_address(wallet_address, title="Address")
validate_is_bytes(account_hash, title="account_hash")
lookup_key = SchemaV1.make_account_by_hash_lookup_key(account_hash)
try:
rlp_encoded = self.db[lookup_key]
account = rlp.decode(rlp_encoded, sedes=Account)
self._set_account(wallet_address, account)
except KeyError:
raise StateRootNotFound()
class AccountDB(BaseAccountDB):
logger = logging.getLogger('hvm.db.account.AccountDB')
def __init__(self, db, state_root=BLANK_ROOT_HASH):
r"""
Internal implementation details (subject to rapid change):
Database entries go through several pipes, like so...
.. code::
-> hash-trie -> storage lookups
/
db > _batchdb ---------------------------> _journaldb ----------------> code lookups
\
-> _batchtrie -> _trie -> _trie_cache -> _journaltrie --------------> account lookups
Journaling sequesters writes at the _journal* attrs ^, until persist is called.
_batchtrie enables us to prune all trie changes while building
state, without deleting old trie roots.
_batchdb and _batchtrie together enable us to make the state root,
without saving everything to the database.
_journaldb is a journaling of the keys and values used to store
code and account storage.
_trie is a hash-trie, used to generate the state root
_trie_cache is a cache tied to the state root of the trie. It
is important that this cache is checked *after* looking for
the key in _journaltrie, because the cache is only invalidated
after a state root change.
_journaltrie is a journaling of the accounts (an address->rlp_templates mapping,
rather than the nodes stored by the trie). This enables
a squashing of all account changes before pushing them into the trie.
.. NOTE:: There is an opportunity to do something similar for storage
AccountDB synchronizes the snapshot/revert/persist of both of the
journals.
"""
self.db = db
self._batchdb = BatchDB(db)
self._batchtrie = BatchDB(db)
self._journaldb = JournalDB(self._batchdb)
self._trie = HashTrie(
HexaryTrie(self._batchtrie, state_root, prune=True))
self._trie_cache = CacheDB(self._trie)
self._journaltrie = JournalDB(self._trie_cache)
@property
def state_root(self):
return self._trie.root_hash
@state_root.setter
def state_root(self, value):
self._trie_cache.reset_cache()
self._trie.root_hash = value
def has_root(self, state_root: bytes) -> bool:
return state_root in self._batchtrie
#
# Storage
#
def get_storage(self, address, slot):
validate_canonical_address(address, title="Storage Address")
validate_uint256(slot, title="Storage Slot")
account = self._get_account(address)
storage = HashTrie(HexaryTrie(self._journaldb, account.storage_root))
slot_as_key = pad32(int_to_big_endian(slot))
if slot_as_key in storage:
encoded_value = storage[slot_as_key]
return rlp.decode(encoded_value, sedes=rlp.sedes.big_endian_int)
else:
return 0
def set_storage(self, address, slot, value):
validate_uint256(value, title="Storage Value")
validate_uint256(slot, title="Storage Slot")
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
storage = HashTrie(HexaryTrie(self._journaldb, account.storage_root))
slot_as_key = pad32(int_to_big_endian(slot))
if value:
encoded_value = rlp.encode(value)
storage[slot_as_key] = encoded_value
else:
del storage[slot_as_key]
self._set_account(address,
account.copy(storage_root=storage.root_hash))
def delete_storage(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
self._set_account(address, account.copy(storage_root=BLANK_ROOT_HASH))
#
# Balance
#
def get_balance(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.balance
def set_balance(self, address, balance):
validate_canonical_address(address, title="Storage Address")
validate_uint256(balance, title="Account Balance")
account = self._get_account(address)
self._set_account(address, account.copy(balance=balance))
#
# Nonce
#
def get_nonce(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.nonce
def set_nonce(self, address, nonce):
validate_canonical_address(address, title="Storage Address")
validate_uint256(nonce, title="Nonce")
account = self._get_account(address)
self._set_account(address, account.copy(nonce=nonce))
def increment_nonce(self, address):
current_nonce = self.get_nonce(address)
self.set_nonce(address, current_nonce + 1)
#
# Block number
#
def get_block_number(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.block_number
def set_block_number(self, address, block_number):
validate_canonical_address(address, title="Storage Address")
validate_uint256(block_number, title="Block Number")
account = self._get_account(address)
self._set_account(address, account.copy(block_number=block_number))
def increment_block_number(self, address):
current_block_number = self.get_block_number(address)
self.set_block_number(address, current_block_number + 1)
#
# Receivable Transactions
#
def get_receivable_transactions(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.receivable_transactions
def has_receivable_transactions(self, address):
tx = self.get_receivable_transactions(address)
if len(tx) == 0:
return False
else:
return True
def get_receivable_transaction(self, address, transaction_hash):
validate_is_bytes(transaction_hash, title="Transaction Hash")
all_tx = self.get_receivable_transactions(address)
for tx_key in all_tx:
if tx_key.transaction_hash == transaction_hash:
return tx_key
return False
def add_receivable_transaction(self, address, transaction_hash,
sender_block_hash):
validate_canonical_address(address, title="Storage Address")
validate_is_bytes(transaction_hash, title="Transaction Hash")
validate_is_bytes(sender_block_hash, title="Sender Block Hash")
#this is the wallet address people send money to when slashed. It is a sink
if address == SLASH_WALLET_ADDRESS:
return
#first lets make sure we don't already have the transaction
if self.get_receivable_transaction(address,
transaction_hash) is not False:
raise ValueError(
"Tried to save a receivable transaction that was already saved"
)
account = self._get_account(address)
receivable_transactions = account.receivable_transactions
new_receivable_transactions = receivable_transactions + (
TransactionKey(transaction_hash, sender_block_hash), )
self.logger.debug(
"adding receivable transaction {}".format(transaction_hash))
#self.logger.debug(new_receivable_transactions)
self._set_account(
address,
account.copy(receivable_transactions=new_receivable_transactions))
def delete_receivable_transaction(self, address, transaction_hash):
validate_canonical_address(address, title="Storage Address")
validate_is_bytes(transaction_hash, title="Transaction Hash")
self.logger.debug("deleting receivable tx {}".format(transaction_hash))
account = self._get_account(address)
receivable_transactions = list(
self.get_receivable_transactions(address))
i = 0
found = False
for tx_key in receivable_transactions:
if tx_key.transaction_hash == transaction_hash:
found = True
break
i += 1
if found == True:
del receivable_transactions[i]
else:
raise ValueError(
"transaction hash {0} not found in receivable_transactions database for wallet {1}"
.format(transaction_hash, address))
self._set_account(
address,
account.copy(
receivable_transactions=tuple(receivable_transactions)))
#
# Code
#
def get_code(self, address):
validate_canonical_address(address, title="Storage Address")
try:
return self._journaldb[self.get_code_hash(address)]
except KeyError:
return b""
def set_code(self, address, code):
validate_canonical_address(address, title="Storage Address")
validate_is_bytes(code, title="Code")
account = self._get_account(address)
code_hash = keccak(code)
self._journaldb[code_hash] = code
self._set_account(address, account.copy(code_hash=code_hash))
def get_code_hash(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
return account.code_hash
def delete_code(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
self._set_account(address, account.copy(code_hash=EMPTY_SHA3))
#
# Account Methods
#
def account_has_code_or_nonce(self, address):
return self.get_nonce(address) != 0 or self.get_code_hash(
address) != EMPTY_SHA3
def delete_account(self, address):
validate_canonical_address(address, title="Storage Address")
del self._journaltrie[address]
def account_exists(self, address):
validate_canonical_address(address, title="Storage Address")
return self._journaltrie.get(address, b'') != b''
def touch_account(self, address):
validate_canonical_address(address, title="Storage Address")
account = self._get_account(address)
self._set_account(address, account)
def account_is_empty(self, address):
return not self.account_has_code_or_nonce(
address) and self.get_balance(
address
) == 0 and self.has_receivable_transactions(address) is False
def get_account_hash(self, address):
account = self._get_account(address)
account_hashable = account.copy(receivable_transactions=())
account_hashable_encoded = rlp.encode(account_hashable)
return keccak(account_hashable_encoded)
#
# Internal
#
def _get_account(self, address):
rlp_account = self._journaltrie.get(address, b'')
if rlp_account:
account = rlp.decode(rlp_account, sedes=Account)
else:
account = Account()
return account
def _set_account(self, address, account):
rlp_account = rlp.encode(account, sedes=Account)
self._journaltrie[address] = rlp_account
#
# Record and discard API
#
def record(self) -> Tuple[UUID, UUID]:
return (self._journaldb.record(), self._journaltrie.record())
def discard(self, changeset: Tuple[UUID, UUID]) -> None:
db_changeset, trie_changeset = changeset
self._journaldb.discard(db_changeset)
self._journaltrie.discard(trie_changeset)
def commit(self, changeset: Tuple[UUID, UUID]) -> None:
db_changeset, trie_changeset = changeset
self._journaldb.commit(db_changeset)
self._journaltrie.commit(trie_changeset)
def make_state_root(self) -> Hash32:
self.logger.debug("Generating AccountDB trie")
self._journaldb.persist()
self._journaltrie.persist()
return self.state_root
def persist(self, save_state_root=False) -> None:
self.make_state_root()
self._batchtrie.commit(apply_deletes=False)
self._batchdb.commit(apply_deletes=True)
if save_state_root:
self.save_current_state_root()
def _log_pending_accounts(self) -> None:
accounts_displayed = set() # type: Set[bytes]
queued_changes = self._journaltrie.journal.journal_data.items()
# mypy bug for ordered dict reversibility: https://github.com/python/typeshed/issues/2078
for checkpoint, accounts in reversed(queued_changes): # type: ignore
for address in accounts:
if address in accounts_displayed:
continue
else:
accounts_displayed.add(address)
account = self._get_account(address)
self.logger.debug(
"Account %s: balance %d, nonce %d, storage root %s, code hash %s",
encode_hex(address),
account.balance,
account.nonce,
encode_hex(account.storage_root),
encode_hex(account.code_hash),
)
def save_current_state_root(self) -> None:
"""
Saves the current state_root to the database to be loaded later
"""
self.logger.debug("Saving current state root")
#if self.state_root==BLANK_ROOT_HASH:
# raise ValueError("cannot save state root because it is BLANK_ROOT_HASH")
current_state_root_lookup_key = SchemaV1.make_current_state_root_lookup_key(
)
self.db.set(
current_state_root_lookup_key,
rlp.encode(self.state_root, sedes=trie_root),
)
@classmethod
def get_saved_state_root(cls, db) -> Hash32:
"""
Loads the last saved state root
"""
current_state_root_lookup_key = SchemaV1.make_current_state_root_lookup_key(
)
try:
loaded_state_root = rlp.decode(db[current_state_root_lookup_key],
sedes=trie_root)
except KeyError:
raise ValueError("There is no saved state root to load")
return loaded_state_root