From d14395bc5db55331115fa3c1e71741d1de7f092f Mon Sep 17 00:00:00 2001 From: Jon Atack Date: Thu, 23 Sep 2021 17:22:05 +0200 Subject: net, doc: provide context for UnserializeV1Array() --- src/netaddress.h | 6 ++++++ 1 file changed, 6 insertions(+) (limited to 'src/netaddress.h') diff --git a/src/netaddress.h b/src/netaddress.h index eb35ed3fac..d76e4d525a 100644 --- a/src/netaddress.h +++ b/src/netaddress.h @@ -386,6 +386,12 @@ private: /** * Unserialize from a pre-ADDRv2/BIP155 format from an array. + * + * This function is only called from UnserializeV1Stream() and is a wrapper + * for SetLegacyIPv6(); however, we keep it for symmetry with + * SerializeV1Array() to have pairs of ser/unser functions and to make clear + * that if one is altered, a corresponding reverse modification should be + * applied to the other. */ void UnserializeV1Array(uint8_t (&arr)[V1_SERIALIZATION_SIZE]) { -- cgit v1.2.3