Block hash publisher #54
There are no files selected for viewing
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
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
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
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
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,83 @@ | ||
| package block_hash_publisher | ||
|
|
||
| import ( | ||
| "encoding/hex" | ||
| "fmt" | ||
| "strconv" | ||
| "strings" | ||
|
|
||
| "github.com/ava-labs/avalanchego/ids" | ||
| "github.com/pkg/errors" | ||
| ) | ||
|
|
||
| type destinationInfo struct { | ||
| ChainID string `json:"chain-id"` | ||
| Address string `json:"address"` | ||
| Interval string `json:"interval"` | ||
|
|
||
| useTimeInterval bool | ||
| blockInterval uint64 | ||
| timeIntervalSeconds uint64 | ||
| } | ||
|
|
||
| type Config struct { | ||
| DestinationChains []destinationInfo `json:"destination-chains"` | ||
| } | ||
|
|
||
| func (c *Config) Validate() error { | ||
| for i, destinationInfo := range c.DestinationChains { | ||
| // Check if the chainID is valid | ||
| if _, err := ids.FromString(destinationInfo.ChainID); err != nil { | ||
| return errors.Wrap(err, fmt.Sprintf("invalid chainID in block hash publisher configuration. Provided ID: %s", destinationInfo.ChainID)) | ||
| } | ||
|
|
||
| // Check if the address is valid | ||
| addr := destinationInfo.Address | ||
| if addr == "" { | ||
| return errors.New("empty address in block hash publisher configuration") | ||
| } | ||
| addr = strings.TrimPrefix(addr, "0x") | ||
| _, err := hex.DecodeString(addr) | ||
| if err != nil { | ||
| return errors.Wrap(err, fmt.Sprintf("invalid address in block hash publisher configuration. Provided address: %s", destinationInfo.Address)) | ||
| } | ||
|
Comment on lines
+39
to
+43
There was a problem hiding this comment. Are we able to check that this is a valid address, and not just a valid hex string? |
||
|
|
||
| // Intervals must be either a positive integer, or a positive integer followed by "s" | ||
| interval, isSeconds, err := parseIntervalWithSuffix(destinationInfo.Interval) | ||
| if err != nil { | ||
| return errors.Wrap(err, fmt.Sprintf("invalid interval in block hash publisher configuration. Provided interval: %s", destinationInfo.Interval)) | ||
| } | ||
| if isSeconds { | ||
| c.DestinationChains[i].timeIntervalSeconds = interval | ||
| } else { | ||
| c.DestinationChains[i].blockInterval = interval | ||
| } | ||
| c.DestinationChains[i].useTimeInterval = isSeconds | ||
| } | ||
| return nil | ||
| } | ||
|
|
||
| func parseIntervalWithSuffix(input string) (uint64, bool, error) { | ||
| // Check if the input string is empty | ||
| if input == "" { | ||
| return 0, false, fmt.Errorf("empty string") | ||
| } | ||
|
|
||
| // Check if the string ends with "s" | ||
| hasSuffix := strings.HasSuffix(input, "s") | ||
|
|
||
| // If it has the "s" suffix, remove it | ||
| if hasSuffix { | ||
| input = input[:len(input)-1] | ||
| } | ||
|
|
||
| // Parse the string as an integer | ||
| intValue, err := strconv.Atoi(input) | ||
|
|
||
| // Check if the parsed value is a positive integer | ||
| if err != nil || intValue < 0 { | ||
| return 0, false, err | ||
| } | ||
|
Comment on lines
+78
to
+80
There was a problem hiding this comment. We should probably separate these cases. Right now if |
||
|
|
||
| return uint64(intValue), hasSuffix, nil | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,128 @@ | ||
| package block_hash_publisher | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| type testResult struct { | ||
| isTimeInterval bool | ||
| blockInterval uint64 | ||
| timeIntervalSeconds uint64 | ||
| } | ||
|
|
||
| func TestConfigValidate(t *testing.T) { | ||
| testCases := []struct { | ||
| name string | ||
| destinationChains []destinationInfo | ||
| isError bool | ||
| testResults []testResult // indexes correspond to destinationChains | ||
| }{ | ||
| { | ||
| name: "valid", | ||
| destinationChains: []destinationInfo{ | ||
| { | ||
| ChainID: "9asUA3QckLh7vGnFQiiUJGPTx8KE4nFtP8c1wTWJuP8XiWW75", | ||
| Address: "0x50A46AA7b2eCBe2B1AbB7df865B9A87f5eed8635", | ||
| Interval: "10", | ||
| }, | ||
| { | ||
| ChainID: "9asUA3QckLh7vGnFQiiUJGPTx8KE4nFtP8c1wTWJuP8XiWW75", | ||
| Address: "0x50A46AA7b2eCBe2B1AbB7df865B9A87f5eed8635", | ||
| Interval: "10s", | ||
| }, | ||
| }, | ||
| isError: false, | ||
| testResults: []testResult{ | ||
| { | ||
| isTimeInterval: false, | ||
| blockInterval: 10, | ||
| }, | ||
| { | ||
| isTimeInterval: true, | ||
| timeIntervalSeconds: 10, | ||
| }, | ||
| }, | ||
| }, | ||
| { | ||
| name: "invalid chainID", | ||
| destinationChains: []destinationInfo{ | ||
| { | ||
| ChainID: "9asUA3QckLh7vGnFQiiUJGPTx8KE4nFtP8c1wTWJuP8XiWW7", | ||
| Address: "0x50A46AA7b2eCBe2B1AbB7df865B9A87f5eed8635", | ||
| Interval: "10", | ||
| }, | ||
| }, | ||
| isError: true, | ||
| }, | ||
| { | ||
| name: "invalid interval 1", | ||
| destinationChains: []destinationInfo{ | ||
| { | ||
| ChainID: "9asUA3QckLh7vGnFQiiUJGPTx8KE4nFtP8c1wTWJuP8XiWW75", | ||
| Address: "0x50A46AA7b2eCBe2B1AbB7df865B9A87f5eed8635", | ||
| Interval: "4r", | ||
| }, | ||
| }, | ||
| isError: true, | ||
| }, | ||
| { | ||
| name: "invalid interval 2", | ||
| destinationChains: []destinationInfo{ | ||
| { | ||
| ChainID: "9asUA3QckLh7vGnFQiiUJGPTx8KE4nFtP8c1wTWJuP8XiWW75", | ||
| Address: "0x50A46AA7b2eCBe2B1AbB7df865B9A87f5eed8635", | ||
| Interval: "l", | ||
| }, | ||
| }, | ||
| isError: true, | ||
| }, | ||
| { | ||
| name: "invalid interval 3", | ||
| destinationChains: []destinationInfo{ | ||
| { | ||
| ChainID: "9asUA3QckLh7vGnFQiiUJGPTx8KE4nFtP8c1wTWJuP8XiWW75", | ||
| Address: "0x50A46AA7b2eCBe2B1AbB7df865B9A87f5eed8635", | ||
| Interval: "", | ||
| }, | ||
| }, | ||
| isError: true, | ||
| }, | ||
| { | ||
| name: "invalid address", | ||
| destinationChains: []destinationInfo{ | ||
| { | ||
| ChainID: "9asUA3QckLh7vGnFQiiUJGPTx8KE4nFtP8c1wTWJuP8XiWW75", | ||
| Address: "0x50A46AA7b2eCBe2B1AbB7df865B9A87f5eed863", | ||
| Interval: "10", | ||
| }, | ||
| }, | ||
| isError: true, | ||
| }, | ||
| } | ||
|
|
||
| for _, test := range testCases { | ||
| t.Run(test.name, func(t *testing.T) { | ||
| c := &Config{ | ||
| DestinationChains: test.destinationChains, | ||
| } | ||
| err := c.Validate() | ||
| fmt.Println(c) | ||
| if test.isError { | ||
| require.Error(t, err) | ||
| } else { | ||
| require.NoError(t, err) | ||
| for i, result := range test.testResults { | ||
| require.Equal(t, result.isTimeInterval, c.DestinationChains[i].useTimeInterval) | ||
| if result.isTimeInterval { | ||
| require.Equal(t, result.timeIntervalSeconds, c.DestinationChains[i].timeIntervalSeconds) | ||
| } else { | ||
| require.Equal(t, result.blockInterval, c.DestinationChains[i].blockInterval) | ||
| } | ||
| } | ||
| } | ||
| }) | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems odd that Blockhash is considered its own VM type. Are we overloading the term "VM" here?