use spl_associated_token_address in spl crates

kevinheavey · kevinheavey · commit 0abe8e689ed3 · 2024-07-18T23:40:08.000+04:00
diff --git a/Cargo.lock b/Cargo.lock
diff --git a/associated-token-account/program-test/tests/create_idempotent.rs b/associated-token-account/program-test/tests/create_idempotent.rs
@@ -17,11 +17,11 @@ use {
     },
     spl_associated_token_account::{
         error::AssociatedTokenAccountError,
-        get_associated_token_address_with_program_id,
         instruction::{
             create_associated_token_account, create_associated_token_account_idempotent,
         },
     },
+    spl_associated_token_address::get_associated_token_address_with_program_id,
     spl_token_2022::{
         extension::ExtensionType,
         instruction::initialize_account,
diff --git a/associated-token-account/program-test/tests/extended_mint.rs b/associated-token-account/program-test/tests/extended_mint.rs
@@ -13,9 +13,8 @@ use {
         signer::keypair::Keypair,
         transaction::{Transaction, TransactionError},
     },
-    spl_associated_token_account::{
-        get_associated_token_address_with_program_id, instruction::create_associated_token_account,
-    },
+    spl_associated_token_account::instruction::create_associated_token_account,
+    spl_associated_token_address::get_associated_token_address_with_program_id,
     spl_token_2022::{
         error::TokenError,
         extension::{
diff --git a/associated-token-account/program-test/tests/process_create_associated_token_account.rs b/associated-token-account/program-test/tests/process_create_associated_token_account.rs
@@ -12,9 +12,8 @@ use {
         signature::Signer,
         transaction::{Transaction, TransactionError},
     },
-    spl_associated_token_account::{
-        get_associated_token_address_with_program_id, instruction::create_associated_token_account,
-    },
+    spl_associated_token_account::instruction::create_associated_token_account,
+    spl_associated_token_address::get_associated_token_address_with_program_id,
     spl_token_2022::{extension::ExtensionType, state::Account},
 };
 
diff --git a/associated-token-account/program-test/tests/recover_nested.rs b/associated-token-account/program-test/tests/recover_nested.rs
@@ -14,7 +14,8 @@ use {
         signer::keypair::Keypair,
         transaction::{Transaction, TransactionError},
     },
-    spl_associated_token_account::{get_associated_token_address_with_program_id, instruction},
+    spl_associated_token_account::instruction,
+    spl_associated_token_address::get_associated_token_address_with_program_id,
     spl_token_2022::{
         extension::{ExtensionType, StateWithExtensionsOwned},
         state::{Account, Mint},
diff --git a/associated-token-account/program-test/tests/spl_token_create.rs b/associated-token-account/program-test/tests/spl_token_create.rs
@@ -11,9 +11,8 @@ use {
     solana_program::pubkey::Pubkey,
     solana_program_test::*,
     solana_sdk::{program_pack::Pack, signature::Signer, transaction::Transaction},
-    spl_associated_token_account::{
-        get_associated_token_address, instruction::create_associated_token_account,
-    },
+    spl_associated_token_account::instruction::create_associated_token_account,
+    spl_associated_token_address::get_associated_token_address,
     spl_token::state::Account,
 };
 
diff --git a/associated-token-account/program/Cargo.toml b/associated-token-account/program/Cargo.toml
@@ -17,6 +17,7 @@ borsh = "1.5.1"
 num-derive = "0.4"
 num-traits = "0.2"
 solana-program = "2.0.0"
+spl-associated-token-address = { version = "1.0.0", path = "../../associated-token-address" }
 spl-token = { version = "6.0", path = "../../token/program", features = [
   "no-entrypoint",
 ] }
diff --git a/associated-token-account/program/src/lib.rs b/associated-token-account/program/src/lib.rs
@@ -17,66 +17,12 @@ use solana_program::{
     sysvar,
 };
 
-solana_program::declare_id!("ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL");
 
-pub(crate) fn get_associated_token_address_and_bump_seed(
-    wallet_address: &Pubkey,
-    token_mint_address: &Pubkey,
-    program_id: &Pubkey,
-    token_program_id: &Pubkey,
-) -> (Pubkey, u8) {
-    get_associated_token_address_and_bump_seed_internal(
-        wallet_address,
-        token_mint_address,
-        program_id,
-        token_program_id,
-    )
-}
-
-/// Derives the associated token account address for the given wallet address
-/// and token mint
-pub fn get_associated_token_address(
-    wallet_address: &Pubkey,
-    token_mint_address: &Pubkey,
-) -> Pubkey {
-    get_associated_token_address_with_program_id(
-        wallet_address,
-        token_mint_address,
-        &spl_token::id(),
-    )
-}
-
-/// Derives the associated token account address for the given wallet address,
-/// token mint and token program id
-pub fn get_associated_token_address_with_program_id(
-    wallet_address: &Pubkey,
-    token_mint_address: &Pubkey,
-    token_program_id: &Pubkey,
-) -> Pubkey {
-    get_associated_token_address_and_bump_seed(
-        wallet_address,
-        token_mint_address,
-        &id(),
-        token_program_id,
-    )
-    .0
-}
-
-fn get_associated_token_address_and_bump_seed_internal(
-    wallet_address: &Pubkey,
-    token_mint_address: &Pubkey,
-    program_id: &Pubkey,
-    token_program_id: &Pubkey,
-) -> (Pubkey, u8) {
-    Pubkey::find_program_address(
-        &[
-            &wallet_address.to_bytes(),
-            &token_program_id.to_bytes(),
-            &token_mint_address.to_bytes(),
-        ],
-        program_id,
-    )
-}
+// Export current SDK types for downstream users building with a different SDK
+// version
+pub use {solana_program, spl_associated_token_address::{id, ID, check_id}};
+#[deprecated(since = "4.1.0", note = "Use `spl-associated-token-address` crate instead.")]
+pub use spl_associated_token_address::{get_associated_token_address, get_associated_token_address_with_program_id};
 
 /// Create an associated token account for the given wallet address and token
 /// mint
diff --git a/associated-token-account/program/src/processor.rs b/associated-token-account/program/src/processor.rs
@@ -5,7 +5,6 @@ use {
         error::AssociatedTokenAccountError,
         instruction::AssociatedTokenAccountInstruction,
         tools::account::{create_pda_account, get_account_len},
-        *,
     },
     borsh::BorshDeserialize,
     solana_program::{
@@ -19,6 +18,7 @@ use {
         system_program,
         sysvar::Sysvar,
     },
+    spl_associated_token_address::get_associated_token_address_and_bump_seed_internal,
     spl_token_2022::{
         extension::{ExtensionType, StateWithExtensions},
         state::{Account, Mint},
diff --git a/associated-token-address/src/lib.rs b/associated-token-address/src/lib.rs
@@ -4,6 +4,8 @@
 
 use solana_program::pubkey::Pubkey;
 
+solana_program::declare_id!("ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL");
+
 /// Derives the associated token account address and bump seed
 /// for the given wallet address, token mint and token program id
 pub fn get_associated_token_address_and_bump_seed(
@@ -20,8 +22,9 @@ pub fn get_associated_token_address_and_bump_seed(
     )
 }
 
-const TOKEN_PROGRAM: Pubkey = solana_program::pubkey!("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA");
-const ASSOCIATED_TOKEN_PROGRAM: Pubkey = solana_program::pubkey!("ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL");
+const TOKEN_PROGRAM_ID: Pubkey = solana_program::pubkey!("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA");
+/// Program ID for the Associated Token Program
+pub const ASSOCIATED_TOKEN_PROGRAM_ID: Pubkey = solana_program::pubkey!("ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL");
 
 /// Derives the associated token account address for the given wallet address
 /// and token mint
@@ -32,7 +35,7 @@ pub fn get_associated_token_address(
     get_associated_token_address_with_program_id(
         wallet_address,
         token_mint_address,
-        &TOKEN_PROGRAM,
+        &TOKEN_PROGRAM_ID,
     )
 }
 
@@ -46,13 +49,14 @@ pub fn get_associated_token_address_with_program_id(
     get_associated_token_address_and_bump_seed(
         wallet_address,
         token_mint_address,
-        &ASSOCIATED_TOKEN_PROGRAM,
+        &ASSOCIATED_TOKEN_PROGRAM_ID,
         token_program_id,
     )
     .0
 }
 
-fn get_associated_token_address_and_bump_seed_internal(
+/// For internal use only.
+pub fn get_associated_token_address_and_bump_seed_internal(
     wallet_address: &Pubkey,
     token_mint_address: &Pubkey,
     program_id: &Pubkey,
diff --git a/managed-token/program/Cargo.toml b/managed-token/program/Cargo.toml
@@ -28,6 +28,7 @@ solana-program = "2.0.0"
 spl-associated-token-account = { version = "4.0.0", path = "../../associated-token-account/program", features = [
   "no-entrypoint",
 ] }
+spl-associated-token-address = { version = "1.0.0", path = "../../associated-token-address" }
 spl-token = { version = "6.0", path = "../../token/program", features = [
   "no-entrypoint",
 ] }
diff --git a/managed-token/program/src/accounts.rs b/managed-token/program/src/accounts.rs
@@ -5,6 +5,7 @@ use {
         program_error::ProgramError,
         system_program,
     },
+    spl_associated_token_address::ASSOCIATED_TOKEN_PROGRAM_ID,
 };
 
 pub struct InitializeMint<'a, 'info> {
@@ -116,7 +117,7 @@ impl<'a, 'info> InitializeAccount<'a, 'info> {
             "Invalid key supplied for System Program",
         )?;
         assert_with_msg(
-            ctx.associated_token_program.key == &spl_associated_token_account::id(),
+            ctx.associated_token_program.key == &ASSOCIATED_TOKEN_PROGRAM_ID,
             ProgramError::InvalidInstructionData,
             "Invalid key supplied for Associataed Token Program",
         )?;
diff --git a/managed-token/program/src/instruction.rs b/managed-token/program/src/instruction.rs
@@ -8,7 +8,7 @@ use {
         pubkey::Pubkey,
         system_program,
     },
-    spl_associated_token_account::get_associated_token_address,
+    spl_associated_token_address::{get_associated_token_address, ASSOCIATED_TOKEN_PROGRAM_ID},
 };
 
 #[derive(Debug, Clone, ShankInstruction, BorshSerialize, BorshDeserialize)]
@@ -127,7 +127,7 @@ pub fn create_initialize_account_instruction(
             AccountMeta::new_readonly(freeze_authority, false),
             AccountMeta::new_readonly(*mint, false),
             AccountMeta::new_readonly(system_program::id(), false),
-            AccountMeta::new_readonly(spl_associated_token_account::id(), false),
+            AccountMeta::new_readonly(ASSOCIATED_TOKEN_PROGRAM_ID, false),
             AccountMeta::new_readonly(spl_token::id(), false),
         ],
         data: borsh::to_vec(&ManagedTokenInstruction::InitializeAccount)?,
diff --git a/stake-pool/cli/Cargo.toml b/stake-pool/cli/Cargo.toml
@@ -26,6 +26,7 @@ solana-sdk = "2.0.0"
 spl-associated-token-account = { version = "=4.0.0", path = "../../associated-token-account/program", features = [
   "no-entrypoint",
 ] }
+spl-associated-token-address = { version = "=1.0.0", path = "../../associated-token-address" }
 spl-stake-pool = { version = "=2.0.0", path = "../program", features = [
   "no-entrypoint",
 ] }
diff --git a/stake-pool/cli/src/main.rs b/stake-pool/cli/src/main.rs
@@ -46,7 +46,7 @@ use {
         system_instruction,
         transaction::Transaction,
     },
-    spl_associated_token_account::get_associated_token_address,
+    spl_associated_token_address::get_associated_token_address,
     spl_stake_pool::{
         self, find_stake_program_address, find_transient_stake_program_address,
         find_withdraw_authority_program_address,
diff --git a/stateless-asks/program/Cargo.toml b/stateless-asks/program/Cargo.toml
@@ -16,9 +16,7 @@ solana-program = "2.0.0"
 spl-token = { version = "6.0", path = "../../token/program", features = [
   "no-entrypoint",
 ] }
-spl-associated-token-account = { version = "4.0.0", path = "../../associated-token-account/program", features = [
-  "no-entrypoint",
-] }
+spl-associated-token-address = { version = "1.0.0", path = "../../associated-token-address" }
 thiserror = "1.0"
 
 [dev-dependencies]
diff --git a/stateless-asks/program/src/validation_utils.rs b/stateless-asks/program/src/validation_utils.rs
@@ -7,7 +7,7 @@ use {
         program_pack::{IsInitialized, Pack},
         pubkey::Pubkey,
     },
-    spl_associated_token_account::get_associated_token_address,
+    spl_associated_token_address::get_associated_token_address,
     spl_token::{self, state::Account},
 };
 
diff --git a/token-upgrade/cli/Cargo.toml b/token-upgrade/cli/Cargo.toml
@@ -19,7 +19,7 @@ solana-client = "2.0.0"
 solana-logger = "2.0.0"
 solana-remote-wallet = "2.0.0"
 solana-sdk = "2.0.0"
-spl-associated-token-account = { version = "4.0.0", path = "../../associated-token-account/program", features = ["no-entrypoint"] }
+spl-associated-token-address = { version = "1.0.0", path = "../../associated-token-address" }
 spl-token = { version = "6.0", path = "../../token/program", features = ["no-entrypoint"] }
 spl-token-2022 = { version = "4.0.0", path = "../../token/program-2022", features = ["no-entrypoint"] }
 spl-token-client = { version = "0.11.0", path = "../../token/client" }
diff --git a/token-upgrade/cli/src/main.rs b/token-upgrade/cli/src/main.rs
@@ -20,7 +20,7 @@ use {
         signature::{Signature, Signer},
         transaction::Transaction,
     },
-    spl_associated_token_account::get_associated_token_address_with_program_id,
+    spl_associated_token_address::get_associated_token_address_with_program_id,
     spl_token_2022::{
         extension::StateWithExtensions,
         state::{Account, Mint},
