-
Notifications
You must be signed in to change notification settings - Fork 148
Add a type for modeling multiple-dimensional gas #482
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
7440768
Add a type for modeling a Resource Constraint
gligneul 61c1413
Fix typo
gligneul 28b015a
Rename constraint struct to resourceConstraint
gligneul 3d66c6b
Add documentation for NewResourceConstraints
gligneul 78af5bf
Check the length of all resources in test
gligneul 7380b46
Replace uint32 with PeriodSecs type
gligneul df5fb1d
Improve error messages of unit tests
gligneul 32d2183
Add resource kind unknown
gligneul 721d353
Move resource constraint to nitro repo
gligneul File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
package multigas | ||
|
||
import "time" | ||
|
||
// The period duration for a resource constraint. | ||
type PeriodSecs uint32 | ||
|
||
// resourceConstraint defines the max gas target per second for the given period for a single resource. | ||
type resourceConstraint struct { | ||
period time.Duration | ||
target uint64 | ||
} | ||
|
||
// ResourceConstraints is a set of constraints for all resources. | ||
// | ||
// The chain owner defines constraints to limit the usage of each resource. A resource can have | ||
// multiple constraints with different periods, but there may be a single constraint given the | ||
// resource and period. | ||
// | ||
// Example constraints: | ||
// - X amount of computation over 12 seconds so nodes can keep up. | ||
// - Y amount of computation over 7 days so fresh nodes can catch up with the chain. | ||
// - Z amount of history growth over one month to avoid bloat. | ||
type ResourceConstraints map[ResourceKind]map[PeriodSecs]resourceConstraint | ||
|
||
// NewResourceConstraints creates a new set of constraints. | ||
// This type can be used as a reference. | ||
func NewResourceConstraints() ResourceConstraints { | ||
c := ResourceConstraints{} | ||
for resource := ResourceKindUnknown + 1; resource < NumResourceKind; resource++ { | ||
c[resource] = map[PeriodSecs]resourceConstraint{} | ||
} | ||
return c | ||
} | ||
|
||
// SetConstraint adds or updates the given resource constraint. | ||
func (rc ResourceConstraints) SetConstraint( | ||
resource ResourceKind, periodSecs PeriodSecs, targetPerPeriod uint64, | ||
) { | ||
rc[resource][periodSecs] = resourceConstraint{ | ||
period: time.Duration(periodSecs) * time.Second, | ||
target: targetPerPeriod / uint64(periodSecs), | ||
} | ||
} | ||
|
||
// ClearConstraint removes the given resource constraint. | ||
func (rc ResourceConstraints) ClearConstraint(resource ResourceKind, periodSecs PeriodSecs) { | ||
delete(rc[resource], periodSecs) | ||
} |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
package multigas | ||
|
||
import ( | ||
"testing" | ||
"time" | ||
) | ||
|
||
func assertEqual[T comparable](t *testing.T, description string, got T, want T) { | ||
t.Helper() | ||
if got != want { | ||
t.Fatalf("unexpected %v: want %v, got %v", description, want, got) | ||
} | ||
} | ||
|
||
func TestResourceConstraints(t *testing.T) { | ||
rc := NewResourceConstraints() | ||
|
||
const ( | ||
minuteSecs = 60 | ||
daySecs = 24 * 60 * 60 | ||
weekSecs = 7 * daySecs | ||
monthSecs = 30 * daySecs | ||
) | ||
|
||
// Adds a few constraints | ||
rc.SetConstraint(ResourceKindComputation, minuteSecs, 5_000_000*minuteSecs) | ||
rc.SetConstraint(ResourceKindComputation, weekSecs, 3_000_000*weekSecs) | ||
rc.SetConstraint(ResourceKindHistoryGrowth, monthSecs, 1_000_000*monthSecs) | ||
assertEqual(t, "number of computation constraints", len(rc[ResourceKindComputation]), 2) | ||
assertEqual(t, "constraint period", rc[ResourceKindComputation][minuteSecs].period, time.Duration(minuteSecs)*time.Second) | ||
assertEqual(t, "constraint target", rc[ResourceKindComputation][minuteSecs].target, 5_000_000) | ||
assertEqual(t, "constraint period", rc[ResourceKindComputation][weekSecs].period, time.Duration(weekSecs)*time.Second) | ||
assertEqual(t, "constraint target", rc[ResourceKindComputation][weekSecs].target, 3_000_000) | ||
assertEqual(t, "number of history growth constraints", len(rc[ResourceKindHistoryGrowth]), 1) | ||
assertEqual(t, "constraint period", rc[ResourceKindHistoryGrowth][monthSecs].period, time.Duration(monthSecs)*time.Second) | ||
assertEqual(t, "constraint target", rc[ResourceKindHistoryGrowth][monthSecs].target, 1_000_000) | ||
assertEqual(t, "number of storage access constraints", len(rc[ResourceKindStorageAccess]), 0) | ||
assertEqual(t, "number of storage growth constraints", len(rc[ResourceKindStorageGrowth]), 0) | ||
|
||
// Updates a constraint | ||
rc.SetConstraint(ResourceKindHistoryGrowth, monthSecs, 500_000*monthSecs) | ||
assertEqual(t, "number of history growth constraints", len(rc[ResourceKindHistoryGrowth]), 1) | ||
assertEqual(t, "constraint target", rc[ResourceKindHistoryGrowth][monthSecs].target, 500_000) | ||
|
||
// Clear constraints | ||
rc.ClearConstraint(ResourceKindComputation, minuteSecs) | ||
rc.ClearConstraint(ResourceKindComputation, weekSecs) | ||
rc.ClearConstraint(ResourceKindHistoryGrowth, monthSecs) | ||
assertEqual(t, "number of computation constraints", len(rc[ResourceKindComputation]), 0) | ||
assertEqual(t, "number of history growth constraints", len(rc[ResourceKindHistoryGrowth]), 0) | ||
assertEqual(t, "number of storage access constraints", len(rc[ResourceKindStorageAccess]), 0) | ||
assertEqual(t, "number of storage growth constraints", len(rc[ResourceKindStorageGrowth]), 0) | ||
} |
gligneul marked this conversation as resolved.
Show resolved
Hide resolved
|
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
// Package multigas defines multi-dimensional gas for the EVM. | ||
eljobe marked this conversation as resolved.
Show resolved
Hide resolved
|
||
// | ||
// This package introduces mechanisms to track each resource used by the EVM separately. The | ||
// possible resources are computation, history growth, storage access, and storage growth. By | ||
// tracking each one individually and setting specific constraints, we can increase the overall gas | ||
// target for the chain. | ||
package multigas |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,16 @@ | ||
package multigas | ||
|
||
// ResourceKind represents a dimension for the multi-dimensional gas. | ||
type ResourceKind uint8 | ||
|
||
const ( | ||
ResourceKindUnknown ResourceKind = iota | ||
ResourceKindComputation | ||
ResourceKindHistoryGrowth | ||
ResourceKindStorageAccess | ||
ResourceKindStorageGrowth | ||
NumResourceKind | ||
) | ||
|
||
// MultiGas tracks gas for each resource separately. | ||
type MultiGas [NumResourceKind]uint64 |
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.