Add comments to FeeConfig #125
Merged
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
aaronbuchwald
force-pushed
the
document-fee-config
branch
from
1de5a6f
to
0f27826
Compare
ceyonur
approved these changes
Jun 3, 2022
params/config.go
Outdated
| TargetGas *big.Int `json:"targetGas,omitempty"` | ||
| // GasLimit sets the max amount of gas consumed per block. | ||
| GasLimit *big.Int `json:"gasLimit,omitempty"` | ||
| // This sets the target rate of block production in seconds. |
There was a problem hiding this comment.
nit: typically comment would start with TargetBlockRate
params/config.go
Outdated
| // When the dynamic fee algorithm observes that network activity is above/below the [TargetGas], it increases/decreases the base fee proportionally to | ||
| // how far above/below the target actual network activity is. | ||
|
|
||
| // TargetGas specifies the targeted amount of gas (including block gas cost) to consume within a given 10s window. |
There was a problem hiding this comment.
nit: rolling 10s window
params/config.go
Outdated
| // If it is produced faster/slower, the block gas cost will be increased/decreased by the step value for each second faster/slower than the target | ||
| // block rate accordingly. | ||
| // | ||
| // Ex. if a block is produced two seconds faster than the target block rate, the block gas cost will increase by 2 * BlockGasCostStep. |
There was a problem hiding this comment.
nit: add a note that if you increase to a very large number, you can effectively limit block production at the target rate
patrick-ogrady
approved these changes
Jun 7, 2022
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 PR adds comments to the FeeConfig struct.