Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cosme12/SimpleCoin
Just a really simple, insecure and incomplete implementation of a blockchain for a cryptocurrency made in Python as educational material. In other words, a simple Bitcoin clone.
https://github.com/cosme12/SimpleCoin
bitcoin blockchain cryptocurrency python
Last synced: 3 months ago
JSON representation
Just a really simple, insecure and incomplete implementation of a blockchain for a cryptocurrency made in Python as educational material. In other words, a simple Bitcoin clone.
- Host: GitHub
- URL: https://github.com/cosme12/SimpleCoin
- Owner: cosme12
- License: mit
- Created: 2018-01-14T02:51:44.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-05T04:23:16.000Z (over 1 year ago)
- Last Synced: 2024-07-17T13:58:56.403Z (4 months ago)
- Topics: bitcoin, blockchain, cryptocurrency, python
- Language: Python
- Homepage: http://copitosystem.com
- Size: 171 KB
- Stars: 1,779
- Watchers: 86
- Forks: 400
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - cosme12/SimpleCoin - Just a really simple, insecure and incomplete implementation of a blockchain for a cryptocurrency made in Python as educational material. In other words, a simple Bitcoin clone. (Python)
README
# SimpleCoin
Just a really simple, insecure and incomplete implementation of a blockchain for a cryptocurrency made in Python. The goal of this project is to make a working blockchain currency, keeping it as simple as possible and to be used as educational material.
>This project is just being made for fun. If you want to make your own cryptocurrency you should probably take a look at the [Bitcoin Repository](https://github.com/bitcoin/bitcoin).
## What is a blockchain?
Taking a look at the [Bitcoin organization wiki website](https://en.bitcoin.it/wiki/Main_Page) we can find this definition:
>A block chain is a transaction database shared by all nodes participating in a system based on the Bitcoin protocol. A full copy of a currency's block chain contains every transaction ever executed in the currency. With this information, one can find out how much value belonged to each address at any point in history.
In simpler terms, blockchain can be seen as a distributed ledger recording each transaction in the network. Each transaction is identified by the public key of the block which is a hash function of the private key. The distributed ledger makes data manipulation in the blockchain difficult, nearly impossible.
You can find more information in the original [Bitcoin Paper](https://bitcoin.org/bitcoin.pdf).
## How to run it
First, install ```requirements.txt```.
```
pip install -r requirements.txt
```
Then you have 2 options:
- Run ```miner.py``` to become a node and start mining
- Run ```wallet.py``` to become a user and send transactions (to send transactions you must run a node, in other words, you must run ```miner.py``` too)
> Important: DO NOT run it in the python IDLE, run it in your console. The ```miner.py``` uses parallel processing that doesn't work in the python IDLE.
## How this code work?
There are 2 main scripts:
- ```miner.py```
- ```wallet.py```
### Miner.py
This file is probably the most important. Running it will create a node (like a server). From here you can connect to the blockchain and process transactions (that other users send) by mining. As a reward for this work, you recieve some coins. The more nodes exist, the more secure the blockchain gets.
```miner.py``` has 2 processes running in parallel:
1. The first process takes care of mining, updating new blockchains and finding the proof of work.
2. The second process runs the flask server where peer nodes and users can connect to ask for the entire blockchain or submit new transactions.
> Parallel processes don't run in python IDLE, so make sure you are running it from the console.
The following flowchart provides a simple , high-level understanding of what the miner does
### Wallet.py
This file is for those who don't want to be nodes but simple users. Running this file allows you to generate a new address, send coins and check your transaction history (keep in mind that if you are running this in a local server, you will need a "miner" to process your transaction).
When creating a wallet address, a new file will be generated with all your security credentials. You are supposed to keep it safe.
## Contribution
Anybody is welcome to collaborate in this project. Feel free to push any pull request (even if you are new to coding). See ```CONTRIBUTING.md``` to learn how to contribute.
Note: the idea of this project is to build a **really simple** blockchain system, so make sure all your code is easy to read (avoid too much code in 1 line) and don't introduce complex updates if they are not critical. In other words, keep it simple.
## Disclaimer
By no means this project should be used for real purposes, it lacks security and may contain several bugs.