Skip to content

Add remote_pubkey to Packet Meta #436

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.

Sign up for GitHub

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

Merged
merged 6 commits into from
Nov 12, 2025
Merged

Add remote_pubkey to Packet Meta #436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5b791f8
Add remote_pubkey to Packet Meta
lijunwangs Nov 6, 2025
3517360
add serde feature for packet
lijunwangs Nov 6, 2025
d7b5e94
store Pubkey without Option to save some space
lijunwangs Nov 8, 2025
a7864d3
check issue on test
lijunwangs Nov 8, 2025
e10cb05
address a few comments from Jon
lijunwangs Nov 11, 2025
7eb366e
Cargo.toml sort
lijunwangs Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 3 additions & 0 deletions packet/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ serde = [
"dep:serde",
"dep:serde_derive",
"dep:serde_with",
"solana-pubkey/serde",
]
frozen-abi = ["dep:solana-frozen-abi", "dep:solana-frozen-abi-macro"]

Expand All @@ -35,9 +36,11 @@ serde_derive = { workspace = true, optional = true }
serde_with = { workspace = true, optional = true, features = ["macros"] }
solana-frozen-abi = { workspace = true, optional = true, features = ["frozen-abi"] }
solana-frozen-abi-macro = { workspace = true, optional = true, features = ["frozen-abi"] }
solana-pubkey = { workspace = true }

[dev-dependencies]
solana-packet = { path = ".", features = ["dev-context-only-utils"] }
solana-pubkey = { workspace = true, features = ["std"] }
static_assertions = { workspace = true }

[lints]
Expand Down
30 changes: 30 additions & 0 deletions packet/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ use {
};
use {
bitflags::bitflags,
solana_pubkey::Pubkey,
std::{
fmt,
net::{IpAddr, Ipv4Addr, SocketAddr},
Expand Down Expand Up @@ -72,6 +73,7 @@ pub struct Meta {
pub addr: IpAddr,
pub port: u16,
pub flags: PacketFlags,
remote_pubkey: Pubkey,
Copy link
Collaborator

@joncinque joncinque Nov 10, 2025

Choose a reason for hiding this comment

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

Flagging that this is technically a breaking change for anyone who builds a Meta without using Default in some way, ie:

let m = Meta { size, addr, port, flags };

It's not a problem, but probably requires a breaking release

Copy link
Contributor Author

@lijunwangs lijunwangs Nov 11, 2025 •
edited
Loading

Choose a reason for hiding this comment

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

I think they can still use struct Meta, by putting the new flag with default
Met {
size,
add,
port,
flags,
..Meta::default()
}

Copy link
Collaborator

@joncinque joncinque Nov 12, 2025

Choose a reason for hiding this comment

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

Correct, but that does still constitute a breaking change since old code will no longer compile.

Copy link
Contributor Author

@lijunwangs lijunwangs Nov 12, 2025

Choose a reason for hiding this comment

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

True, whenever we introduce a field it will break as we lack a constructor.

}

#[cfg(feature = "frozen-abi")]
Expand Down Expand Up @@ -300,6 +302,21 @@ impl Meta {
pub fn is_from_staked_node(&self) -> bool {
self.flags.contains(PacketFlags::FROM_STAKED_NODE)
}

#[inline]
pub fn remote_pubkey(&self) -> Option<Pubkey> {
if self.remote_pubkey == Pubkey::default() {
Copy link
Contributor

@alexpyattaev alexpyattaev Nov 9, 2025

Choose a reason for hiding this comment

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

In such cases it may be preferable to explicitly compare with array of zeros rather than relying on the Default impl staying stable. Unlikely to be a problem for us of course.

None
} else {
Some(self.remote_pubkey)
}
}

/// Sets the remote pubkey. Use Pubkey::default() to clear.
#[inline]
pub fn set_remote_pubkey(&mut self, pubkey: Pubkey) {
self.remote_pubkey = pubkey;
}
}

impl Default for Meta {
Expand All @@ -309,6 +326,7 @@ impl Default for Meta {
addr: IpAddr::V4(Ipv4Addr::UNSPECIFIED),
port: 0,
flags: PacketFlags::empty(),
remote_pubkey: Pubkey::default(),
}
}
}
Expand Down Expand Up @@ -355,4 +373,16 @@ mod tests {
Err("the size limit has been reached".to_string()),
);
}

#[test]
fn test_remote_pubkey() {
let mut meta = Meta::default();
assert!(meta.remote_pubkey().is_none());
let pubkey = Pubkey::new_unique();
meta.set_remote_pubkey(pubkey);
assert_eq!(meta.remote_pubkey(), Some(pubkey));
let pubkey = Pubkey::default();
meta.set_remote_pubkey(pubkey);
assert!(meta.remote_pubkey().is_none());
}
}