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.
172 commits 7 branches 73 tags 37 MiB
Rust 99.8%
Shell 0.1%
Find a file
dan-da 6122152003 Add some basic build instructions to help people get started (#50)
2017-05-03 13:56:03 -07:00
api Fix error[E0243]: wrong number of type arguments (#41) 2017-04-15 16:36:42 -07:00
chain Fixes for chain processing during bootstrap 2017-04-27 21:59:53 -07:00
core Delegate Block Encoding to Store (#44) 2017-05-03 10:27:38 -07:00
doc Add some basic build instructions to help people get started (#50) 2017-05-03 13:56:03 -07:00
grin Variety of small p2p fixes to block sync 2017-04-27 22:05:12 -07:00
p2p Variety of small p2p fixes to block sync 2017-04-27 22:05:12 -07:00
secp256k1zkp Delegate Block Encoding to Store (#44) 2017-05-03 10:27:38 -07:00
src/bin Integrated clap for a better command line 2017-04-27 22:07:25 -07:00
store Delegate Block Encoding to Store (#44) 2017-05-03 10:27:38 -07:00
util Add workspace support for all crates 2017-04-05 23:41:49 -07:00
wallet Create the beginning of the wallet library. (#36) 2017-04-29 13:58:26 -07: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
Cargo.toml Integrated clap for a better command line 2017-04-27 22:07:25 -07:00
README.md Add some basic build instructions to help people get started (#50) 2017-05-03 13:56:03 -07:00
rustfmt.toml Start of a binary file for the grin node 2017-04-24 18:55:01 -07: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.

To learn more, read our introduction to MimbleWimble and Grin.

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:

Getting Started

See the build docs.

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.