Added comment on MarshalJSON to explain the reason of the intermediat…

…e struct
teserakt-io · Aug 13, 2019 · 6c3b34e · 6c3b34e
1 parent 60e19f8
commit 6c3b34e
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/keys/publickey.go b/keys/publickey.go
@@ -239,6 +239,8 @@ func (k *pubKeyMaterial) SetKey(key []byte) error {
 // MarshalJSON  will infer the key type in the marshalled json data
 // to be able to know which key to instantiate when unmarshalling back
 func (k *pubKeyMaterial) MarshalJSON() ([]byte, error) {
+	// we have to use a temporary intermediate struct here as
+	// passing directly k to KeyData would cause an infinite loop of MarshalJSON calls
 	jsonKey := &jsonKey{
 		KeyType: pubKeyMaterialType,
 		KeyData: struct {

diff --git a/keys/symmetric.go b/keys/symmetric.go
@@ -83,6 +83,8 @@ func (k *symKeyMaterial) SetKey(key []byte) error {
 // MarshalJSON  will infer the key type in the marshalled json data
 // to be able to know which key to instantiate when unmarshalling back
 func (k *symKeyMaterial) MarshalJSON() ([]byte, error) {
+	// we have to use a temporary intermediate struct here as
+	// passing directly k to KeyData would cause an infinite loop of MarshalJSON calls
 	jsonKey := &jsonKey{
 		KeyType: symKeyMaterialType,
 		KeyData: struct {