From 8080c30c02855afdbed4d6476fa9210d865d5914 Mon Sep 17 00:00:00 2001 From: Joe Date: Wed, 18 Oct 2023 15:37:21 +0200 Subject: [PATCH] token 2022: add `InitializeGroup` instruction from SPL Token Group interface --- Cargo.lock | 3 + token/client/Cargo.toml | 1 + token/client/src/token.rs | 72 +++++ token/program-2022-test/Cargo.toml | 1 + .../tests/token_group_initialize.rs | 271 ++++++++++++++++++ token/program-2022/Cargo.toml | 1 + token/program-2022/src/extension/mod.rs | 9 +- .../src/extension/token_group/mod.rs | 11 + .../src/extension/token_group/processor.rs | 101 +++++++ token/program-2022/src/processor.rs | 5 +- 10 files changed, 473 insertions(+), 2 deletions(-) create mode 100644 token/program-2022-test/tests/token_group_initialize.rs create mode 100644 token/program-2022/src/extension/token_group/mod.rs create mode 100644 token/program-2022/src/extension/token_group/processor.rs diff --git a/Cargo.lock b/Cargo.lock index 62094f314e5..9aa59713d47 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -7232,6 +7232,7 @@ dependencies = [ "spl-memo 4.0.0", "spl-pod 0.1.0", "spl-token 4.0.0", + "spl-token-group-interface", "spl-token-metadata-interface 0.2.0", "spl-transfer-hook-interface 0.3.0", "spl-type-length-value 0.3.0", @@ -7276,6 +7277,7 @@ dependencies = [ "spl-pod 0.1.0", "spl-token-2022 0.9.0", "spl-token-client", + "spl-token-group-interface", "spl-token-metadata-interface 0.2.0", "spl-transfer-hook-example", "spl-transfer-hook-interface 0.3.0", @@ -7336,6 +7338,7 @@ dependencies = [ "spl-memo 4.0.0", "spl-token 4.0.0", "spl-token-2022 0.9.0", + "spl-token-group-interface", "spl-token-metadata-interface 0.2.0", "spl-transfer-hook-interface 0.3.0", "thiserror", diff --git a/token/client/Cargo.toml b/token/client/Cargo.toml index 9c209264e3c..f5e012711da 100644 --- a/token/client/Cargo.toml +++ b/token/client/Cargo.toml @@ -24,6 +24,7 @@ spl-associated-token-account = { version = "2.0", path = "../../associated-token spl-memo = { version = "4.0.0", path = "../../memo/program", features = ["no-entrypoint"] } spl-token = { version = "4.0", path="../program", features = [ "no-entrypoint" ] } spl-token-2022 = { version = "0.9", path="../program-2022" } +spl-token-group-interface = { version = "0.1", path="../../token-group/interface" } spl-token-metadata-interface = { version = "0.2", path="../../token-metadata/interface" } spl-transfer-hook-interface = { version = "0.3", path="../transfer-hook-interface" } thiserror = "1.0" diff --git a/token/client/src/token.rs b/token/client/src/token.rs index 8233c57bce0..4caa85d4416 100644 --- a/token/client/src/token.rs +++ b/token/client/src/token.rs @@ -3846,4 +3846,76 @@ where ) .await } + + /// Initialize token-group on a mint + pub async fn token_group_initialize( + &self, + mint_authority: &Pubkey, + update_authority: &Pubkey, + max_size: u32, + signing_keypairs: &S, + ) -> TokenResult { + self.process_ixs( + &[spl_token_group_interface::instruction::initialize_group( + &self.program_id, + &self.pubkey, + &self.pubkey, + mint_authority, + Some(*update_authority), + max_size, + )], + signing_keypairs, + ) + .await + } + + async fn get_additional_rent_for_new_group(&self) -> TokenResult { + let account = self.get_account(self.pubkey).await?; + let account_lamports = account.lamports; + let mint_state = self.unpack_mint_info(account)?; + let new_account_len = mint_state + .try_get_account_len()? + .checked_add(ExtensionType::try_calculate_account_len::(&[ + ExtensionType::TokenGroup, + ])?) + .ok_or(TokenError::Program( + spl_token_2022::error::TokenError::Overflow.into(), + ))?; + let new_rent_exempt_minimum = self + .client + .get_minimum_balance_for_rent_exemption(new_account_len) + .await + .map_err(TokenError::Client)?; + Ok(new_rent_exempt_minimum.saturating_sub(account_lamports)) + } + + /// Initialize token-group on a mint + #[allow(clippy::too_many_arguments)] + pub async fn token_group_initialize_with_rent_transfer( + &self, + payer: &Pubkey, + mint_authority: &Pubkey, + update_authority: &Pubkey, + max_size: u32, + signing_keypairs: &S, + ) -> TokenResult { + let additional_lamports = self.get_additional_rent_for_new_group().await?; + let mut instructions = vec![]; + if additional_lamports > 0 { + instructions.push(system_instruction::transfer( + payer, + &self.pubkey, + additional_lamports, + )); + } + instructions.push(spl_token_group_interface::instruction::initialize_group( + &self.program_id, + &self.pubkey, + &self.pubkey, + mint_authority, + Some(*update_authority), + max_size, + )); + self.process_ixs(&instructions, signing_keypairs).await + } } diff --git a/token/program-2022-test/Cargo.toml b/token/program-2022-test/Cargo.toml index 75068f62fd4..5408f8f41f2 100644 --- a/token/program-2022-test/Cargo.toml +++ b/token/program-2022-test/Cargo.toml @@ -29,6 +29,7 @@ spl-pod = { version = "0.1.0", path = "../../libraries/pod" } spl-token-2022 = { version = "0.9", path="../program-2022", features = ["no-entrypoint"] } spl-instruction-padding = { version = "0.1.0", path="../../instruction-padding/program", features = ["no-entrypoint"] } spl-token-client = { version = "0.7", path = "../client" } +spl-token-group-interface = { version = "0.1", path = "../../token-group/interface" } spl-token-metadata-interface = { version = "0.2", path = "../../token-metadata/interface" } spl-transfer-hook-example = { version = "0.3", path="../transfer-hook-example", features = ["no-entrypoint"] } spl-transfer-hook-interface = { version = "0.3", path="../transfer-hook-interface" } diff --git a/token/program-2022-test/tests/token_group_initialize.rs b/token/program-2022-test/tests/token_group_initialize.rs new file mode 100644 index 00000000000..54ecf3c5dab --- /dev/null +++ b/token/program-2022-test/tests/token_group_initialize.rs @@ -0,0 +1,271 @@ +#![cfg(feature = "test-sbf")] + +mod program_test; +use { + program_test::TestContext, + solana_program_test::{processor, tokio, ProgramTest}, + solana_sdk::{ + instruction::InstructionError, pubkey::Pubkey, signature::Signer, signer::keypair::Keypair, + transaction::TransactionError, transport::TransportError, + }, + spl_pod::bytemuck::pod_from_bytes, + spl_token_2022::{error::TokenError, extension::BaseStateWithExtensions, processor::Processor}, + spl_token_client::token::{ExtensionInitializationParams, TokenError as TokenClientError}, + spl_token_group_interface::{error::TokenGroupError, state::TokenGroup}, + std::{convert::TryInto, sync::Arc}, +}; + +fn setup_program_test() -> ProgramTest { + let mut program_test = ProgramTest::default(); + program_test.add_program( + "spl_token_2022", + spl_token_2022::id(), + processor!(Processor::process), + ); + program_test +} + +async fn setup(mint: Keypair, authority: &Pubkey) -> TestContext { + let program_test = setup_program_test(); + + let context = program_test.start_with_context().await; + let context = Arc::new(tokio::sync::Mutex::new(context)); + let mut context = TestContext { + context, + token_context: None, + }; + let group_address = Some(mint.pubkey()); + context + .init_token_with_mint_keypair_and_freeze_authority( + mint, + vec![ExtensionInitializationParams::GroupPointer { + authority: Some(*authority), + group_address, + }], + None, + ) + .await + .unwrap(); + context +} + +#[tokio::test] +async fn success_initialize() { + let authority = Pubkey::new_unique(); + let mint_keypair = Keypair::new(); + let mut test_context = setup(mint_keypair, &authority).await; + let payer_pubkey = test_context.context.lock().await.payer.pubkey(); + let token_context = test_context.token_context.take().unwrap(); + + let update_authority = Pubkey::new_unique(); + let max_size = 10; + let token_group = TokenGroup::new( + token_context.token.get_address(), + Some(update_authority).try_into().unwrap(), + max_size, + ); + + // fails without more lamports for new rent-exemption + let error = token_context + .token + .token_group_initialize( + &token_context.mint_authority.pubkey(), + &update_authority, + max_size, + &[&token_context.mint_authority], + ) + .await + .unwrap_err(); + assert_eq!( + error, + TokenClientError::Client(Box::new(TransportError::TransactionError( + TransactionError::InsufficientFundsForRent { account_index: 2 } + ))) + ); + + // fail wrong signer + let not_mint_authority = Keypair::new(); + let error = token_context + .token + .token_group_initialize_with_rent_transfer( + &payer_pubkey, + ¬_mint_authority.pubkey(), + &update_authority, + max_size, + &[¬_mint_authority], + ) + .await + .unwrap_err(); + assert_eq!( + error, + TokenClientError::Client(Box::new(TransportError::TransactionError( + TransactionError::InstructionError( + 1, + InstructionError::Custom(TokenGroupError::IncorrectMintAuthority as u32) + ) + ))) + ); + + token_context + .token + .token_group_initialize_with_rent_transfer( + &payer_pubkey, + &token_context.mint_authority.pubkey(), + &update_authority, + max_size, + &[&token_context.mint_authority], + ) + .await + .unwrap(); + + // check that the data is correct + let mint_info = token_context.token.get_mint_info().await.unwrap(); + let group_bytes = mint_info.get_extension_bytes::().unwrap(); + let fetched_group = pod_from_bytes::(group_bytes).unwrap(); + assert_eq!(fetched_group, &token_group); + + // fail double-init + let error = token_context + .token + .token_group_initialize_with_rent_transfer( + &payer_pubkey, + &token_context.mint_authority.pubkey(), + &update_authority, + max_size, + &[&token_context.mint_authority], + ) + .await + .unwrap_err(); + assert_eq!( + error, + TokenClientError::Client(Box::new(TransportError::TransactionError( + TransactionError::InstructionError( + 1, + InstructionError::Custom(TokenError::ExtensionAlreadyInitialized as u32) + ) + ))) + ); +} + +#[tokio::test] +async fn fail_without_group_pointer() { + let mut test_context = { + let mint_keypair = Keypair::new(); + let program_test = setup_program_test(); + let context = program_test.start_with_context().await; + let context = Arc::new(tokio::sync::Mutex::new(context)); + let mut context = TestContext { + context, + token_context: None, + }; + context + .init_token_with_mint_keypair_and_freeze_authority(mint_keypair, vec![], None) + .await + .unwrap(); + context + }; + + let payer_pubkey = test_context.context.lock().await.payer.pubkey(); + let token_context = test_context.token_context.take().unwrap(); + + let error = token_context + .token + .token_group_initialize_with_rent_transfer( + &payer_pubkey, + &token_context.mint_authority.pubkey(), + &Pubkey::new_unique(), + 5, + &[&token_context.mint_authority], + ) + .await + .unwrap_err(); + assert_eq!( + error, + TokenClientError::Client(Box::new(TransportError::TransactionError( + TransactionError::InstructionError( + 1, + InstructionError::Custom(TokenError::InvalidExtensionCombination as u32) + ) + ))) + ); +} + +#[tokio::test] +async fn fail_init_in_another_mint() { + let authority = Pubkey::new_unique(); + let first_mint_keypair = Keypair::new(); + let first_mint = first_mint_keypair.pubkey(); + let mut test_context = setup(first_mint_keypair, &authority).await; + let second_mint_keypair = Keypair::new(); + let second_mint = second_mint_keypair.pubkey(); + test_context + .init_token_with_mint_keypair_and_freeze_authority( + second_mint_keypair, + vec![ExtensionInitializationParams::GroupPointer { + authority: Some(authority), + group_address: Some(second_mint), + }], + None, + ) + .await + .unwrap(); + + let token_context = test_context.token_context.take().unwrap(); + + let error = token_context + .token + .process_ixs( + &[spl_token_group_interface::instruction::initialize_group( + &spl_token_2022::id(), + &first_mint, + token_context.token.get_address(), + &token_context.mint_authority.pubkey(), + Some(Pubkey::new_unique()), + 5, + )], + &[&token_context.mint_authority], + ) + .await + .unwrap_err(); + + assert_eq!( + error, + TokenClientError::Client(Box::new(TransportError::TransactionError( + TransactionError::InstructionError( + 0, + InstructionError::Custom(TokenError::MintMismatch as u32) + ) + ))) + ); +} + +#[tokio::test] +async fn fail_without_signature() { + let authority = Pubkey::new_unique(); + let mint_keypair = Keypair::new(); + let mut test_context = setup(mint_keypair, &authority).await; + + let token_context = test_context.token_context.take().unwrap(); + + let mut instruction = spl_token_group_interface::instruction::initialize_group( + &spl_token_2022::id(), + token_context.token.get_address(), + token_context.token.get_address(), + &token_context.mint_authority.pubkey(), + Some(Pubkey::new_unique()), + 5, + ); + instruction.accounts[2].is_signer = false; + let error = token_context + .token + .process_ixs(&[instruction], &[] as &[&dyn Signer; 0]) // yuck, but the compiler needs it + .await + .unwrap_err(); + + assert_eq!( + error, + TokenClientError::Client(Box::new(TransportError::TransactionError( + TransactionError::InstructionError(0, InstructionError::MissingRequiredSignature) + ))) + ); +} diff --git a/token/program-2022/Cargo.toml b/token/program-2022/Cargo.toml index a3e014566e7..aaad153665b 100644 --- a/token/program-2022/Cargo.toml +++ b/token/program-2022/Cargo.toml @@ -27,6 +27,7 @@ solana-program = "1.17.2" solana-zk-token-sdk = "1.17.2" spl-memo = { version = "4.0.0", path = "../../memo/program", features = [ "no-entrypoint" ] } spl-token = { version = "4.0", path = "../program", features = ["no-entrypoint"] } +spl-token-group-interface = { version = "0.1.0", path = "../../token-group/interface" } spl-token-metadata-interface = { version = "0.2.0", path = "../../token-metadata/interface" } spl-transfer-hook-interface = { version = "0.3.0", path = "../transfer-hook-interface" } spl-type-length-value = { version = "0.3.0", path = "../../libraries/type-length-value" } diff --git a/token/program-2022/src/extension/mod.rs b/token/program-2022/src/extension/mod.rs index 46a43a4562f..12b3998db50 100644 --- a/token/program-2022/src/extension/mod.rs +++ b/token/program-2022/src/extension/mod.rs @@ -34,6 +34,7 @@ use { bytemuck::{pod_from_bytes, pod_from_bytes_mut, pod_get_packed_len}, primitives::PodU16, }, + spl_token_group_interface::state::TokenGroup, spl_type_length_value::variable_len_pack::VariableLenPack, std::{ cmp::Ordering, @@ -71,6 +72,8 @@ pub mod non_transferable; pub mod permanent_delegate; /// Utility to reallocate token accounts pub mod reallocate; +/// Token-group extension +pub mod token_group; /// Token-metadata extension pub mod token_metadata; /// Transfer Fee extension @@ -905,6 +908,8 @@ pub enum ExtensionType { ConfidentialTransferFeeAmount, /// Mint contains a pointer to another account (or the same account) that holds metadata MetadataPointer, + /// Mint contains token group configurations + TokenGroup, /// Mint contains token-metadata TokenMetadata, /// Test variable-length mint extension @@ -985,6 +990,7 @@ impl ExtensionType { ExtensionType::MetadataPointer => pod_get_packed_len::(), ExtensionType::TokenMetadata => unreachable!(), ExtensionType::GroupPointer => pod_get_packed_len::(), + ExtensionType::TokenGroup => pod_get_packed_len::(), #[cfg(test)] ExtensionType::AccountPaddingTest => pod_get_packed_len::(), #[cfg(test)] @@ -1045,7 +1051,8 @@ impl ExtensionType { | ExtensionType::ConfidentialTransferFeeConfig | ExtensionType::MetadataPointer | ExtensionType::TokenMetadata - | ExtensionType::GroupPointer => AccountType::Mint, + | ExtensionType::GroupPointer + | ExtensionType::TokenGroup => AccountType::Mint, ExtensionType::ImmutableOwner | ExtensionType::TransferFeeAmount | ExtensionType::ConfidentialTransferAccount diff --git a/token/program-2022/src/extension/token_group/mod.rs b/token/program-2022/src/extension/token_group/mod.rs new file mode 100644 index 00000000000..986bda89999 --- /dev/null +++ b/token/program-2022/src/extension/token_group/mod.rs @@ -0,0 +1,11 @@ +use { + crate::extension::{Extension, ExtensionType}, + spl_token_group_interface::state::TokenGroup, +}; + +/// Instruction processor for the TokenGroup extensions +pub mod processor; + +impl Extension for TokenGroup { + const TYPE: ExtensionType = ExtensionType::TokenGroup; +} diff --git a/token/program-2022/src/extension/token_group/processor.rs b/token/program-2022/src/extension/token_group/processor.rs new file mode 100644 index 00000000000..2489b49324b --- /dev/null +++ b/token/program-2022/src/extension/token_group/processor.rs @@ -0,0 +1,101 @@ +//! Token-group processor + +use { + crate::{ + check_program_account, + error::TokenError, + extension::{ + group_pointer::GroupPointer, BaseStateWithExtensions, ExtensionType, + StateWithExtensions, StateWithExtensionsMut, + }, + state::Mint, + }, + solana_program::{ + account_info::{next_account_info, AccountInfo}, + entrypoint::ProgramResult, + msg, + program_error::ProgramError, + program_option::COption, + pubkey::Pubkey, + }, + spl_token_group_interface::{ + error::TokenGroupError, + instruction::{InitializeGroup, TokenGroupInstruction}, + state::TokenGroup, + }, +}; + +/// Processes a [InitializeGroup](enum.TokenGroupInstruction.html) instruction. +pub fn process_initialize_group( + _program_id: &Pubkey, + accounts: &[AccountInfo], + data: InitializeGroup, +) -> ProgramResult { + let account_info_iter = &mut accounts.iter(); + + let group_info = next_account_info(account_info_iter)?; + let mint_info = next_account_info(account_info_iter)?; + let mint_authority_info = next_account_info(account_info_iter)?; + + // check that the mint and group accounts are the same, since the group + // extension should only describe itself + if group_info.key != mint_info.key { + msg!("Group configurations for a mint must be initialized in the mint itself."); + return Err(TokenError::MintMismatch.into()); + } + + // scope the mint authority check, since the mint is in the same account! + { + // This check isn't really needed since we'll be writing into the account, + // but auditors like it + check_program_account(mint_info.owner)?; + let mint_data = mint_info.try_borrow_data()?; + let mint = StateWithExtensions::::unpack(&mint_data)?; + + if !mint_authority_info.is_signer { + return Err(ProgramError::MissingRequiredSignature); + } + if mint.base.mint_authority.as_ref() != COption::Some(mint_authority_info.key) { + return Err(TokenGroupError::IncorrectMintAuthority.into()); + } + + if mint.get_extension::().is_err() { + msg!( + "A mint with group configurations must have the group-pointer extension \ + initialized" + ); + return Err(TokenError::InvalidExtensionCombination.into()); + } + } + + // Allocate a TLV entry for the space and write it in + // Assumes that there's enough SOL for the new rent-exemption + let group_extension_len = + ExtensionType::try_calculate_account_len::(&[ExtensionType::TokenGroup])?; + let new_account_len = group_info + .data_len() + .checked_add(group_extension_len) + .ok_or(TokenError::Overflow)?; + group_info.realloc(new_account_len, false)?; + let mut buffer = group_info.try_borrow_mut_data()?; + let mut state = StateWithExtensionsMut::::unpack(&mut buffer)?; + let group = state.init_extension::(false)?; + *group = TokenGroup::new(mint_info.key, data.update_authority, data.max_size.into()); + + Ok(()) +} + +/// Processes an [Instruction](enum.Instruction.html). +pub fn process_instruction( + program_id: &Pubkey, + accounts: &[AccountInfo], + instruction: TokenGroupInstruction, +) -> ProgramResult { + match instruction { + TokenGroupInstruction::InitializeGroup(data) => { + msg!("TokenGroupInstruction: InitializeGroup"); + process_initialize_group(program_id, accounts, data) + } + _ => Err(ProgramError::InvalidInstructionData), + } +} diff --git a/token/program-2022/src/processor.rs b/token/program-2022/src/processor.rs index 4bcfb09b10c..77a3bb5191a 100644 --- a/token/program-2022/src/processor.rs +++ b/token/program-2022/src/processor.rs @@ -19,7 +19,7 @@ use { mint_close_authority::MintCloseAuthority, non_transferable::{NonTransferable, NonTransferableAccount}, permanent_delegate::{get_permanent_delegate, PermanentDelegate}, - reallocate, token_metadata, + reallocate, token_group, token_metadata, transfer_fee::{self, TransferFeeAmount, TransferFeeConfig}, transfer_hook::{self, TransferHook, TransferHookAccount}, AccountType, BaseStateWithExtensions, ExtensionType, StateWithExtensions, @@ -42,6 +42,7 @@ use { system_instruction, system_program, sysvar::{rent::Rent, Sysvar}, }, + spl_token_group_interface::instruction::TokenGroupInstruction, spl_token_metadata_interface::instruction::TokenMetadataInstruction, std::convert::{TryFrom, TryInto}, }; @@ -1681,6 +1682,8 @@ impl Processor { } } else if let Ok(instruction) = TokenMetadataInstruction::unpack(input) { token_metadata::processor::process_instruction(program_id, accounts, instruction) + } else if let Ok(instruction) = TokenGroupInstruction::unpack(input) { + token_group::processor::process_instruction(program_id, accounts, instruction) } else { Err(TokenError::InvalidInstruction.into()) }