def assertEqual_block(self, expected_block, actual_block):
"""
Function to assertEqual two blocks
"""
crypto = ECCrypto()
self.assertTrue(expected_block is not None)
self.assertTrue(actual_block is not None)
self.assertTrue(crypto.is_valid_public_bin(expected_block.public_key))
self.assertTrue(crypto.is_valid_public_bin(actual_block.public_key))
self.assertDictEqual(expected_block.transaction, actual_block.transaction)
self.assertEqual(expected_block.public_key, actual_block.public_key)
self.assertEqual(expected_block.sequence_number, actual_block.sequence_number)
self.assertEqual(expected_block.link_public_key, actual_block.link_public_key)
self.assertEqual(expected_block.link_sequence_number, actual_block.link_sequence_number)
self.assertEqual(expected_block.previous_hash, actual_block.previous_hash)
self.assertEqual(expected_block.signature, actual_block.signature)
def validate(self, database):
"""
Validates this block against what is known in the database
:param database: the database to check against
:return: A tuple consisting of a ValidationResult and a list of user string errors
"""
# we start off thinking everything is hunky dory
result = [ValidationResult.valid]
errors = []
crypto = ECCrypto()
# short cut for invalidating so we don't have repeating similar code for every error.
# this is also the reason result is a list, we need a mutable container. Assignments in err are limited to its
# scope. So setting result directly is not possible.
def err(reason):
result[0] = ValidationResult.invalid
errors.append(reason)
# Step 1: get all related blocks from the database.
# The validity of blocks is immutable. Once they are accepted they cannot change validation result. In such
# cases subsequent blocks can get validation errors and will not get inserted into the database. Thus we can
# assume that all retrieved blocks are not invalid themselves. Blocks can get inserted into the database in any
# order, so we need to find successors, predecessors as well as the block itself and its linked block.
blk = database.get(self.public_key, self.sequence_number)
link = database.get_linked(self)
prev_blk = database.get_block_before(self)
next_blk = database.get_block_after(self)
# Step 2: determine the maximum validation level
# Depending on the blocks we get from the database, we can decide to reduce the validation level. We must do
# this prior to flagging any errors. This way we are only ever reducing the validation level without having to
# resort to min()/max() every time we set it. We first determine some booleans to make everything readable.
is_genesis = self.sequence_number == GENESIS_SEQ or self.previous_hash == GENESIS_HASH
is_prev_gap = prev_blk.sequence_number != self.sequence_number - 1 if prev_blk else True
is_next_gap = next_blk.sequence_number != self.sequence_number + 1 if next_blk else True
if not prev_blk and not next_blk:
# Is this block a non genesis block? If so, we know nothing about this public key, else pretend the
# prev_blk exists
if not is_genesis:
result[0] = ValidationResult.no_info
else:
# We pretend prev_blk exists. This leaves us with next missing, which means partial-next at best.
result[0] = ValidationResult.partial_next
elif not prev_blk and next_blk:
# Is this block a non genesis block?
if not is_genesis:
# We are really missing prev_blk. So now partial-prev at best.
result[0] = ValidationResult.partial_previous
if is_next_gap:
# Both sides are unknown or non-contiguous return a full partial result.
result[0] = ValidationResult.partial
elif is_next_gap:
# This is a genesis block, so the missing previous is expected. If there is a gap to the next block
# this reduces the validation result to partial-next
result[0] = ValidationResult.partial_next
elif prev_blk and not next_blk:
# We are missing next_blk, so now partial-next at best.
result[0] = ValidationResult.partial_next
if is_prev_gap:
# Both sides are unknown or non-contiguous return a full partial result.
result[0] = ValidationResult.partial
else:
# both sides have known blocks, see if there are gaps
if is_prev_gap and is_next_gap:
result[0] = ValidationResult.partial
elif is_prev_gap:
result[0] = ValidationResult.partial_previous
elif is_next_gap:
result[0] = ValidationResult.partial_next
# Step 3: validate that the block is sane
# Some basic self tests. It is possible to violate these when constructing a block in code or getting a block
# from the database. The wire format is such that it impossible to hit many of these for blocks that went over
# the network.
if self.up < 0:
err("Up field is negative")
if self.down < 0:
err("Down field is negative")
if self.down == 0 and self.up == 0:
# In this case the block doesn't modify any counters, these block are without purpose and are thus invalid.
err("Up and down are zero")
if self.total_up < 0:
err("Total up field is negative")
if self.total_down < 0:
err("Total down field is negative")
if self.sequence_number < GENESIS_SEQ:
err("Sequence number is prior to genesis")
if self.link_sequence_number < GENESIS_SEQ and self.link_sequence_number != UNKNOWN_SEQ:
err("Link sequence number not empty and is prior to genesis")
if not crypto.is_valid_public_bin(self.public_key):
err("Public key is not valid")
else:
# If the public key is valid, we can use it to check the signature. We want just a yes/no answer here, and
# we want to keep checking for more errors, so just catch all packing exceptions and err() if any happen.
try:
pck = self.pack(signature=False)
except:
pck = None
if pck is None or not crypto.is_valid_signature(
crypto.key_from_public_bin(self.public_key), pck,
self.signature):
err("Invalid signature")
if not crypto.is_valid_public_bin(self.link_public_key):
err("Linked public key is not valid")
if self.public_key == self.link_public_key:
# Blocks to self serve no purpose and are thus invalid.
err("Self signed block")
if is_genesis:
if self.sequence_number == GENESIS_SEQ and self.previous_hash != GENESIS_HASH:
err("Sequence number implies previous hash should be Genesis ID"
)
if self.sequence_number != GENESIS_SEQ and self.previous_hash == GENESIS_HASH:
err("Sequence number implies previous hash should not be Genesis ID"
)
if self.total_up != self.up:
err("Genesis block invalid total_up and/or up")
if self.total_down != self.down:
err("Genesis block invalid total_down and/or down")
# Step 4: does the database already know about this block? If so it should be equal or else we caught a
# branch in someones multichain.
if blk:
# Sanity check to see if the database returned the expected block, we want to cover all our bases before
# crying wolf and making a fraud claim.
assert blk.public_key == self.public_key and blk.sequence_number == self.sequence_number, \
"Database returned unexpected block"
if blk.up != self.up:
err("Up does not match known block")
if blk.down != self.down:
err("Down does not match known block")
if blk.total_up != self.total_up:
err("Total up does not match known block")
if blk.total_down != self.total_down:
err("Total down does not match known block")
if blk.link_public_key != self.link_public_key:
err("Link public key does not match known block")
if blk.link_sequence_number != self.link_sequence_number:
err("Link sequence number does not match known block")
if blk.previous_hash != self.previous_hash:
err("Previous hash does not match known block")
if blk.signature != self.signature:
err("Signature does not match known block")
# if the known block is not equal, and the signatures are valid, we have a double signed PK/seq. Fraud!
if self.hash != blk.hash and "Invalid signature" not in errors and "Public key is not valid" not in errors:
err("Double sign fraud")
# Step 5: does the database have the linked block? If so do the values match up? If the values do not match up
# someone comitted fraud, but it is impossible to decide who. So we just invalidate the block that is the latter
# to get validated. We can also detect double counter sign fraud at this point.
if link:
# Sanity check to see if the database returned the expected block, we want to cover all our bases before
# crying wolf and making a fraud claim.
assert link.public_key == self.link_public_key and \
(link.link_sequence_number == self.sequence_number or
link.sequence_number == self.link_sequence_number), \
"Database returned unexpected block"
if self.public_key != link.link_public_key:
err("Public key mismatch on linked block")
elif self.link_sequence_number != UNKNOWN_SEQ:
# self counter signs another block (link). If link has a linked block that is not equal to self,
# then self is fraudulent, since it tries to countersign a block that is already countersigned
linklinked = database.get_linked(link)
if linklinked is not None and linklinked.hash != self.hash:
err("Double countersign fraud")
if self.up != link.down:
err("Up/down mismatch on linked block")
if self.down != link.up:
err("Down/up mismatch on linked block")
# Step 6: Did we get blocks from the database before or after self? They should be checked for violations too.
if prev_blk:
# Sanity check of the block the database gave us.
assert prev_blk.public_key == self.public_key and prev_blk.sequence_number < self.sequence_number,\
"Database returned unexpected block"
if prev_blk.total_up + self.up > self.total_up:
err("Total up is lower than expected compared to the preceding block"
)
if prev_blk.total_down + self.down > self.total_down:
err("Total down is lower than expected compared to the preceding block"
)
if not is_prev_gap and prev_blk.hash != self.previous_hash:
err("Previous hash is not equal to the hash id of the previous block"
)
# Is this fraud? It is certainly an error, but fixing it would require a different signature on the same
# sequence number which is fraud.
if next_blk:
# Sanity check of the block the database gave us.
assert next_blk.public_key == self.public_key and next_blk.sequence_number > self.sequence_number,\
"Database returned unexpected block"
if self.total_up + next_blk.up > next_blk.total_up:
err("Total up is higher than expected compared to the next block"
)
# In this case we could say there is fraud too, since the counters are too high. Also anyone that
# counter signed any such counters should be suspected since they apparently failed to validate or put
# their signature on it regardless of validation status. But it is not immediately clear where this
# error occurred, it might be lower on the chain than self. So it is hard to create a fraud proof here
if self.total_down + next_blk.down > next_blk.total_down:
err("Total down is higher than expected compared to the next block"
)
# See previous comment
if not is_next_gap and next_blk.previous_hash != self.hash:
err("Next hash is not equal to the hash id of the block")
# Again, this might not be fraud, but fixing it can only result in fraud.
return result[0], errors