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

Author: joncinque

Cargo.toml

@@ -3,9 +3,9 @@ split-debuginfo = "unpacked"
 
 [workspace]
 members = [
+  "associated-token-account/client",
   "associated-token-account/program",
   "associated-token-account/program-test",
-  "associated-token-address",
   "binary-option/program",
   "binary-oracle-pair/program",
   "examples/rust/cross-program-invocation",

associated-token-address/Cargo.toml renamed to associated-token-account/client/Cargo.toml

@@ -1,15 +1,15 @@
 [package]
-name = "spl-associated-token-address"
+name = "spl-associated-token-account-client"
 version = "1.0.0"
-description = "Solana Program Library Associated Token Address"
+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-inline-spl = "2.1.0"
-solana-program = "2.1.0"
+solana-inline-spl = "2.0.3"
+solana-program = "2.0.3"
 
 [package.metadata.docs.rs]
 targets = ["x86_64-unknown-linux-gnu"]

associated-token-address/src/lib.rs renamed to associated-token-account/client/src/address.rs

@@ -1,11 +1,7 @@
-//! Convention for associating token accounts with a user wallet
-#![deny(missing_docs)]
-#![forbid(unsafe_code)]
+//! Address derivation functions
 
 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(
@@ -31,7 +27,7 @@ pub fn get_associated_token_address(
     get_associated_token_address_with_program_id(
         wallet_address,
         token_mint_address,
-        &solana_inline_spl::spl_token::ID,
+        &solana_inline_spl::token::ID,
     )
 }
 
@@ -45,7 +41,7 @@ pub fn get_associated_token_address_with_program_id(
     get_associated_token_address_and_bump_seed(
         wallet_address,
         token_mint_address,
-        &solana_inline_spl::spl_associated_token_account::ID,
+        &crate::id(),
         token_program_id,
     )
     .0

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

@@ -0,0 +1,106 @@
+//! Instruction creators for the program
+use {
+    crate::{id, address::get_associated_token_address_with_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/lib.rs

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

associated-token-account/program/Cargo.toml

@@ -17,7 +17,7 @@ borsh = "1.5.1"
 num-derive = "0.4"
 num-traits = "0.2"
 solana-program = "2.0.3"
-spl-associated-token-address = { version = "1.0.0", path = "../../associated-token-address" }
+spl-associated-token-account-client = { version = "1.0.0", path = "../client" }
 spl-token = { version = "6.0", path = "../../token/program", features = [
   "no-entrypoint",
 ] }

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

@@ -1,17 +1,10 @@
 //! Program instructions
 
-use {
-    crate::id,
-    assert_matches::assert_matches,
-    borsh::{BorshDeserialize, BorshSchema, BorshSerialize},
-    solana_program::{
-        instruction::{AccountMeta, Instruction},
-        pubkey::Pubkey,
-    },
-    spl_associated_token_address::get_associated_token_address_with_program_id,
-};
+use borsh::{BorshDeserialize, BorshSchema, BorshSerialize};
+pub use spl_associated_token_account_client::intruction::*;
 
 /// Instructions supported by the AssociatedTokenAccount program
+#[deprecated(since = "4.1.0", note = "Use instructions in `spl-associated-token-account-client` crate instead.")]
 #[derive(Clone, Debug, PartialEq, BorshDeserialize, BorshSerialize, BorshSchema)]
 pub enum AssociatedTokenAccountInstruction {
     /// Creates an associated token account for the given wallet address and
@@ -56,107 +49,3 @@ pub enum AssociatedTokenAccountInstruction {
     ///   6. `[]` SPL Token program
     RecoverNested,
 }
-
-fn build_associated_token_account_instruction(
-    funding_address: &Pubkey,
-    wallet_address: &Pubkey,
-    token_mint_address: &Pubkey,
-    token_program_id: &Pubkey,
-    instruction: AssociatedTokenAccountInstruction,
-) -> 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
-    assert_matches!(
-        instruction,
-        AssociatedTokenAccountInstruction::Create
-            | AssociatedTokenAccountInstruction::CreateIdempotent
-    );
-    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(solana_program::system_program::id(), false),
-            AccountMeta::new_readonly(*token_program_id, false),
-        ],
-        data: borsh::to_vec(&instruction).unwrap(),
-    }
-}
-
-/// 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,
-        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,
-        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,
-    );
-
-    let instruction_data = AssociatedTokenAccountInstruction::RecoverNested;
-
-    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: borsh::to_vec(&instruction_data).unwrap(),
-    }
-}

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

@@ -17,12 +17,11 @@ use solana_program::{
     sysvar,
 };
 
-
 // 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};
+pub use {solana_program, spl_associated_token_account_client::{id, ID, check_id}};
+#[deprecated(since = "4.1.0", note = "Use `spl-associated-token-account-client` crate instead.")]
+pub use spl_associated_token_account_client::{get_associated_token_address, get_associated_token_address_with_program_id};
 
 /// Create an associated token account for the given wallet address and token
 /// mint