Core/grin
0
0
Fork 0
mirror of https://github.com/mimblewimble/grin.git synced 2025-01-20 19:11:08 +03:00
Code Issues Projects Releases Packages Wiki Activity Actions
Minimal implementation of the Mimblewimble protocol.
24 commits 7 branches 73 tags 37 MiB
Rust 99.8%
Shell 0.1%
Find a file
Garrick Ollivander 4e11aab1ea
added comment to avoid this vulnarability sneaking back
2016-10-29 18:18:32 +02:00
chain p2p module getting close to first integration test allowing 2 peers to connect. Fleshed out handshake and protocol use. Fixed most errors, just need to make the borrow checker happy. 2016-10-25 22:06:13 -07:00
core added comment to avoid this vulnarability sneaking back 2016-10-29 18:18:32 +02:00
grin Add apache 2.0 license header to all source files 2016-10-23 13:20:39 +00:00
p2p First working test with related fixes demonstrating a full peer handshake. 2016-10-27 14:28:02 -07:00
secp256k1zkp Initial import. 2016-10-20 20:06:12 -04:00
store Add apache 2.0 license header to all source files 2016-10-23 13:20:39 +00:00
.gitignore p2p module getting close to first integration test allowing 2 peers to connect. Fleshed out handshake and protocol use. Fixed most errors, just need to make the borrow checker happy. 2016-10-25 22:06:13 -07:00
README.md Corrected spelling of Cuckoo Cycle here and there and updated easiness to 50% following @tromp feedback. 2016-10-21 18:02:20 -04:00
TODO.md fix some trivial typos 2016-10-21 10:17:33 -05:00

README.md

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 on Gitter: https://gitter.im/grin_community/Lobby

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.