diff --git a/Pipfile.lock b/Pipfile.lock index da56139b..6a83c293 100644 --- a/Pipfile.lock +++ b/Pipfile.lock @@ -1,7 +1,7 @@ { "_meta": { "hash": { - "sha256": "36d1480b2857d3ca47d87e44b63f4bb1c3ba85e9fba71a9389c6f8161f5edd29" + "sha256": "1cfc261928838be069088d094d13b664d7ff98667a8a9b432e94c3241ab5ad6c" }, "pipfile-spec": 6, "requires": { @@ -18,10 +18,10 @@ "default": { "certifi": { "hashes": [ - "sha256:046832c04d4e752f37383b628bc601a7ea7211496b4638f6514d0e5b9acc4939", - "sha256:945e3ba63a0b9f577b1395204e13c3a231f9bc0223888be653286534e5873695" + "sha256:017c25db2a153ce562900032d5bc68e9f191e44e9a0f762f373977de9df1fbb3", + "sha256:25b64c7da4cd7479594d035c08c2d809eb4aab3a26e5a990ea98cc450c320f1f" ], - "version": "==2019.6.16" + "version": "==2019.11.28" }, "chardet": { "hashes": [ @@ -32,25 +32,25 @@ }, "click": { "hashes": [ - "sha256:2335065e6395b9e67ca716de5f7526736bfa6ceead690adf616d925bdc622b13", - "sha256:5b94b49521f6456670fdb30cd82a4eca9412788a93fa6dd6df72c94d5a8ff2d7" + "sha256:8a18b4ea89d8820c5d0c7da8a64b2c324b4dabb695804dbfea19b9be9d88c0cc", + "sha256:e345d143d80bf5ee7534056164e5e112ea5e22716bbb1ce727941f4c8b471b9a" ], - "version": "==7.0" + "version": "==7.1.1" }, "flask": { "hashes": [ - "sha256:0749df235e3ff61ac108f69ac178c9770caeaccad2509cb762ce1f65570a8856", - "sha256:49f44461237b69ecd901cc7ce66feea0319b9158743dd27a2899962ab214dac1" + "sha256:13f9f196f330c7c2c5d7a5cf91af894110ca0215ac051b5844701f2bfd934d52", + "sha256:45eb5a6fd193d6cf7e0cf5d8a5b31f83d5faae0293695626f539a823e93b13f6" ], "index": "pypi", - "version": "==0.12.2" + "version": "==1.1.1" }, "idna": { "hashes": [ - "sha256:2c6a5de3089009e3da7c5dde64a141dbc8551d5b7f6cf4ed7c2568d0cc520a8f", - "sha256:8c7309c718f94b3a625cb648ace320157ad16ff131ae0af362c9f21b80ef6ec4" + "sha256:7588d1c14ae4c77d74036e8c22ff447b26d0fde8f007354fd48a7814db15b7cb", + "sha256:a068a21ceac8a4d63dbfd964670474107f541babbd2250d61922f029858365fa" ], - "version": "==2.6" + "version": "==2.9" }, "itsdangerous": { "hashes": [ @@ -61,10 +61,10 @@ }, "jinja2": { "hashes": [ - "sha256:065c4f02ebe7f7cf559e49ee5a95fb800a9e4528727aec6f24402a5374c65013", - "sha256:14dd6caf1527abb21f08f86c784eac40853ba93edb79552aa1e4b8aef1b61c7b" + "sha256:93187ffbc7808079673ef52771baa950426fd664d3aad1d0fa3e95644360e250", + "sha256:b0eaf100007721b5c16c1fc1eecb87409464edc10469ddc9a22a27a99123be49" ], - "version": "==2.10.1" + "version": "==2.11.1" }, "markupsafe": { "hashes": [ @@ -72,13 +72,16 @@ "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161", "sha256:09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235", "sha256:1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5", + "sha256:13d3144e1e340870b25e7b10b98d779608c02016d5184cfb9927a9f10c689f42", "sha256:24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff", "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b", "sha256:43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1", "sha256:46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e", "sha256:500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183", "sha256:535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66", + "sha256:596510de112c685489095da617b5bcbbac7dd6384aeebeda4df6025d0256a81b", "sha256:62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1", + "sha256:6788b695d50a51edb699cb55e35487e430fa21f1ed838122d722e0ff0ac5ba15", "sha256:6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1", "sha256:717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e", "sha256:79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b", @@ -95,31 +98,33 @@ "sha256:ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6", "sha256:c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f", "sha256:cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f", - "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7" + "sha256:cdb132fc825c38e1aeec2c8aa9338310d29d337bebbd7baa06889d09a60a1fa2", + "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7", + "sha256:e8313f01ba26fbbe36c7be1966a7b7424942f670f38e666995b88d012765b9be" ], "version": "==1.1.1" }, "requests": { "hashes": [ - "sha256:6a1b267aa90cac58ac3a765d067950e7dbbf75b1da07e895d1f594193a40a38b", - "sha256:9c443e7324ba5b85070c4a818ade28bfabedf16ea10206da1132edaa6dda237e" + "sha256:43999036bfa82904b6af1d99e4882b560e5e2c68e5c4b0aa03b655f3d7d73fee", + "sha256:b3f43d496c6daba4493e7c431722aeb7dbc6288f52a6e04e7b6023b0247817e6" ], "index": "pypi", - "version": "==2.18.4" + "version": "==2.23.0" }, "urllib3": { "hashes": [ - "sha256:06330f386d6e4b195fbfc736b297f58c5a892e4440e54d294d7004e3a9bbea1b", - "sha256:cc44da8e1145637334317feebd728bd869a35285b93cbb4cca2577da7e62db4f" + "sha256:2f3db8b19923a873b3e5256dc9c2dedfa883e33d87c690d9c7913e1f40673cdc", + "sha256:87716c2d2a7121198ebcb7ce7cccf6ce5e9ba539041cfbaeecfb641dc0bf6acc" ], - "version": "==1.22" + "version": "==1.25.8" }, "werkzeug": { "hashes": [ - "sha256:865856ebb55c4dcd0630cdd8f3331a1847a819dda7e8c750d3db6f2aa6c0209c", - "sha256:a0b915f0815982fb2a09161cb8f31708052d0951c3ba433ccc5e1aa276507ca6" + "sha256:169ba8a33788476292d04186ab33b01d6add475033dfc07215e6d219cc077096", + "sha256:6dc65cf9091cf750012f56f2cad759fa9e879f511b5ff8685e456b4e3bf90d16" ], - "version": "==0.15.4" + "version": "==1.0.0" } }, "develop": { @@ -132,11 +137,11 @@ }, "flake8": { "hashes": [ - "sha256:859996073f341f2670741b51ec1e67a01da142831aa1fdc6242dbf88dffbe661", - "sha256:a796a115208f5c03b18f332f7c11729812c8c3ded6c46319c59b53efd3819da8" + "sha256:45681a117ecc81e870cbf1262835ae4af5e7a8b08e40b944a8a6e6b895914cfb", + "sha256:49356e766643ad15072a789a20915d3c91dc89fd313ccd71802303fd67e4deca" ], "index": "pypi", - "version": "==3.7.7" + "version": "==3.7.9" }, "mccabe": { "hashes": [ diff --git a/README.md b/README.md index 204d46a7..14b991fc 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,12 @@ https://imgur.com/xSlgvtl ### Part 1 in Class Project * Basic Setup and Proof of Work (basic_block_gp) +``` +pipenv shell +pipenv install +python basic_block_gp/blockchain.py +``` ### Part 1 Take Home Project * Client Miners (client_mining_p) diff --git a/basic_block_gp/blockchain.py b/basic_block_gp/blockchain.py index 54ead5c1..361bae53 100644 --- a/basic_block_gp/blockchain.py +++ b/basic_block_gp/blockchain.py @@ -5,7 +5,6 @@ from flask import Flask, jsonify, request - class Blockchain(object): def __init__(self): self.chain = [] @@ -17,32 +16,35 @@ def __init__(self): def new_block(self, proof, previous_hash=None): """ Create a new Block in the Blockchain - A block should have: * Index * Timestamp * List of current transactions * The proof used to mine this block * The hash of the previous block - :param proof: The proof given by the Proof of Work algorithm :param previous_hash: (Optional) Hash of previous Block :return: New Block """ block = { - # TODO + 'index': len(self.chain) + 1, + 'proof': proof, + 'timestamp': time(), + 'transactions': self.current_transactions, + 'previous_hash': previous_hash, } # Reset the current list of transactions + self.current_transactions = [] # Append the chain to the block + self.chain.append(block) # Return the new block - pass + return block def hash(self, block): """ Creates a SHA-256 hash of a Block - :param block": Block "return": """ @@ -55,35 +57,26 @@ def hash(self, block): # We must make sure that the Dictionary is Ordered, # or we'll have inconsistent hashes - # TODO: Create the block_string - - # TODO: Hash this string using sha256 + # Create the block_string + block_str = json.dumps(block, sort_keys=True) + str_bytes = block_str.encode() + # Hash this string using sha256 + hash_obj = hashlib.sha256(str_bytes) + hash_str = hash_obj.hexdigest() # By itself, the sha256 function returns the hash in a raw string # that will likely include escaped characters. # This can be hard to read, but .hexdigest() converts the # hash to a string of hexadecimal characters, which is # easier to work with and understand - # TODO: Return the hashed block string in hexadecimal format - pass + # Return the hashed block string in hexadecimal format + return hash_str @property def last_block(self): return self.chain[-1] - def proof_of_work(self, block): - """ - Simple Proof of Work Algorithm - Stringify the block and look for a proof. - Loop through possibilities, checking each one against `valid_proof` - in an effort to find a number that is a valid proof - :return: A valid proof for the provided block - """ - # TODO - pass - # return proof - @staticmethod def valid_proof(block_string, proof): """ @@ -96,10 +89,16 @@ def valid_proof(block_string, proof): correct number of leading zeroes. :return: True if the resulting hash is a valid proof, False otherwise """ - # TODO - pass + guess = f'{block_string}{proof}'.encode() + # return True or False + guess_hash = hashlib.sha256(guess).hexdigest() + return guess_hash[:6] == '000000' + def new_transaction(self, sender, recipient, amount): + transaction = {"sender": sender, "recipient": recipient, "amount": amount} + self.current_transactions.append(transaction) + return self.last_block["index"] + 1 # Instantiate our Node app = Flask(__name__) @@ -111,27 +110,60 @@ def valid_proof(block_string, proof): blockchain = Blockchain() -@app.route('/mine', methods=['GET']) +@app.route('/mine', methods=['POST']) def mine(): - # Run the proof of work algorithm to get the next proof + data = request.get_json() - # Forge the new Block by adding it to the chain with the proof + req_params = ['proof', 'id'] + if not all(k in data for k in req_params): + response = { + 'message': 'Missing required fields.' + } + return jsonify(response), 400 + + proof_sent = data['proof'] + + blk_str = json.dumps(blockchain.last_block, sort_keys=True) + + is_proof_valid = blockchain.valid_proof(blk_str, proof_sent) + recipient_id = data["id"] + + if is_proof_valid: + previous_hash = blockchain.hash(blockchain.last_block) + new_blk = blockchain.new_block(proof_sent, previous_hash) + blockchain.new_transaction(sender="0", recipient=recipient_id, amount=1) + + response = { + "message": "Congratulation! New block is found", + "index": new_blk["index"], + "transactions": new_blk["transactions"], + "proof": new_blk["proof"], + "previous_hash": new_blk["previous_hash"] + } + return jsonify(response), 200 + else: + return jsonify({'message': 'Invalid Proof. Unsuccessful Try again.'}), 200 +@app.route('/chain', methods=['GET']) +def full_chain(): response = { - # TODO: Send a JSON response with the new block + # Return the chain and its current length + 'chain': blockchain.chain, + 'chain_length': len(blockchain.chain) } - return jsonify(response), 200 -@app.route('/chain', methods=['GET']) -def full_chain(): +@app.route('/last_block', methods=['GET']) +def last_block_in_chain(): + # last block in chain + last_block = blockchain.chain[-1] response = { - # TODO: Return the chain and its current length + 'last_block': last_block } return jsonify(response), 200 # Run the program on port 5000 if __name__ == '__main__': - app.run(host='0.0.0.0', port=5000) + app.run(host='0.0.0.0', port=5000) \ No newline at end of file diff --git a/client_mining_p/blockchain.py b/client_mining_p/blockchain.py index a0a26551..bae3c2d1 100644 --- a/client_mining_p/blockchain.py +++ b/client_mining_p/blockchain.py @@ -1,2 +1,164 @@ -# Paste your version of blockchain.py from the basic_block_gp -# folder here +import hashlib +import json +from time import time +from uuid import uuid4 + +from flask import Flask, jsonify, request + + +class Blockchain(object): + def __init__(self): + self.chain = [] + self.current_transactions = [] + + # Create the genesis block + self.new_block(previous_hash=1, proof=100) + + def new_block(self, proof, previous_hash=None): + """ + Create a new Block in the Blockchain + + A block should have: + * Index + * Timestamp + * List of current transactions + * The proof used to mine this block + * The hash of the previous block + + :param proof: The proof given by the Proof of Work algorithm + :param previous_hash: (Optional) Hash of previous Block + :return: New Block + """ + + block = { + 'index': len(self.chain) + 1, + 'proof': proof, + 'timestamp': time(), + 'transactions': self.current_transactions, + 'previous_hash': previous_hash, + } + + # Reset the current list of transactions + self.current_transactions = [] + # Append the block to the chain + self.chain.append(block) + # Return the new block + return block + + def hash(self, block): + """ + Creates a SHA-256 hash of a Block + + :param block": Block + "return": + """ + + # Use json.dumps to convert json into a string + # Use hashlib.sha256 to create a hash + # It requires a `bytes-like` object, which is what + # .encode() does. + # It converts the Python string into a byte string. + + # We must make sure that the Dictionary is Ordered, + # or we'll have inconsistent hashes + + # TODO: Create the block_string + block_string = json.dumps(block, sort_keys=True) + string_in_bytes = block_string.encode() + + # TODO: Hash this string using sha256 + hash_object = hashlib.sha256(string_in_bytes) + hash_string = hash_object.hexdigest() + + # By itself, the sha256 function returns the hash in a raw string + # that will likely include escaped characters. + # This can be hard to read, but .hexdigest() converts the + # hash to a string of hexadecimal characters, which is + # easier to work with and understand + + # TODO: Return the hashed block string in hexadecimal format + return hash_string + + @property + def last_block(self): + return self.chain[-1] + + def proof_of_work(self, block): + """ + Simple Proof of Work Algorithm + Stringify the block and look for a proof. + Loop through possibilities, checking each one against `valid_proof` + in an effort to find a number that is a valid proof + :return: A valid proof for the provided block + """ + + block_string = json.dumps(block, sort_keys=True) + + proof = 0 + while self.valid_proof(block_string, proof) is False: + proof += 1 + + return proof + + @staticmethod + def valid_proof(block_string, proof): + """ + Validates the Proof: Does hash(block_string, proof) contain 3 + leading zeroes? Return true if the proof is valid + :param block_string: The stringified block to use to + check in combination with `proof` + :param proof: The value that when combined with the + stringified previous block results in a hash that has the + correct number of leading zeroes. + :return: True if the resulting hash is a valid proof, False otherwise + """ + guess = f'{block_string}{proof}'.encode() + + guess_hash = hashlib.sha256(guess).hexdigest() + return guess_hash[:3] == '000' + +# Instantiate our Node +app = Flask(__name__) + +# Generate a globally unique address for this node +node_identifier = str(uuid4()).replace('-', '') + +# Instantiate the Blockchain +blockchain = Blockchain() + +@app.route('/mine', methods=['GET']) +def mine(): + # Run the proof of work algorithm to get the next proof + + block = blockchain.last_block + proof = blockchain.proof_of_work(block) + + # Forge the new Block by adding it to the chain with the proof + + block_hash = blockchain.hash(block) + new_block = blockchain.new_block(proof, block_hash) + + response = { + 'message': "hey I found a proof! and forged a new block", + 'index': new_block['index'], + 'transactions': new_block['transactions'], + 'proof': new_block['proof'], + 'previous_hash': block_hash, + } + + return jsonify(response), 200 + + +@app.route('/chain', methods=['GET']) +def full_chain(): + response = { + # TODO: Return the chain and its current length + 'chain': blockchain.chain, + 'chain_length': len(blockchain.chain) + } + return jsonify(response), 200 + + +# Run the program on port 5000 +if __name__ == '__main__': + app.run(host='0.0.0.0', port=5000) \ No newline at end of file diff --git a/client_mining_p/miner.py b/client_mining_p/miner.py index 8e211b88..8adabeb9 100644 --- a/client_mining_p/miner.py +++ b/client_mining_p/miner.py @@ -1,10 +1,9 @@ import hashlib import requests - +import time import sys import json - def proof_of_work(block): """ Simple Proof of Work Algorithm @@ -13,8 +12,13 @@ def proof_of_work(block): in an effort to find a number that is a valid proof :return: A valid proof for the provided block """ - pass + block_string = json.dumps(block, sort_keys=True) + proof = 0 + while valid_proof(block_string, proof) is False: + proof += 1 + + return proof def valid_proof(block_string, proof): """ @@ -27,8 +31,11 @@ def valid_proof(block_string, proof): correct number of leading zeroes. :return: True if the resulting hash is a valid proof, False otherwise """ - pass + guess = f'{block_string}{proof}'.encode() + guess_hash = hashlib.sha256(guess).hexdigest() + + return guess_hash[:6] == "000000" if __name__ == '__main__': # What is the server address? IE `python3 miner.py https://server.com/api/` @@ -42,7 +49,8 @@ def valid_proof(block_string, proof): id = f.read() print("ID is", id) f.close() - + coin_mined = 0 + # Run forever until interrupted while True: r = requests.get(url=node + "/last_block") @@ -56,15 +64,22 @@ def valid_proof(block_string, proof): break # TODO: Get the block from `data` and use it to look for a new proof - # new_proof = ??? + print(data) + new_proof = proof_of_work(data.get('last_block')) # When found, POST it to the server {"proof": new_proof, "id": id} post_data = {"proof": new_proof, "id": id} - + print("post_data: ", post_data) r = requests.post(url=node + "/mine", json=post_data) data = r.json() # TODO: If the server responds with a 'message' 'New Block Forged' # add 1 to the number of coins mined and print it. Otherwise, # print the message from the server. + if data["message"] == "Congratulation! New block is found": + coin_mined += 1 + print(F"Got a coin!, you now have {coin_mined} coin(s) ") + + else: + print(data["message"]) pass diff --git a/client_mining_p/my_id.txt b/client_mining_p/my_id.txt index 757227a3..33a8fca5 100644 --- a/client_mining_p/my_id.txt +++ b/client_mining_p/my_id.txt @@ -1 +1 @@ -your-name-here +Jason Pham \ No newline at end of file