Move solana_sdk::pubkey functions to solana-pubkey
#2980
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
kevinheavey
force-pushed
the
move-sdk-pubkey
branch
4 times, most recently
from
2f95a37 to
39c2c85
Compare
kevinheavey
force-pushed
the
move-sdk-pubkey
branch
from
39c2c85 to
0a6762a
Compare
joncinque
reviewed
Oct 15, 2024
sdk/pubkey/src/lib.rs
Outdated
Comment on lines
1123
to
1156
| #[cfg(all(feature = "std", not(target_os = "solana")))] | ||
| pub fn write_pubkey_file( | ||
| outfile: &str, | ||
| pubkey: Pubkey, | ||
| ) -> Result<(), std::boxed::Box<dyn std::error::Error>> { | ||
| use std::io::Write; | ||
| let serialized = std::format!("\"{pubkey}\""); | ||
|
|
||
| if let Some(outdir) = std::path::Path::new(&outfile).parent() { | ||
| std::fs::create_dir_all(outdir)?; | ||
| } | ||
| let mut f = std::fs::File::create(outfile)?; | ||
| f.write_all(&serialized.into_bytes())?; | ||
|
|
||
| Ok(()) | ||
| } | ||
|
|
||
| #[cfg(all(feature = "std", not(target_os = "solana")))] | ||
| pub fn read_pubkey_file(infile: &str) -> Result<Pubkey, std::boxed::Box<dyn std::error::Error>> { | ||
| use std::io::Read; | ||
| let mut f = std::fs::File::open(infile)?; | ||
| let mut buffer = std::string::String::new(); | ||
| f.read_to_string(&mut buffer)?; | ||
| let trimmed = buffer.trim(); | ||
| if !trimmed.starts_with('"') || !trimmed.ends_with('"') { | ||
| return Err(std::io::Error::new( | ||
| std::io::ErrorKind::InvalidData, | ||
| "Input must be a JSON string.", | ||
| ) | ||
| .into()); | ||
| } | ||
| let contents = &trimmed[1..trimmed.len() - 1]; | ||
| Ok(Pubkey::from_str(contents)?) | ||
| } |
There was a problem hiding this comment.
Considering these are only used by solana-keygen, how about copying the implementations into there and deprecating them from sdk rather than moving them down into here?
Comment on lines
+1117
to
+1121
| /// New random Pubkey for tests and benchmarks. | ||
| #[cfg(all(feature = "rand", not(target_os = "solana")))] | ||
| pub fn new_rand() -> Pubkey { | ||
| Pubkey::from(rand::random::<[u8; PUBKEY_BYTES]>()) | ||
| } |
There was a problem hiding this comment.
I'm a bit torn about this one, since we should really favor using Pubkey::new_unique() in almost all cases. On the flipside, there are some legit usecases, and this is the best place to put it, so let's go with it.
…icate in solana-keygen
joncinque
added
the
automerge
ray-kast
pushed a commit
to abklabs/agave
that referenced
this pull request
Nov 27, 2024
* move functions from solana_sdk::pubkey to solana_pubkey
* fix test
* remove serde_json from write_pubkey_file
* remove serde_json
* fix import
* put new_rand behind a separate feature
* lint
* fix imports
* fmt
* deprecate sdk::pubkey::{read_pubkey_file, write_pubkey_file} and duplicate in solana-keygen
* lint
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.
Problem
solana_sdk::pubkeydefines three helper functions. These would be useful to have outside solana-sdk. I can't think of a anywhere else to move them so I put them insolana-pubkeybehind anot(target_os = "solana").Summary of Changes
solana-pubkeyand re-export insolana_sdk::pubkeyfor backwards compatibilityserde_jsonusage in these functions with a simple inline parser