token 2022: add InitializeGroup instruction from SPL Token Group in…

…terface (#5601) * token 2022: add `InitializeGroup` instruction from SPL Token Group interface * feedback: rework rent check and test tx dedupe * clip clip clippy
solana-labs · Nov 9, 2023 · a019dcc · a019dcc
1 parent c817ecb
commit a019dcc
Show file tree

Hide file tree

Showing 10 changed files with 467 additions and 4 deletions.
diff --git a/Cargo.lock b/Cargo.lock
diff --git 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
@@ -43,8 +43,8 @@ use {
                 ConfidentialTransferFeeConfig,
             },
             cpi_guard, default_account_state, group_pointer, interest_bearing_mint, memo_transfer,
-            metadata_pointer, transfer_fee, transfer_hook, BaseStateWithExtensions, ExtensionType,
-            StateWithExtensionsOwned,
+            metadata_pointer, transfer_fee, transfer_hook, BaseStateWithExtensions, Extension,
+            ExtensionType, StateWithExtensionsOwned,
         },
         instruction, offchain,
         proof::ProofLocation,
@@ -61,6 +61,7 @@ use {
         },
         state::{Account, AccountState, Mint, Multisig},
     },
+    spl_token_group_interface::state::TokenGroup,
     spl_token_metadata_interface::state::{Field, TokenMetadata},
     std::{
         fmt, io,
@@ -3649,4 +3650,76 @@ where
         )
         .await
     }
+
+    /// Initialize token-group on a mint
+    pub async fn token_group_initialize<S: Signers>(
+        &self,
+        mint_authority: &Pubkey,
+        update_authority: &Pubkey,
+        max_size: u32,
+        signing_keypairs: &S,
+    ) -> TokenResult<T::Output> {
+        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_fixed_len_extension<V: Extension + Pod>(
+        &self,
+    ) -> TokenResult<u64> {
+        let account = self.get_account(self.pubkey).await?;
+        let account_lamports = account.lamports;
+        let mint_state = self.unpack_mint_info(account)?;
+        if mint_state.get_extension::<V>().is_ok() {
+            Ok(0)
+        } else {
+            let new_account_len = mint_state.try_get_new_account_len::<V>()?;
+            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
+    pub async fn token_group_initialize_with_rent_transfer<S: Signers>(
+        &self,
+        payer: &Pubkey,
+        mint_authority: &Pubkey,
+        update_authority: &Pubkey,
+        max_size: u32,
+        signing_keypairs: &S,
+    ) -> TokenResult<T::Output> {
+        let additional_lamports = self
+            .get_additional_rent_for_fixed_len_extension::<TokenGroup>()
+            .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
@@ -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.8", 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" }