Repository: philipperemy/my-first-bitcoin-miner Branch: master Commit: b5b071d24ea6 Files: 4 Total size: 20.3 KB Directory structure: gitextract_mv3mvvfa/ ├── LICENSE ├── README.md ├── Resources └── miner.py ================================================ FILE CONTENTS ================================================ ================================================ FILE: LICENSE ================================================ Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright {yyyy} {name of copyright owner} Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. ================================================ FILE: README.md ================================================ # My First Bitcoin Miner For the people who are curious to understand in a simplified setup: - **How the Bitcoin blockchain works** - **How mining works** For a complete implementation (that can actually mine!), please browse this repository https://github.com/jgarzik/pyminer. This miner is not connected to the bitcoin network and is a very simplified version of what would be a real bitcoin miner. The purpose of this implementation is to provide a basic comprehension of the mining logic. ## What are bitcoin miners really solving? ### Step 1 At a high level, the miner software takes a list of active transactions, and then groups them together in something called a "block". Or more *accurately stated*: The miner software converts all the transactions into a summary view called a "merkle root", and hashes it, which is representative of the transactions. ### Step 2 The mining software then converts this to into a binary format called a Block Header, which also references the previous blocks (also called a chain). ``` Field Purpose Updated when... Size (Bytes) Version Block version number You upgrade the software and 4 it specifies a new version hashPrevBlock 256-bit hash of the previous A new block comes in 32 block header hashMerkleRoot 256-bit hash based on all A transaction is accepted 32 the transactions in the block Time Current timestamp as seconds Every few seconds 4 since 1970-01-01T00:00 UTC Bits Current target in compact format The difficulty is adjusted 4 Nonce 32-bit number (starts at 0) A hash is tried (increments) 4 ``` ### Step 3 The miner hardware changes a small portion of this block called a "nonce". ### Step 4 The block header is hashed and compared to the Target as if it were simply a large number like 10,000,000 > 7,000,000 (the real numbers are much bigger, and in hex). The target is compressed and stored in each block in a field called bits. An expanded target looks like this: ``` Target 0000000000000083ef00000000000000000000000000000000000000000000000 ``` And the goal is to make sure the SHA256 hash of the block is less than this value. In the example below "83ee" is smaller than "83ef" To simplify this concept, you can ballpark the target by counting the leading zeros (as the other answer here explains). Here is an example: Here is a sample block with transactions you can view on BlockChain.info. Look in the upper right hand corner of the webpage for this hash: ``` Hash 0000000000000083ee9371ddff055eed7f02348e4eda36c741a2fc62c85bc5cf ``` That previous hash was from today and has 14 leading zeroes. Let's compare that to what was needed 3 years ago with block 100 which has 8 leading zeros. ``` Hash 00000000a8ed5e960dccdf309f2ee2132badcc9247755c32a4b7081422d51899 ``` ### Summary So at the end of the day, all a miner does is: - Take a block header as input. - Change the nonce. - Test if the Block Header hash is less than the Target. If it is, you win. - Go to step 2 (or go to step 1 if someone else won the block). ## References - https://bitcoin.stackexchange.com/questions/8031/what-are-bitcoin-miners-really-solving - https://en.bitcoin.it/wiki/Difficulty - https://en.bitcoin.it/wiki/Target - https://bitcoin.stackexchange.com/questions/30467/what-are-the-equations-to-convert-between-bits-and-difficulty - https://stackoverflow.com/questions/22059359/trying-to-understand-nbits-value-from-stratum-protocol/22161019#22161019 - https://en.bitcoin.it/wiki/Nonce ================================================ FILE: Resources ================================================ https://bitcoin.stackexchange.com/questions/8031/what-are-bitcoin-miners-really-solving https://en.bitcoin.it/wiki/Difficulty https://en.bitcoin.it/wiki/Target https://bitcoin.stackexchange.com/questions/30467/what-are-the-equations-to-convert-between-bits-and-difficulty https://stackoverflow.com/questions/22059359/trying-to-understand-nbits-value-from-stratum-protocol/22161019#22161019 https://en.bitcoin.it/wiki/Nonce ================================================ FILE: miner.py ================================================ import hashlib from time import sleep def hash_256(string): return hashlib.sha256(string.encode('utf-8')).hexdigest() class TransactionGenerator: def __init__(self): self.random_seed = 0 def generate_transaction(self): transaction_payload = 'This is a transaction between A and B. ' \ 'We add a random seed here {} to make its hash unique'.format(self.random_seed) transaction_hash = hash_256(transaction_payload) self.random_seed += 1 return transaction_hash # a block is a set of transactions and contains information of the previous blocks. # https://bitcoin.stackexchange.com/questions/8031/what-are-bitcoin-miners-really-solving class Block: def __init__(self, hash_prev_block, target): self.transactions = [] self.hash_prev_block = hash_prev_block # hash of the all previous blocks. used to maintain integrity. self.hash_merkle_block = None self.target = target self.nounce = 0 def add_transaction(self, new_transac): if not self.is_block_full(): self.transactions.append(new_transac) self.hash_merkle_block = hash_256(str('-'.join(self.transactions))) def is_block_full(self): # blocks cannot go above 1Mb. Here let's say we cannot go above 1000 transactions. return len(self.transactions) >= 1000 def is_block_ready_to_mine(self): return self.is_block_full() def __str__(self): return '-'.join([self.hash_merkle_block, str(self.nounce)]) def apply_mining_step(self): current_block_hash = hash_256(self.__str__()) print('CURRENT_BLOCK_HASH = {}, TARGET = {}'.format(current_block_hash, self.target)) if int(current_block_hash, 16) < int(self.target, 16): print('Block was successfully mined! You will get a reward of x BTC!') print('It took {} steps to mine it.'.format(self.nounce)) return True else: # Incrementing the nounce to change current_block_hash to hope to be below the target. self.nounce += 1 return False class BlockChain: def __init__(self): self.block_chain = [] def push(self, block): self.block_chain.append(block) def notify_everybody(self): print('-' * 80) print('TO ALL THE NODES OF THE NETWORK, THIS BLOCK HAS BEEN ADDED:') print('[block #{}] : {}'.format(len(self.block_chain), self.get_last_block())) print('-' * 80) def get_last_block(self): return self.block_chain[-1] def my_first_miner(): last_block_header = '0e0fb2e3ae9bd2a0fa8b6999bfe6ab7df197a494d4a02885783a697ac74940d9' last_block_target = '000ddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd' # init the block chains block_chain = BlockChain() transaction_generator = TransactionGenerator() # fills a block with transactions. We have 1500 pending transactions. # Sorry 500 transactions will have to wait for the next block! block = Block(last_block_header, last_block_target) for i in range(1500): block.add_transaction(transaction_generator.generate_transaction()) assert block.is_block_full() assert block.is_block_ready_to_mine() # now that our block is full, we can start to mine it. while not block.apply_mining_step(): continue block_chain.push(block) block_chain.notify_everybody() sleep(5) # Difficulty is updated every 2016 blocks. # Objective is one block generated every 10 minutes. # If during the last two weeks, blocks are generated every 5 minutes, then difficulty is multiplied by 2. last_block_header = hash_256(str(block_chain.get_last_block())) block_2 = Block(last_block_header, last_block_target) for i in range(1232): block_2.add_transaction(transaction_generator.generate_transaction()) assert block_2.is_block_full() assert block_2.is_block_ready_to_mine() # now that our block is full, we can start to mine it. while not block_2.apply_mining_step(): continue block_chain.push(block_2) block_chain.notify_everybody() sleep(5) # now let's increase the difficulty. # we have now 4 zeros at the beginning instead of 3. last_block_target = '0000dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd' last_block_header = hash_256(str(block_chain.get_last_block())) block_3 = Block(last_block_header, last_block_target) for i in range(1876): block_3.add_transaction(transaction_generator.generate_transaction()) assert block_3.is_block_full() assert block_3.is_block_ready_to_mine() # now that our block is full, we can start to mine it. while not block_3.apply_mining_step(): continue block_chain.push(block_3) block_chain.notify_everybody() sleep(5) print('') print('SUMMARY') print('') for i, block_added in enumerate(block_chain.block_chain): print('Block #{} was added. It took {} steps to find it.'.format(i, block_added.nounce)) print('Difficulty was increased for the last block!') if __name__ == '__main__': my_first_miner()