Minimal implementation of the Mimblewimble protocol.
Find a file
Mike Dallas d5c3e61cbe Add mining instructions in docs (#2025)
I see this question being asked multiple times every day in the chat.
2018-11-26 10:41:40 -08:00
.hooks cannot use unstable rustfmt features outside nightly toolchain (#1338) 2018-08-10 14:54:09 +01:00
api Provide wallet 'plugin' architecture (#1983) 2018-11-19 19:47:40 +00:00
chain Refactor is_orphan and is_fork during block processing (#2015) 2018-11-25 10:22:19 +00:00
config Configurable max block weight for mining (aka soft limit) (#1976) 2018-11-14 10:22:08 -08:00
core Fix T4 genesis after #1997 2018-11-24 22:50:50 +00:00
doc Add mining instructions in docs (#2025) 2018-11-26 10:41:40 -08:00
etc Moving distro-related files to etc subdir 2018-11-08 22:29:30 +00:00
keychain Wallet Seed Encryption + BIP39 (#2004) 2018-11-24 10:03:09 +00:00
p2p rustfmt 2018-11-16 14:34:05 +00:00
pool Block accepted reorg aware (#2003) 2018-11-21 14:35:38 +00:00
servers Cuckaroo Testnet4 hard fork (#1997) 2018-11-24 12:33:17 -08:00
src fix self send command (#2022) 2018-11-26 12:35:14 +00:00
store cleanup 2018-11-12 13:59:22 +00:00
util Streaming headers (#1989) 2018-11-16 11:00:39 +00:00
wallet more wallet api docs (#2023) 2018-11-26 14:41:23 +00:00
.auto-release.sh chore: automatic binaries release (#1540) 2018-09-25 08:37:24 +08:00
.editorconfig Add a .editorconfig file 2018-05-07 10:08:55 -04:00
.gitignore Provide wallet 'plugin' architecture (#1983) 2018-11-19 19:47:40 +00:00
.gitlab-ci.yml Add gitlab ci config (#860) 2018-03-25 17:41:49 +00:00
.travis.yml Chain init reset sync head (#1724) 2018-10-11 12:28:07 +01:00
Cargo.lock Wallet Seed Encryption + BIP39 (#2004) 2018-11-24 10:03:09 +00:00
Cargo.toml Wallet Seed Encryption + BIP39 (#2004) 2018-11-24 10:03:09 +00:00
CODE_OF_CONDUCT.md Many typo fixes (#1158) 2018-06-13 17:03:34 +01:00
CONTRIBUTING.md docs: contributing.md twitter link for the council (#1708) 2018-10-10 09:52:06 +08:00
LICENSE Create LICENSE 2017-06-29 09:24:44 -07:00
README.md Readme twitter link for the council 2018-10-09 18:39:34 +00:00
rustfmt.toml cannot use unstable rustfmt features outside nightly toolchain (#1338) 2018-08-10 14:54:09 +01:00
SECURITY.md First pass at Grin's security policy 2018-09-10 22:52:17 +00:00

Build Status Gitter chat Codecov coverage status

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.
  • Relatively fast block time (a minute).
  • Fixed block reward over time with a decreasing dilution.
  • Transaction fees are based on the number of Outputs 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). Check our mailing list archives for the latest status.

Contributing

To get involved, read our contributing docs.

Find us:

Getting Started

To learn more about the technology, read our introduction.

To build and try out Grin, 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 disrespect 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.