vdf-rs

vdf-rs copied to clipboard

• [x] Get CI setup to test on all 3 major platforms
  • [x] cargo check
  • [x] cargo fmt
  • [x] cargo clippy
  • [x] cargo test
  • [x] Use a basic tester for most of these then run tests on MSRV, stable, and beta
  • [x] Automate releases by pushing tags (need separate tags for each library?)
• [x] Figure out MSRV (document this)
• [x] Document everything
  • [x] Add in doc comments
  • [x] Update all READMEs
• [x] Re-export common components and double-check public things
• [x] Update all dependencies
• [x] ~~Add in conversions between all main types from the parser~~ (tokenstream is being kept behind unstable feature for initial release)
• [x] Check through all the TODOs left throughout the repo
• [x] Move tokenstreams behind unstable feature flag
• [x] Update benchmarks

Post-Release

• [ ] Update any placeholder links to documentation
• [ ] Badge swag

Pushed Off

• [ ] Add in GitHub requested documentation
• [ ] Add a doc explaining assumptions from VDF representations
• [ ] Double-check method names and see where traits could be used instead
• [ ] Go through the official release checklist

Current MSRV is 1.42.0 due to the use of matches!. This was release on September 10th 2020, but I'll go ahead and work around matches! to see how far back we can easily go

Removing matches got the MSRV down to 1.40.0, but going below that seems like it would be a hassle. 1.40.0 was released on 2019-12-19 which seems reasonable to me, so that will be the MSRV for now

MSRV was bumped back up to 1.42.0 due to clippy issues. I think that's still reasonable for the time being