dusk-network / dusk-blockchain

Reference implementation of the DUSK Network node, written in Golang
MIT License
102 stars 47 forks source link

Improve Sortition Documentation #1493

Closed fed-franz closed 1 year ago

fed-franz commented 1 year ago

This PR adds/improves documentation of Deterministic Sortition code.


Resolves #1491

codecov-commenter commented 1 year ago

Codecov Report

Base: 40.18% // Head: 40.14% // Decreases project coverage by -0.04% :warning:

Coverage data is based on head (79b1346) compared to base (57c6bbd). Patch coverage: 19.46% of modified lines in pull request are covered.

:exclamation: Current head 79b1346 differs from pull request most recent head 3b7351c. Consider uploading reports for the commit 3b7351c to get more accurate results

Additional details and impacted files ```diff @@ Coverage Diff @@ ## master #1493 +/- ## ========================================== - Coverage 40.18% 40.14% -0.04% ========================================== Files 147 147 Lines 9651 9737 +86 ========================================== + Hits 3878 3909 +31 - Misses 5144 5204 +60 + Partials 629 624 -5 ``` | [Impacted Files](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network) | Coverage Δ | | |---|---|---| | [pkg/config/genesis/config.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2NvbmZpZy9nZW5lc2lzL2NvbmZpZy5nbw==) | `0.00% <ø> (ø)` | | | [pkg/config/genesis/presets.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2NvbmZpZy9nZW5lc2lzL3ByZXNldHMuZ28=) | `69.23% <ø> (ø)` | | | [...nsensus/blockgenerator/candidate/blockgenerator.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2NvcmUvY29uc2Vuc3VzL2Jsb2NrZ2VuZXJhdG9yL2NhbmRpZGF0ZS9ibG9ja2dlbmVyYXRvci5nbw==) | `0.00% <0.00%> (ø)` | | | [...core/consensus/blockgenerator/candidate/genesis.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2NvcmUvY29uc2Vuc3VzL2Jsb2NrZ2VuZXJhdG9yL2NhbmRpZGF0ZS9nZW5lc2lzLmdv) | `0.00% <0.00%> (ø)` | | | [...kg/core/consensus/blockgenerator/candidate/mock.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2NvcmUvY29uc2Vuc3VzL2Jsb2NrZ2VuZXJhdG9yL2NhbmRpZGF0ZS9tb2NrLmdv) | `0.00% <0.00%> (ø)` | | | [pkg/core/consensus/user/sortition.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2NvcmUvY29uc2Vuc3VzL3VzZXIvc29ydGl0aW9uLmdv) | `58.25% <ø> (ø)` | | | [pkg/core/data/ipc/transactions/fixtures.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2NvcmUvZGF0YS9pcGMvdHJhbnNhY3Rpb25zL2ZpeHR1cmVzLmdv) | `13.76% <0.00%> (-0.21%)` | :arrow_down: | | [pkg/core/data/ipc/transactions/provider.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2NvcmUvZGF0YS9pcGMvdHJhbnNhY3Rpb25zL3Byb3ZpZGVyLmdv) | `0.00% <0.00%> (ø)` | | | [pkg/gql/query/blocks.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2dxbC9xdWVyeS9ibG9ja3MuZ28=) | `63.22% <0.00%> (ø)` | | | [pkg/gql/query/mempool.go](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network#diff-cGtnL2dxbC9xdWVyeS9tZW1wb29sLmdv) | `30.00% <0.00%> (ø)` | | | ... and [12 more](https://codecov.io/gh/dusk-network/dusk-blockchain/pull/1493?src=pr&el=tree-more&utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network) | | Help us with your feedback. Take ten seconds to tell us [how you rate us](https://about.codecov.io/nps?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network). Have a feature suggestion? [Share it here.](https://app.codecov.io/gh/feedback/?utm_medium=referral&utm_source=github&utm_content=comment&utm_campaign=pr+comments&utm_term=dusk-network)

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.