Interface and local implementation for sortition chain #3056
Conversation
This file contains hidden or 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
This change is greatly inspired by the work of @nkuba in #3028 but it is just a subset of the original work with some changes introduced. First, `sortition.Chain` handle interface is introduced. In opposite to v1 approach, where we had a global chain handle, the new proposed approach is to keep a chain handle per module. This should make the chain code less complicated and allow introducing custom behavior to functions, if needed be the logic of the given module. Second, `chain.Address` type based on `string` is introduced. We need a chain-agnostic implementation of a chain address to use in interfaces. So far, it's been an array of bytes, as presented in `Signing` interface, but `string` seems easier to use in most cases. Last but not least, a local implementation of `sortition.Chain` handle is introduced. Also, a set of simple test utils for assertions is added. Most of the time, such simple assertions are all we need, and having them extracted to a single place lets us avoid the assertion error message formatting boilerplate in test files. Long-term, if needed, we may use some more sophisticated assertion library.
Instead of returning an error, we should return a boolean saying if the staking provider registered operator address. This way, we can distinguish this situation from infrastructure-level errors.
Moved the code to internal directory to clearly indicate nothing in `local.go` should be in the interest of the code outside of `keep-core`. This is just a mock for `sortition.Chain` interface that we'll use in future `sortition.go` unit tests.
Merged
lukasz-zimnoch
approved these changes
Jul 6, 2022
Comment on lines
+11
to
+15
| OperatorToStakingProvider() (chain.Address, bool, error) | ||
| EligibleStake(stakingProvider chain.Address) (*big.Int, error) | ||
| IsPoolLocked() (bool, error) | ||
| IsOperatorInPool() (bool, error) | ||
| JoinSortitionPool() error |
Member
There was a problem hiding this comment.
Non-blocking for this PR but can we document those functions?
Member
Author
There was a problem hiding this comment.
Yeah, I am planning to do it in the next PR, when adding ethereum implementation.
This was referenced Jul 6, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Refs #3006
This change is greatly inspired by the work of @nkuba in #3028 but it is just a subset of the original work with some changes introduced.
First,
sortition.Chainhandle interface is introduced. In opposite to v1 approach, where we had a global chain handle, the new proposed approach is to keep a chain handle per module. This should make the chain code less complicated and allow introducing custom behavior to functions, if needed be the logic of the given module.Second,
chain.Addresstype based onstringis introduced. We need a chain-agnostic implementation of a chain address to use in interfaces. So far, it's been an array of bytes, as presented inSigninginterface, butstringseems easier to use in most cases.Last but not least, a local implementation of
sortition.Chainhandle is introduced.Also, a set of simple test utils for assertions is added. Most of the time, such simple assertions are all we need, and having them extracted to a single place lets us avoid the assertion error message formatting boilerplate in test files. Long-term, if needed, we may use some more sophisticated assertion library.