Introducing GenericNodeID #1989
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
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 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 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 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,123 @@ | ||
| // Copyright (C) 2019-2023, Ava Labs, Inc. All rights reserved. | ||
| // See the file LICENSE for licensing terms. | ||
|
|
||
| package ids | ||
|
|
||
| import ( | ||
| "encoding/json" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/require" | ||
| ) | ||
|
|
||
| func FuzzNodeIDMarshallUnmarshalInversion(f *testing.F) { | ||
| f.Fuzz(func(t *testing.T, buf string) { | ||
| var ( | ||
| require = require.New(t) | ||
| input = NodeID{buf: buf} | ||
| output = new(NodeID) | ||
| ) | ||
|
|
||
| // json package marshalling | ||
| b, err := json.Marshal(input) | ||
| require.NoError(err) | ||
|
|
||
| require.NoError(json.Unmarshal(b, output)) | ||
| require.Equal(input, *output) | ||
|
|
||
| // MarshalJson/UnmarshalJson | ||
| output = new(NodeID) | ||
| b, err = input.MarshalJSON() | ||
| require.NoError(err) | ||
|
|
||
| require.NoError(output.UnmarshalJSON(b)) | ||
| require.Equal(input, *output) | ||
| }) | ||
| } | ||
|
|
||
| func FuzzShortNodeIDMarshallUnmarshalInversion(f *testing.F) { | ||
| f.Fuzz(func(t *testing.T, buf []byte) { | ||
| if len(buf) != ShortNodeIDLen { | ||
| return | ||
| } | ||
|
|
||
| var ( | ||
| require = require.New(t) | ||
| input = ShortNodeID(buf) | ||
| output = new(ShortNodeID) | ||
| ) | ||
|
|
||
| // json package marshalling | ||
| b, err := json.Marshal(input) | ||
| require.NoError(err) | ||
|
|
||
| require.NoError(json.Unmarshal(b, output)) | ||
| require.Equal(input, *output) | ||
|
|
||
| // MarshalJson/UnmarshalJson | ||
| output = new(ShortNodeID) | ||
| b, err = input.MarshalJSON() | ||
| require.NoError(err) | ||
|
|
||
| require.NoError(output.UnmarshalJSON(b)) | ||
| require.Equal(input, *output) | ||
| }) | ||
| } | ||
|
|
||
| func FuzzShortIDMarshallUnmarshalInversion(f *testing.F) { | ||
| f.Fuzz(func(t *testing.T, buf []byte) { | ||
| if len(buf) != ShortIDLen { | ||
| return | ||
| } | ||
|
|
||
| var ( | ||
| require = require.New(t) | ||
| input = ShortID(buf) | ||
| output = new(ShortID) | ||
| ) | ||
|
|
||
| // json package marshalling | ||
| b, err := json.Marshal(input) | ||
| require.NoError(err) | ||
|
|
||
| require.NoError(json.Unmarshal(b, output)) | ||
| require.Equal(input, *output) | ||
|
|
||
| // MarshalJson/UnmarshalJson | ||
| output = new(ShortID) | ||
| b, err = input.MarshalJSON() | ||
| require.NoError(err) | ||
|
|
||
| require.NoError(output.UnmarshalJSON(b)) | ||
| require.Equal(input, *output) | ||
| }) | ||
| } | ||
|
|
||
| func FuzzIDMarshallUnmarshalInversion(f *testing.F) { | ||
| f.Fuzz(func(t *testing.T, buf []byte) { | ||
| if len(buf) != IDLen { | ||
| return | ||
| } | ||
|
|
||
| var ( | ||
| require = require.New(t) | ||
| input = ID(buf) | ||
| output = new(ID) | ||
| ) | ||
|
|
||
| // json package marshalling | ||
| b, err := json.Marshal(input) | ||
| require.NoError(err) | ||
|
|
||
| require.NoError(json.Unmarshal(b, output)) | ||
| require.Equal(input, *output) | ||
|
|
||
| // MarshalJson/UnmarshalJson | ||
| output = new(ID) | ||
| b, err = input.MarshalJSON() | ||
| require.NoError(err) | ||
|
|
||
| require.NoError(output.UnmarshalJSON(b)) | ||
| require.Equal(input, *output) | ||
| }) | ||
| } |
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 |
|---|---|---|
|
|
@@ -4,51 +4,60 @@ | |
| package ids | ||
|
|
||
| import ( | ||
| "errors" | ||
| "fmt" | ||
| "strings" | ||
|
|
||
| "github.com/ava-labs/avalanchego/staking" | ||
| "github.com/ava-labs/avalanchego/utils" | ||
| "github.com/ava-labs/avalanchego/utils/cb58" | ||
| "github.com/ava-labs/avalanchego/utils/hashing" | ||
| ) | ||
|
|
||
| const ( | ||
| NodeIDPrefix = "NodeID-" | ||
|
|
||
| NodeIDLen = 32 | ||
| ) | ||
|
|
||
| var ( | ||
| EmptyNodeID = NodeID{} | ||
|
|
||
| ErrBadNodeIDLength = errors.New("bad nodeID length") | ||
|
|
||
| _ utils.Sortable[NodeID] = NodeID{} | ||
| ) | ||
|
|
||
| // NodeID embeds a string, rather than being a type alias for a string | ||
| // to be able to use custom marshaller for json encoding. | ||
| // See https://github.com/golang/go/blob/go1.20.8/src/encoding/json/encode.go#L1004-L1026 | ||
| // which checks for the string type first, then checks to see if a custom marshaller exists, | ||
| // then checks if any other of the primitive types are provided. | ||
| type NodeID struct { | ||
| buf string | ||
| } | ||
|
Comment on lines
+36
to
38
There was a problem hiding this comment. I feel like we should explicitly link or document why func (w *reflectWithString) resolve() error {
if w.k.Kind() == reflect.String {
w.ks = w.k.String()
return nil
}
if tm, ok := w.k.Interface().(encoding.TextMarshaler); ok {
if w.k.Kind() == reflect.Pointer && w.k.IsNil() {
return nil
}
buf, err := tm.MarshalText()
w.ks = string(buf)
return err
}
switch w.k.Kind() {
case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
w.ks = strconv.FormatInt(w.k.Int(), 10)
return nil
case reflect.Uint, reflect.Uint8, reflect.Uint16, reflect.Uint32, reflect.Uint64, reflect.Uintptr:
w.ks = strconv.FormatUint(w.k.Uint(), 10)
return nil
}
panic("unexpected map key type")
}For some reason this function checks for the There was a problem hiding this comment. Added a comment with the ref you found. |
||
|
|
||
| func (n NodeID) Bytes() []byte { | ||
| return []byte(n.buf) | ||
| } | ||
|
|
||
| func (n NodeID) String() string { | ||
| // We assume that the maximum size of a byte slice that | ||
| // can be stringified is at least the length of an ID | ||
| str, _ := cb58.Encode([]byte(n.buf)) | ||
| return NodeIDPrefix + str | ||
| } | ||
|
|
||
| func (n NodeID) MarshalJSON() ([]byte, error) { | ||
| return []byte(`"` + n.String() + `"`), nil | ||
| } | ||
|
|
||
| func (n *NodeID) UnmarshalJSON(b []byte) error { | ||
| str := string(b) | ||
| if str == nullStr { // If "null", do nothing | ||
| return nil | ||
| } | ||
| if len(str) <= 2+len(NodeIDPrefix) { | ||
| return fmt.Errorf("%w: expected to be > %d", errShortNodeID, 2+len(NodeIDPrefix)) | ||
| } | ||
|
|
||
|
|
@@ -58,35 +67,66 @@ func (id *NodeID) UnmarshalJSON(b []byte) error { | |
| } | ||
|
|
||
| var err error | ||
| *n, err = NodeIDFromString(str[1:lastIndex]) | ||
| return err | ||
| } | ||
|
|
||
| func (n NodeID) MarshalText() ([]byte, error) { | ||
| return []byte(n.String()), nil | ||
| } | ||
|
|
||
| func (n *NodeID) UnmarshalText(text []byte) error { | ||
| return n.UnmarshalJSON(text) | ||
|
Comment on lines
+74
to
+79
There was a problem hiding this comment. We should explicitly document why these are not symmetric |
||
| } | ||
|
|
||
| func (n NodeID) Compare(other NodeID) int { | ||
| return strings.Compare(n.buf, other.buf) | ||
| } | ||
|
|
||
| func ToNodeID(src []byte) (NodeID, error) { | ||
| switch { | ||
| case len(src) == 0: | ||
| return EmptyNodeID, nil | ||
|
|
||
|
Comment on lines
+88
to
+90
There was a problem hiding this comment. I'm wondering if we can get away with not supporting this parsing here (treating the zero value of |
||
| case len(src) == ShortIDLen || len(src) == NodeIDLen: | ||
| return NodeID{ | ||
| buf: string(src), | ||
| }, nil | ||
|
|
||
| default: | ||
| return EmptyNodeID, fmt.Errorf("%w: expected %d or %d bytes but got %d", ErrBadNodeIDLength, ShortNodeIDLen, NodeIDLen, len(src)) | ||
| } | ||
| } | ||
|
|
||
| func NodeIDFromShortNodeID(nodeID ShortNodeID) NodeID { | ||
| if nodeID == EmptyShortNodeID { | ||
| return EmptyNodeID | ||
| } | ||
| return NodeID{ | ||
| buf: string(nodeID.Bytes()), | ||
| } | ||
| } | ||
|
|
||
| func NodeIDFromCert(cert *staking.Certificate) NodeID { | ||
| return NodeID{ | ||
| buf: string(hashing.ComputeHash160( | ||
| hashing.ComputeHash256(cert.Raw), | ||
| )), | ||
| } | ||
| } | ||
|
|
||
| // NodeIDFromString is the inverse of NodeID.String() | ||
| func NodeIDFromString(nodeIDStr string) (NodeID, error) { | ||
StephenButtolph marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| s, found := strings.CutPrefix(nodeIDStr, NodeIDPrefix) | ||
| if !found { | ||
| return EmptyNodeID, fmt.Errorf("ID: %s is missing the prefix: %s", nodeIDStr, NodeIDPrefix) | ||
| } | ||
|
|
||
| bytes, err := cb58.Decode(s) | ||
| if err != nil { | ||
| return EmptyNodeID, err | ||
| } | ||
| return NodeID{ | ||
| buf: string(bytes), | ||
| }, nil | ||
| } | ||
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.