Introduce ShortNodeID #3313

tsachiherman · 2024-08-20T15:57:49Z

Why this should be merged

This PR is the first step toward ACP-20.
The existing NodeID was renamed into ShortNodeID, and a new, backward compatible NodeID was added.
Given that the ACP-20 changes are expected to be massive, I'd like to merge this backward-compatible change
before moving with the rest of the changes.

How this works

For most of the places, the usages of NodeID would remain as is.
Places that need to retain the classic NodeID were modified to be using the ShortNodeID.
The change is expected to be in a single direction only. i.e. ShortNodeID can be converted into NodeID by calling it's NodeID() function. No conversion from NodeID to ShortNodeID should be needed.

How this was tested

Tested against existing unit tests.

ids/node_id.go

StephenButtolph

I think we should be removing ids.NodeIDLen entirely. Every usage of it right now seems like it will break in the future.
"vms/platformvm/txs".Validator#NodeID should be a ids.ShortNodeID because it is serialized.
- "vms/platformvm/txs/fee.intrinsicValidatorBandwidth" should be using ids.ShortNodeIDLen
- "vms/platformvm/txs/fee.IntrinsicRemoveSubnetValidatorTxComplexities" should be using ids.ShortNodeIDLen
"vms/platformvm/txs.RemoveSubnetValidatorTx".NodeID should be a ids.ShortNodeID because it is serialized.

StephenButtolph · 2024-08-26T19:48:41Z

tests/e2e/p/workflow.go

