ATA: Extract associated-token-account-client crate from associated-token-account crate (#7005)

* extract associated-token-address crate

* use spl_associated_token_address in spl crates

* use spl-program-ids in associated-token-address crate

* update imports in repo

* use solana-inline-spl instead of spl-program-ids

* remove remaining references to spl-program-ids

* Rename associated-token-address -> associated-token-account-client

* Use the new package everywhere

* Remove solana-inline-spl dependency

* Remove dependency on ata program from token-client

* Add #[doc(hidden)] attribute to internal function

* Remove ATA from token upgrade CLI

* Add program module for program id

---------

Co-authored-by: Jon C <[email protected]>

Author: kevinheavey

Cargo.lock

@@ -3,6 +3,7 @@ split-debuginfo = "unpacked"
 
 [workspace]
 members = [
+  "associated-token-account/client",
   "associated-token-account/program",
   "associated-token-account/program-test",
   "binary-option/program",

Cargo.toml

@@ -0,0 +1,14 @@
+[package]
+name = "spl-associated-token-account-client"
+version = "1.0.0"
+description = "Solana Program Library Associated Token Account Client"
+authors = ["Solana Labs Maintainers <[email protected]>"]
+repository = "https://github.com/solana-labs/solana-program-library"
+license = "Apache-2.0"
+edition = "2021"
+
+[dependencies]
+solana-program = "2.0.3"
+
+[package.metadata.docs.rs]
+targets = ["x86_64-unknown-linux-gnu"]

associated-token-account/client/Cargo.toml

@@ -0,0 +1,70 @@
+//! Address derivation functions
+
+use solana_program::pubkey::Pubkey;
+
+/// 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(
+    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,
+    )
+}
+
+mod inline_spl_token {
+    solana_program::declare_id!("TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA");
+}
+
+/// 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,
+        &inline_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,
+        &crate::program::id(),
+        token_program_id,
+    )
+    .0
+}
+
+/// For internal use only.
+#[doc(hidden)]
+pub 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,
+    )
+}

associated-token-account/client/src/address.rs

@@ -0,0 +1,107 @@
+//! Instruction creators for the program
+use {
+    crate::{address::get_associated_token_address_with_program_id, program::id},
+    solana_program::{
+        instruction::{AccountMeta, Instruction},
+        pubkey::Pubkey,
+        system_program,
+    },
+};
+
+fn build_associated_token_account_instruction(
+    funding_address: &Pubkey,
+    wallet_address: &Pubkey,
+    token_mint_address: &Pubkey,
+    token_program_id: &Pubkey,
+    instruction: u8,
+) -> Instruction {
+    let associated_account_address = get_associated_token_address_with_program_id(
+        wallet_address,
+        token_mint_address,
+        token_program_id,
+    );
+    // safety check, assert if not a creation instruction, which is only 0 or 1
+    assert!(instruction <= 1);
+    Instruction {
+        program_id: id(),
+        accounts: vec![
+            AccountMeta::new(*funding_address, true),
+            AccountMeta::new(associated_account_address, false),
+            AccountMeta::new_readonly(*wallet_address, false),
+            AccountMeta::new_readonly(*token_mint_address, false),
+            AccountMeta::new_readonly(system_program::id(), false),
+            AccountMeta::new_readonly(*token_program_id, false),
+        ],
+        data: vec![instruction],
+    }
+}
+
+/// Creates Create instruction
+pub fn create_associated_token_account(
+    funding_address: &Pubkey,
+    wallet_address: &Pubkey,
+    token_mint_address: &Pubkey,
+    token_program_id: &Pubkey,
+) -> Instruction {
+    build_associated_token_account_instruction(
+        funding_address,
+        wallet_address,
+        token_mint_address,
+        token_program_id,
+        0, // AssociatedTokenAccountInstruction::Create
+    )
+}
+
+/// Creates CreateIdempotent instruction
+pub fn create_associated_token_account_idempotent(
+    funding_address: &Pubkey,
+    wallet_address: &Pubkey,
+    token_mint_address: &Pubkey,
+    token_program_id: &Pubkey,
+) -> Instruction {
+    build_associated_token_account_instruction(
+        funding_address,
+        wallet_address,
+        token_mint_address,
+        token_program_id,
+        1, // AssociatedTokenAccountInstruction::CreateIdempotent
+    )
+}
+
+/// Creates a `RecoverNested` instruction
+pub fn recover_nested(
+    wallet_address: &Pubkey,
+    owner_token_mint_address: &Pubkey,
+    nested_token_mint_address: &Pubkey,
+    token_program_id: &Pubkey,
+) -> Instruction {
+    let owner_associated_account_address = get_associated_token_address_with_program_id(
+        wallet_address,
+        owner_token_mint_address,
+        token_program_id,
+    );
+    let destination_associated_account_address = get_associated_token_address_with_program_id(
+        wallet_address,
+        nested_token_mint_address,
+        token_program_id,
+    );
+    let nested_associated_account_address = get_associated_token_address_with_program_id(
+        &owner_associated_account_address, // ATA is wrongly used as a wallet_address
+        nested_token_mint_address,
+        token_program_id,
+    );
+
+    Instruction {
+        program_id: id(),
+        accounts: vec![
+            AccountMeta::new(nested_associated_account_address, false),
+            AccountMeta::new_readonly(*nested_token_mint_address, false),
+            AccountMeta::new(destination_associated_account_address, false),
+            AccountMeta::new_readonly(owner_associated_account_address, false),
+            AccountMeta::new_readonly(*owner_token_mint_address, false),
+            AccountMeta::new(*wallet_address, true),
+            AccountMeta::new_readonly(*token_program_id, false),
+        ],
+        data: vec![2], // AssociatedTokenAccountInstruction::RecoverNested
+    }
+}

associated-token-account/client/src/instruction.rs

@@ -0,0 +1,11 @@
+//! Client crate for interacting with the spl-associated-token-account program
+#![deny(missing_docs)]
+#![forbid(unsafe_code)]
+
+pub mod address;
+pub mod instruction;
+
+/// Module defining the program id
+pub mod program {
+    solana_program::declare_id!("ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL");
+}

associated-token-account/client/src/lib.rs

@@ -15,5 +15,6 @@ solana-program = "2.0.3"
 solana-program-test = "2.0.3"
 solana-sdk = "2.0.3"
 spl-associated-token-account = { version = "4.0.0", path = "../program", features = ["no-entrypoint"] }
+spl-associated-token-account-client = { version = "1.0.0", path = "../client" }
 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"] }

associated-token-account/program-test/Cargo.toml

@@ -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_account_client::address::get_associated_token_address_with_program_id,
     spl_token_2022::{
         extension::ExtensionType,
         instruction::initialize_account,

associated-token-account/program-test/tests/create_idempotent.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_account_client::address::get_associated_token_address_with_program_id,
     spl_token_2022::{
         error::TokenError,
         extension::{

associated-token-account/program-test/tests/extended_mint.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_account_client::address::get_associated_token_address_with_program_id,
     spl_token_2022::{extension::ExtensionType, state::Account},
 };