Minimal implementation of the Mimblewimble protocol.
Find a file
Jacob Payne de4ebdde71 [WIP] Partial Transition from Writeable/Readable to Codecs (#51)
* Sample Signatures for put_enc and get_dec
* Implement put_enc and get_dec
* Implement ChainCodec in grin_chain
* Truncate src only on complete Blocks
* Truncate src only on complete Tip + Check Len
* Move BlockHeader Encoding to BlockHeaderCodec
* Define put_enc for store::Batch
* Replace BlockCodec and BlockHeaderCodec with generic BlockCodec<T>
* Implement Default for BlockCodec Manually
* Replace get_ser/put_ser with get_enc/get_dec for chain::ChainKVStore
* Remove Writeable/Readable for chain::Tip
* Add Tokio-io and Bytes to grin_p2p
* Additional Setup for Message enum + Msg{Encode,Decode} traits
* base msg ping pong encoding and test
* fill out msg-codec tests
* Implement Hand Encoding/Decoding
* msg-encode shake
* msg-encode getpeeraddr
* codec peer-addrs message, SockAddr struct wierdness
* header message codec
* msg encoding finished prelim
* Implement PeerCodec Encoding/Decoding
* Set PeerStore to use PeerCodec for Encoding/Decoding
* Add a DecIterator
* Prune PeerStore
* Replace Decoding and Encoding in handle_payload
* Prune Writeable/Readable methods in store::Store
* Remove Incomplete Frame Testing ( Not Nessesary right now )
* separate block and tx codec tests
* Refactor {Tx,Block}Codec Tests
2017-05-22 19:16:13 +02:00
api Custom REST API operations in addition to CRUD 2017-05-19 14:35:49 -07:00
chain [WIP] Partial Transition from Writeable/Readable to Codecs (#51) 2017-05-22 19:16:13 +02:00
core [WIP] Partial Transition from Writeable/Readable to Codecs (#51) 2017-05-22 19:16:13 +02:00
doc WIP: Tracking Transaction Pool Implementation (#48) 2017-05-19 17:22:08 +02:00
grin Variety of small p2p fixes to block sync 2017-04-27 22:05:12 -07:00
p2p [WIP] Partial Transition from Writeable/Readable to Codecs (#51) 2017-05-22 19:16:13 +02:00
pool WIP: Tracking Transaction Pool Implementation (#48) 2017-05-19 17:22:08 +02:00
secp256k1zkp [WIP] Partial Transition from Writeable/Readable to Codecs (#51) 2017-05-22 19:16:13 +02:00
src/bin Integrated clap for a better command line 2017-04-27 22:07:25 -07:00
store [WIP] Partial Transition from Writeable/Readable to Codecs (#51) 2017-05-22 19:16:13 +02: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 WIP: Tracking Transaction Pool Implementation (#48) 2017-05-19 17:22:08 +02:00
README.md Minor clarifications and additional getting started link 2017-05-03 14:23:12 -07:00
rustfmt.toml Start of a binary file for the grin node 2017-04-24 18:55:01 -07:00

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). Check our mailing list archives for the latest status.

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

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 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.