@@ -100,12 +100,12 @@ var _ = e2e.DescribePChain("[Workflow]", func() {

 		// Use a random node ID to ensure that repeated test runs will succeed
 		// against a network that persists across runs.
-		validatorID, err := ids.ToNodeID(utils.RandomBytes(ids.NodeIDLen))
+		validatorID, err := ids.ToShortNodeID(utils.RandomBytes(ids.NodeIDLen))


Suggested change

validatorID, err := ids.ToShortNodeID(utils.RandomBytes(ids.NodeIDLen))

validatorID, err := ids.ToShortNodeID(utils.RandomBytes(ids.ShortNodeIDLen))

StephenButtolph · 2024-08-26T20:14:43Z

snow/engine/common/appsender/appsender_server.go

Why does this file use ids.ShortNodeID rather than keeping it generic as ids.NodeID?

StephenButtolph · 2024-08-26T20:15:33Z

snow/validators/gvalidators/validator_state_client.go

Why does this file use ids.ShortNodeID rather than keeping it generic as ids.NodeID?

StephenButtolph · 2024-08-26T20:24:25Z

vms/platformvm/state/disk_staker_diff_iterator.go

marshalDiffKey and unmarshalDiffKey seem to make the assumption that ids.NodeID has the same length as ids.ShortNodeID. This doesn't seem safe in the long term

good point. let me address that.

StephenButtolph · 2024-08-26T20:25:15Z

vms/rpcchainvm/vm_server.go

Why does this file use ids.ShortNodeID rather than keeping it generic as ids.NodeID?

StephenButtolph · 2024-08-26T20:33:01Z

ids/test_generator.go

Not for this PR - but we should move this file out into an idstest package.

created #3343 to track this.

StephenButtolph · 2024-08-26T20:39:09Z

vms/platformvm/genesis/genesistest/genesis.go

+		for _, shortNodeID := range DefaultNodeIDs {
+			c.NodeIDs = append(c.NodeIDs, shortNodeID.NodeID())
+		}


I don't think we should be transforming the types here. I think the users of this util should be specifying the NodeID type they expect to have used.

StephenButtolph · 2024-08-26T20:40:04Z

vms/platformvm/service_test.go

@@ -623,7 +623,7 @@ func TestGetCurrentValidators(t *testing.T) {
 		found := false
 		for i := 0; i < len(response.Validators); i++ {
 			gotVdr := response.Validators[i].(pchainapi.PermissionlessValidator)
-			if gotVdr.NodeID != nodeID {
+			if gotVdr.NodeID.Compare(nodeID) != 0 {


Why change from using != to .Compare (here and below)?

given that the NodeID is now a struct, using a comparison method allow us to ensure we can retain the comparison functionality even if we were to add, let's say, a non-comparable variable to the struct ( i.e. pointer ).
I figured that since we already having a comparison method, we should use it instead of relying on a mix of comparison techniques.

StephenButtolph · 2024-08-26T20:42:35Z

ids/node_id.go

-func (id *NodeID) UnmarshalText(text []byte) error {
-	return id.UnmarshalJSON(text)
+type NodeID struct {
+	ShortNodeID `serialize:"true"`


If this diff is "forwards safe" I think we should be able to add an additional field (or somehow else change the serialized format of this struct) without breaking a ton of tests.

StephenButtolph · 2024-08-26T20:45:18Z

utils/ips/claimed_ip_port.go

 	packer := wrappers.Packer{
 		Bytes: make([]byte, preimageLen),
 	}
-	packer.PackFixedBytes(ip.NodeID[:])
+	packer.PackFixedBytes(ip.NodeID.Bytes())
 	packer.PackLong(timestamp)
 	ip.GossipID = hashing.ComputeHash256Array(packer.Bytes)


This looks dubious. If ip.NodeID.Bytes() started returning 32 bytes, it seems like this may behave unexpectedly.

I need to look into this a bit more carefully.

in the context of this PR, I believe that this change is safe. The ip.NodeID is populated few lines above as NodeID: ids.ShortNodeIDFromCert(cert).NodeID(). Hence, guarantee that it's a 20 bytes slice.
Future PRs would need to update this logic, naturally.

update

dce85fd

tsachiherman self-assigned this Aug 20, 2024

tsachiherman added 11 commits August 21, 2024 11:45

Merge branch 'master' into tsachi/acp20-nodeid

26073e7

update

05e180d

update

f87604d

Merge branch 'master' into tsachi/acp20-nodeid

71d596b

update

fbe8fc7

update

dab14e0

fix unit tests

b44ca0d

update

4f1ac5a

update

79cc15c

fix lint

169d8bb

Merge branch 'master' into tsachi/acp20-nodeid

7e5a753

tsachiherman changed the title ~~[wip] Prepare for ACP-20 : Update NodeID and ShortNodeID~~ Introduce ShortNodeID Aug 22, 2024

Merge branch 'master' into tsachi/acp20-nodeid

4c5c396

tsachiherman marked this pull request as ready for review August 22, 2024 18:01

tsachiherman requested review from marun and StephenButtolph as code owners August 22, 2024 18:01

marun reviewed Aug 22, 2024

View reviewed changes

ids/node_id.go Show resolved Hide resolved

tsachiherman added 3 commits August 22, 2024 15:09

Merge branch 'master' into tsachi/acp20-nodeid

fb4f52e

Merge branch 'master' into tsachi/acp20-nodeid

d4d2610

fix merge errors

108bd24

tsachiherman requested a review from dhrubabasu August 23, 2024 22:13

tsachiherman added the acp20 label Aug 23, 2024

tsachiherman added 2 commits August 26, 2024 08:59

Merge branch 'master' into tsachi/acp20-nodeid

3d0e519

Merge branch 'master' into tsachi/acp20-nodeid

ced7eec

StephenButtolph reviewed Aug 26, 2024

View reviewed changes

tsachiherman added 3 commits August 27, 2024 16:08

update per CR

ff2dc60

Merge branch 'master' into tsachi/acp20-nodeid

6e5692e

rollback appsender_server changes.

68845b4

tsachiherman added 8 commits August 27, 2024 16:36

fix unit test

111c0fe

fix unit tests

0934976

Merge branch 'master' into tsachi/acp20-nodeid

a952ad1

update per CR

181b8c6

Merge branch 'master' into tsachi/acp20-nodeid

200fc37

fix linter

ae9598a

Merge branch 'master' into tsachi/acp20-nodeid

f1b1a84

fix merge with master

0af70b1

tsachiherman removed the request for review from dhrubabasu September 4, 2024 13:58

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Introduce ShortNodeID #3313

Introduce ShortNodeID #3313

tsachiherman commented Aug 20, 2024 •

edited

Loading

StephenButtolph left a comment

StephenButtolph Aug 26, 2024

tsachiherman Aug 27, 2024

StephenButtolph Aug 26, 2024

tsachiherman Aug 27, 2024

StephenButtolph Aug 26, 2024

tsachiherman Aug 27, 2024

StephenButtolph Aug 26, 2024

tsachiherman Sep 3, 2024

tsachiherman Sep 3, 2024

StephenButtolph Aug 26, 2024

tsachiherman Sep 3, 2024

StephenButtolph Aug 26, 2024

tsachiherman Aug 28, 2024

StephenButtolph Aug 26, 2024

StephenButtolph Aug 26, 2024

tsachiherman Aug 28, 2024

StephenButtolph Aug 26, 2024

StephenButtolph Aug 26, 2024

tsachiherman Aug 28, 2024

	validatorID, err := ids.ToShortNodeID(utils.RandomBytes(ids.NodeIDLen))
	validatorID, err := ids.ToShortNodeID(utils.RandomBytes(ids.ShortNodeIDLen))

Introduce ShortNodeID #3313

Are you sure you want to change the base?

Introduce ShortNodeID #3313

Conversation

tsachiherman commented Aug 20, 2024 • edited Loading

Why this should be merged

How this works

How this was tested

StephenButtolph left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tsachiherman commented Aug 20, 2024 •

edited

Loading