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.
1943 commits 7 branches 73 tags 37 MiB
Rust 99.8%
Shell 0.1%
Find a file
Peter Mrekaj 6808a07234 docs: update/add new README.md badges (#2708) 
Replace existing badges with SVG counterparts and add a bunch of new ones.
2019-03-26 13:47:57 +01:00
.ci refactor(ci): reorganize CI related code (#2658) 2019-03-11 23:23:16 +08:00
.github Update contributing guidelines (#2563) 2019-02-19 14:29:58 +00:00
.hooks cannot use unstable rustfmt features outside nightly toolchain (#1338) 2018-08-10 14:54:09 +01:00
api Add some better logging for get_outputs_by_id failure states (#2705) 2019-03-25 15:17:47 +01:00
chain let check_txhashset_needed return true on abnormal case (#2684) 2019-03-18 10:46:36 -07:00
config add a new configure item for log_max_files (#2601) 2019-03-08 19:02:07 +08:00
core Add some better logging for get_outputs_by_id failure states (#2705) 2019-03-25 15:17:47 +01:00
doc Switch commitment doc fixes (#2645) 2019-03-26 13:45:57 +01:00
etc Version bump to 1.0.0 2019-01-15 16:24:29 +00:00
keychain Small QoL improvements for wallet developers (#2651) 2019-03-19 16:13:49 +00:00
p2p Simplify (and fix) output_pos cleanup during chain compaction (#2609) 2019-02-27 21:02:54 +00:00
pool Bump version to 1.0.2 (#2623) 2019-02-24 21:57:56 -08:00
servers fix: the restart of state sync doesn't work sometimes (#2687) 2019-03-18 10:44:51 -07:00
src Display the current download rate rather than the average when syncing the chain (#2633) 2019-03-03 13:44:31 -08:00
store Simplify (and fix) output_pos cleanup during chain compaction (#2609) 2019-02-27 21:02:54 +00:00
util catch the panic to avoid peer thread quit early (#2686) 2019-03-23 13:39:50 -07:00
wallet Add some better logging for get_outputs_by_id failure states (#2705) 2019-03-25 15:17:47 +01:00
.editorconfig remove root = true from editorconfig (#2655) 2019-03-06 09:19:58 +00:00
.gitignore Optimizing the code and making it more idiomatic (#2269) 2019-01-01 15:29:16 -08:00
.gitlab-ci.yml Add gitlab ci config (#860) 2018-03-25 17:41:49 +00:00
.travis.yml refactor(ci): reorganize CI related code (#2658) 2019-03-11 23:23:16 +08:00
Cargo.lock Don't extract unexpected files from txhashset archive (#2624) 2019-02-24 22:57:56 -08:00
Cargo.toml Bump version to 1.0.2 (#2623) 2019-02-24 21:57:56 -08:00
CODE_OF_CONDUCT.md Many typo fixes (#1158) 2018-06-13 17:03:34 +01:00
CONTRIBUTING.md Update contributing guidelines (#2563) 2019-02-19 14:29:58 +00:00
LICENSE Create LICENSE 2017-06-29 09:24:44 -07:00
README.md docs: update/add new README.md badges (#2708) 2019-03-26 13:47:57 +01:00
rustfmt.toml cannot use unstable rustfmt features outside nightly toolchain (#1338) 2018-08-10 14:54:09 +01:00
SECURITY.md Fix domain for my email address 2018-12-19 12:11:42 -08:00

README.md

Build Status Coverage Status Chat Support Documentation Wiki Release Version License

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, and aiming to stay as such.
  • Follows the MimbleWimble protocol, which provides great anonymity and scaling characteristics.
  • Cuckoo Cycle proof of work in two variants named Cuckaroo (ASIC-resistant) and Cuckatoo (ASIC-targeted).
  • Relatively fast block time: one 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 live with mainnet. Still, 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.