-
Notifications
You must be signed in to change notification settings - Fork 168
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
Extract account-decoder-client-types #2872
base: master
Are you sure you want to change the base?
Changes from all commits
96f45f1
6f9354a
6e1e160
55003de
7e18cb2
9cb8d1c
f3fbf92
e4eb481
47e0066
4ce4e3b
3ce4508
5bc2af4
c12fb05
78caaf5
6f9a408
a6fc160
d059ead
3628c03
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
[package] | ||
name = "solana-account-decoder-client-types" | ||
description = "Core RPC client types for solana-account-decoder" | ||
documentation = "https://docs.rs/solana-account-decoder-client-types" | ||
version = { workspace = true } | ||
authors = { workspace = true } | ||
repository = { workspace = true } | ||
homepage = { workspace = true } | ||
license = { workspace = true } | ||
edition = { workspace = true } | ||
|
||
[dependencies] | ||
base64 = { workspace = true } | ||
bs58 = { workspace = true } | ||
serde = { workspace = true } | ||
serde_derive = { workspace = true } | ||
serde_json = { workspace = true } | ||
solana-account = { workspace = true } | ||
solana-pubkey = { workspace = true } | ||
zstd = { workspace = true, optional = true } | ||
|
||
[features] | ||
zstd = ["dep:zstd"] | ||
|
||
[package.metadata.docs.rs] | ||
targets = ["x86_64-unknown-linux-gnu"] | ||
all-features = true | ||
rustdoc-args = ["--cfg=docsrs"] | ||
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,99 @@ | ||
//! Core RPC client types for solana-account-decoder | ||
#![cfg_attr(docsrs, feature(doc_auto_cfg))] | ||
#[cfg(feature = "zstd")] | ||
use std::io::Read; | ||
use { | ||
base64::{prelude::BASE64_STANDARD, Engine}, | ||
core::str::FromStr, | ||
serde_derive::{Deserialize, Serialize}, | ||
serde_json::Value, | ||
solana_account::WritableAccount, | ||
solana_pubkey::Pubkey, | ||
}; | ||
pub mod token; | ||
|
||
/// A duplicate representation of an Account for pretty JSON serialization | ||
#[derive(Serialize, Deserialize, Clone, Debug, PartialEq, Eq)] | ||
#[serde(rename_all = "camelCase")] | ||
pub struct UiAccount { | ||
pub lamports: u64, | ||
pub data: UiAccountData, | ||
pub owner: String, | ||
pub executable: bool, | ||
pub rent_epoch: u64, | ||
pub space: Option<u64>, | ||
} | ||
|
||
#[derive(Clone, Debug, PartialEq, Eq, Serialize, Deserialize)] | ||
#[serde(rename_all = "camelCase", untagged)] | ||
pub enum UiAccountData { | ||
LegacyBinary(String), // Legacy. Retained for RPC backwards compatibility | ||
Json(ParsedAccount), | ||
Binary(String, UiAccountEncoding), | ||
} | ||
|
||
impl UiAccountData { | ||
/// Returns decoded account data in binary format if possible | ||
pub fn decode(&self) -> Option<Vec<u8>> { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Why not also make this one a free function, like its There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. oh because rpc-client still needs the |
||
match self { | ||
UiAccountData::Json(_) => None, | ||
UiAccountData::LegacyBinary(blob) => bs58::decode(blob).into_vec().ok(), | ||
UiAccountData::Binary(blob, encoding) => match encoding { | ||
UiAccountEncoding::Base58 => bs58::decode(blob).into_vec().ok(), | ||
UiAccountEncoding::Base64 => BASE64_STANDARD.decode(blob).ok(), | ||
#[cfg(feature = "zstd")] | ||
UiAccountEncoding::Base64Zstd => { | ||
BASE64_STANDARD.decode(blob).ok().and_then(|zstd_data| { | ||
let mut data = vec![]; | ||
zstd::stream::read::Decoder::new(zstd_data.as_slice()) | ||
.and_then(|mut reader| reader.read_to_end(&mut data)) | ||
.map(|_| data) | ||
.ok() | ||
}) | ||
} | ||
#[cfg(not(feature = "zstd"))] | ||
UiAccountEncoding::Base64Zstd => None, | ||
UiAccountEncoding::Binary | UiAccountEncoding::JsonParsed => None, | ||
}, | ||
} | ||
} | ||
} | ||
|
||
#[derive(Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq, Hash)] | ||
#[serde(rename_all = "camelCase")] | ||
pub enum UiAccountEncoding { | ||
Binary, // Legacy. Retained for RPC backwards compatibility | ||
Base58, | ||
Base64, | ||
JsonParsed, | ||
#[serde(rename = "base64+zstd")] | ||
Base64Zstd, | ||
} | ||
|
||
impl UiAccount { | ||
pub fn decode<T: WritableAccount>(&self) -> Option<T> { | ||
let data = self.data.decode()?; | ||
Some(T::create( | ||
self.lamports, | ||
data, | ||
Pubkey::from_str(&self.owner).ok()?, | ||
self.executable, | ||
self.rent_epoch, | ||
)) | ||
} | ||
} | ||
|
||
#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)] | ||
#[serde(rename_all = "camelCase")] | ||
pub struct ParsedAccount { | ||
pub program: String, | ||
pub parsed: Value, | ||
pub space: u64, | ||
} | ||
|
||
#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)] | ||
#[serde(rename_all = "camelCase")] | ||
pub struct UiDataSliceConfig { | ||
pub offset: usize, | ||
pub length: usize, | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Are these extra keys necessary here? I don't see them used anywhere else in the monorepo.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
they were added to the monorepo the other day: #3121
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I just checked and it doesn't make a difference here. But may as well leave it in imo in case someone comes along later and does something that would benefit from it