def test_ztest_maximum_win_deviation(self, mock_config_view): """Verify that retrieving zTest maximum win deviation works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Underlying config setting does not parse to an integer mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') self.assertEqual( poet_config_view.ztest_maximum_win_deviation, TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MAXIMUM_WIN_DEVIATION_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.ztest_maximum_win_deviation') self.assertEqual( kwargs['default_value'], TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MAXIMUM_WIN_DEVIATION_) self.assertEqual(kwargs['value_type'], float) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None mock_config_view.return_value.get_setting.return_value = -1.0 self.assertEqual( poet_config_view.ztest_maximum_win_deviation, TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MAXIMUM_WIN_DEVIATION_) mock_config_view.return_value.get_setting.return_value = 0.0 self.assertEqual( poet_config_view.ztest_maximum_win_deviation, TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MAXIMUM_WIN_DEVIATION_) mock_config_view.return_value.get_setting.return_value = float('nan') self.assertEqual( poet_config_view.ztest_maximum_win_deviation, TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MAXIMUM_WIN_DEVIATION_) mock_config_view.return_value.get_setting.return_value = float('inf') self.assertEqual( poet_config_view.ztest_maximum_win_deviation, TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MAXIMUM_WIN_DEVIATION_) mock_config_view.return_value.get_setting.return_value = float('-inf') self.assertEqual( poet_config_view.ztest_maximum_win_deviation, TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MAXIMUM_WIN_DEVIATION_) # Underlying config setting is a valid value mock_config_view.return_value.get_setting.return_value = 2.575 self.assertEqual(poet_config_view.ztest_maximum_win_deviation, 2.575)
def test_population_estimate_sample_size(self, mock_config_view): """Verify that retrieving population estimate sample size works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Simulate an underlying error parsing value mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') self.assertEqual( poet_config_view.population_estimate_sample_size, TestPoetConfigView. _EXPECTED_DEFAULT_POPULATION_ESTIMATE_SAMPLE_SIZE_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.population_estimate_sample_size') self.assertEqual( kwargs['default_value'], TestPoetConfigView. _EXPECTED_DEFAULT_POPULATION_ESTIMATE_SAMPLE_SIZE_) self.assertEqual(kwargs['value_type'], int) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None for bad_value in [-100, -1, 0]: mock_config_view.return_value.get_setting.return_value = bad_value poet_config_view = PoetConfigView(state_view=None) self.assertEqual( poet_config_view.population_estimate_sample_size, TestPoetConfigView. _EXPECTED_DEFAULT_POPULATION_ESTIMATE_SAMPLE_SIZE_) # Underlying config setting is a valid value mock_config_view.return_value.get_setting.return_value = 1 poet_config_view = PoetConfigView(state_view=None) self.assertEqual(poet_config_view.population_estimate_sample_size, 1)
def test_block_claim_delay(self, mock_config_view): """Verify that retrieving block claim delay works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Simulate an underlying error parsing value mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') self.assertEqual( poet_config_view.block_claim_delay, TestPoetConfigView._EXPECTED_DEFAULT_BLOCK_CLAIM_DELAY_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.block_claim_delay') self.assertEqual( kwargs['default_value'], TestPoetConfigView._EXPECTED_DEFAULT_BLOCK_CLAIM_DELAY_) self.assertEqual(kwargs['value_type'], int) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None for bad_value in [-100, -1]: mock_config_view.return_value.get_setting.return_value = bad_value poet_config_view = PoetConfigView(state_view=None) self.assertEqual( poet_config_view.block_claim_delay, TestPoetConfigView._EXPECTED_DEFAULT_BLOCK_CLAIM_DELAY_) # Underlying config setting is a valid value poet_config_view = PoetConfigView(state_view=None) mock_config_view.return_value.get_setting.return_value = 0 self.assertEqual(poet_config_view.block_claim_delay, 0) poet_config_view = PoetConfigView(state_view=None) mock_config_view.return_value.get_setting.return_value = 1 self.assertEqual(poet_config_view.block_claim_delay, 1)
def test_signup_commit_maximum_delay(self, mock_config_view): """Verify that retrieving signup commit maximum delay works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Simulate an underlying error parsing value mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') self.assertEqual( poet_config_view.signup_commit_maximum_delay, TestPoetConfigView._EXPECTED_DEFAULT_SIGNUP_COMMIT_MAXIMUM_DELAY_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.signup_commit_maximum_delay') self.assertEqual( kwargs['default_value'], TestPoetConfigView._EXPECTED_DEFAULT_SIGNUP_COMMIT_MAXIMUM_DELAY_) self.assertEqual(kwargs['value_type'], int) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None for bad_value in [-100, -1]: mock_config_view.return_value.get_setting.return_value = bad_value poet_config_view = PoetConfigView(state_view=None) self.assertEqual( poet_config_view.signup_commit_maximum_delay, TestPoetConfigView. _EXPECTED_DEFAULT_SIGNUP_COMMIT_MAXIMUM_DELAY_) # Underlying config setting is a valid value mock_config_view.return_value.get_setting.return_value = 123 poet_config_view = PoetConfigView(state_view=None) self.assertEqual(poet_config_view.signup_commit_maximum_delay, 123)
def test_ztest_minimum_win_count(self, mock_config_view): """Verify that retrieving zTest minimum win observations works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Simulate an underlying error parsing value mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') self.assertEqual( poet_config_view.ztest_minimum_win_count, TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MINIMUM_WIN_COUNT_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.ztest_minimum_win_count') self.assertEqual( kwargs['default_value'], TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MINIMUM_WIN_COUNT_) self.assertEqual(kwargs['value_type'], int) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None for bad_value in [-100, -1]: mock_config_view.return_value.get_setting.return_value = bad_value poet_config_view = PoetConfigView(state_view=None) self.assertEqual( poet_config_view.ztest_minimum_win_count, TestPoetConfigView._EXPECTED_DEFAULT_ZTEST_MINIMUM_WIN_COUNT_) # Underlying config setting is a valid value mock_config_view.return_value.get_setting.return_value = 0 poet_config_view = PoetConfigView(state_view=None) self.assertEqual(poet_config_view.ztest_minimum_win_count, 0)
def test_target_wait_time(self, mock_config_view): """Verify that retrieving target wait time works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Simulate an underlying error parsing value mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') self.assertEqual( poet_config_view.target_wait_time, TestPoetConfigView._EXPECTED_DEFAULT_TARGET_WAIT_TIME_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.target_wait_time') self.assertEqual( kwargs['default_value'], TestPoetConfigView._EXPECTED_DEFAULT_TARGET_WAIT_TIME_) self.assertEqual(kwargs['value_type'], float) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None for bad_value in \ [-100.0, -1.0, 0.0, float('nan'), float('inf'), float('-inf')]: mock_config_view.return_value.get_setting.return_value = bad_value poet_config_view = PoetConfigView(state_view=None) self.assertEqual( poet_config_view.target_wait_time, TestPoetConfigView._EXPECTED_DEFAULT_TARGET_WAIT_TIME_) # Underlying config setting is a valid value mock_config_view.return_value.get_setting.return_value = 3.1415 poet_config_view = PoetConfigView(state_view=None) self.assertEqual(poet_config_view.target_wait_time, 3.1415)
def get_poet_enclave_module(cls, state_view, config_dir): """Returns the PoET enclave module based upon the corresponding value set by the sawtooth_config transaction family. If no PoET enclave module has been set in the configuration, it defaults to the PoET enclave simulator. Args: state_view (StateView): The current state view. config_dir (str): path to location where configuration for the poet enclave module can be found. Returns: module: The configured PoET enclave module, or the PoET enclave simulator module if none configured. Raises: ImportError: Raised if the given module_name does not correspond to a consensus implementation. """ with cls._lock: # We are only going to load the PoET enclave if we haven't already # done so. Otherwise, we are just going to return the previously- # loaded enclave module. if cls._poet_enclave_module is None: # Get the configured PoET enclave module name. poet_config_view = PoetConfigView(state_view) module_name = poet_config_view.enclave_module_name LOGGER.info('Load PoET enclave module: %s', module_name) LOGGER.info( 'Target wait time: %f', poet_config_view.target_wait_time) LOGGER.info( 'Initial wait time: %f', poet_config_view.initial_wait_time) LOGGER.info( 'Population estimate sample size: %d', poet_config_view.population_estimate_sample_size) LOGGER.info( 'Minimum wait time: %f', poet_config_view.minimum_wait_time) # Load and initialize the module module = importlib.import_module(module_name) module.initialize(config_dir) cls._poet_enclave_module = module return cls._poet_enclave_module
def test_enclave_module_name(self, mock_config_view): """Verify that retrieving enclave module name works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Simulate an underlying error parsing value mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') self.assertEqual( poet_config_view.enclave_module_name, TestPoetConfigView._EXPECTED_DEFAULT_ENCLAVE_MODULE_NAME_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.enclave_module_name') self.assertEqual( kwargs['default_value'], TestPoetConfigView._EXPECTED_DEFAULT_ENCLAVE_MODULE_NAME_) self.assertEqual(kwargs['value_type'], str) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None mock_config_view.return_value.get_setting.return_value = '' poet_config_view = PoetConfigView(state_view=None) self.assertEqual( poet_config_view.enclave_module_name, TestPoetConfigView._EXPECTED_DEFAULT_ENCLAVE_MODULE_NAME_) # Underlying config setting is a valid value mock_config_view.return_value.get_setting.return_value = 'valid value' poet_config_view = PoetConfigView(state_view=None) self.assertEqual(poet_config_view.enclave_module_name, 'valid value')
def test_key_block_claim_limit(self, mock_config_view): """Verify that retrieving key block claim limit works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Underlying config setting does not parse to an integer mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') # pylint: disable=protected-access self.assertEqual( poet_config_view.key_block_claim_limit, PoetConfigView._DEFAULT_KEY_CLAIM_LIMIT_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.key_block_claim_limit') # pylint: disable=protected-access self.assertEqual( kwargs['default_value'], PoetConfigView._DEFAULT_KEY_CLAIM_LIMIT_) self.assertEqual(kwargs['value_type'], int) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None mock_config_view.return_value.get_setting.return_value = -1 # pylint: disable=protected-access self.assertEqual( poet_config_view.key_block_claim_limit, PoetConfigView._DEFAULT_KEY_CLAIM_LIMIT_) mock_config_view.return_value.get_setting.return_value = 0 # pylint: disable=protected-access self.assertEqual( poet_config_view.key_block_claim_limit, PoetConfigView._DEFAULT_KEY_CLAIM_LIMIT_) # Underlying config setting is a valid value mock_config_view.return_value.get_setting.return_value = 1 self.assertEqual( poet_config_view.key_block_claim_limit, 1)
def test_fixed_duration_block_count(self, mock_config_view): """Verify that retrieving fixed duration block count works for invalid cases (missing, invalid format, invalid value) as well as valid case. """ poet_config_view = PoetConfigView(state_view=None) # Underlying config setting does not parse to an integer mock_config_view.return_value.get_setting.side_effect = \ ValueError('bad value') self.assertEqual( poet_config_view.fixed_duration_block_count, TestPoetConfigView._EXPECTED_DEFAULT_FIXED_DURATION_BLOCK_COUNT_) _, kwargs = \ mock_config_view.return_value.get_setting.call_args self.assertEqual(kwargs['key'], 'sawtooth.poet.fixed_duration_block_count') self.assertEqual( kwargs['default_value'], TestPoetConfigView._EXPECTED_DEFAULT_FIXED_DURATION_BLOCK_COUNT_) self.assertEqual(kwargs['value_type'], int) # Underlying config setting is not a valid value mock_config_view.return_value.get_setting.side_effect = None mock_config_view.return_value.get_setting.return_value = -1 self.assertEqual( poet_config_view.fixed_duration_block_count, TestPoetConfigView._EXPECTED_DEFAULT_FIXED_DURATION_BLOCK_COUNT_) mock_config_view.return_value.get_setting.return_value = 0 self.assertEqual( poet_config_view.fixed_duration_block_count, TestPoetConfigView._EXPECTED_DEFAULT_FIXED_DURATION_BLOCK_COUNT_) # Underlying config setting is a valid value mock_config_view.return_value.get_setting.return_value = 1 self.assertEqual(poet_config_view.fixed_duration_block_count, 1)
def initialize_block(self, block_header): """Do initialization necessary for the consensus to claim a block, this may include initiating voting activities, starting proof of work hash generation, or create a PoET wait timer. Args: block_header (BlockHeader): The BlockHeader to initialize. Returns: Boolean: True if the candidate block should be built. False if no candidate should be built. """ # If the previous block ID matches our cached one, that means that we # have already determined that even if we initialize the requested # block we would not be able to claim it. So, instead of wasting time # doing all of the checking again, simply short-circuit the failure so # that the validator can go do something more useful. if block_header.previous_block_id == \ PoetBlockPublisher._previous_block_id: return False PoetBlockPublisher._previous_block_id = block_header.previous_block_id # Using the current chain head, we need to create a state view so we # can create a PoET enclave. state_view = \ BlockWrapper.state_view_for_block( block_wrapper=self._block_cache.block_store.chain_head, state_view_factory=self._state_view_factory) poet_enclave_module = \ factory.PoetEnclaveFactory.get_poet_enclave_module( state_view=state_view, config_dir=self._config_dir) # Get our validator registry entry to see what PoET public key # other validators think we are using. validator_registry_view = ValidatorRegistryView(state_view) validator_info = None try: validator_id = block_header.signer_pubkey validator_info = \ validator_registry_view.get_validator_info( validator_id=validator_id) except KeyError: pass # If we don't have a validator registry entry, then check the active # key. If we don't have one, then we need to sign up. # If we do have one, then our validator registry entry has not # percolated through the system, so nothing to to but wait. active_poet_public_key = self._poet_key_state_store.active_key if validator_info is None: if active_poet_public_key is None: LOGGER.debug( 'No public key found, so going to register new signup ' 'information') self._register_signup_information( block_header=block_header, poet_enclave_module=poet_enclave_module) return False # Otherwise, we have a current validator registry entry. In that # case, we need to make sure that we are using the same PPK that the # other validators think we are using. If not, then we need to switch # the PoET enclave to using the correct keys. elif validator_info.signup_info.poet_public_key != \ active_poet_public_key: # Retrieve the key state corresponding to the PoET public key and # use it to re-establish the key used by the enclave. Also update # the active PoET public key. poet_key_state = \ self._poet_key_state_store[ validator_info.signup_info.poet_public_key] active_poet_public_key = \ SignupInfo.unseal_signup_data( poet_enclave_module=poet_enclave_module, validator_address=block_header.signer_pubkey, sealed_signup_data=poet_key_state.sealed_signup_data) self._poet_key_state_store.active_key = active_poet_public_key assert active_poet_public_key == \ validator_info.signup_info.poet_public_key LOGGER.debug('Switched to public key: %s...%s', active_poet_public_key[:8], active_poet_public_key[-8:]) LOGGER.debug('Unseal signup data: %s...%s', poet_key_state.sealed_signup_data[:8], poet_key_state.sealed_signup_data[-8:]) consensus_state = \ ConsensusState.consensus_state_for_block_id( block_id=block_header.previous_block_id, block_cache=self._block_cache, state_view_factory=self._state_view_factory, consensus_state_store=self._consensus_state_store, poet_enclave_module=poet_enclave_module) poet_config_view = PoetConfigView(state_view) # If our signup information does not pass the freshness test, then we # know that other validators will reject any blocks we try to claim so # we need to try to sign up again. if consensus_state.validator_signup_was_committed_too_late( validator_info=validator_info, poet_config_view=poet_config_view, block_cache=self._block_cache): LOGGER.error( 'Reject building on block %s: Validator signup information ' 'not committed in a timely manner.', block_header.previous_block_id[:8]) self._register_signup_information( block_header=block_header, poet_enclave_module=poet_enclave_module) return False # Using the consensus state for the block upon which we want to # build, check to see how many blocks we have claimed on this chain # with this PoET key. If we have hit the key block claim limit, then # we need to check if the key has been refreshed. if consensus_state.validator_has_claimed_block_limit( validator_info=validator_info, poet_config_view=poet_config_view): # Because we have hit the limit, check to see if we have already # submitted a validator registry transaction with new signup # information, and therefore a new PoET public key. If not, then # mark this PoET public key in the store as having been refreshed # and register new signup information. Regardless, since we have # hit the key block claim limit, we won't even bother initializing # a block on this chain as it will be rejected by other # validators. poet_key_state = self._poet_key_state_store[active_poet_public_key] if not poet_key_state.has_been_refreshed: LOGGER.info('Reached block claim limit for key: %s...%s', active_poet_public_key[:8], active_poet_public_key[-8:]) sealed_signup_data = poet_key_state.sealed_signup_data self._poet_key_state_store[active_poet_public_key] = \ PoetKeyState( sealed_signup_data=sealed_signup_data, has_been_refreshed=True) self._register_signup_information( block_header=block_header, poet_enclave_module=poet_enclave_module) LOGGER.error( 'Reject building on block %s: Validator has reached maximum ' 'number of blocks with key pair.', block_header.previous_block_id[:8]) return False # Verify that we are abiding by the block claim delay (i.e., waiting a # certain number of blocks since our validator registry was added/ # updated). if consensus_state.validator_is_claiming_too_early( validator_info=validator_info, block_number=block_header.block_num, validator_registry_view=validator_registry_view, poet_config_view=poet_config_view, block_store=self._block_cache.block_store): LOGGER.error( 'Reject building on block %s: Validator has not waited long ' 'enough since registering validator information.', block_header.previous_block_id[:8]) return False # We need to create a wait timer for the block...this is what we # will check when we are asked if it is time to publish the block previous_certificate_id = \ utils.get_previous_certificate_id( block_header=block_header, block_cache=self._block_cache, poet_enclave_module=poet_enclave_module) wait_timer = \ WaitTimer.create_wait_timer( poet_enclave_module=poet_enclave_module, validator_address=block_header.signer_pubkey, previous_certificate_id=previous_certificate_id, consensus_state=consensus_state, poet_config_view=poet_config_view) # NOTE - we do the zTest after we create the wait timer because we # need its population estimate to see if this block would be accepted # by other validators based upon the zTest. # Check to see if by chance we were to be able to claim this block # if it would result in us winning more frequently than statistically # expected. If so, then refuse to initialize the block because other # validators will not accept anyway. if consensus_state.validator_is_claiming_too_frequently( validator_info=validator_info, previous_block_id=block_header.previous_block_id, poet_config_view=poet_config_view, population_estimate=wait_timer.population_estimate( poet_config_view=poet_config_view), block_cache=self._block_cache, poet_enclave_module=poet_enclave_module): LOGGER.error( 'Reject building on block %s: Validator is claiming blocks ' 'too frequently.', block_header.previous_block_id[:8]) return False # At this point, we know that if we are able to claim the block we are # initializing, we will not be prevented from doing so because of PoET # policies. self._wait_timer = wait_timer PoetBlockPublisher._previous_block_id = None LOGGER.debug('Created wait timer: %s', self._wait_timer) return True
def compare_forks(self, cur_fork_head, new_fork_head): """Given the head of two forks, return which should be the fork that the validator chooses. When this is called both forks consist of only valid blocks. Args: cur_fork_head (Block): The current head of the block chain. new_fork_head (Block): The head of the fork that is being evaluated. Returns: Boolean: True if the new chain should replace the current chain. False if the new chain should be discarded. """ chosen_fork_head = None state_view = \ BlockWrapper.state_view_for_block( block_wrapper=cur_fork_head, state_view_factory=self._state_view_factory) poet_enclave_module = \ factory.PoetEnclaveFactory.get_poet_enclave_module( state_view=state_view, config_dir=self._config_dir) current_fork_wait_certificate = \ utils.deserialize_wait_certificate( block=cur_fork_head, poet_enclave_module=poet_enclave_module) new_fork_wait_certificate = \ utils.deserialize_wait_certificate( block=new_fork_head, poet_enclave_module=poet_enclave_module) # If we ever get a new fork head that is not a PoET block, then bail # out. This should never happen, but defensively protect against it. if new_fork_wait_certificate is None: raise \ TypeError( 'New fork head {} is not a PoET block'.format( new_fork_head.identifier[:8])) # Criterion #1: If the current fork head is not PoET, then check to see # if the new fork head is building on top of it. That would be okay. # However if not, then we don't have a good deterministic way of # choosing a winner. Again, the latter should never happen, but # defensively protect against it. if current_fork_wait_certificate is None: if new_fork_head.previous_block_id == cur_fork_head.identifier: LOGGER.info( 'Choose new fork %s: New fork head switches consensus to ' 'PoET', new_fork_head.identifier[:8]) chosen_fork_head = new_fork_head else: raise \ TypeError( 'Trying to compare a PoET block {} to a non-PoET ' 'block {} that is not the direct predecessor'.format( new_fork_head.identifier[:8], cur_fork_head.identifier[:8])) # Criterion #2: If they share the same immediate previous block, # then the one with the smaller wait duration is chosen elif cur_fork_head.previous_block_id == \ new_fork_head.previous_block_id: if current_fork_wait_certificate.duration < \ new_fork_wait_certificate.duration: LOGGER.info( 'Choose current fork %s: Current fork wait duration ' '(%f) less than new fork wait duration (%f)', cur_fork_head.header_signature[:8], current_fork_wait_certificate.duration, new_fork_wait_certificate.duration) chosen_fork_head = cur_fork_head elif new_fork_wait_certificate.duration < \ current_fork_wait_certificate.duration: LOGGER.info( 'Choose new fork %s: New fork wait duration (%f) ' 'less than new fork wait duration (%f)', new_fork_head.header_signature[:8], new_fork_wait_certificate.duration, current_fork_wait_certificate.duration) chosen_fork_head = new_fork_head # Criterion #3: If they don't share the same immediate previous # block, then the one with the higher aggregate local mean wins else: # Get the consensus state for the current fork head and the # block immediately before the new fork head (as we haven't # committed to the block yet). So that the new fork doesn't # have to fight with one hand tied behind its back, add the # new fork head's wait certificate's local mean to the # aggregate local mean for the predecessor block's consensus # state for the comparison. current_fork_consensus_state = \ ConsensusState.consensus_state_for_block_id( block_id=cur_fork_head.identifier, block_cache=self._block_cache, state_view_factory=self._state_view_factory, consensus_state_store=self._consensus_state_store, poet_enclave_module=poet_enclave_module) new_fork_consensus_state = \ ConsensusState.consensus_state_for_block_id( block_id=new_fork_head.previous_block_id, block_cache=self._block_cache, state_view_factory=self._state_view_factory, consensus_state_store=self._consensus_state_store, poet_enclave_module=poet_enclave_module) new_fork_aggregate_local_mean = \ new_fork_consensus_state.aggregate_local_mean + \ new_fork_wait_certificate.local_mean if current_fork_consensus_state.aggregate_local_mean > \ new_fork_aggregate_local_mean: LOGGER.info( 'Choose current fork %s: Current fork aggregate ' 'local mean (%f) greater than new fork aggregate ' 'local mean (%f)', cur_fork_head.header_signature[:8], current_fork_consensus_state.aggregate_local_mean, new_fork_aggregate_local_mean) chosen_fork_head = cur_fork_head elif new_fork_aggregate_local_mean > \ current_fork_consensus_state.aggregate_local_mean: LOGGER.info( 'Choose new fork %s: New fork aggregate local mean ' '(%f) greater than current fork aggregate local mean ' '(%f)', new_fork_head.header_signature[:8], new_fork_aggregate_local_mean, current_fork_consensus_state.aggregate_local_mean) chosen_fork_head = new_fork_head # Criterion #4: If we have gotten to this point and we have not chosen # yet, we are going to fall back on using the block identifiers # (header signatures) . The lexicographically larger one will be the # chosen one. The chance that they are equal are infinitesimally # small. if chosen_fork_head is None: if cur_fork_head.header_signature > \ new_fork_head.header_signature: LOGGER.info( 'Choose current fork %s: Current fork header signature' '(%s) greater than new fork header signature (%s)', cur_fork_head.header_signature[:8], cur_fork_head.header_signature[:8], new_fork_head.header_signature[:8]) chosen_fork_head = cur_fork_head else: LOGGER.info( 'Choose new fork %s: New fork header signature (%s) ' 'greater than current fork header signature (%s)', new_fork_head.header_signature[:8], new_fork_head.header_signature[:8], cur_fork_head.header_signature[:8]) chosen_fork_head = new_fork_head # Now that we have chosen a fork for the chain head, if we chose the # new fork and it is a PoET block (i.e., it has a wait certificate), # we need to create consensus state store information for the new # fork's chain head. if chosen_fork_head == new_fork_head: # Get the state view for the previous block in the chain so we can # create a PoET enclave previous_block = None try: previous_block = \ self._block_cache[new_fork_head.previous_block_id] except KeyError: pass state_view = \ BlockWrapper.state_view_for_block( block_wrapper=previous_block, state_view_factory=self._state_view_factory) validator_registry_view = ValidatorRegistryView(state_view) try: # Get the validator info for the validator that claimed the # fork head validator_info = \ validator_registry_view.get_validator_info( new_fork_head.header.signer_pubkey) # Get the consensus state for the new fork head's previous # block, let the consensus state update itself appropriately # based upon the validator claiming a block, and then # associate the consensus state with the new block in the # store. consensus_state = \ ConsensusState.consensus_state_for_block_id( block_id=new_fork_head.previous_block_id, block_cache=self._block_cache, state_view_factory=self._state_view_factory, consensus_state_store=self._consensus_state_store, poet_enclave_module=poet_enclave_module) consensus_state.validator_did_claim_block( validator_info=validator_info, wait_certificate=utils.deserialize_wait_certificate( block=new_fork_head, poet_enclave_module=poet_enclave_module), poet_config_view=PoetConfigView(state_view)) self._consensus_state_store[new_fork_head.identifier] = \ consensus_state LOGGER.debug('Create consensus state: BID=%s, ALM=%f, TBCC=%d', new_fork_head.identifier[:8], consensus_state.aggregate_local_mean, consensus_state.total_block_claim_count) except KeyError: # This _should_ never happen. The new potential fork head # has to have been a PoET block and for it to be verified # by the PoET block verifier, it must have been signed by # validator in the validator registry. If not found, we # are going to just stick with the current fork head. LOGGER.error( 'New fork head claimed by validator not in validator ' 'registry: %s...%s', new_fork_head.header.signer_pubkey[:8], new_fork_head.header.signer_pubkey[-8:]) chosen_fork_head = cur_fork_head return chosen_fork_head == new_fork_head
def verify_block(self, block_wrapper): """Check that the block received conforms to the consensus rules. Args: block_wrapper (BlockWrapper): The block to validate. Returns: Boolean: True if the Block is valid, False if the block is invalid. """ # Get the state view for the previous block in the chain so we can # create a PoET enclave and validator registry view previous_block = None try: previous_block = \ self._block_cache[block_wrapper.previous_block_id] except KeyError: pass state_view = \ BlockWrapper.state_view_for_block( block_wrapper=previous_block, state_view_factory=self._state_view_factory) poet_enclave_module = \ factory.PoetEnclaveFactory.get_poet_enclave_module(state_view) validator_registry_view = ValidatorRegistryView(state_view) try: # Grab the validator info based upon the block signer's public # key try: validator_info = \ validator_registry_view.get_validator_info( block_wrapper.header.signer_pubkey) except KeyError: raise \ ValueError( 'Received block from an unregistered validator ' '{}...{}'.format( block_wrapper.header.signer_pubkey[:8], block_wrapper.header.signer_pubkey[-8:])) LOGGER.debug( 'Block Signer Name=%s, ID=%s...%s, PoET public key=' '%s...%s', validator_info.name, validator_info.id[:8], validator_info.id[-8:], validator_info.signup_info.poet_public_key[:8], validator_info.signup_info.poet_public_key[-8:]) # Create a list of certificates leading up to this block. # This seems to have a little too much knowledge of the # WaitTimer implementation, but there is no use getting more # than WaitTimer.certificate_sample_length wait certificates. certificates = \ utils.build_certificate_list( block_header=block_wrapper.header, block_cache=self._block_cache, poet_enclave_module=poet_enclave_module, maximum_number=WaitTimer.certificate_sample_length) # For the candidate block, reconstitute the wait certificate # and verify that it is valid wait_certificate = \ utils.deserialize_wait_certificate( block=block_wrapper, poet_enclave_module=poet_enclave_module) if wait_certificate is None: raise \ ValueError( 'Being asked to verify a block that was not ' 'created by PoET consensus module') poet_public_key = \ validator_info.signup_info.poet_public_key wait_certificate.check_valid( poet_enclave_module=poet_enclave_module, certificates=certificates, poet_public_key=poet_public_key) # Get the consensus state for the block that is being built # upon, fetch the validator state for this validator, and then # see if that validator has already claimed the key bock limit # for its current PoET key pair. If so, then we reject the # block. consensus_state = \ utils.get_consensus_state_for_block_id( block_id=block_wrapper.previous_block_id, block_cache=self._block_cache, state_view_factory=self._state_view_factory, consensus_state_store=self._consensus_state_store, poet_enclave_module=poet_enclave_module) validator_state = \ utils.get_current_validator_state( validator_info=validator_info, consensus_state=consensus_state, block_cache=self._block_cache) poet_config_view = PoetConfigView(state_view=state_view) if validator_state.poet_public_key == poet_public_key and \ validator_state.key_block_claim_count >= \ poet_config_view.key_block_claim_limit: raise \ ValueError( 'Validator {} has already reached claim block limit ' 'for current PoET key pair: {} >= {}'.format( validator_info.name, validator_state.key_block_claim_count, poet_config_view.key_block_claim_limit)) # While having a block claim delay is nice, it turns out that in # practice the claim delay should not be more than one less than # the number of validators. It helps to imagine the scenario # where each validator hits their block claim limit in sequential # blocks and their new validator registry information is updated # in the following block by another validator, assuming that there # were no forks. If there are N validators, once all N validators # have updated their validator registry information, there will # have been N-1 block commits and the Nth validator will only be # able to get its updated validator registry information updated # if the first validator that kicked this off is now able to claim # a block. If the block claim delay was greater than or equal to # the number of validators, at this point no validators would be # able to claim a block. number_of_validators = \ len(validator_registry_view.get_validators()) block_claim_delay = \ min( poet_config_view.block_claim_delay, number_of_validators - 1) # While a validator network is starting up, we need to be careful # about applying the block claim delay because if we are too # aggressive we will get ourselves into a situation where the # block claim delay will prevent any validators from claiming # blocks. So, until we get at least block_claim_delay blocks # we are going to choose not to enforce the delay. if consensus_state.total_block_claim_count <= block_claim_delay: LOGGER.debug( 'Skipping block claim delay check. Only %d block(s) in ' 'the chain. Claim delay is %d block(s). %d validator(s) ' 'registered.', consensus_state.total_block_claim_count, block_claim_delay, number_of_validators) return True blocks_since_registration = \ block_wrapper.block_num - \ validator_state.commit_block_number - 1 if block_claim_delay > blocks_since_registration: raise \ ValueError( 'Validator {} claiming too early. Block: {}, ' 'registered in: {}, wait until after: {}.'.format( validator_info.name, block_wrapper.block_num, validator_state.commit_block_number, validator_state.commit_block_number + block_claim_delay)) LOGGER.debug( '%d block(s) claimed since %s was registered and block ' 'claim delay is %d block(s). Check passed.', blocks_since_registration, validator_info.name, block_claim_delay) except ValueError as error: LOGGER.error('Failed to verify block: %s', error) return False return True
def consensus_state_for_block_id(block_id, block_cache, state_view_factory, consensus_state_store, poet_enclave_module): """Returns the consensus state for the block referenced by block ID, creating it from the consensus state history if necessary. Args: block_id (str): The ID of the block for which consensus state will be returned. block_cache (BlockCache): The block store cache state_view_factory (StateViewFactory): A factory that can be used to create state view object corresponding to blocks consensus_state_store (ConsensusStateStore): The consensus state store that is used to store interim consensus state created up to resulting consensus state poet_enclave_module (module): The PoET enclave module Returns: ConsensusState object representing the consensus state for the block referenced by block_id """ consensus_state = None previous_wait_certificate = None blocks = collections.OrderedDict() # Starting at the chain head, walk the block store backwards until we # either get to the root or we get a block for which we have already # created consensus state while True: block = \ ConsensusState._block_for_id( block_id=block_id, block_cache=block_cache) if block is None: break # Try to fetch the consensus state. If that succeeds, we can # stop walking back as we can now build on that consensus # state. consensus_state = consensus_state_store.get(block_id=block_id) if consensus_state is not None: break wait_certificate = \ utils.deserialize_wait_certificate( block=block, poet_enclave_module=poet_enclave_module) # If this is a PoET block (i.e., it has a wait certificate), get # the validator info for the validator that signed this block and # add the block information we will need to set validator state in # the block's consensus state. if wait_certificate is not None: state_view = \ state_view_factory.create_view( state_root_hash=block.state_root_hash) validator_registry_view = \ ValidatorRegistryView(state_view=state_view) validator_info = \ validator_registry_view.get_validator_info( validator_id=block.header.signer_pubkey) LOGGER.debug( 'We need to build consensus state for block: %s...%s', block_id[:8], block_id[-8:]) blocks[block_id] = \ ConsensusState._BlockInfo( wait_certificate=wait_certificate, validator_info=validator_info, poet_config_view=PoetConfigView(state_view)) # Otherwise, this is a non-PoET block. If we don't have any blocks # yet or the last block we processed was a PoET block, put a # placeholder in the list so that when we get to it we know that we # need to reset the statistics. elif len(blocks) == 0 or previous_wait_certificate is not None: blocks[block_id] = \ ConsensusState._BlockInfo( wait_certificate=None, validator_info=None, poet_config_view=None) previous_wait_certificate = wait_certificate # Move to the previous block block_id = block.previous_block_id # At this point, if we have not found any consensus state, we need to # create default state from which we can build upon if consensus_state is None: consensus_state = ConsensusState() # Now, walk through the blocks for which we were supposed to create # consensus state, from oldest to newest (i.e., in the reverse order in # which they were added), and store state for PoET blocks so that the # next time we don't have to walk so far back through the block chain. for block_id, block_info in reversed(blocks.items()): # If the block was not a PoET block (i.e., didn't have a wait # certificate), reset the consensus state statistics. We are not # going to store this in the consensus state store, but we will use # it as the starting for the next PoET block. if block_info.wait_certificate is None: consensus_state = ConsensusState() # Otherwise, let the consensus state update itself appropriately # based upon the validator claiming a block, and then associate the # consensus state with the new block in the store. # validator state for the validator which claimed the block, create # updated validator state for the validator, set/update the # validator state in the consensus state object, and then associate # the consensus state with the corresponding block in the consensus # state store. else: consensus_state.validator_did_claim_block( validator_info=block_info.validator_info, wait_certificate=block_info.wait_certificate, poet_config_view=block_info.poet_config_view) consensus_state_store[block_id] = consensus_state LOGGER.debug('Create consensus state: BID=%s, ALM=%f, TBCC=%d', block_id[:8], consensus_state.aggregate_local_mean, consensus_state.total_block_claim_count) return consensus_state
def get_poet_enclave_module(cls, state_view): """Returns the PoET enclave module based upon the corresponding value set by the sawtooth_config transaction family. If no PoET enclave module has been set in the configuration, it defaults to the PoET enclave simulator. Args: state_view (StateView): The current state view. Returns: module: The configured PoET enclave module, or the PoET enclave simulator module if none configured. Raises: ImportError: Raised if the given module_name does not correspond to a consensus implementation. """ with cls._lock: # We are only going to load the PoET enclave if we haven't already # done so. Otherwise, we are just going to return the previously- # loaded enclave module. if cls._poet_enclave_module is None: # Get the configured PoET enclave module name, defaulting to # the PoET enclave simulator module if not present. config_view = ConfigView(state_view) module_name = \ config_view.get_setting( key='sawtooth.poet.enclave_module', default_value='sawtooth_poet_simulator.' 'poet_enclave_simulator.' 'poet_enclave_simulator') LOGGER.info('Load PoET enclave module: %s', module_name) poet_config_view = PoetConfigView(state_view) # For now, configure the wait timer settings based upon the # values in the configuration if present. target_wait_time = \ config_view.get_setting( key='sawtooth.poet.target_wait_time', default_value=wait_timer.WaitTimer.target_wait_time, value_type=float) initial_wait_time = \ config_view.get_setting( key='sawtooth.poet.initial_wait_time', default_value=wait_timer.WaitTimer.initial_wait_time, value_type=float) fixed_duration_blocks = \ poet_config_view.fixed_duration_block_count certificate_sample_length = \ config_view.get_setting( key='sawtooth.poet.certificate_sample_length', default_value=fixed_duration_blocks, value_type=int) minimum_wait_time = \ config_view.get_setting( key='sawtooth.poet.minimum_wait_time', default_value=wait_timer.WaitTimer.minimum_wait_time, value_type=float) LOGGER.info( 'sawtooth.poet.target_wait_time: %f', target_wait_time) LOGGER.info( 'sawtooth.poet.initial_wait_time: %f', initial_wait_time) LOGGER.info( 'sawtooth.poet.certificate_sample_length: %d', certificate_sample_length) LOGGER.info( 'sawtooth.poet.fixed_duration_block_count: %d', poet_config_view.fixed_duration_block_count) LOGGER.info( 'sawtooth.poet.minimum_wait_time: %f', minimum_wait_time) wait_timer.set_wait_timer_globals( target_wait_time=target_wait_time, initial_wait_time=initial_wait_time, certificate_sample_length=certificate_sample_length, fixed_duration_blocks=fixed_duration_blocks, minimum_wait_time=minimum_wait_time) # Load and initialize the module module = importlib.import_module(module_name) module.initialize(**{}) cls._poet_enclave_module = module return cls._poet_enclave_module
def initialize_block(self, block_header): """Do initialization necessary for the consensus to claim a block, this may include initiating voting activities, starting proof of work hash generation, or create a PoET wait timer. Args: block_header (BlockHeader): The BlockHeader to initialize. Returns: Boolean: True if the candidate block should be built. False if no candidate should be built. """ # Using the current chain head, we need to create a state view so we # can create a PoET enclave. state_view = \ BlockWrapper.state_view_for_block( block_wrapper=self._block_cache.block_store.chain_head, state_view_factory=self._state_view_factory) poet_enclave_module = \ factory.PoetEnclaveFactory.get_poet_enclave_module(state_view) # Get our validator registry entry to see what PoET public key # other validators think we are using. validator_registry_view = ValidatorRegistryView(state_view) validator_info = None try: validator_id = block_header.signer_pubkey validator_info = \ validator_registry_view.get_validator_info( validator_id=validator_id) except KeyError: pass # If we don't have a validator registry entry, then check our cached # PoET public key. If we don't have one, then we need to sign up. # If we do have one, then our validator registry entry has not # percolated through the system, so nothing to to but wait. if validator_info is None: if PoetBlockPublisher._poet_public_key is None: LOGGER.debug( 'No public key found, so going to register new signup ' 'information') self._register_signup_information( block_header=block_header, poet_enclave_module=poet_enclave_module) return False # Otherwise, we have a current validator registry entry. In that # case, we need to make sure that we are using the same PPK that the # other validators think we are using. If not, then we need to switch # the PoET enclave to using the correct keys. elif validator_info.signup_info.poet_public_key != \ PoetBlockPublisher._poet_public_key: # Retrieve the key state corresponding to the PoET public key and # use it to re-establish the key used by the enclave. poet_key_state = \ self._poet_key_state_store[ validator_info.signup_info.poet_public_key] PoetBlockPublisher._poet_public_key = \ SignupInfo.unseal_signup_data( poet_enclave_module=poet_enclave_module, validator_address=block_header.signer_pubkey, sealed_signup_data=poet_key_state.sealed_signup_data) assert PoetBlockPublisher._poet_public_key == \ validator_info.signup_info.poet_public_key LOGGER.debug('Switched to public key: %s...%s', PoetBlockPublisher._poet_public_key[:8], PoetBlockPublisher._poet_public_key[-8:]) LOGGER.debug('Unseal signup data: %s...%s', poet_key_state.sealed_signup_data[:8], poet_key_state.sealed_signup_data[-8:]) consensus_state = \ utils.get_consensus_state_for_block_id( block_id=block_header.previous_block_id, block_cache=self._block_cache, state_view_factory=self._state_view_factory, consensus_state_store=self._consensus_state_store, poet_enclave_module=poet_enclave_module) validator_state = \ utils.get_current_validator_state( validator_info=validator_info, consensus_state=consensus_state, block_cache=self._block_cache) poet_config_view = PoetConfigView(state_view) # Using the consensus state for the block upon which we want to # build, check to see how many blocks we have claimed on this chain # with this PoET key. If we have hit the key block claim limit, then # we need to check if the key has been refreshed. key_block_claim_limit = poet_config_view.key_block_claim_limit if validator_state.poet_public_key == \ PoetBlockPublisher._poet_public_key and \ validator_state.key_block_claim_count >= \ key_block_claim_limit: # Because we have hit the limit, check to see if we have already # submitted a validator registry transaction with new signup # information, and therefore a new PoET public key. If not, then # mark this PoET public key in the store as having been refreshed # and register new signup information. Regardless, since we have # hit the key block claim limit, we won't even bother initializing # a block on this chain as it will be rejected by other # validators. poet_key_state = \ self._poet_key_state_store[ PoetBlockPublisher._poet_public_key] if not poet_key_state.has_been_refreshed: LOGGER.info( 'Reached block claim limit (%d) for key for key: %s...%s', key_block_claim_limit, PoetBlockPublisher._poet_public_key[:8], PoetBlockPublisher._poet_public_key[-8:]) sealed_signup_data = poet_key_state.sealed_signup_data self._poet_key_state_store[ PoetBlockPublisher._poet_public_key] = \ PoetKeyState( sealed_signup_data=sealed_signup_data, has_been_refreshed=True) self._register_signup_information( block_header=block_header, poet_enclave_module=poet_enclave_module) return False # Verify that we are abiding by the block claim delay (i.e., waiting a # certain number of blocks since our validator registry was added/ # updated). # While having a block claim delay is nice, it turns out that in # practice the claim delay should not be more than one less than # the number of validators. It helps to imagine the scenario # where each validator hits their block claim limit in sequential # blocks and their new validator registry information is updated # in the following block by another validator, assuming that there # were no forks. If there are N validators, once all N validators # have updated their validator registry information, there will # have been N-1 block commits and the Nth validator will only be # able to get its updated validator registry information updated # if the first validator that kicked this off is now able to claim # a block. If the block claim delay was greater than or equal to # the number of validators, at this point no validators would be # able to claim a block. number_of_validators = \ len(validator_registry_view.get_validators()) block_claim_delay = \ min( poet_config_view.block_claim_delay, number_of_validators - 1) # While a validator network is starting up, we need to be careful # about applying the block claim delay because if we are too # aggressive we will get ourselves into a situation where the # block claim delay will prevent any validators from claiming # blocks. So, until we get at least block_claim_delay blocks # we are going to choose not to enforce the delay. if consensus_state.total_block_claim_count > block_claim_delay: blocks_since_registration = \ block_header.block_num - \ validator_state.commit_block_number - 1 if block_claim_delay > blocks_since_registration: return False # Create a list of certificates for the wait timer. This seems to # have a little too much knowledge of the WaitTimer implementation, # but there is no use getting more than # WaitTimer.certificate_sample_length wait certificates. certificates = \ utils.build_certificate_list( block_header=block_header, block_cache=self._block_cache, poet_enclave_module=poet_enclave_module, maximum_number=WaitTimer.certificate_sample_length) # We need to create a wait timer for the block...this is what we # will check when we are asked if it is time to publish the block self._wait_timer = \ WaitTimer.create_wait_timer( poet_enclave_module=poet_enclave_module, validator_address=block_header.signer_pubkey, certificates=list(certificates)) LOGGER.debug('Created wait timer: %s', self._wait_timer) return True
def verify_block(self, block_wrapper): """Check that the block received conforms to the consensus rules. Args: block_wrapper (BlockWrapper): The block to validate. Returns: Boolean: True if the Block is valid, False if the block is invalid. """ # Get the state view for the previous block in the chain so we can # create a PoET enclave and validator registry view previous_block = None try: previous_block = \ self._block_cache[block_wrapper.previous_block_id] except KeyError: pass state_view = \ BlockWrapper.state_view_for_block( block_wrapper=previous_block, state_view_factory=self._state_view_factory) poet_enclave_module = \ factory.PoetEnclaveFactory.get_poet_enclave_module( state_view=state_view, config_dir=self._config_dir) validator_registry_view = ValidatorRegistryView(state_view) # Grab the validator info based upon the block signer's public # key try: validator_info = \ validator_registry_view.get_validator_info( block_wrapper.header.signer_pubkey) except KeyError: LOGGER.error( 'Block %s rejected: Received block from an unregistered ' 'validator %s...%s', block_wrapper.identifier[:8], block_wrapper.header.signer_pubkey[:8], block_wrapper.header.signer_pubkey[-8:]) return False LOGGER.debug( 'Block Signer Name=%s, ID=%s...%s, PoET public key=' '%s...%s', validator_info.name, validator_info.id[:8], validator_info.id[-8:], validator_info.signup_info.poet_public_key[:8], validator_info.signup_info.poet_public_key[-8:]) # For the candidate block, reconstitute the wait certificate # and verify that it is valid wait_certificate = \ utils.deserialize_wait_certificate( block=block_wrapper, poet_enclave_module=poet_enclave_module) if wait_certificate is None: LOGGER.error( 'Block %s rejected: Block from validator %s (ID=%s...%s) was ' 'not created by PoET consensus module', block_wrapper.identifier[:8], validator_info.name, validator_info.id[:8], validator_info.id[-8:]) return False # Get the consensus state and PoET configuration view for the block # that is being built upon consensus_state = \ ConsensusState.consensus_state_for_block_id( block_id=block_wrapper.previous_block_id, block_cache=self._block_cache, state_view_factory=self._state_view_factory, consensus_state_store=self._consensus_state_store, poet_enclave_module=poet_enclave_module) poet_config_view = PoetConfigView(state_view=state_view) previous_certificate_id = \ utils.get_previous_certificate_id( block_header=block_wrapper.header, block_cache=self._block_cache, poet_enclave_module=poet_enclave_module) try: wait_certificate.check_valid( poet_enclave_module=poet_enclave_module, previous_certificate_id=previous_certificate_id, poet_public_key=validator_info.signup_info.poet_public_key, consensus_state=consensus_state, poet_config_view=poet_config_view) except ValueError as error: LOGGER.error( 'Block %s rejected: Wait certificate check failed - %s', block_wrapper.identifier[:8], error) return False # Reject the block if the validator signup information fails the # freshness check. if consensus_state.validator_signup_was_committed_too_late( validator_info=validator_info, poet_config_view=poet_config_view, block_cache=self._block_cache): LOGGER.error( 'Block %s rejected: Validator signup information not ' 'committed in a timely manner.', block_wrapper.identifier[:8]) return False # Reject the block if the validator has already claimed the key bock # limit for its current PoET key pair. if consensus_state.validator_has_claimed_block_limit( validator_info=validator_info, poet_config_view=poet_config_view): LOGGER.error( 'Block %s rejected: Validator has reached maximum number of ' 'blocks with key pair.', block_wrapper.identifier[:8]) return False # Reject the block if the validator has not waited the required number # of blocks between when the block containing its validator registry # transaction was committed to the chain and trying to claim this # block if consensus_state.validator_is_claiming_too_early( validator_info=validator_info, block_number=block_wrapper.block_num, validator_registry_view=validator_registry_view, poet_config_view=poet_config_view, block_store=self._block_cache.block_store): LOGGER.error( 'Block %s rejected: Validator has not waited long enough ' 'since registering validator information.', block_wrapper.identifier[:8]) return False # Reject the block if the validator is claiming blocks at a rate that # is more frequent than is statistically allowed (i.e., zTest) if consensus_state.validator_is_claiming_too_frequently( validator_info=validator_info, previous_block_id=block_wrapper.previous_block_id, poet_config_view=poet_config_view, population_estimate=wait_certificate.population_estimate( poet_config_view=poet_config_view), block_cache=self._block_cache, poet_enclave_module=poet_enclave_module): LOGGER.error( 'Block %s rejected: Validator is claiming blocks too ' 'frequently.', block_wrapper.identifier[:8]) return False return True
def verify_block(self, block_wrapper): """Check that the block received conforms to the consensus rules. Args: block_wrapper (BlockWrapper): The block to validate. Returns: Boolean: True if the Block is valid, False if the block is invalid. """ # Get the state view for the previous block in the chain so we can # create a PoET enclave and validator registry view previous_block = None try: previous_block = \ self._block_cache[block_wrapper.previous_block_id] except KeyError: pass state_view = \ BlockWrapper.state_view_for_block( block_wrapper=previous_block, state_view_factory=self._state_view_factory) poet_enclave_module = \ factory.PoetEnclaveFactory.get_poet_enclave_module(state_view) validator_registry_view = ValidatorRegistryView(state_view) # Grab the validator info based upon the block signer's public # key try: validator_info = \ validator_registry_view.get_validator_info( block_wrapper.header.signer_pubkey) except KeyError: LOGGER.error( 'Block %s rejected: Received block from an unregistered ' 'validator %s...%s', block_wrapper.identifier[:8], block_wrapper.header.signer_pubkey[:8], block_wrapper.header.signer_pubkey[-8:]) return False LOGGER.debug( 'Block Signer Name=%s, ID=%s...%s, PoET public key=' '%s...%s', validator_info.name, validator_info.id[:8], validator_info.id[-8:], validator_info.signup_info.poet_public_key[:8], validator_info.signup_info.poet_public_key[-8:]) # Create a list of certificates leading up to this block. # This seems to have a little too much knowledge of the # WaitTimer implementation, but there is no use getting more # than WaitTimer.certificate_sample_length wait certificates. certificates = \ utils.build_certificate_list( block_header=block_wrapper.header, block_cache=self._block_cache, poet_enclave_module=poet_enclave_module, maximum_number=WaitTimer.certificate_sample_length) # For the candidate block, reconstitute the wait certificate # and verify that it is valid wait_certificate = \ utils.deserialize_wait_certificate( block=block_wrapper, poet_enclave_module=poet_enclave_module) if wait_certificate is None: LOGGER.error( 'Block %s rejected: Block from validator %s (ID=%s...%s) was ' 'not created by PoET consensus module', block_wrapper.identifier[:8], validator_info.name, validator_info.id[:8], validator_info.id[-8:]) return False wait_certificate.check_valid( poet_enclave_module=poet_enclave_module, certificates=certificates, poet_public_key=validator_info.signup_info.poet_public_key) # Get the consensus state for the block that is being built upon and # then fetch the validator state for this validator consensus_state = \ utils.get_consensus_state_for_block_id( block_id=block_wrapper.previous_block_id, block_cache=self._block_cache, state_view_factory=self._state_view_factory, consensus_state_store=self._consensus_state_store, poet_enclave_module=poet_enclave_module) validator_state = \ utils.get_current_validator_state( validator_info=validator_info, consensus_state=consensus_state, block_cache=self._block_cache) poet_config_view = PoetConfigView(state_view=state_view) # Reject the block if the validator has already claimed the key bock # limit for its current PoET key pair. key_block_claim_limit = poet_config_view.key_block_claim_limit if utils.validator_has_claimed_maximum_number_of_blocks( validator_info=validator_info, validator_state=validator_state, key_block_claim_limit=key_block_claim_limit): LOGGER.error( 'Block %s rejected: Validator has reached maximum number of ' 'blocks with key pair.', block_wrapper.identifier[:8]) return False # Reject the block if the validator has not waited the required number # of blocks between when the block containing its validator registry # transaction was committed to the chain and trying to claim this # block if utils.validator_has_claimed_too_early( validator_info=validator_info, consensus_state=consensus_state, block_number=block_wrapper.block_num, validator_registry_view=validator_registry_view, poet_config_view=poet_config_view, block_store=self._block_cache.block_store): LOGGER.error( 'Block %s rejected: Validator has not waited long enough ' 'since registering validator information.', block_wrapper.identifier[:8]) return False # Reject the block if the validator is claiming blocks at a rate that # is more frequent than is statistically allowed (i.e., zTest) if utils.validator_has_claimed_too_frequently( validator_info=validator_info, previous_block_id=block_wrapper.previous_block_id, consensus_state=consensus_state, poet_config_view=poet_config_view, population_estimate=wait_certificate.population_estimate, block_cache=self._block_cache, poet_enclave_module=poet_enclave_module): LOGGER.error( 'Block %s rejected: Validator is claiming blocks too ' 'frequently.', block_wrapper.identifier[:8]) return False return True