Git Product home page Git Product logo

tinycoin's Introduction

#TinyCoin

What is TinyCoin?

The goal of TinyCoin is to provide a simple teaching cryptocurrency.

It is not "industrial quality", with an emphasis on simplicity over robustness.

It is a work in progress and is not feature complete at this point, however it is usable as an educational tool.

TinyCoin has the following constraint: total size of executable code should not exceed 1000 lines of code or teachable in an hour or two. This limit does not include tests or the README.md.

This initial version was put together in a couple of hours for HackMIT HackWeek 2015.

Repo Overview

  1. LICENSE -- MIT License
  2. README.md -- This File
  3. base.py -- Some primitives and common imports
  4. transaction.py -- the way to build the instruction to tell the TinyCoin chain to spend an amount from A to B
  5. block.py -- The structure and header that transactions are bundled into
  6. chain.py -- The data structure that aggregates blocks together and checks for validity of blocks
  7. node.py -- the network code for talking to other users running TinyCoin and propagating blocks as well as interacting with clients.
  8. miner.py -- a client script that gets mining work from a running nod
  9. tests.py -- A (growing!) set of tests to ensure proper behavior. Full testing is not needed as certain "industrial strength" classes of errors should be ignored for simplicity

TODO

  1. Add a persistent client/wallet feature and more calls to node.py (perhaps spv)
  2. Fix bugs in the networking code
  3. Refactor the transaction format to be simpler
  4. Provide a better mechanism for peering than local_peers in node.py.
  5. Come up with some labs for adding certain features.
  6. More todos ;)

Pull requests welcome! Please keep in mind simplicity & teaching over correctness.

tinycoin's People

Contributors

jeremyrubin avatar

Watchers

James Cloos avatar Bienvenido Rodriguez avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.