Skip to content

Commit

Permalink
minor wording changes
Browse files Browse the repository at this point in the history
  • Loading branch information
arahangua committed Jun 19, 2023
1 parent 82e642a commit 02eb660
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion evaluations/validated-streams_2_arahangua.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
| ------ | ----------- | :------: | ---- |----------------- |
| **0a.** | License | <ul><li>[x] </li></ul> | [LICENSE](https://github.com/comrade-coop/validated-streams/blob/5dc862fc2fe3cab7e8b6e2272b89ff21607a4038/LICENSE) | MIT |
| **0b.** | Documentation | <ul><li>[x] </li></ul> | [README](https://github.com/comrade-coop/validated-streams/blob/feed169d51143e1fd303a14a9aaaaaddb6f2a831/README.md) | easy to follow description with a schematic |
| **0c.** | Testing and Testing Guide | <ul><li>[ ] </li></ul> | [Running tests](https://github.com/comrade-coop/validated-streams/blob/feed169d51143e1fd303a14a9aaaaaddb6f2a831/README.md#testing) <br> [proofs](https://github.com/comrade-coop/validated-streams/blob/main/vstreams/src/proofs/tests.rs) <br> [events](https://github.com/comrade-coop/validated-streams/blob/main/vstreams/src/events/tests.rs) <br> [pallet](https://github.com/comrade-coop/validated-streams/blob/a8a55ab7f2f16401c8aefefccdcdfa4638ddb39a/pallet/src/tests.rs) | <ul><li> With 'on-chain proofs' : the project could be built successfully with ```cargo build --release --no-default-features```. However, tests for 'on-chain proofs' case failed (see Outstanding Issues below) </li></ul><ul><li> Without 'on-chain proofs' : `cargo tarpaulin` reports ~33% test coverage for the 'consensus' crate with 19 tests and ~7% coverage for the 'pallet' with 3 tests. The links provided for ['proofs'](https://github.com/comrade-coop/validated-streams/blob/main/vstreams/src/proofs/tests.rs) and ['events'](https://github.com/comrade-coop/validated-streams/blob/main/vstreams/src/events/tests.rs) seem to point at invalid urls. Presumably these links are outdated with the recent changes (i.e., renaming 'vstream' to 'consensus_validated_streams', integration of 'proof'/'event' to the 'consensus' crate).</li></ul><ul><li> Could not build benchmarks follwing the instruction (see Outstanding Issues).</li></ul> |
| **0c.** | Testing and Testing Guide | <ul><li>[ ] </li></ul> | [Running tests](https://github.com/comrade-coop/validated-streams/blob/feed169d51143e1fd303a14a9aaaaaddb6f2a831/README.md#testing) <br> [proofs](https://github.com/comrade-coop/validated-streams/blob/main/vstreams/src/proofs/tests.rs) <br> [events](https://github.com/comrade-coop/validated-streams/blob/main/vstreams/src/events/tests.rs) <br> [pallet](https://github.com/comrade-coop/validated-streams/blob/a8a55ab7f2f16401c8aefefccdcdfa4638ddb39a/pallet/src/tests.rs) | <ul><li> With 'on-chain proofs' : the project could be built successfully with ```cargo build --release --no-default-features```. However, the tests for 'on-chain proofs' cases failed (see Outstanding Issues below) </li></ul><ul><li> Without 'on-chain proofs' : `cargo tarpaulin` reports ~33% test coverage for the 'consensus' crate with 19 tests and ~7% coverage for the 'pallet' with 3 tests. The links provided for ['proofs'](https://github.com/comrade-coop/validated-streams/blob/main/vstreams/src/proofs/tests.rs) and ['events'](https://github.com/comrade-coop/validated-streams/blob/main/vstreams/src/events/tests.rs) seem to point at invalid urls. Presumably these links are outdated with the recent changes (i.e., renaming 'vstream' to 'consensus_validated_streams', integration of 'proof'/'event' to the 'consensus' crate).</li></ul><ul><li> Could not build benchmarks following the instruction (see Outstanding Issues).</li></ul> |
| **0d.** | Docker | <ul><li>[ ] </li></ul> | [Main](https://github.com/comrade-coop/validated-streams/blob/64db1c20f561115f807f41c5da58bca7b3325d5a/Dockerfile) <br> [IRC](https://github.com/comrade-coop/validated-streams/blob/beb99456091f33f1f1b3cf6a555ff656c107e9cf/samples/irc/Dockerfile) <br> [Test script](https://github.com/comrade-coop/validated-streams/blob/main/scripts/run-example.sh) <br> [Benchmark](https://github.com/comrade-coop/validated-streams/blob/64db1c20f561115f807f41c5da58bca7b3325d5a/samples/tps-benchmark/Dockerfile) | <ul><li> Again, [Test script](https://github.com/comrade-coop/validated-streams/blob/main/scripts/run-example.sh) seems to point at the old url. Shouldn't it be https://github.com/comrade-coop/validated-streams/tree/main/samples/basic/run_example.sh ? </li></ul><ul><li> Also path to the stream.proto should be corrected (in run_example.sh) if we intend to use the same sample solution as in M1 for the integration test </li></ul>|
| **0e.** | Article | <ul><li>[x] </li></ul> |[Google Docs link](https://docs.google.com/document/u/1/d/12EsVUDydsDWfngQP6-zYRiC-dFbn696Evr3VSxgcpjU/edit) | --
| 1. | Substrate module: Witnessed events block import | <ul><li>[x] </li></ul> |[Old](https://github.com/comrade-coop/validated-streams/blob/fa7e20c5f0bf34cd8b89f975eceb6e29955202ab/node/src/streams/services/witness_block_import.rs) <br><br>[New](https://github.com/comrade-coop/validated-streams/blob/9d1dd933395f9cca69834ccb43b3330922d531c4/consensus/src/block_import.rs) | The new implementation matches the description in delivery documentation. |
Expand Down

0 comments on commit 02eb660

Please sign in to comment.