use { crate::{ parse_account_data::{ParsableAccount, ParseAccountError}, parse_token_extension::{parse_extension, UiExtension}, StringAmount, StringDecimals, }, solana_sdk::pubkey::Pubkey, spl_token_2022::{ extension::StateWithExtensions, generic_token_account::GenericTokenAccount, solana_program::{ program_option::COption, program_pack::Pack, pubkey::Pubkey as SplTokenPubkey, }, state::{Account, AccountState, Mint, Multisig}, }, std::str::FromStr, }; // A helper function to convert spl_token::id() as spl_sdk::pubkey::Pubkey to // solana_sdk::pubkey::Pubkey pub(crate) fn spl_token_id() -> Pubkey { Pubkey::new_from_array(spl_token::id().to_bytes()) } // A helper function to convert spl_token_2022::id() as spl_sdk::pubkey::Pubkey to // solana_sdk::pubkey::Pubkey pub(crate) fn spl_token_2022_id() -> Pubkey { Pubkey::new_from_array(spl_token_2022::id().to_bytes()) } // Returns all known SPL Token program ids pub fn spl_token_ids() -> Vec { vec![spl_token_id(), spl_token_2022_id()] } // Check if the provided program id as a known SPL Token program id pub fn is_known_spl_token_id(program_id: &Pubkey) -> bool { *program_id == spl_token_id() || *program_id == spl_token_2022_id() } // A helper function to convert spl_token::native_mint::id() as spl_sdk::pubkey::Pubkey to // solana_sdk::pubkey::Pubkey pub fn spl_token_native_mint() -> Pubkey { Pubkey::new_from_array(spl_token::native_mint::id().to_bytes()) } // The program id of the `spl_token_native_mint` account pub fn spl_token_native_mint_program_id() -> Pubkey { spl_token_id() } // A helper function to convert a solana_sdk::pubkey::Pubkey to spl_sdk::pubkey::Pubkey pub fn spl_token_pubkey(pubkey: &Pubkey) -> SplTokenPubkey { SplTokenPubkey::new_from_array(pubkey.to_bytes()) } // A helper function to convert a spl_sdk::pubkey::Pubkey to solana_sdk::pubkey::Pubkey pub fn pubkey_from_spl_token(pubkey: &SplTokenPubkey) -> Pubkey { Pubkey::new_from_array(pubkey.to_bytes()) } pub fn parse_token( data: &[u8], mint_decimals: Option, ) -> Result { if let Ok(account) = StateWithExtensions::::unpack(data) { let decimals = mint_decimals.ok_or_else(|| { ParseAccountError::AdditionalDataMissing( "no mint_decimals provided to parse spl-token account".to_string(), ) })?; let extension_types = account.get_extension_types().unwrap_or_default(); let ui_extensions = extension_types .iter() .map(|extension_type| parse_extension::(extension_type, &account)) .collect(); return Ok(TokenAccountType::Account(UiTokenAccount { mint: account.base.mint.to_string(), owner: account.base.owner.to_string(), token_amount: token_amount_to_ui_amount(account.base.amount, decimals), delegate: match account.base.delegate { COption::Some(pubkey) => Some(pubkey.to_string()), COption::None => None, }, state: account.base.state.into(), is_native: account.base.is_native(), rent_exempt_reserve: match account.base.is_native { COption::Some(reserve) => Some(token_amount_to_ui_amount(reserve, decimals)), COption::None => None, }, delegated_amount: if account.base.delegate.is_none() { None } else { Some(token_amount_to_ui_amount( account.base.delegated_amount, decimals, )) }, close_authority: match account.base.close_authority { COption::Some(pubkey) => Some(pubkey.to_string()), COption::None => None, }, extensions: ui_extensions, })); } if let Ok(mint) = StateWithExtensions::::unpack(data) { let extension_types = mint.get_extension_types().unwrap_or_default(); let ui_extensions = extension_types .iter() .map(|extension_type| parse_extension::(extension_type, &mint)) .collect(); return Ok(TokenAccountType::Mint(UiMint { mint_authority: match mint.base.mint_authority { COption::Some(pubkey) => Some(pubkey.to_string()), COption::None => None, }, supply: mint.base.supply.to_string(), decimals: mint.base.decimals, is_initialized: mint.base.is_initialized, freeze_authority: match mint.base.freeze_authority { COption::Some(pubkey) => Some(pubkey.to_string()), COption::None => None, }, extensions: ui_extensions, })); } if data.len() == Multisig::get_packed_len() { let multisig = Multisig::unpack(data) .map_err(|_| ParseAccountError::AccountNotParsable(ParsableAccount::SplToken))?; Ok(TokenAccountType::Multisig(UiMultisig { num_required_signers: multisig.m, num_valid_signers: multisig.n, is_initialized: multisig.is_initialized, signers: multisig .signers .iter() .filter_map(|pubkey| { if pubkey != &SplTokenPubkey::default() { Some(pubkey.to_string()) } else { None } }) .collect(), })) } else { Err(ParseAccountError::AccountNotParsable( ParsableAccount::SplToken, )) } } #[derive(Debug, Serialize, Deserialize, PartialEq)] #[serde(rename_all = "camelCase", tag = "type", content = "info")] #[allow(clippy::large_enum_variant)] pub enum TokenAccountType { Account(UiTokenAccount), Mint(UiMint), Multisig(UiMultisig), } #[derive(Debug, Serialize, Deserialize, PartialEq)] #[serde(rename_all = "camelCase")] pub struct UiTokenAccount { pub mint: String, pub owner: String, pub token_amount: UiTokenAmount, #[serde(skip_serializing_if = "Option::is_none")] pub delegate: Option, pub state: UiAccountState, pub is_native: bool, #[serde(skip_serializing_if = "Option::is_none")] pub rent_exempt_reserve: Option, #[serde(skip_serializing_if = "Option::is_none")] pub delegated_amount: Option, #[serde(skip_serializing_if = "Option::is_none")] pub close_authority: Option, #[serde(skip_serializing_if = "Vec::is_empty", default)] pub extensions: Vec, } #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] #[serde(rename_all = "camelCase")] pub enum UiAccountState { Uninitialized, Initialized, Frozen, } impl From for UiAccountState { fn from(state: AccountState) -> Self { match state { AccountState::Uninitialized => UiAccountState::Uninitialized, AccountState::Initialized => UiAccountState::Initialized, AccountState::Frozen => UiAccountState::Frozen, } } } pub fn real_number_string(amount: u64, decimals: u8) -> StringDecimals { let decimals = decimals as usize; if decimals > 0 { // Left-pad zeros to decimals + 1, so we at least have an integer zero let mut s = format!("{:01$}", amount, decimals + 1); // Add the decimal point (Sorry, "," locales!) s.insert(s.len() - decimals, '.'); s } else { amount.to_string() } } pub fn real_number_string_trimmed(amount: u64, decimals: u8) -> StringDecimals { let mut s = real_number_string(amount, decimals); if decimals > 0 { let zeros_trimmed = s.trim_end_matches('0'); s = zeros_trimmed.trim_end_matches('.').to_string(); } s } #[derive(Serialize, Deserialize, Clone, Debug, PartialEq)] #[serde(rename_all = "camelCase")] pub struct UiTokenAmount { pub ui_amount: Option, pub decimals: u8, pub amount: StringAmount, pub ui_amount_string: StringDecimals, } impl UiTokenAmount { pub fn real_number_string(&self) -> String { real_number_string( u64::from_str(&self.amount).unwrap_or_default(), self.decimals as u8, ) } pub fn real_number_string_trimmed(&self) -> String { if !self.ui_amount_string.is_empty() { self.ui_amount_string.clone() } else { real_number_string_trimmed( u64::from_str(&self.amount).unwrap_or_default(), self.decimals as u8, ) } } } pub fn token_amount_to_ui_amount(amount: u64, decimals: u8) -> UiTokenAmount { let amount_decimals = 10_usize .checked_pow(decimals as u32) .map(|dividend| amount as f64 / dividend as f64); UiTokenAmount { ui_amount: amount_decimals, decimals, amount: amount.to_string(), ui_amount_string: real_number_string_trimmed(amount, decimals), } } #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] #[serde(rename_all = "camelCase")] pub struct UiMint { pub mint_authority: Option, pub supply: StringAmount, pub decimals: u8, pub is_initialized: bool, pub freeze_authority: Option, #[serde(skip_serializing_if = "Vec::is_empty", default)] pub extensions: Vec, } #[derive(Debug, Serialize, Deserialize, PartialEq, Eq)] #[serde(rename_all = "camelCase")] pub struct UiMultisig { pub num_required_signers: u8, pub num_valid_signers: u8, pub is_initialized: bool, pub signers: Vec, } pub fn get_token_account_mint(data: &[u8]) -> Option { if Account::valid_account_data(data) { Some(Pubkey::new(&data[0..32])) } else { None } } #[cfg(test)] mod test { use { super::*, crate::parse_token_extension::{UiMemoTransfer, UiMintCloseAuthority}, spl_token_2022::{ extension::{ immutable_owner::ImmutableOwner, memo_transfer::MemoTransfer, mint_close_authority::MintCloseAuthority, ExtensionType, StateWithExtensionsMut, }, pod::OptionalNonZeroPubkey, }, }; #[test] fn test_parse_token() { let mint_pubkey = SplTokenPubkey::new(&[2; 32]); let owner_pubkey = SplTokenPubkey::new(&[3; 32]); let mut account_data = vec![0; Account::get_packed_len()]; let mut account = Account::unpack_unchecked(&account_data).unwrap(); account.mint = mint_pubkey; account.owner = owner_pubkey; account.amount = 42; account.state = AccountState::Initialized; account.is_native = COption::None; account.close_authority = COption::Some(owner_pubkey); Account::pack(account, &mut account_data).unwrap(); assert!(parse_token(&account_data, None).is_err()); assert_eq!( parse_token(&account_data, Some(2)).unwrap(), TokenAccountType::Account(UiTokenAccount { mint: mint_pubkey.to_string(), owner: owner_pubkey.to_string(), token_amount: UiTokenAmount { ui_amount: Some(0.42), decimals: 2, amount: "42".to_string(), ui_amount_string: "0.42".to_string() }, delegate: None, state: UiAccountState::Initialized, is_native: false, rent_exempt_reserve: None, delegated_amount: None, close_authority: Some(owner_pubkey.to_string()), extensions: vec![], }), ); let mut mint_data = vec![0; Mint::get_packed_len()]; let mut mint = Mint::unpack_unchecked(&mint_data).unwrap(); mint.mint_authority = COption::Some(owner_pubkey); mint.supply = 42; mint.decimals = 3; mint.is_initialized = true; mint.freeze_authority = COption::Some(owner_pubkey); Mint::pack(mint, &mut mint_data).unwrap(); assert_eq!( parse_token(&mint_data, None).unwrap(), TokenAccountType::Mint(UiMint { mint_authority: Some(owner_pubkey.to_string()), supply: 42.to_string(), decimals: 3, is_initialized: true, freeze_authority: Some(owner_pubkey.to_string()), extensions: vec![], }), ); let signer1 = SplTokenPubkey::new(&[1; 32]); let signer2 = SplTokenPubkey::new(&[2; 32]); let signer3 = SplTokenPubkey::new(&[3; 32]); let mut multisig_data = vec![0; Multisig::get_packed_len()]; let mut signers = [SplTokenPubkey::default(); 11]; signers[0] = signer1; signers[1] = signer2; signers[2] = signer3; let mut multisig = Multisig::unpack_unchecked(&multisig_data).unwrap(); multisig.m = 2; multisig.n = 3; multisig.is_initialized = true; multisig.signers = signers; Multisig::pack(multisig, &mut multisig_data).unwrap(); assert_eq!( parse_token(&multisig_data, None).unwrap(), TokenAccountType::Multisig(UiMultisig { num_required_signers: 2, num_valid_signers: 3, is_initialized: true, signers: vec![ signer1.to_string(), signer2.to_string(), signer3.to_string() ], }), ); let bad_data = vec![0; 4]; assert!(parse_token(&bad_data, None).is_err()); } #[test] fn test_get_token_account_mint() { let mint_pubkey = SplTokenPubkey::new(&[2; 32]); let mut account_data = vec![0; Account::get_packed_len()]; let mut account = Account::unpack_unchecked(&account_data).unwrap(); account.mint = mint_pubkey; account.state = AccountState::Initialized; Account::pack(account, &mut account_data).unwrap(); let expected_mint_pubkey = Pubkey::new(&[2; 32]); assert_eq!( get_token_account_mint(&account_data), Some(expected_mint_pubkey) ); } #[test] fn test_ui_token_amount_real_string() { assert_eq!(&real_number_string(1, 0), "1"); assert_eq!(&real_number_string_trimmed(1, 0), "1"); let token_amount = token_amount_to_ui_amount(1, 0); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(1, 0) ); assert_eq!(token_amount.ui_amount, Some(1.0)); assert_eq!(&real_number_string(10, 0), "10"); assert_eq!(&real_number_string_trimmed(10, 0), "10"); let token_amount = token_amount_to_ui_amount(10, 0); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(10, 0) ); assert_eq!(token_amount.ui_amount, Some(10.0)); assert_eq!(&real_number_string(1, 9), "0.000000001"); assert_eq!(&real_number_string_trimmed(1, 9), "0.000000001"); let token_amount = token_amount_to_ui_amount(1, 9); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(1, 9) ); assert_eq!(token_amount.ui_amount, Some(0.000000001)); assert_eq!(&real_number_string(1_000_000_000, 9), "1.000000000"); assert_eq!(&real_number_string_trimmed(1_000_000_000, 9), "1"); let token_amount = token_amount_to_ui_amount(1_000_000_000, 9); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(1_000_000_000, 9) ); assert_eq!(token_amount.ui_amount, Some(1.0)); assert_eq!(&real_number_string(1_234_567_890, 3), "1234567.890"); assert_eq!(&real_number_string_trimmed(1_234_567_890, 3), "1234567.89"); let token_amount = token_amount_to_ui_amount(1_234_567_890, 3); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(1_234_567_890, 3) ); assert_eq!(token_amount.ui_amount, Some(1234567.89)); assert_eq!( &real_number_string(1_234_567_890, 25), "0.0000000000000001234567890" ); assert_eq!( &real_number_string_trimmed(1_234_567_890, 25), "0.000000000000000123456789" ); let token_amount = token_amount_to_ui_amount(1_234_567_890, 20); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(1_234_567_890, 20) ); assert_eq!(token_amount.ui_amount, None); } #[test] fn test_ui_token_amount_real_string_zero() { assert_eq!(&real_number_string(0, 0), "0"); assert_eq!(&real_number_string_trimmed(0, 0), "0"); let token_amount = token_amount_to_ui_amount(0, 0); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(0, 0) ); assert_eq!(token_amount.ui_amount, Some(0.0)); assert_eq!(&real_number_string(0, 9), "0.000000000"); assert_eq!(&real_number_string_trimmed(0, 9), "0"); let token_amount = token_amount_to_ui_amount(0, 9); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(0, 9) ); assert_eq!(token_amount.ui_amount, Some(0.0)); assert_eq!(&real_number_string(0, 25), "0.0000000000000000000000000"); assert_eq!(&real_number_string_trimmed(0, 25), "0"); let token_amount = token_amount_to_ui_amount(0, 20); assert_eq!( token_amount.ui_amount_string, real_number_string_trimmed(0, 20) ); assert_eq!(token_amount.ui_amount, None); } #[test] fn test_parse_token_account_with_extensions() { let mint_pubkey = SplTokenPubkey::new(&[2; 32]); let owner_pubkey = SplTokenPubkey::new(&[3; 32]); let account_base = Account { mint: mint_pubkey, owner: owner_pubkey, amount: 42, state: AccountState::Initialized, is_native: COption::None, close_authority: COption::Some(owner_pubkey), delegate: COption::None, delegated_amount: 0, }; let account_size = ExtensionType::get_account_len::(&[ ExtensionType::ImmutableOwner, ExtensionType::MemoTransfer, ]); let mut account_data = vec![0; account_size]; let mut account_state = StateWithExtensionsMut::::unpack_uninitialized(&mut account_data).unwrap(); account_state.base = account_base; account_state.pack_base(); account_state.init_account_type().unwrap(); assert!(parse_token(&account_data, None).is_err()); assert_eq!( parse_token(&account_data, Some(2)).unwrap(), TokenAccountType::Account(UiTokenAccount { mint: mint_pubkey.to_string(), owner: owner_pubkey.to_string(), token_amount: UiTokenAmount { ui_amount: Some(0.42), decimals: 2, amount: "42".to_string(), ui_amount_string: "0.42".to_string() }, delegate: None, state: UiAccountState::Initialized, is_native: false, rent_exempt_reserve: None, delegated_amount: None, close_authority: Some(owner_pubkey.to_string()), extensions: vec![], }), ); let mut account_data = vec![0; account_size]; let mut account_state = StateWithExtensionsMut::::unpack_uninitialized(&mut account_data).unwrap(); account_state.base = account_base; account_state.pack_base(); account_state.init_account_type().unwrap(); account_state.init_extension::().unwrap(); let mut memo_transfer = account_state.init_extension::().unwrap(); memo_transfer.require_incoming_transfer_memos = true.into(); assert!(parse_token(&account_data, None).is_err()); assert_eq!( parse_token(&account_data, Some(2)).unwrap(), TokenAccountType::Account(UiTokenAccount { mint: mint_pubkey.to_string(), owner: owner_pubkey.to_string(), token_amount: UiTokenAmount { ui_amount: Some(0.42), decimals: 2, amount: "42".to_string(), ui_amount_string: "0.42".to_string() }, delegate: None, state: UiAccountState::Initialized, is_native: false, rent_exempt_reserve: None, delegated_amount: None, close_authority: Some(owner_pubkey.to_string()), extensions: vec![ UiExtension::ImmutableOwner, UiExtension::MemoTransfer(UiMemoTransfer { require_incoming_transfer_memos: true, }), ], }), ); } #[test] fn test_parse_token_mint_with_extensions() { let owner_pubkey = SplTokenPubkey::new(&[3; 32]); let mint_size = ExtensionType::get_account_len::(&[ExtensionType::MintCloseAuthority]); let mint_base = Mint { mint_authority: COption::Some(owner_pubkey), supply: 42, decimals: 3, is_initialized: true, freeze_authority: COption::Some(owner_pubkey), }; let mut mint_data = vec![0; mint_size]; let mut mint_state = StateWithExtensionsMut::::unpack_uninitialized(&mut mint_data).unwrap(); mint_state.base = mint_base; mint_state.pack_base(); mint_state.init_account_type().unwrap(); assert_eq!( parse_token(&mint_data, None).unwrap(), TokenAccountType::Mint(UiMint { mint_authority: Some(owner_pubkey.to_string()), supply: 42.to_string(), decimals: 3, is_initialized: true, freeze_authority: Some(owner_pubkey.to_string()), extensions: vec![], }), ); let mut mint_data = vec![0; mint_size]; let mut mint_state = StateWithExtensionsMut::::unpack_uninitialized(&mut mint_data).unwrap(); let mut mint_close_authority = mint_state.init_extension::().unwrap(); mint_close_authority.close_authority = OptionalNonZeroPubkey::try_from(Some(owner_pubkey)).unwrap(); mint_state.base = mint_base; mint_state.pack_base(); mint_state.init_account_type().unwrap(); assert_eq!( parse_token(&mint_data, None).unwrap(), TokenAccountType::Mint(UiMint { mint_authority: Some(owner_pubkey.to_string()), supply: 42.to_string(), decimals: 3, is_initialized: true, freeze_authority: Some(owner_pubkey.to_string()), extensions: vec![UiExtension::MintCloseAuthority(UiMintCloseAuthority { close_authority: Some(owner_pubkey.to_string()), })], }), ); } }