Feed peer selection governor with big ledger peers obtained from a snapshot #4850
+479
−163
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crocodile-dentist
force-pushed
the
mwojtowicz/provide-peers-from-snapshot
branch
from
4c893c8
to
e3cf273
Compare
crocodile-dentist
force-pushed
the
mwojtowicz/provide-peers-from-snapshot
branch
3 times, most recently
from
30b0651
to
bd190c2
Compare
9 tasks
crocodile-dentist
force-pushed
the
mwojtowicz/provide-peers-from-snapshot
branch
2 times, most recently
from
e0f3ac8
to
c074f34
Compare
coot
reviewed
Apr 24, 2024
Comment on lines
32
to
34
| accBigPoolStake :: [(PoolStake, NonEmpty RelayAccessPoint)] | ||
| -> [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))] | ||
| accBigPoolStake = |
There was a problem hiding this comment.
Sine accBigPoolStake nand reRelativeState are now public API, it's better to give them better name, maybe:
accumulateBigLedgerStaterecomputeRelativeStake
| -- | ||
| accBigPoolStake :: [(PoolStake, NonEmpty RelayAccessPoint)] | ||
| -> [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))] | ||
| accBigPoolStake = |
There was a problem hiding this comment.
We have some code duplication between accPoolStake and accBigPoolStake; could you create an issue to address this in the future?
Comment on lines
65
to
82
| toCBOR = mconcat . (encodeListLen 3 :) . \case | ||
| RelayAccessDomain domain port -> | ||
| [encodeWord8 0, serialize' port, toCBOR domain] | ||
| RelayAccessAddress (IP.IPv4 ip4) port -> | ||
| [encodeWord8 1, serialize' port, toCBOR (IP.fromIPv4 ip4)] | ||
| RelayAccessAddress (IP.IPv6 ip6) port -> | ||
| [encodeWord8 2, serialize' port, toCBOR (IP.fromIPv6 ip6)] | ||
| where | ||
| serialize' = toCBOR . toInteger |
There was a problem hiding this comment.
It will be cleaner to avoid mconcat;
toCBOR (RelayAccessDomain domain port) =
encodeListLen 3
<> encodeWord8 0
<> serialize' port
<> toCBOR domain
toCBOR (RelayAccessAddress (IP.IPv4 ipv4) port) =
encodeListLen 3
<> encodeWord8 1
<> serialize' port
<> toCBOR (IP.fromIPv4 ipv4)
toCBOR (RelayAccessAddress (IP.IPv6 ip6) port) =
encodeListLen 3
<> encodeWord8 2
<> serialize' port
<> toCBOR (IP.fromIPv4 ip6)
Comment on lines
78
to
79
| when (codeTag /= 3) . fail $ "Unrecognized RelayAccessPoint encoding tag " | ||
| <> show codeTag |
There was a problem hiding this comment.
it's an unrecognised list length rather than a tag.
ouroboros-network/sim-tests-lib/Test/Ouroboros/Network/LedgerPeers.hs
Outdated
Show resolved
Hide resolved
| -- | ||
| accBigPoolStake :: [(PoolStake, NonEmpty RelayAccessPoint)] | ||
| -> [(AccPoolStake, (PoolStake, NonEmpty RelayAccessPoint))] | ||
| accBigPoolStake = |
There was a problem hiding this comment.
Do we have any properties for accBigPoolStake and reRelativeState; it's a good opportunity to add some if we don't.
There was a problem hiding this comment.
We had a test for the first one, and I've added a test for recomputeRelativeStake - the properties I've considered are that
- It should not add/remove/modify any relay access points
- Each relative stake should be non-negative
- Total normalized stake adds up to unity
crocodile-dentist
force-pushed
the
mwojtowicz/provide-peers-from-snapshot
branch
6 times, most recently
from
9a27667
to
249edf8
Compare
This change tidies up a function signature to make use of records that were created previously for use by other functions. They bundle many common related values together to facilitate passing them around.
This change binds useLedgerPeers after unblocking due to a demand for ledger peers by its clients. If this value has changed in the configuration while the thread was dormant, ie. a race, it will be picked up when the function unblocks.
Moved utility functions to ouroboros-network-api to support calculating big ledger peer snapshots by upstream libraries, for eg. Genesis consensus mode and bootstrapping a node with a recent snapshot of these peers.
This change adds ToCBOR and FromCBOR instances that are necessary to serialize a snapshot of ledger peers.
Depending on its topology configuration, a node may provide diffusion layer with a snapshot of big ledger peers from some slot. This value is provided as an argument when diffusion is initialized, and is provided to ledgerPeersThread function, which contains the logic when these peers, if any, can be provided to peer selection governor when it requests them. This is especially useful when consensus is ran in Genesis mode and when the node is bootstrapping so it may have opportunity to connect to these trustworthy peers when they may not be yet available on its own ledger.
encoding, as well as checking that ToCBOR and FromCBOR are working together correctly.
crocodile-dentist
force-pushed
the
mwojtowicz/provide-peers-from-snapshot
branch
from
249edf8
to
8916d88
Compare
component. Added property tests to check whether ledger peer snapshot peers are provided in appropriate circumstances.
crocodile-dentist
force-pushed
the
mwojtowicz/provide-peers-from-snapshot
branch
from
8916d88
to
062381a
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Consensus Genesis syncing mode relies on having at least one honest peer to ensure a syncing node will finish on a good chain. Largest stake pools are a good proxy for honesty, and therefore these peers are the big ledger peers, which a syncing node may not be aware of when its ledger state may still be too stale. A snapshot file of these peers can be provided in a node's topology configuration, and this set will be provided to peer selection governor so it has an opportunity to make these connections.
This change modifies ledgerPeersThread to leverage this data, and appropriately randomly pick from this set and respond to peer selection governor when it makes a request for big ledger peers.
Checklist