Minimal implementation of the Mimblewimble protocol.
Find a file
John Tromp 53414ae105
Fixmmr part2 (#3666)
* use 0-based positions in  methods pmmr_leaf_to_insertion_index and bintree_postorder_height; add round_up_to_leaf_pos method

* use 0-based positions in method insertion_to_pmmr_index

* use 0-based positions in method is_leaf

* use 0-based positions in method family()

* use 0-based positions in method is_left_sibling

* use 0-based positions in method family_branch

* use 0-based positions in methods bintree_{left,right}most

* use 0-based positions in method bintree_pos_iter

* use 0-based positions in method bintree_range

* use 0-based positions in method bintree_leaf_pos_iter

* rename last_pos in MMR related structs to size

* use 0-based positions in method prune

* use 0-based positions in method push and apply_output return value

* use 0-based position argument of method merkle_proof

* use 0-based outputs in method pmmr::peaks

* fix peaks() code comments

* refix peaks() code comments

* use 0-based positions in method get_peak_from_file

* use 0-based positions in methods get_data_from_file

* use 0-based positions in methods get_from_file

* use 0-based positions in methods get_data

* use 0-based positions in methods get_hash

* use 0-based positions in method peak_path

* use 0-based positions in method bag_the_rhs

* use 0-based positions in method Backend::remove

* use 0-based positions in method leaf_pos_iter

* use 0-based positions in method self.LeafSet::includes

* use 0-based positions in methods self.LeafSet::{add,remove}

* use 0-based positions in methods is_pruned,is_pruned_root,is_compacted

* use 0-based positions in methods PruneList::append

* use 0-based positions in methods append_pruned_subtree

* use 0-based positions in method calculate_next_leaf_shift

* use 0-based positions in method append_single

* use 0-based positions in method calculate_next_shift

* use 0-based positions in method segment_pos_range

* use 0-based positions in method reconstruct_root

* use 0-based positions in method validate_with

* use 0-based positions in method validate

* rename size (formerly last_pos) to mmr_size

* use 0-based positions in Segment's hash_pos and leaf_pos

* minimize use of saturating_sub(1) and rename some pos/idx to size

* use 0-based positions in methods get_output_pos

* use 0-based positions in method get_unspent_output_at

* use 0-based positions in method get_header_hash

* use 0-based positions in methods MerkleProof::verify{,_consume}

* use 0-based positions in method cleanup_subtree

* don't allow 0 in prunelist bitmap

* use 0-based positions in methods get_{,leaf_}shift

* rename some 1-based pos to pos1; identify TODO

* Address yeastplume's PR review comments
2021-11-26 11:25:10 +00:00
.cargo windows cargo settings (#2632) 2019-02-26 16:48:45 +00:00
.ci Change connection name for CI Release (#3653) 2021-08-18 15:45:52 +02:00
.github Rename Floonet to Testnet (#3431) 2020-10-07 09:36:02 -04:00
.hooks Update copyright year to 2021 (#3592) 2021-03-10 10:14:48 -05:00
api Fixmmr part2 (#3666) 2021-11-26 11:25:10 +00:00
chain Fixmmr part2 (#3666) 2021-11-26 11:25:10 +00:00
config bump to 5.2.0-alpha.1 on master (#3652) 2021-08-19 09:06:52 +02:00
core Fixmmr part2 (#3666) 2021-11-26 11:25:10 +00:00
doc Spelling Improvements (#3642) 2021-05-13 14:07:14 -04:00
etc Update copyright year to 2021 (#3592) 2021-03-10 10:14:48 -05:00
keychain Update digest, hmac, ripemd160, sha2 and pbkdf2 crates (#3655) 2021-11-02 15:40:31 +00:00
p2p bump to 5.2.0-alpha.1 on master (#3652) 2021-08-19 09:06:52 +02:00
pool Rust 2021 Macro Warning Cleanup (#3658) 2021-11-02 15:10:01 +00:00
servers bump to 5.2.0-alpha.1 on master (#3652) 2021-08-19 09:06:52 +02:00
src Rust 2021 Macro Warning Cleanup (#3658) 2021-11-02 15:10:01 +00:00
store Fixmmr part2 (#3666) 2021-11-26 11:25:10 +00:00
util bump to 5.2.0-alpha.1 on master (#3652) 2021-08-19 09:06:52 +02:00
.editorconfig [1.1.0] Merge master into 1.1.0 (#2720) 2019-04-01 11:47:48 +01:00
.gitignore ignore .vscode (#3333) 2020-05-24 23:34:33 +02:00
azure-pipelines.yml Update copyright year to 2021 (#3592) 2021-03-10 10:14:48 -05:00
Cargo.lock Update digest, hmac, ripemd160, sha2 and pbkdf2 crates (#3655) 2021-11-02 15:40:31 +00:00
Cargo.toml bump to 5.2.0-alpha.1 on master (#3652) 2021-08-19 09:06:52 +02:00
CODE_OF_CONDUCT.md Update Code of Conduct (#3447) 2020-09-22 17:15:37 +01:00
CONTRIBUTING.md Rename Floonet to Testnet (#3431) 2020-10-07 09:36:02 -04:00
LICENSE Create LICENSE 2017-06-29 09:24:44 -07:00
README.md credit where credit is due (#3356) 2020-06-16 18:41:09 +01:00
rustfmt.toml Update hyper/tokio/futures dependencies (#3214) 2020-02-18 23:45:27 +01:00
SECURITY.md fix: correct typo in SECURITY.md (#3462) 2020-10-08 09:46:48 -04:00

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 hidden amounts and scaling advantages.
  • 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.

License

Apache License v2.0.