[group key addrs 3/5]: misc refactor #1611
Merged
Conversation
This file contains hidden or 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
Pull Request Test Coverage Report for Build 15844222703Details
💛 - Coveralls |
ffranr
approved these changes
Jun 20, 2025
fn/memory.go
Outdated
Comment on lines
98
to
117
| // Serializer is an interface that defines a method to serialize data | ||
| // into an io.Writer. | ||
| type Serializer interface { | ||
| Serialize(w io.Writer) error | ||
| } | ||
|
|
||
| // Serialize encodes the given Serializer into a byte slice. | ||
| func Serialize(s Serializer) ([]byte, error) { | ||
| if s == nil { | ||
| return nil, nil | ||
| } | ||
|
|
||
| var buf bytes.Buffer | ||
| err := s.Serialize(&buf) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| return buf.Bytes(), nil | ||
| } |
There was a problem hiding this comment.
Drop these in favour of the encode style above? I think that having both in a core package like fn just leads to unnecessary confusion. Fundamental packages like fn provide future dev guidance.
Or perhaps there is some fundamental meaning difference between the terms "encode" and "serialize" that I don't know about? If there is please add to doc comments so that I know what one to use.
There was a problem hiding this comment.
Maybe also add a new file called encoding.go to fn to accommodate these changes. From my pov, I don't think they're related to memory.
There was a problem hiding this comment.
I'm not sure what you mean by "in favor of the encoding style above"? These are helper functions to easily convert existing types to bytes. And some types (e.g. wire.MsgTx, psbt.Packet) define a Serialize() method while other types have an Encode() method. And we want to support both.
Moved the definitions to encoding.go.
guggero
force-pushed
the
misc-refactor
branch
2 times, most recently
from
ec4345c to
81fbf58
Compare
guggero
changed the title
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
This commit adds a helper for serializing/encoding structs that otherwise require the use of a buffer. In most situations this makes the code a bit shorter and less repetitive.
We'll need to be able to derive a shared key using ECDH against a wallet key (while supporting remote signing) for the ECIES encryption in part 4 of the on-chain group key address support PR series. We can prepare for that by adding the already exising RPC method to the lnd key ring.
This allows us to use an asset specifier when creating a new address, which means we also have to be able to look up the asset group info using a group key. We can't test this on the RPC layer yet, because we don't actually allow addresses to be created for group keys only (this will com in part 4 of the group key address PR series).
github-project-automation
bot
moved this from 👀 In review
to ✅ Done
in Taproot-Assets Project Board
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.
Extracts some refactor commits out from #1587, which are mostly independent of the functionality in that PR and can be reviewed and merged individually.