Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-21 03:21:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
Minimal implementation of the Mimblewimble protocol.
138 commits 7 branches 73 tags 37 MiB
Rust 99.8%
Shell 0.1%
Find a file
Ignotus Peverell 7c72ccec7c
Cleaned up error handling in p2p module. Setting peer status on disconnect.
2017-02-26 20:08:40 -08:00
chain Moved down to the store module some common persistence code. 2017-02-09 11:41:46 -08:00
core PoW only ever needs the block header, full block unnecessary. 2017-02-07 13:48:11 -08:00
doc Chain logic to support multiple forks, select the most worked fork as the head. Significantly simplified from the original direction as it doesn't seem that explicitly materializing forks is necessary. Simple total difficulty accounting in block headers helping a lot there. 2017-01-09 15:16:44 -08:00
grin Cleaned up error handling in p2p module. Setting peer status on disconnect. 2017-02-26 20:08:40 -08:00
p2p Cleaned up error handling in p2p module. Setting peer status on disconnect. 2017-02-26 20:08:40 -08:00
secp256k1zkp Safer serialization of base types (#18) 2016-12-17 13:44:14 -08:00
store Discovery and seeding of other peers. Relies either on a gist with IP addresses or a static list. Connects to a first list, sending peer request messages to discover more. Monitor the server to make sure there's always enough peer connections. 2017-02-18 18:42:34 -08:00
util Utility crate for things that don't fit anywhere else. Helper struct to emcapsulate one time initializations with a RefCell of an Option. 2016-12-20 17:29:35 -08:00
.gitignore ignore ItelliJ IDEA project files 2016-10-31 12:54:22 +01:00
.travis.yml Reintroducing Rust beta channel testing. 2017-02-18 19:05:18 -08:00
README.md Badges. 2016-12-15 16:46:16 -08:00
TODO.md fix some trivial typos 2016-10-21 10:17:33 -05:00

README.md

Build Status Gitter chat

Grin

Grin is an in-progress implementation of the MimbleWimble protocol. Many characteristics are still undefined but the following constitutes a first set of choices:

  • Clean and minimal implementation, aiming to stay as such.
  • Follows the MimbleWimble protocol, which provides great anonymity and scaling characteristics.
  • Cuckoo Cycle proof of work (at least to start with).
  • Relatively fast block time (a minute or less, possibly decreasing as networks improve).
  • Fixed block reward, both over time and in blocks (fees are not additive).
  • Transaction fees are based on the number of UTXO created/destroyed and total transaction size.
  • Smooth curve for difficulty adjustments.

Status

Grin is still an infant, much is left to be done and contributions are welcome (see below). Our status file may help.

Contributing

Find an area you can help with and do it. Open source is about collaboration and open participation. Try to make your code look like what already exists and submit a pull request. If you're looking for additional ideas, the code includes TODO comments for minor to major improvements. Grep is your friend.

Additional tests are rewarded with an immense amount of positive karma. So is documentation.

Find us:

Philosophy

Grin likes itself small and easy on the eyes. It wants to be inclusive and welcoming for all walks of life, without judgement. Grin is terribly ambitious, but not at the detriment of others, rather to further us all. It may have strong opinions to stay in line with its objectives, which doesn't mean disrepect of others' ideas.

We believe in pull requests, data and scientific research. We do not believe in unfounded beliefs.

Credits

Tom Elvis Jedusor for the first formulation of MimbleWimble.

Andrew Poelstra for his related work and improvements.

John Tromp for the Cuckoo Cycle proof of work.

J.K. Rowling for making it despite extraordinary adversity.

License

Apache License v2.0.