storage module: add go docs and minor code quality refactors
#6259
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
nonsense
reviewed
May 14, 2021
nonsense
reviewed
May 14, 2021
nonsense
reviewed
May 14, 2021
|
@nonsense comments addressed! |
nonsense
approved these changes
May 14, 2021
dirkmc
approved these changes
May 19, 2021
| adaptedAPI = NewSealingAPIAdapter(m.api) | ||
|
|
||
| // Instantiate a precommit policy. | ||
| defaultDuration = policy.GetMaxSectorExpirationExtension() - (md.WPoStProvingPeriod * 2) |
There was a problem hiding this comment.
Suggest adding a comment to explain this calculation
| pcp = sealing.NewBasicPreCommitPolicy(adaptedAPI, defaultDuration, provingBoundary) | ||
|
|
||
| // address selector. | ||
| as = func(ctx context.Context, mi miner.MinerInfo, use api.AddrUse, goodFunds, minFunds abi.TokenAmount) (address.Address, abi.TokenAmount, error) { |
There was a problem hiding this comment.
Suggest adding a comment explaining what the address selector does
| @@ -833,6 +879,8 @@ func (s *WindowPoStScheduler) setSender(ctx context.Context, msg *types.Message, | |||
| minGasFeeMsg.GasFeeCap = msg.GasFeeCap | |||
| } | |||
|
|
|||
| // goodFunds = funds needed for optimal inclusion probability. | |||
magik6k
reviewed
May 19, 2021
Comment on lines
+47
to
+49
| // This object is the owner of the sealing pipeline. Most of the actual logic | ||
| // lives in the storage-sealing module (sealing.Sealing), and the Miner object | ||
| // exposes it to the rest of the system by proxying calls. |
There was a problem hiding this comment.
This is mostly tech debt, but it's really tricky to untangle storage-sealing from this object, which is why it's here
magik6k
approved these changes
May 20, 2021
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.
This absorbs #2340. Refer to the commit log for details.