use crate::parse::{
check_num_accounts, ParsableProgram, ParseInstructionError, ParsedInstructionEnum,
};
use serde::{Deserialize, Serialize};
use serde_json::{json, Map, Value};
use solana_account_decoder::parse_token::token_amount_to_ui_amount;
use solana_program::{program_option::COption, pubkey::Pubkey};
use solana_sdk::instruction::CompiledInstruction;
use spl_token::instruction::{AuthorityType, TokenInstruction};
pub fn parse_token(
instruction: &CompiledInstruction,
account_keys: &[Pubkey],
) -> Result<ParsedInstructionEnum, ParseInstructionError> {
let token_instruction = TokenInstruction::unpack(&instruction.data)
.map_err(|_| ParseInstructionError::InstructionNotParsable(ParsableProgram::SPLToken))?;
match instruction.accounts.iter().max() {
Some(index) if (*index as usize) < account_keys.len() => {}
_ => {
return Err(ParseInstructionError::InstructionKeyMismatch(
ParsableProgram::SPLToken,
));
}
}
match token_instruction {
TokenInstruction::InitializeMint {
decimals,
mint_authority,
freeze_authority,
} => {
check_num_token_accounts(&instruction.accounts, 2)?;
let mut value = json!({
"mint": account_keys[instruction.accounts[0] as usize].to_string(),
"decimals": decimals,
"mintAuthority": mint_authority.to_string(),
"rentSysvar": account_keys[instruction.accounts[1] as usize].to_string(),
});
let map = value.as_object_mut().unwrap();
if let COption::Some(freeze_authority) = freeze_authority {
map.insert(
"freezeAuthority".to_string(),
json!(freeze_authority.to_string()),
);
}
Ok(ParsedInstructionEnum {
instruction_type: "initializeMint".to_string(),
info: value,
})
}
TokenInstruction::InitializeAccount => {
check_num_token_accounts(&instruction.accounts, 4)?;
Ok(ParsedInstructionEnum {
instruction_type: "initializeAccount".to_string(),
info: json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"mint": account_keys[instruction.accounts[1] as usize].to_string(),
"owner": account_keys[instruction.accounts[2] as usize].to_string(),
"rentSysvar": account_keys[instruction.accounts[3] as usize].to_string(),
}),
})
}
TokenInstruction::InitializeAccount2 { owner } => {
check_num_token_accounts(&instruction.accounts, 3)?;
Ok(ParsedInstructionEnum {
instruction_type: "initializeAccount2".to_string(),
info: json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"mint": account_keys[instruction.accounts[1] as usize].to_string(),
"owner": owner.to_string(),
"rentSysvar": account_keys[instruction.accounts[2] as usize].to_string(),
}),
})
}
TokenInstruction::InitializeMultisig { m } => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut signers: Vec<String> = vec![];
for i in instruction.accounts[2..].iter() {
signers.push(account_keys[*i as usize].to_string());
}
Ok(ParsedInstructionEnum {
instruction_type: "initializeMultisig".to_string(),
info: json!({
"multisig": account_keys[instruction.accounts[0] as usize].to_string(),
"rentSysvar": account_keys[instruction.accounts[1] as usize].to_string(),
"signers": signers,
"m": m,
}),
})
}
TokenInstruction::Transfer { amount } => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"source": account_keys[instruction.accounts[0] as usize].to_string(),
"destination": account_keys[instruction.accounts[1] as usize].to_string(),
"amount": amount.to_string(),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"authority",
"multisigAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "transfer".to_string(),
info: value,
})
}
TokenInstruction::Approve { amount } => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"source": account_keys[instruction.accounts[0] as usize].to_string(),
"delegate": account_keys[instruction.accounts[1] as usize].to_string(),
"amount": amount.to_string(),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"owner",
"multisigOwner",
);
Ok(ParsedInstructionEnum {
instruction_type: "approve".to_string(),
info: value,
})
}
TokenInstruction::Revoke => {
check_num_token_accounts(&instruction.accounts, 2)?;
let mut value = json!({
"source": account_keys[instruction.accounts[0] as usize].to_string(),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
1,
account_keys,
&instruction.accounts,
"owner",
"multisigOwner",
);
Ok(ParsedInstructionEnum {
instruction_type: "revoke".to_string(),
info: value,
})
}
TokenInstruction::SetAuthority {
authority_type,
new_authority,
} => {
check_num_token_accounts(&instruction.accounts, 2)?;
let owned = match authority_type {
AuthorityType::MintTokens | AuthorityType::FreezeAccount => "mint",
AuthorityType::AccountOwner | AuthorityType::CloseAccount => "account",
};
let mut value = json!({
owned: account_keys[instruction.accounts[0] as usize].to_string(),
"authorityType": Into::<UiAuthorityType>::into(authority_type),
"newAuthority": match new_authority {
COption::Some(authority) => Some(authority.to_string()),
COption::None => None,
},
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
1,
account_keys,
&instruction.accounts,
"authority",
"multisigAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "setAuthority".to_string(),
info: value,
})
}
TokenInstruction::MintTo { amount } => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"mint": account_keys[instruction.accounts[0] as usize].to_string(),
"account": account_keys[instruction.accounts[1] as usize].to_string(),
"amount": amount.to_string(),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"mintAuthority",
"multisigMintAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "mintTo".to_string(),
info: value,
})
}
TokenInstruction::Burn { amount } => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"mint": account_keys[instruction.accounts[1] as usize].to_string(),
"amount": amount.to_string(),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"authority",
"multisigAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "burn".to_string(),
info: value,
})
}
TokenInstruction::CloseAccount => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"destination": account_keys[instruction.accounts[1] as usize].to_string(),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"owner",
"multisigOwner",
);
Ok(ParsedInstructionEnum {
instruction_type: "closeAccount".to_string(),
info: value,
})
}
TokenInstruction::FreezeAccount => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"mint": account_keys[instruction.accounts[1] as usize].to_string(),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"freezeAuthority",
"multisigFreezeAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "freezeAccount".to_string(),
info: value,
})
}
TokenInstruction::ThawAccount => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"mint": account_keys[instruction.accounts[1] as usize].to_string(),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"freezeAuthority",
"multisigFreezeAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "thawAccount".to_string(),
info: value,
})
}
TokenInstruction::TransferChecked { amount, decimals } => {
check_num_token_accounts(&instruction.accounts, 4)?;
let mut value = json!({
"source": account_keys[instruction.accounts[0] as usize].to_string(),
"mint": account_keys[instruction.accounts[1] as usize].to_string(),
"destination": account_keys[instruction.accounts[2] as usize].to_string(),
"tokenAmount": token_amount_to_ui_amount(amount, decimals),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
3,
account_keys,
&instruction.accounts,
"authority",
"multisigAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "transferChecked".to_string(),
info: value,
})
}
TokenInstruction::ApproveChecked { amount, decimals } => {
check_num_token_accounts(&instruction.accounts, 4)?;
let mut value = json!({
"source": account_keys[instruction.accounts[0] as usize].to_string(),
"mint": account_keys[instruction.accounts[1] as usize].to_string(),
"delegate": account_keys[instruction.accounts[2] as usize].to_string(),
"tokenAmount": token_amount_to_ui_amount(amount, decimals),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
3,
account_keys,
&instruction.accounts,
"owner",
"multisigOwner",
);
Ok(ParsedInstructionEnum {
instruction_type: "approveChecked".to_string(),
info: value,
})
}
TokenInstruction::MintToChecked { amount, decimals } => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"mint": account_keys[instruction.accounts[0] as usize].to_string(),
"account": account_keys[instruction.accounts[1] as usize].to_string(),
"tokenAmount": token_amount_to_ui_amount(amount, decimals),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"mintAuthority",
"multisigMintAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "mintToChecked".to_string(),
info: value,
})
}
TokenInstruction::BurnChecked { amount, decimals } => {
check_num_token_accounts(&instruction.accounts, 3)?;
let mut value = json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"mint": account_keys[instruction.accounts[1] as usize].to_string(),
"tokenAmount": token_amount_to_ui_amount(amount, decimals),
});
let map = value.as_object_mut().unwrap();
parse_signers(
map,
2,
account_keys,
&instruction.accounts,
"authority",
"multisigAuthority",
);
Ok(ParsedInstructionEnum {
instruction_type: "burnChecked".to_string(),
info: value,
})
}
TokenInstruction::SyncNative => {
check_num_token_accounts(&instruction.accounts, 1)?;
Ok(ParsedInstructionEnum {
instruction_type: "syncNative".to_string(),
info: json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
}),
})
}
TokenInstruction::InitializeAccount3 { owner } => {
check_num_token_accounts(&instruction.accounts, 2)?;
Ok(ParsedInstructionEnum {
instruction_type: "initializeAccount3".to_string(),
info: json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"mintAccount": account_keys[instruction.accounts[1] as usize].to_string(),
"owner": owner.to_string(),
}),
})
}
TokenInstruction::InitializeMint2 { mint_authority, .. } => {
check_num_token_accounts(&instruction.accounts, 1)?;
Ok(ParsedInstructionEnum {
instruction_type: "initializeMint2".to_string(),
info: json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
"mintAuthority": mint_authority.to_string(),
}),
})
}
TokenInstruction::InitializeMultisig2 { m } => {
check_num_token_accounts(&instruction.accounts, 2)?;
let mut signers: Vec<String> = vec![];
for i in instruction.accounts[1..].iter() {
signers.push(account_keys[*i as usize].to_string());
}
Ok(ParsedInstructionEnum {
instruction_type: "initializeMultisig2".to_string(),
info: json!({
"multisig": account_keys[instruction.accounts[0] as usize].to_string(),
"signers": signers,
"m": m,
}),
})
}
TokenInstruction::GetAccountDataSize => {
check_num_token_accounts(&instruction.accounts, 1)?;
Ok(ParsedInstructionEnum {
instruction_type: "getAccountDataSize".to_string(),
info: json!({
"mint": account_keys[instruction.accounts[0] as usize].to_string(),
}),
})
}
TokenInstruction::InitializeImmutableOwner => {
check_num_token_accounts(&instruction.accounts, 1)?;
Ok(ParsedInstructionEnum {
instruction_type: "initializeImmutableOwner".to_string(),
info: json!({
"account": account_keys[instruction.accounts[0] as usize].to_string(),
}),
})
}
TokenInstruction::AmountToUiAmount { amount } => {
check_num_token_accounts(&instruction.accounts, 1)?;
Ok(ParsedInstructionEnum {
instruction_type: "amountToUiAmount".to_string(),
info: json!({
"amount": amount,
"mint": account_keys[instruction.accounts[0] as usize].to_string(),
}),
})
}
TokenInstruction::UiAmountToAmount { ui_amount } => {
check_num_token_accounts(&instruction.accounts, 1)?;
Ok(ParsedInstructionEnum {
instruction_type: "uiAmountToAmount".to_string(),
info: json!({
"uiAmount": ui_amount,
"mint": account_keys[instruction.accounts[0] as usize].to_string(),
}),
})
}
}
}
#[derive(Debug, Serialize, Deserialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub enum UiAuthorityType {
MintTokens,
FreezeAccount,
AccountOwner,
CloseAccount,
}
impl From<AuthorityType> for UiAuthorityType {
fn from(authority_type: AuthorityType) -> Self {
match authority_type {
AuthorityType::MintTokens => UiAuthorityType::MintTokens,
AuthorityType::FreezeAccount => UiAuthorityType::FreezeAccount,
AuthorityType::AccountOwner => UiAuthorityType::AccountOwner,
AuthorityType::CloseAccount => UiAuthorityType::CloseAccount,
}
}
}
fn parse_signers(
map: &mut Map<String, Value>,
last_nonsigner_index: usize,
account_keys: &[Pubkey],
accounts: &[u8],
owner_field_name: &str,
multisig_field_name: &str,
) {
if accounts.len() > last_nonsigner_index + 1 {
let mut signers: Vec<String> = vec![];
for i in accounts[last_nonsigner_index + 1..].iter() {
signers.push(account_keys[*i as usize].to_string());
}
map.insert(
multisig_field_name.to_string(),
json!(account_keys[accounts[last_nonsigner_index] as usize].to_string()),
);
map.insert("signers".to_string(), json!(signers));
} else {
map.insert(
owner_field_name.to_string(),
json!(account_keys[accounts[last_nonsigner_index] as usize].to_string()),
);
}
}
fn check_num_token_accounts(accounts: &[u8], num: usize) -> Result<(), ParseInstructionError> {
check_num_accounts(accounts, num, ParsableProgram::SPLToken)
}
#[cfg(test)]
mod test {
use super::*;
use solana_sdk::{instruction::CompiledInstruction, pubkey::Pubkey};
use spl_token::{
instruction::*,
solana_program::{
instruction::CompiledInstruction as SplTokenCompiledInstruction,
instruction::Instruction as SplTokenInstruction, message::Message,
pubkey::Pubkey as SplTokenPubkey,
},
};
use std::str::FromStr;
fn convert_pubkey(pubkey: Pubkey) -> SplTokenPubkey {
SplTokenPubkey::from_str(&pubkey.to_string()).unwrap()
}
fn convert_compiled_instruction(
instruction: &SplTokenCompiledInstruction,
) -> CompiledInstruction {
CompiledInstruction {
program_id_index: instruction.program_id_index,
accounts: instruction.accounts.clone(),
data: instruction.data.clone(),
}
}
fn make_coerced_message(
mut instruction: SplTokenInstruction,
program_id: &SplTokenPubkey,
) -> Message {
instruction.program_id = *program_id;
Message::new(&[instruction], None)
}
#[test]
#[allow(clippy::same_item_push)]
fn test_parse_token_v3() {
test_parse_token(&spl_token::id());
}
fn test_parse_token(program_id: &SplTokenPubkey) {
let mint_pubkey = Pubkey::new_unique();
let mint_authority = Pubkey::new_unique();
let freeze_authority = Pubkey::new_unique();
let rent_sysvar = solana_sdk::sysvar::rent::id();
let initialize_mint_ix = initialize_mint(
&spl_token::id(), &convert_pubkey(mint_pubkey),
&convert_pubkey(mint_authority),
Some(&convert_pubkey(freeze_authority)),
2,
)
.unwrap();
let message = make_coerced_message(initialize_mint_ix, program_id);
let compiled_instruction = convert_compiled_instruction(&message.instructions[0]);
assert_eq!(
parse_token(&compiled_instruction, &message.account_keys).unwrap(),
ParsedInstructionEnum {
instruction_type: "initializeMint".to_string(),
info: json!({
"mint": mint_pubkey.to_string(),
"decimals": 2,
"mintAuthority": mint_authority.to_string(),
"freezeAuthority": freeze_authority.to_string(),
"rentSysvar": rent_sysvar.to_string(),
})
}
);
let initialize_mint_ix = initialize_mint(
&spl_token::id(), &convert_pubkey(mint_pubkey),
&convert_pubkey(mint_authority),
None,
2,
)
.unwrap();
let message = make_coerced_message(initialize_mint_ix, program_id);
let compiled_instruction = convert_compiled_instruction(&message.instructions[0]);
assert_eq!(
parse_token(&compiled_instruction, &message.account_keys).unwrap(),
ParsedInstructionEnum {
instruction_type: "initializeMint".to_string(),
info: json!({
"mint": mint_pubkey.to_string(),
"decimals": 2,
"mintAuthority": mint_authority.to_string(),
"rentSysvar": rent_sysvar.to_string(),
})
}
);
let account_pubkey = Pubkey::new_unique();
let owner = Pubkey::new_unique();
let initialize_account_ix = initialize_account(
&spl_token::id(), &convert_pubkey(account_pubkey),
&convert_pubkey(mint_pubkey),
&convert_pubkey(owner),
)
.unwrap();
let message = make_coerced_message(initialize_account_ix, program_id);
let compiled_instruction = convert_compiled_instruction(&message.instructions[0]);
assert_eq!(
parse_token(&compiled_instruction, &message.account_keys).unwrap(),
ParsedInstructionEnum {
instruction_type: "initializeAccount".to_string(),
info: json!({
"account": account_pubkey.to_string(),
"mint": mint_pubkey.to_string(),
"owner": owner.to_string(),
"rentSysvar": rent_sysvar.to_string(),
})
}
);
let initialize_account_ix = initialize_account2(
&spl_token::id(), &convert_pubkey(account_pubkey),
&convert_pubkey(mint_pubkey),
&convert_pubkey(owner),
)
.unwrap();
let message = make_coerced_message(initialize_account_ix, program_id);
let compiled_instruction = convert_compiled_instruction(&message.instructions[0]);
assert_eq!(
parse_token(&compiled_instruction, &message.account_keys).unwrap(),
ParsedInstructionEnum {
instruction_type: "initializeAccount2".to_string(),
info: json!({
"account": account_pubkey.to_string(),
"mint": mint_pubkey.to_string(),
"owner": owner.to_string(),
"rentSysvar": rent_sysvar.to_string(),
})
}
);
}
}