Skip to content

Commit

Permalink
V5 (v28 params) release updates (#1254)
Browse files Browse the repository at this point in the history 
* feat: prep for v28 parameters and version 5 proofs release

* feat: update open file limit for tests to avoid failures
fix: remove comment that is no longer needed
feat: update changelog for the upcoming release

* feat: publish v28 parameters

* docs: candidate final v28 changelog updates
  • Loading branch information
@cryptonemo
cryptonemo authored Aug 10, 2020
1 parent 0e8b133 commit 212585d
Show file tree
Hide file tree
Showing 13 changed files with 157 additions and 146 deletions.
26 changes: 16 additions & 10 deletions .circleci/config.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ jobs:
no_output_timeout: 30m
- restore_cache:
keys:
- cargo-v27h-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- cargo-v28-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- run: rustup install $(cat rust-toolchain)
- run: rustup default $(cat rust-toolchain)
- run: rustup component add rustfmt-preview
Expand All @@ -39,7 +39,7 @@ jobs:
paths:
- Cargo.lock
- save_cache:
key: cargo-v27h-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
key: cargo-v28-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
paths:
- /root/.cargo
- /root/.rustup
Expand All @@ -55,7 +55,7 @@ jobs:
at: "."
- restore_cache:
keys:
- cargo-v27h-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- cargo-v28-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- restore_parameter_cache
- run:
name: Test
Expand Down Expand Up @@ -84,11 +84,14 @@ jobs:
at: "."
- restore_cache:
keys:
- cargo-v27h-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- cargo-v28-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- restore_parameter_cache
- run:
name: Test in release profile
command: |
ulimit -n 20000
ulimit -u 20000
ulimit -n 20000
cargo +$(cat rust-toolchain) test --verbose --release --workspace
RUSTFLAGS="-D warnings" cargo +$(cat rust-toolchain) build --examples --release --workspace
Expand All @@ -110,11 +113,14 @@ jobs:
at: "."
- restore_cache:
keys:
- cargo-v27h-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- cargo-v28-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- restore_parameter_cache
- run:
name: Test ignored in release profile
command: |
ulimit -n 20000
ulimit -u 20000
ulimit -n 20000
cd << parameters.crate >>
cargo test --release << parameters.features >> -- --ignored
environment:
Expand All @@ -133,7 +139,7 @@ jobs:
at: "."
- restore_cache:
keys:
- cargo-v27h-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- cargo-v28-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- restore_parameter_cache
- run:
name: Benchmarks
Expand Down Expand Up @@ -224,7 +230,7 @@ jobs:
at: "."
- restore_cache:
keys:
- cargo-v27h-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- cargo-v28-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- run:
name: Run cargo fmt
command: cargo fmt --all -- --check
Expand All @@ -241,7 +247,7 @@ jobs:
at: "."
- restore_cache:
keys:
- cargo-v27h-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- cargo-v28-{{ checksum "rust-toolchain" }}-{{ checksum "Cargo.toml" }}-{{ checksum "Cargo.lock" }}-{{ arch }}
- run:
name: Run cargo clippy
command: cargo +$(cat rust-toolchain) clippy --workspace
Expand Down Expand Up @@ -286,7 +292,7 @@ commands:
save_parameter_cache:
steps:
- save_cache:
key: proof-params-v27h-{{ checksum "filecoin-proofs/parameters.json" }}-{{ arch }}
key: proof-params-v28-{{ checksum "filecoin-proofs/parameters.json" }}-{{ arch }}
paths:
- "~/paramcache.awesome"
- "~/filecoin-proof-parameters/"
Expand All @@ -295,7 +301,7 @@ commands:
- configure_environment_variables
- restore_cache:
keys:
- proof-params-v27h-{{ checksum "filecoin-proofs/parameters.json" }}-{{ arch }}
- proof-params-v28-{{ checksum "filecoin-proofs/parameters.json" }}-{{ arch }}
configure_environment_variables:
steps:
- run:
Expand Down
85 changes: 50 additions & 35 deletions CHANGELOG.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,57 +7,71 @@ and this project adheres to [Semantic Versioning](https://book.async.rs/overview

## Unreleased

## 5.0.0 - 2020-08-10

- Publish v28 parameters and update Changelog for release [#1254](https://github.com/filecoin-project/rust-fil-proofs/pull/1254)
- Fix benchmark examples in README [#1253](https://github.com/filecoin-project/rust-fil-proofs/pull/1253)
- Remove unused dependencies [#1124](https://github.com/filecoin-project/rust-fil-proofs/pull/1124) and [#1252](https://github.com/filecoin-project/rust-fil-proofs/pull/1252)
- Add script to validate parameter checksums in parameters.json [#1251](https://github.com/filecoin-project/rust-fil-proofs/pull/1251)
- phase2-cli force small-raw contributions [#1248](https://github.com/filecoin-project/rust-fil-proofs/pull/1248)
- phase2-cli parse command [#1247](https://github.com/filecoin-project/rust-fil-proofs/pull/1247)
- phase2-cli merge command [#1242](https://github.com/filecoin-project/rust-fil-proofs/pull/1242)
- phase2-cli paramgen and filename parsing [#1240](https://github.com/filecoin-project/rust-fil-proofs/pull/1240)
- Verify transitions from non-raw to raw parameters in phase2-cli [#1239](https://github.com/filecoin-project/rust-fil-proofs/pull/1239)
- Add a check parameter command that maps parameter files [#1238](https://github.com/filecoin-project/rust-fil-proofs/pull/1238)
- Add tool to split phase2 parameters [#1235](https://github.com/filecoin-project/rust-fil-proofs/pull/1235)

## 4.0.5 - 2020-07-28

- Include proofs and snark security audit documents, with updated references [1233](https://github.com/filecoin-project/rust-fil-proofs/pull/1233)
- Remove `stacked` benchmark from benchy (broken) [1229](https://github.com/filecoin-project/rust-fil-proofs/pull/1229)
- Update range for feistel tests [1228](https://github.com/filecoin-project/rust-fil-proofs/pull/1228)
- Allow for compilation on aarch64 [1204](https://github.com/filecoin-project/rust-fil-proofs/pull/1204)
- Implement `fauxrep2`: a testable fake replication API [1218]((https://github.com/filecoin-project/rust-fil-proofs/pull/1218)
- Fix CI `metrics_capture` jobs from consistently failing [1215](https://github.com/filecoin-project/rust-fil-proofs/pull/1215)
- Correct `rows_to_discard` value during post [1220](https://github.com/filecoin-project/rust-fil-proofs/pull/1220)
- Include proofs and snark security audit documents, with updated references [#1233](https://github.com/filecoin-project/rust-fil-proofs/pull/1233)
- Remove `stacked` benchmark from benchy (broken) [#1229](https://github.com/filecoin-project/rust-fil-proofs/pull/1229)
- Update range for feistel tests [#1228](https://github.com/filecoin-project/rust-fil-proofs/pull/1228)
- Allow for compilation on aarch64 [#1204](https://github.com/filecoin-project/rust-fil-proofs/pull/1204)
- Implement `fauxrep2`: a testable fake replication API [#1218](https://github.com/filecoin-project/rust-fil-proofs/pull/1218)
- Fix CI `metrics_capture` jobs from consistently failing [#1215](https://github.com/filecoin-project/rust-fil-proofs/pull/1215)
- Correct `rows_to_discard` value during post [#1220](https://github.com/filecoin-project/rust-fil-proofs/pull/1220)

## 4.0.4 - 2020-07-15

- Default parent cache path to use FIL_PROOFS_CACHE_DIR if set [1207](https://github.com/filecoin-project/rust-fil-proofs/pull/1207)
- Investigate CI metrics capture [1212](https://github.com/filecoin-project/rust-fil-proofs/pull/1212) and [1213](https://github.com/filecoin-project/rust-fil-proofs/pull/1213)
- Additional README updates and corrections [1211](https://github.com/filecoin-project/rust-fil-proofs/pull/1211)
- Update README [1208](https://github.com/filecoin-project/rust-fil-proofs/pull/1208)
- Swap buffers instead of memcpy in generate_labels [1197](https://github.com/filecoin-project/rust-fil-proofs/pull/1197)
- Apply suggested security audit fixes [1196](https://github.com/filecoin-project/rust-fil-proofs/pull/1196)
- Make pieces::Stack methods private [1202](https://github.com/filecoin-project/rust-fil-proofs/pull/1202)
- Remove dead code [1201](https://github.com/filecoin-project/rust-fil-proofs/pull/1201)
- Test feistel implementation is a valid permutation [1193](https://github.com/filecoin-project/rust-fil-proofs/pull/1193)
- Default parent cache path to use FIL_PROOFS_CACHE_DIR if set [#1207](https://github.com/filecoin-project/rust-fil-proofs/pull/1207)
- Investigate CI metrics capture [#1212](https://github.com/filecoin-project/rust-fil-proofs/pull/1212) and [#1213](https://github.com/filecoin-project/rust-fil-proofs/pull/1213)
- Additional README updates and corrections [#1211](https://github.com/filecoin-project/rust-fil-proofs/pull/1211)
- Update README [#1208](https://github.com/filecoin-project/rust-fil-proofs/pull/1208)
- Swap buffers instead of memcpy in generate_labels [#1197](https://github.com/filecoin-project/rust-fil-proofs/pull/1197)
- Apply suggested security audit fixes [#1196](https://github.com/filecoin-project/rust-fil-proofs/pull/1196)
- Make pieces::Stack methods private [#1202](https://github.com/filecoin-project/rust-fil-proofs/pull/1202)
- Remove dead code [#1201](https://github.com/filecoin-project/rust-fil-proofs/pull/1201)
- Test feistel implementation is a valid permutation [#1193](https://github.com/filecoin-project/rust-fil-proofs/pull/1193)

## 4.0.3 - 2020-07-01

- Add fauxrep to API for fake sealing [1194](https://github.com/filecoin-project/rust-fil-proofs/pull/1194)
- Streaming phase2 contribution and fast I/O [1188](https://github.com/filecoin-project/rust-fil-proofs/pull/1188)
- Add omitted changelog updates [1190](https://github.com/filecoin-project/rust-fil-proofs/pull/1190)
- Add fauxrep to API for fake sealing [#1194](https://github.com/filecoin-project/rust-fil-proofs/pull/1194)
- Streaming phase2 contribution and fast I/O [#1188](https://github.com/filecoin-project/rust-fil-proofs/pull/1188)
- Add omitted changelog updates [#1190](https://github.com/filecoin-project/rust-fil-proofs/pull/1190)

## 4.0.2 - 2020-06-25

- Allow parameters map to be accessible externally [1186](https://github.com/filecoin-project/rust-fil-proofs/pull/1186)
- Extend update_tree_r_cache command with new features [1175](https://github.com/filecoin-project/rust-fil-proofs/pull/1175)
- Add OpenCL to the build instructions [1112](https://github.com/filecoin-project/rust-fil-proofs/pull/1112)
- Use file locking for cache generation [1179](https://github.com/filecoin-project/rust-fil-proofs/pull/1179)
- Add logging to all public API functions [1137](https://github.com/filecoin-project/rust-fil-proofs/pull/1137)
- Upgrade some dependencies [1126](https://github.com/filecoin-project/rust-fil-proofs/pull/1126)
- Fix clippy warnings [1147](https://github.com/filecoin-project/rust-fil-proofs/pull/1147)
- Partial caching for SDR [1163](https://github.com/filecoin-project/rust-fil-proofs/pull/1163)
- Add tool to rebuild tree_r_last from a replica [1170](https://github.com/filecoin-project/rust-fil-proofs/pull/1170)
- Verify consistent use of porep_id when sealing [1167](https://github.com/filecoin-project/rust-fil-proofs/pull/1167)
- Allow parameters map to be accessible externally [#1186](https://github.com/filecoin-project/rust-fil-proofs/pull/1186)
- Extend update_tree_r_cache command with new features [#1175](https://github.com/filecoin-project/rust-fil-proofs/pull/1175)
- Add OpenCL to the build instructions [#1112](https://github.com/filecoin-project/rust-fil-proofs/pull/1112)
- Use file locking for cache generation [#1179](https://github.com/filecoin-project/rust-fil-proofs/pull/1179)
- Add logging to all public API functions [#1137](https://github.com/filecoin-project/rust-fil-proofs/pull/1137)
- Upgrade some dependencies [#1126](https://github.com/filecoin-project/rust-fil-proofs/pull/1126)
- Fix clippy warnings [#1147](https://github.com/filecoin-project/rust-fil-proofs/pull/1147)
- Partial caching for SDR [#1163](https://github.com/filecoin-project/rust-fil-proofs/pull/1163)
- Add tool to rebuild tree_r_last from a replica [#1170](https://github.com/filecoin-project/rust-fil-proofs/pull/1170)
- Verify consistent use of porep_id when sealing [#1167](https://github.com/filecoin-project/rust-fil-proofs/pull/1167)

## 4.0.1 - 2020-06-22

- This release is a hotfix that pinned dependencies to avoid a build break [1182](https://github.com/filecoin-project/rust-fil-proofs/pull/1182)
- This release is a hotfix that pinned dependencies to avoid a build break [#1182](https://github.com/filecoin-project/rust-fil-proofs/pull/1182)

## 4.0.0 - 2020-06-15

- Change default rows_to_discard for cached oct-trees [1165](https://github.com/filecoin-project/rust-fil-proofs/pull/1165)
- Remove validate commit message [1164](https://github.com/filecoin-project/rust-fil-proofs/pull/1164)
- Modularized window-post bench [1162](https://github.com/filecoin-project/rust-fil-proofs/pull/1162)
- Updated reported PoSt constraints (in comments) [1161](https://github.com/filecoin-project/rust-fil-proofs/pull/1161)
- Change default rows_to_discard for cached oct-trees [#1165](https://github.com/filecoin-project/rust-fil-proofs/pull/1165)
- Remove validate commit message [#1164](https://github.com/filecoin-project/rust-fil-proofs/pull/1164)
- Modularized window-post bench [#1162](https://github.com/filecoin-project/rust-fil-proofs/pull/1162)
- Updated reported PoSt constraints (in comments) [#1161](https://github.com/filecoin-project/rust-fil-proofs/pull/1161)

## 3.0.0 - 2020-06-08

Expand Down Expand Up @@ -86,7 +100,8 @@ and this project adheres to [Semantic Versioning](https://book.async.rs/overview

- Initial stable release

[Unreleased]: https://github.com/filecoin-project/rust-fil-proofs/compare/v4.0.5...HEAD
[Unreleased]: https://github.com/filecoin-project/rust-fil-proofs/compare/v5.0.0...HEAD
[5.0.0]: https://github.com/filecoin-project/rust-fil-proofs/tree/releases/v5.0.0
[4.0.5]: https://github.com/filecoin-project/rust-fil-proofs/tree/releases/v4.0.5
[4.0.4]: https://github.com/filecoin-project/rust-fil-proofs/tree/releases/v4.0.4
[4.0.3]: https://github.com/filecoin-project/rust-fil-proofs/tree/releases/v4.0.3
Expand Down
Loading

0 comments on commit 212585d

Please sign in to comment.