ScriptPubKey human-readable ser/deser (for json) #232
Merged
Conversation
This file contains 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
consensus/core/src/tx.rs
Outdated
| let mut hex = [0u8; SCRIPT_VECTOR_SIZE * 2 + 4]; | ||
| faster_hex::hex_encode(&self.version.to_be_bytes(), &mut hex).expect("Unable to serialize ScriptPubKey version"); | ||
| faster_hex::hex_encode(&self.script, &mut hex[4..]).expect("Unable to serialize ScriptPubKey script"); | ||
| serializer.serialize_str(str::from_utf8(&hex).expect("hex is must be a valid UTF-8")) |
There was a problem hiding this comment.
It's safe to use unsafe from_utf8_unchecked, because hex encoding will never produce non-utf8.
consensus/core/src/tx.rs
Outdated
Comment on lines
58
to
60
| faster_hex::hex_encode(&self.version.to_be_bytes(), &mut hex).expect("Unable to serialize ScriptPubKey version"); | ||
| faster_hex::hex_encode(&self.script, &mut hex[4..]).expect("Unable to serialize ScriptPubKey script"); | ||
| serializer.serialize_str(str::from_utf8(&hex).expect("hex is must be a valid UTF-8")) |
There was a problem hiding this comment.
.expect -> .map_err(serde::de::Error::custom)
| faster_hex::hex_encode(&self.script, &mut hex[4..]).expect("Unable to serialize ScriptPubKey script"); | ||
| serializer.serialize_str(str::from_utf8(&hex).expect("hex is must be a valid UTF-8")) | ||
| } else { | ||
| ScriptPublicKeyInternal { version: self.version, script: &self.script }.serialize(serializer) |
There was a problem hiding this comment.
let mut state = serializer.serialize_struct("ScriptPublicKey", 2)?;
state.serialize_field("version", &self.version)?;
state.serialize_field("script", self.script.as_ref())?;
state.end()
it can be done without ScriptPublicKeyInternal, but I dont think it's a big deal
There was a problem hiding this comment.
let's keep it as-is
consensus/core/src/tx.rs
Outdated
| version: ScriptPublicKeyVersion, | ||
| script: &'a [u8], | ||
| if deserializer.is_human_readable() { | ||
| let s = <std::string::String as Deserialize>::deserialize(deserializer)?; |
There was a problem hiding this comment.
Suggested change
| let s = <std::string::String as Deserialize>::deserialize(deserializer)?; | |
| let s = <&str as Deserialize>::deserialize(deserializer)?; |
It needs to be tested, I think it can prevent String allocation
consensus/core/src/tx.rs
Outdated
Comment on lines
44
to
46
| #[derive(Default, Debug, PartialEq, Eq, Serialize, Deserialize, Clone, Hash)] | ||
| #[serde(rename_all = "camelCase")] | ||
| struct ScriptPublicKeyInternal<'a> { |
There was a problem hiding this comment.
Suggested change
| #[derive(Default, Debug, PartialEq, Eq, Serialize, Deserialize, Clone, Hash)] | |
| #[serde(rename_all = "camelCase")] | |
| struct ScriptPublicKeyInternal<'a> { | |
| #[derive(Default, Debug, PartialEq, Eq, Serialize, Deserialize, Clone, Hash)] | |
| #[serde(rename_all = "camelCase")] | |
| #[serde(rename = "ScriptPublicKey")] | |
| struct ScriptPublicKeyInternal<'a> { |
Could you add this renaming? It was my fault. I think without renaming it, xml and other structure-name sensitive formats can work incorrectly
michaelsutton
approved these changes
Jul 28, 2023
smartgoo
pushed a commit
to smartgoo/rusty-kaspa
that referenced
this pull request
Jun 18, 2024
* ScriptPubKey human-readable ser/deser (for json) * switch to from_utf8_unchecked() + serde rename ScriptPublicKey * replace serializer use of expect() with map_err(Error::custom) * fix incorrect usage of script length and handling of larger scripts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR implements ScriptPubKey serialization/deserialization for JSON.