Add token account decoding (#11136)

* Add token decoding

* Bump versions

account-decoder/src/lib.rs

@@ -5,6 +5,7 @@ extern crate serde_derive;
 
 pub mod parse_account_data;
 pub mod parse_nonce;
+pub mod parse_token;
 pub mod parse_vote;
 
 use crate::parse_account_data::parse_account_data;

account-decoder/src/parse_account_data.rs

@@ -1,4 +1,4 @@
-use crate::{parse_nonce::parse_nonce, parse_vote::parse_vote};
+use crate::{parse_nonce::parse_nonce, parse_token::parse_token, parse_vote::parse_vote};
 use inflector::Inflector;
 use serde_json::{json, Value};
 use solana_sdk::{instruction::InstructionError, pubkey::Pubkey, system_program};
@@ -8,11 +8,13 @@ use thiserror::Error;
 lazy_static! {
     static ref SYSTEM_PROGRAM_ID: Pubkey =
         Pubkey::from_str(&system_program::id().to_string()).unwrap();
+    static ref TOKEN_PROGRAM_ID: Pubkey = Pubkey::from_str(&spl_token::id().to_string()).unwrap();
     static ref VOTE_PROGRAM_ID: Pubkey =
         Pubkey::from_str(&solana_vote_program::id().to_string()).unwrap();
     pub static ref PARSABLE_PROGRAM_IDS: HashMap<Pubkey, ParsableAccount> = {
         let mut m = HashMap::new();
         m.insert(*SYSTEM_PROGRAM_ID, ParsableAccount::Nonce);
+        m.insert(*TOKEN_PROGRAM_ID, ParsableAccount::Token);
         m.insert(*VOTE_PROGRAM_ID, ParsableAccount::Vote);
         m
     };
@@ -20,6 +22,9 @@ lazy_static! {
 
 #[derive(Error, Debug)]
 pub enum ParseAccountError {
+    #[error("{0:?} account not parsable")]
+    AccountNotParsable(ParsableAccount),
+
     #[error("Program not parsable")]
     ProgramNotParsable,
 
@@ -34,6 +39,7 @@ pub enum ParseAccountError {
 #[serde(rename_all = "camelCase")]
 pub enum ParsableAccount {
     Nonce,
+    Token,
     Vote,
 }
 
@@ -43,6 +49,7 @@ pub fn parse_account_data(program_id: &Pubkey, data: &[u8]) -> Result<Value, Par
         .ok_or_else(|| ParseAccountError::ProgramNotParsable)?;
     let parsed_json = match program_name {
         ParsableAccount::Nonce => serde_json::to_value(parse_nonce(data)?)?,
+        ParsableAccount::Token => serde_json::to_value(parse_token(data)?)?,
         ParsableAccount::Vote => serde_json::to_value(parse_vote(data)?)?,
     };
     Ok(json!({

account-decoder/src/parse_token.rs

@@ -0,0 +1,171 @@
+use crate::parse_account_data::{ParsableAccount, ParseAccountError};
+use spl_sdk::pubkey::Pubkey;
+use spl_token::{
+    option::COption,
+    state::{Account, Mint, Multisig, State},
+};
+use std::mem::size_of;
+
+pub fn parse_token(data: &[u8]) -> Result<TokenAccountType, ParseAccountError> {
+    let mut data = data.to_vec();
+    if data.len() == size_of::<Account>() {
+        let account: Account = *State::unpack(&mut data)
+            .map_err(|_| ParseAccountError::AccountNotParsable(ParsableAccount::Token))?;
+        Ok(TokenAccountType::Account(UiTokenAccount {
+            mint: account.mint.to_string(),
+            owner: account.owner.to_string(),
+            amount: account.amount,
+            delegate: match account.delegate {
+                COption::Some(pubkey) => Some(pubkey.to_string()),
+                COption::None => None,
+            },
+            is_initialized: account.is_initialized,
+            is_native: account.is_native,
+            delegated_amount: account.delegated_amount,
+        }))
+    } else if data.len() == size_of::<Mint>() {
+        let mint: Mint = *State::unpack(&mut data)
+            .map_err(|_| ParseAccountError::AccountNotParsable(ParsableAccount::Token))?;
+        Ok(TokenAccountType::Mint(UiMint {
+            owner: match mint.owner {
+                COption::Some(pubkey) => Some(pubkey.to_string()),
+                COption::None => None,
+            },
+            decimals: mint.decimals,
+            is_initialized: mint.is_initialized,
+        }))
+    } else if data.len() == size_of::<Multisig>() {
+        let multisig: Multisig = *State::unpack(&mut data)
+            .map_err(|_| ParseAccountError::AccountNotParsable(ParsableAccount::Token))?;
+        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 != &Pubkey::default() {
+                        Some(pubkey.to_string())
+                    } else {
+                        None
+                    }
+                })
+                .collect(),
+        }))
+    } else {
+        Err(ParseAccountError::AccountNotParsable(
+            ParsableAccount::Token,
+        ))
+    }
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+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 amount: u64,
+    pub delegate: Option<String>,
+    pub is_initialized: bool,
+    pub is_native: bool,
+    pub delegated_amount: u64,
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+pub struct UiMint {
+    pub owner: Option<String>,
+    pub decimals: u8,
+    pub is_initialized: bool,
+}
+
+#[derive(Debug, Serialize, Deserialize, PartialEq)]
+#[serde(rename_all = "camelCase")]
+pub struct UiMultisig {
+    pub num_required_signers: u8,
+    pub num_valid_signers: u8,
+    pub is_initialized: bool,
+    pub signers: Vec<String>,
+}
+
+#[cfg(test)]
+mod test {
+    use super::*;
+
+    #[test]
+    fn test_parse_token() {
+        let mint_pubkey = Pubkey::new(&[2; 32]);
+        let owner_pubkey = Pubkey::new(&[3; 32]);
+        let mut account_data = [0; size_of::<Account>()];
+        let mut account: &mut Account = State::unpack_unchecked(&mut account_data).unwrap();
+        account.mint = mint_pubkey;
+        account.owner = owner_pubkey;
+        account.amount = 42;
+        account.is_initialized = true;
+        assert_eq!(
+            parse_token(&account_data).unwrap(),
+            TokenAccountType::Account(UiTokenAccount {
+                mint: mint_pubkey.to_string(),
+                owner: owner_pubkey.to_string(),
+                amount: 42,
+                delegate: None,
+                is_initialized: true,
+                is_native: false,
+                delegated_amount: 0,
+            }),
+        );
+
+        let mut mint_data = [0; size_of::<Mint>()];
+        let mut mint: &mut Mint = State::unpack_unchecked(&mut mint_data).unwrap();
+        mint.owner = COption::Some(owner_pubkey);
+        mint.decimals = 3;
+        mint.is_initialized = true;
+        assert_eq!(
+            parse_token(&mint_data).unwrap(),
+            TokenAccountType::Mint(UiMint {
+                owner: Some(owner_pubkey.to_string()),
+                decimals: 3,
+                is_initialized: true,
+            }),
+        );
+
+        let signer1 = Pubkey::new(&[1; 32]);
+        let signer2 = Pubkey::new(&[2; 32]);
+        let signer3 = Pubkey::new(&[3; 32]);
+        let mut multisig_data = [0; size_of::<Multisig>()];
+        let mut multisig: &mut Multisig = State::unpack_unchecked(&mut multisig_data).unwrap();
+        let mut signers = [Pubkey::default(); 11];
+        signers[0] = signer1;
+        signers[1] = signer2;
+        signers[2] = signer3;
+        multisig.m = 2;
+        multisig.n = 3;
+        multisig.is_initialized = true;
+        multisig.signers = signers;
+        assert_eq!(
+            parse_token(&multisig_data).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).is_err());
+    }
+}