def context(ms_database: Database):
return Context(
ms_state=ms_database.load_state(),
db=ms_database,
w3=Mock(),
last_known_block=0,
monitoring_service_contract=Mock(),
user_deposit_contract=Mock(),
min_reward=1,
)
def context(ms_database: Database):
return Context(
ms_state=ms_database.load_state(),
database=ms_database,
web3=Web3Mock(),
monitoring_service_contract=Mock(),
user_deposit_contract=Mock(),
min_reward=1,
required_confirmations=1,
)
class MonitoringService:
# pylint: disable=too-few-public-methods,too-many-instance-attributes
def __init__( # pylint: disable=too-many-arguments
self,
web3: Web3,
private_key: PrivateKey,
db_filename: str,
contracts: Dict[str, Contract],
sync_start_block: BlockNumber,
required_confirmations: BlockTimeout,
poll_interval: float,
min_reward: int = 0,
):
self.web3 = web3
self.chain_id = ChainID(web3.eth.chainId)
self.private_key = private_key
self.address = private_key_to_address(private_key)
self.poll_interval = poll_interval
self.service_registry = contracts[CONTRACT_SERVICE_REGISTRY]
self.token_network_registry = contracts[
CONTRACT_TOKEN_NETWORK_REGISTRY]
web3.middleware_onion.add(
construct_sign_and_send_raw_middleware(private_key))
monitoring_contract = contracts[CONTRACT_MONITORING_SERVICE]
user_deposit_contract = contracts[CONTRACT_USER_DEPOSIT]
self.database = Database(
filename=db_filename,
chain_id=self.chain_id,
registry_address=to_canonical_address(
self.token_network_registry.address),
receiver=self.address,
msc_address=MonitoringServiceAddress(
to_canonical_address(monitoring_contract.address)),
sync_start_block=sync_start_block,
)
ms_state = self.database.load_state()
self.context = Context(
ms_state=ms_state,
database=self.database,
web3=self.web3,
monitoring_service_contract=monitoring_contract,
user_deposit_contract=user_deposit_contract,
min_reward=min_reward,
required_confirmations=required_confirmations,
)
def start(self) -> None:
if not self.service_registry.functions.hasValidRegistration(
self.address).call():
log.error("No valid registration in ServiceRegistry",
address=self.address)
sys.exit(1)
last_gas_check_block = 0
while True:
last_confirmed_block = self.context.latest_confirmed_block
# check gas reserve
do_gas_reserve_check = (
last_confirmed_block >=
last_gas_check_block + DEFAULT_GAS_CHECK_BLOCKS)
if do_gas_reserve_check:
check_gas_reserve(self.web3, self.private_key)
last_gas_check_block = last_confirmed_block
self._process_new_blocks(
latest_confirmed_block=last_confirmed_block)
self._trigger_scheduled_events()
self._check_pending_transactions()
self._purge_old_monitor_requests()
gevent.sleep(self.poll_interval)
def _process_new_blocks(self, latest_confirmed_block: BlockNumber) -> None:
token_network_addresses = self.context.database.get_token_network_addresses(
)
events = get_blockchain_events_adaptive(
web3=self.web3,
blockchain_state=self.context.ms_state.blockchain_state,
token_network_addresses=token_network_addresses,
latest_confirmed_block=latest_confirmed_block,
)
if events is None:
return
for event in events:
handle_event(event, self.context)
def _trigger_scheduled_events(self) -> None:
"""Trigger scheduled events
Here `latest_block` is used instead of `latest_confirmed_block`, because triggered
events only rely on block number, and not on certain events that might change during
a chain reorg.
"""
triggered_events = self.context.database.get_scheduled_events(
max_trigger_block=self.context.get_latest_unconfirmed_block())
for scheduled_event in triggered_events:
event = scheduled_event.event
handle_event(event, self.context)
self.context.database.remove_scheduled_event(scheduled_event)
def _check_pending_transactions(self) -> None:
"""Checks if pending transaction have been mined and confirmed.
This is done here so we don't have to block waiting for receipts in the state machine.
In theory it's not necessary to check all pending transactions, but only the one with the
smallest nonce, and continue from there when this one is mined and confirmed. However,
as it is not expected that this list becomes to big this isn't optimized currently.
"""
for tx_hash in self.context.database.get_waiting_transactions():
try:
receipt = self.web3.eth.getTransactionReceipt(Hash32(tx_hash))
except TransactionNotFound:
continue
tx_block = receipt.get("blockNumber")
if tx_block is None:
continue
confirmation_block = tx_block + self.context.required_confirmations
if self.web3.eth.blockNumber < confirmation_block:
continue
self.context.database.remove_waiting_transaction(tx_hash)
if receipt["status"] == 1:
log.info(
"Transaction was mined successfully",
transaction_hash=tx_hash,
receipt=receipt,
)
else:
log.error(
"Transaction was not mined successfully",
transaction_hash=tx_hash,
receipt=receipt,
)
def _purge_old_monitor_requests(self) -> None:
"""Delete all old MRs for which still no channel exists.
Also marks all MRs which have a channel as not waiting_for_channel to
avoid checking them again, every time.
"""
with self.context.database.conn:
self.context.database.conn.execute("""
UPDATE monitor_request SET waiting_for_channel = 0
WHERE waiting_for_channel
AND EXISTS (
SELECT 1
FROM channel
WHERE channel.identifier = monitor_request.channel_identifier
AND channel.token_network_address = monitor_request.token_network_address
)
""")
before_this_is_old = datetime.utcnow() - KEEP_MRS_WITHOUT_CHANNEL
self.context.database.conn.execute(
"""
DELETE FROM monitor_request
WHERE waiting_for_channel
AND saved_at < ?
""",
[before_this_is_old],
)
class MonitoringService: # pylint: disable=too-few-public-methods,too-many-instance-attributes
def __init__( # pylint: disable=too-many-arguments
self,
web3: Web3,
private_key: str,
db_filename: str,
contracts: Dict[str, Contract],
sync_start_block: BlockNumber = BlockNumber(0),
required_confirmations: int = DEFAULT_NUMBER_OF_BLOCK_CONFIRMATIONS,
poll_interval: float = 1,
min_reward: int = 0,
):
self.web3 = web3
self.private_key = private_key
self.address = private_key_to_address(private_key)
self.required_confirmations = required_confirmations
self.poll_interval = poll_interval
self.service_registry = contracts[CONTRACT_SERVICE_REGISTRY]
web3.middleware_stack.add(
construct_sign_and_send_raw_middleware(private_key))
monitoring_contract = contracts[CONTRACT_MONITORING_SERVICE]
user_deposit_contract = contracts[CONTRACT_USER_DEPOSIT]
chain_id = ChainID(int(web3.net.version))
self.database = Database(
filename=db_filename,
chain_id=chain_id,
registry_address=contracts[CONTRACT_TOKEN_NETWORK_REGISTRY].
address,
receiver=self.address,
msc_address=monitoring_contract.address,
sync_start_block=sync_start_block,
)
ms_state = self.database.load_state()
self.context = Context(
ms_state=ms_state,
db=self.database,
web3=self.web3,
monitoring_service_contract=monitoring_contract,
user_deposit_contract=user_deposit_contract,
min_reward=min_reward,
required_confirmations=required_confirmations,
)
def start(self,
wait_function: Callable = time.sleep,
check_account_gas_reserve: bool = True) -> None:
if not self.service_registry.functions.hasValidRegistration(
self.address).call():
log.error("No valid registration in ServiceRegistry",
address=self.address)
exit(1)
last_gas_check_block = 0
while True:
last_confirmed_block = self.context.latest_confirmed_block
# check gas reserve
do_gas_reserve_check = (
check_account_gas_reserve and last_confirmed_block >=
last_gas_check_block + DEFAULT_GAS_CHECK_BLOCKS)
if do_gas_reserve_check:
check_gas_reserve(self.web3, self.private_key)
last_gas_check_block = last_confirmed_block
max_query_interval_end_block = (
self.context.ms_state.blockchain_state.latest_commited_block +
MAX_FILTER_INTERVAL)
# Limit the max number of blocks that is processed per iteration
last_block = BlockNumber(
min(last_confirmed_block, max_query_interval_end_block))
self._process_new_blocks(last_block)
self._check_pending_transactions()
self._purge_old_monitor_requests()
try:
wait_function(self.poll_interval)
except KeyboardInterrupt:
log.info("Shutting down")
sys.exit(0)
def _process_new_blocks(self, last_block: BlockNumber) -> None:
# BCL return a new state and events related to channel lifecycle
new_chain_state, events = get_blockchain_events(
web3=self.web3,
contract_manager=CONTRACT_MANAGER,
chain_state=self.context.ms_state.blockchain_state,
to_block=last_block,
)
# If a new token network was found we need to write it to the DB, otherwise
# the constraints for new channels will not be constrained. But only update
# the network addresses here, all else is done later.
token_networks_changed = (
self.context.ms_state.blockchain_state.token_network_addresses !=
new_chain_state.token_network_addresses)
if token_networks_changed:
self.context.ms_state.blockchain_state.token_network_addresses = (
new_chain_state.token_network_addresses)
self.context.db.update_blockchain_state(
self.context.ms_state.blockchain_state)
# Now set the updated chain state to the context, will be stored later
self.context.ms_state.blockchain_state = new_chain_state
for event in events:
handle_event(event, self.context)
# check triggered events and trigger the correct ones
triggered_events = self.context.db.get_scheduled_events(
max_trigger_block=last_block)
for scheduled_event in triggered_events:
event = scheduled_event.event
handle_event(event, self.context)
self.context.db.remove_scheduled_event(scheduled_event)
def _check_pending_transactions(self) -> None:
""" Checks if pending transaction have been mined and confirmed.
This is done here so we don't have to block waiting for receipts in the state machine.
In theory it's not necessary to check all pending transactions, but only the one with the
smallest nonce, and continue from there when this one is mined and confirmed. However,
as it is not expected that this list becomes to big this isn't optimized currently.
"""
for tx_hash in self.context.db.get_waiting_transactions():
receipt = self.web3.eth.getTransactionReceipt(tx_hash)
if receipt is None:
continue
tx_block = receipt.get("blockNumber")
if tx_block is None:
continue
confirmation_block = tx_block + self.context.required_confirmations
if self.web3.eth.blockNumber < confirmation_block:
continue
self.context.db.remove_waiting_transaction(tx_hash)
if receipt["status"] == 1:
log.info("Transaction was mined successfully",
transaction_hash=tx_hash,
receipt=receipt)
else:
log.error(
"Transaction was not mined successfully",
transaction_hash=tx_hash,
receipt=receipt,
)
def _purge_old_monitor_requests(self) -> None:
""" Delete all old MRs for which still no channel exists.
Also marks all MRs which have a channel as not waiting_for_channel to
avoid checking them again, every time.
"""
with self.context.db.conn:
self.context.db.conn.execute("""
UPDATE monitor_request SET waiting_for_channel = 0
WHERE waiting_for_channel
AND EXISTS (
SELECT 1
FROM channel
WHERE channel.identifier = monitor_request.channel_identifier
AND channel.token_network_address = monitor_request.token_network_address
)
""")
before_this_is_old = datetime.utcnow() - KEEP_MRS_WITHOUT_CHANNEL
self.context.db.conn.execute(
"""
DELETE FROM monitor_request
WHERE waiting_for_channel
AND saved_at < ?
""",
[before_this_is_old],
)
class MonitoringService: # pylint: disable=too-few-public-methods
def __init__(
self,
web3: Web3,
private_key: str,
db_filename: str,
contracts: Dict[str, Contract],
sync_start_block: BlockNumber = BlockNumber(0),
required_confirmations: int = DEFAULT_REQUIRED_CONFIRMATIONS,
poll_interval: float = 1,
min_reward: int = 0,
):
self.web3 = web3
self.private_key = private_key
self.address = private_key_to_address(private_key)
self.required_confirmations = required_confirmations
self.poll_interval = poll_interval
self.last_gas_check_block = 0
web3.middleware_stack.add(construct_sign_and_send_raw_middleware(private_key))
monitoring_contract = contracts[CONTRACT_MONITORING_SERVICE]
user_deposit_contract = contracts[CONTRACT_USER_DEPOSIT]
chain_id = int(web3.net.version)
self.database = Database(
filename=db_filename,
chain_id=chain_id,
registry_address=contracts[CONTRACT_TOKEN_NETWORK_REGISTRY].address,
receiver=self.address,
msc_address=monitoring_contract.address,
sync_start_block=sync_start_block,
)
ms_state = self.database.load_state()
self.context = Context(
ms_state=ms_state,
db=self.database,
w3=self.web3,
contract_manager=CONTRACT_MANAGER,
last_known_block=0,
monitoring_service_contract=monitoring_contract,
user_deposit_contract=user_deposit_contract,
min_reward=min_reward,
)
def start(
self, wait_function: Callable = time.sleep, check_account_gas_reserve: bool = True
) -> None:
while True:
last_confirmed_block = self.web3.eth.blockNumber - self.required_confirmations
# check gas reserve
do_gas_reserve_check = (
check_account_gas_reserve
and last_confirmed_block >= self.last_gas_check_block + DEFAULT_GAS_CHECK_BLOCKS
)
if do_gas_reserve_check:
check_gas_reserve(self.web3, self.private_key)
self.last_gas_check_block = last_confirmed_block
max_query_interval_end_block = (
self.context.ms_state.blockchain_state.latest_known_block + MAX_FILTER_INTERVAL
)
# Limit the max number of blocks that is processed per iteration
last_block = min(last_confirmed_block, max_query_interval_end_block)
self._process_new_blocks(last_block)
try:
wait_function(self.poll_interval)
except KeyboardInterrupt:
log.info("Shutting down")
sys.exit(0)
def _process_new_blocks(self, last_block: BlockNumber) -> None:
self.context.last_known_block = last_block
# BCL return a new state and events related to channel lifecycle
new_chain_state, events = get_blockchain_events(
web3=self.web3,
contract_manager=CONTRACT_MANAGER,
chain_state=self.context.ms_state.blockchain_state,
to_block=last_block,
)
# If a new token network was found we need to write it to the DB, otherwise
# the constraints for new channels will not be constrained. But only update
# the network addresses here, all else is done later.
token_networks_changed = (
self.context.ms_state.blockchain_state.token_network_addresses
!= new_chain_state.token_network_addresses
)
if token_networks_changed:
self.context.ms_state.blockchain_state.token_network_addresses = (
new_chain_state.token_network_addresses
)
self.context.db.update_blockchain_state(self.context.ms_state.blockchain_state)
# Now set the updated chain state to the context, will be stored later
self.context.ms_state.blockchain_state = new_chain_state
for event in events:
handle_event(event, self.context)
# check triggered events and trigger the correct ones
triggered_events = self.context.db.get_scheduled_events(max_trigger_block=last_block)
for scheduled_event in triggered_events:
event = scheduled_event.event
handle_event(event, self.context)
self.context.db.remove_scheduled_event(scheduled_event)
# check pending transactions
# this is done here so we don't have to block waiting for receipts in the state machine
for tx_hash in self.context.db.get_waiting_transactions():
receipt = self.web3.eth.getTransactionReceipt(tx_hash)
if receipt is not None:
self.context.db.remove_waiting_transaction(tx_hash)
if receipt["status"] == 1:
log.info(
"Transaction was mined successfully",
transaction_hash=tx_hash,
receipt=receipt,
)
else:
log.error(
"Transaction was not mined successfully",
transaction_hash=tx_hash,
receipt=receipt,
)