Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support Prysm and Ethdo Keystores (Fixes #4107) #4149

Merged
merged 1 commit into from Sep 19, 2022
Merged

Support Prysm and Ethdo Keystores (Fixes #4107) #4149

merged 1 commit into from Sep 19, 2022

Conversation

zah
Copy link
Member

@zah zah commented Sep 19, 2022

No description provided.

writer.writeField("version", JsonString(
Base10.toString(uint64(value.version))))
writer.endRecord()
error: "keystores must be converted to json with Json.encode(keystore). " &
Copy link
Member

@arnetheduck arnetheduck Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we use the "default" json serialization for logging - we should use a dedicated standard serializer for the keystore standard, which may or may not match our logging json serializer

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ie the correct way to do this is to introduce a KeystoreJson that implements the keystore standard, whatever that may be - we cannot keep on using Json, this prevents migrating nim-json-rpc to json-ser for example

Copy link
Member Author

@zah zah Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

While this would be a theoretical improvement, the current state of affairs is that Json.encode(keystore) is a correct implementation of the standard, while the removed functions here were not.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

well, architecturally, this PR is a regression because it moves further away from dedicated serializers - we could do the right thing here and introduce the KeystoreJson already - otherwise, it deserves documenting at least, because it's a fragile setup causing easily preventable bugs

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

in particular, the outright recommendation to use Json.encode is simply poor advice - it's one hack/workaround replacing another

Copy link
Member Author

@zah zah Sep 19, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In case that's not clear, we have been using Json.decode for keystores all along. The encoding/decoding routines were defined before the support for flavours were added to the JSON library and they are tested in the test_keystore.nim module. This PR is certainly not a regression as it removes an unnecessary duplicated definition that should not have been created at all. It also addresses a very specific issue, encountered by our end users.

I don't disagree regarding introducing KeystoreJson, but this can happen in another PR.

@github-actions
Copy link

Unit Test Results

       9 files  +       6     660 suites  +440   20m 32s ⏱️ + 14m 20s
1 982 tests +   148  1 835 ✔️ +     20  147 💤 +128  0 ±0 
8 060 runs  +5 372  7 889 ✔️ +5 220  171 💤 +152  0 ±0 

Results for commit 1749e98. ± Comparison against base commit 23007ea.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants